Skip to content

Latest commit

 

History

History
108 lines (103 loc) · 17.7 KB

NimbleVolumeDetails.md

File metadata and controls

108 lines (103 loc) · 17.7 KB

NimbleVolumeDetails

Properties

Name Type Description Notes
request_uri str, none_type requestUri for detailed volume objects [optional]
base_snap_id str, none_type Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation. A 42 digit hexadecimal number. [optional]
base_snap_name str, none_type Name of base snapshot. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. [optional]
clone bool, none_type Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true. [optional]
dest_pool_id str, none_type ID of the destination pool where the volume is moving to. A 42 digit hexadecimal number. [optional]
dest_pool_name str, none_type Name of the destination pool where the volume is moving to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
folder_id str, none_type ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. [optional]
folder_name str, none_type Name of the folder holding this volume. It can be empty. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
id str, none_type Identifier for the volume. A 42 digit hexadecimal number. [optional]
name str, none_type Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. [optional]
online bool, none_type Online state of volume, available for host initiators to establish connections. [optional]
owned_by_group str, none_type Name of group that currently owns the volume. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
owned_by_group_id str, none_type ID of group that currently owns the volume. A 42 digit hexadecimal number. [optional]
parent_vol_id str, none_type Parent volume ID. A 42 digit hexadecimal number. [optional]
parent_vol_name str, none_type Name of parent volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints. [optional]
perfpolicy_id str, none_type Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal number. [optional]
perfpolicy_name str, none_type Name of performance policy. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
pool_id str, none_type Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal number. [optional]
pool_name str, none_type Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
read_only bool, none_type Volume is read-only. [optional]
replication_role str, none_type Replication role that this volume performs. Possible values: 'periodic_snapshot_downstream', 'synchronous_upstream', 'synchronous_downstream', 'no_replication', 'periodic_snapshot_upstream'. [optional]
secondary_serial_number str, none_type Secondary identifier associated with the volume for the SCSI protocol. [optional]
serial_number str, none_type Identifier associated with the volume for the SCSI protocol. A 32 digit hexadecimal number. [optional]
size int, none_type Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume. [optional]
target_name str, none_type The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target. [optional]
volcoll_id str, none_type ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string. An optional NsObjectID. A 42 digit hexadecimal number or the empty string. [optional]
volcoll_name str, none_type Name of volume collection of which this volume is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. [optional]
access_control_records [AccessControlRecord], none_type List of access control records that apply to this volume. List of access control records associated with a volume or snapshot or protocol endpoint. [optional]
agent_type str, none_type External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'. [optional]
app_category str, none_type Application category that the volume belongs to. Plain string. [optional]
app_uuid str, none_type Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. [optional]
associated_links AssociatedLinks [optional]
block_size int, none_type Size in bytes of blocks in the volume. [optional]
cache_needed_for_pin int, none_type The amount of flash needed to pin the volume. [optional]
cache_pinned bool, none_type If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume. [optional]
cache_policy str, none_type Cache policy applied to the volume. Possible values: 'disabled', 'normal', 'aggressive', 'no_write', 'aggressive_read_no_write'. [optional]
caching_enabled bool, none_type Indicate caching the volume is enabled. [optional]
cksum_last_verified int, none_type Last checksum verification time. [optional]
console_uri str, none_type consoleUri for detailed storage object [optional]
content_repl_errors_found bool, none_type Indicates whether the last content based replication had errors. [optional]
creation_time int, none_type Time when this volume was created. Seconds since last epoch i.e. 00:00 January 1, 1970. [optional]
customer_id str, none_type customerId [optional]
dedupe_enabled bool, none_type Indicate whether dedupe is enabled. [optional]
description str, none_type Text description of volume. String of up to 255 printable ASCII characters. [optional]
encryption_cipher str, none_type The encryption cipher of the volume. Possible values: 'none', 'aes_256_xts'. [optional]
force bool, none_type Forcibly offline, reduce size or change read-only status a volume. [optional]
full_name str, none_type Fully qualified name of volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. [optional]
generation int, none_type generation [optional]
inherit_acl bool, none_type In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list. [optional]
iscsi_target_scope str, none_type This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting. Possible values: 'volume', 'group'. [optional]
last_content_snap_br_cg_uid int, none_type The branch cg uid of the content based snapshot that was last replicated. [optional]
last_content_snap_br_gid int, none_type The branch gid of the content based snapshot that was last replicated. [optional]
last_content_snap_id int, none_type The ID of the content based snapshot that was last replicated. [optional]
last_modified int, none_type Time when this volume was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. [optional]
last_snap SnapSummary [optional]
limit int, none_type Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100. [optional]
limit_iops int, none_type IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). [optional]
limit_mbps int, none_type Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). [optional]
metadata [KeyValue], none_type Key-value pairs that augment a volume's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. [optional]
move_aborting bool, none_type This indicates whether the move of the volume is aborting or not. [optional]
move_bytes_migrated int, none_type The bytes of volume which have been moved. [optional]
move_bytes_remaining int, none_type The bytes of volume which have not been moved. [optional]
move_est_compl_time int, none_type The estimated time of completion of a move. Seconds since last epoch i.e. 00:00 January 1, 1970. [optional]
move_start_time int, none_type The Start time when this volume was moved. Seconds since last epoch i.e. 00:00 January 1, 1970. [optional]
multi_initiator bool, none_type This indicates whether volume and its snapshots are multi-initiator accessible. This attribute applies only to volumes and snapshots available to iSCSI initiators.Online state of volume, available for host initiators to establish connections. [optional]
needs_content_repl bool, none_type Indicates whether the volume needs content based replication. [optional]
num_snaps int, none_type Number of live, non-hidden snapshots for this volume. [optional]
offline_reason str, none_type Volume offline reason. Possible values: 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'over_snapshot_reserve', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress'. [optional]
online_snaps [SnapshotFromVolume], none_type The list of online snapshots of this volume. Snapshot list as presented in volumes object set. [optional]
pinned_cache_size int, none_type The amount of flash pinned on the volume. [optional]
pre_filter str, none_type Pre-filtering criteria. Plain string. [optional]
previously_deduped bool, none_type Indicate whether dedupe has ever been enabled on this volume. [optional]
projected_num_snaps int, none_type Depricated. Projected number of snapshots (including schedued and manual) for this volume. [optional]
protection_type str, none_type Specifies if volume is protected with schedules. If protected, indicate whether replication is setup. Volume Collection or volume is protected locally or remotely or unprotected. Possible values: 'local', 'remote' or 'unprotected'. [optional]
reserve int, none_type Amount of space to reserve for this volume as a percentage of volume size. Percentage as integer from 0 to 100. [optional]
resource_uri str, none_type Link to the object URI [optional]
search_name str, none_type Name of volume used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. [optional]
snap_reserve int, none_type Amount of space to reserve for snapshots of this volume as a percentage of volume size. [optional]
snap_usage_compressed_bytes int, none_type Sum of compressed backup data in bytes stored in snapshots of this volume. [optional]
snap_usage_populated_bytes int, none_type Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots. [optional]
snap_usage_uncompressed_bytes int, none_type Sum of uncompressed unique backup data in bytes stored in snapshots of this volume. [optional]
snap_warn_level int, none_type Threshold for available space as a percentage of volume size below which an alert is raised. [optional]
space_usage_level str Indicates space usage level based on warning level. Possible values: 'normal', 'warning', 'critical'. [optional]
srep_last_sync int, none_type Time when synchronously replicated volume was last synchronized. [optional]
srep_resync_sync int, none_type Percentage of resync progress for synchronously replicated volume. [optional]
thinly_provisioned bool, none_type Allow volume to be advertised as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. This change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently. [optional]
total_usage_bytes int, none_type Sum of compressed data and compressed backup data in bytes of this volume. [optional]
type str, none_type type [optional]
upstream_cache_pinned bool, none_type This indicates whether the upstream volume is cache pinned or not. [optional]
usage_valid bool, none_type This indicates whether usage information of volume and snapshots are valid or not. [optional]
vol_state str, none_type Status of the volume. Possible values: 'online', 'offline', 'non_writable', 'read_only', 'login_only'. [optional]
vol_usage_compressed_bytes int, none_type Compressed data in bytes for this volume. [optional]
vol_usage_uncompressed_bytes int, none_type Uncompressed data in bytes for this volume. [optional]
vpd_ieee0 str, none_type The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string. [optional]
vpd_ieee1 str, none_type The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string. Plain string. [optional]
vpd_t10 str, none_type The volume's T10 Vendor ID-based identifier. Plain string. [optional]
warn_level int, none_type Threshold for available space as a percentage of volume size below which an alert is raised. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]