request_uri |
str, none_type |
requestUri for detailed volume snapshot objects |
[optional] |
id |
str, none_type |
Identifier for the snapshot. A 42 digit hexadecimal number. |
[optional] |
name |
str, none_type |
Name of snapshot. 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 for a snapshot means it could be mounted for data restore. |
[optional] |
pool_name |
str, none_type |
Name of the pool in which the parent volume belongs to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. |
[optional] |
replication_status |
str, none_type |
Replication status. Possible values: 'complete', 'in_progress', 'pending', 'fail'. |
[optional] |
schedule_id |
str, none_type |
Identifier of protection schedule. A 42 digit hexadecimal number. |
[optional] |
schedule_name |
str, none_type |
Name of protection schedule. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. |
[optional] |
serial_number |
str, none_type |
Identifier for the SCSI protocol. A 32 digit hexadecimal number. |
[optional] |
size |
int, none_type |
Size of volume at time of snapshot (in bytes). |
[optional] |
snap_collection_id |
str, none_type |
Identifier of snapshot collection. A 42 digit hexadecimal number. |
[optional] |
snap_collection_name |
str, none_type |
Name of snapshot collection. 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] |
target_name |
str, none_type |
The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot. The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target. |
[optional] |
writable |
bool, none_type |
Whether snapshot is writable or not. Mandatory and must be set to 'true' for VSS application synchronized snapshots. |
[optional] |
access_control_records |
[AccessControlRecord], none_type |
List of access control records that apply to this snapshot. 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_uuid |
str, none_type |
Application identifier of snapshots. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. |
[optional] |
associated_links |
AssociatedLinks |
|
[optional] |
console_uri |
str, none_type |
consoleUri for detailed storage object |
[optional] |
creation_time |
int, none_type |
Time when this snapshot was created. Seconds since last epoch i.e. 00:00 January 1, 1970. |
[optional] |
customer_id |
str, none_type |
customerId |
[optional] |
description |
str, none_type |
Text description of snapshot. String of up to 255 printable ASCII characters. |
[optional] |
expiry_after |
int, none_type |
Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds. |
[optional] |
expiry_time |
int, none_type |
Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires. Seconds since last epoch i.e. 00:00 January 1, 1970. |
[optional] |
generation |
int, none_type |
generation |
[optional] |
is_manually_managed |
bool, none_type |
Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize. |
[optional] |
is_replica |
bool, none_type |
Snapshot is a replica from upstream replication partner. |
[optional] |
is_unmanaged |
bool, none_type |
Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled. |
[optional] |
last_modified |
int, none_type |
Time when this snapshot was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. |
[optional] |
metadata |
[KeyValue], none_type |
Key-value pairs that augment a snapshot'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] |
new_data_compressed_bytes |
int, none_type |
The bytes of compressed new data. |
[optional] |
new_data_uncompressed_bytes |
int, none_type |
The bytes of uncompressed new data. |
[optional] |
new_data_valid |
bool, none_type |
Indicate the usage information is valid. |
[optional] |
offline_reason |
str, none_type |
Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' . Possible values: 'user', 'recovery', 'replica', 'nvram_loss_recovery', 'serial_number_collision', 'encryption_inactive', 'encryption_key_deleted', 'vvol_unbind', 'cache_unpin_in_progress', 'over_folder_overdraft_limit', 'over_volume_usage_limit', 'pool_free_space_exhausted', 'srep_unconfigured'. |
[optional] |
origin_name |
str, none_type |
Origination group name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. |
[optional] |
resource_uri |
str, none_type |
Link to the object URI |
[optional] |
type |
str, none_type |
type |
[optional] |
vol_id |
str, none_type |
Parent volume ID. A 42 digit hexadecimal number. |
[optional] |
vol_name |
str, none_type |
Name of the parent volume in which the snapshot belongs to. 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] |
vpd_ieee0 |
str, none_type |
The first 64 bits of the snapshot's EUI-64 identifier, encoded as a hexadecimal string. Plain string. |
[optional] |
vpd_ieee1 |
str, none_type |
The last 64 bits of the snapshot's EUI-64 identifier, encoded as a hexadecimal string. Plain string. |
[optional] |
vpd_t10 |
str, none_type |
The snapshot's T10 Vendor ID-based identifier. Plain string. |
[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] |