Create
POST v1/snapshot_collections
Description
Create a snapshot collection. VSS application-synchronized snapshot collection must specify the 'allow_writes' parameter ans set it to 'true'.
Normal Response Codes
201 202
HTTP Error Codes
400 401 403 404 409 500 501 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsVolSnapName | string | 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. | true | ||
| description | NsDescription | string | Text description of snapshot collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | false | |
| volcoll_id | NsObjectID | string | Parent volume collection ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true | ||
| is_external_trigger | NsBoolean | boolean | Is externally triggered. Possible values: 'true', 'false'. | 'false' | false | |
| vol_snap_attr_list | NsVolumeSnapshotAttributeList | Array of NsVolumeSnapshotAttribute | List of snapshot attributes for snapshots being created as part of snapshot collection creation. List of volumes with per snapshot attributes. | false | ||
| replicate | NsBoolean | boolean | True if this snapshot collection has been marked for replication. Possible values: 'true', 'false'. | 'false' | false | |
| start_online | NsBoolean | boolean | Start with snapshot set online. Possible values: 'true', 'false'. | 'false' | false | |
| allow_writes | NsBoolean | boolean | Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots. Possible values: 'true', 'false'. | 'false' | false | |
| disable_appsync | NsBoolean | boolean | Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead. Possible values: 'true', 'false'. | 'false' | false | |
| snap_verify | NsBoolean | boolean | Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization. Possible values: 'true', 'false'. | 'false' | false | |
| skip_db_consistency_check | NsBoolean | boolean | Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false. Possible values: 'true', 'false'. | 'false' | false | |
| invoke_on_upstream_partner | NsBoolean | boolean | Invoke snapshot request on upstream partner. Possible values: 'true', 'false'. | 'false' | false | |
| agent_type | NsAgentType | string enum | External management agent type for snapshots being created as part of snapshot collection. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'. | false | ||
| metadata | NsKeyValues | Array of NsKeyValue | Key-value pairs that augment a snapshot collection'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. | [] | false |
JSON Request
{
"data" : {
"vol_snap_attr_list" : [
{
"app_uuid" : "uuid-0.84816852548574",
"metadata" : [
{
"value" : "foo1",
"key" : "bar1"
},
{
"value" : "foo2",
"key" : "bar2"
}
],
"vol_id" : "0600000000000004d300000000000000000000000f"
},
{
"app_uuid" : "uuid-0.546490314142222",
"metadata" : [
{
"value" : "foo1",
"key" : "bar1"
},
{
"value" : "foo2",
"key" : "bar2"
}
],
"vol_id" : "0600000000000004d3000000000000000000000010"
}
],
"name" : "snapcoll0.491625298539827",
"agent_type" : "openstack",
"metadata" : [
{
"value" : "foo1",
"key" : "bar1"
},
{
"value" : "foo2",
"key" : "bar2"
}
],
"volcoll_id" : "0700000000000004d300000000000000000000000e",
"description" : "X1fN9Vt4ExFAPX29UaXxH5OGhx4xawWoqCwTyTbbrBfBgQl0YhiSfrgvlNMaEcye"
}
}
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for snapshot collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsVolSnapName | string | 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. | |
| description | NsDescription | string | Text description of snapshot collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| volcoll_name | NsObjectName | string | Volume collection name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| volcoll_id | NsObjectID | string | Parent volume collection ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| origin_name | NsObjectName | string | Origination group name/ID. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| is_replica | NsBoolean | boolean | Mark or unmark specified snapshot collection for replication. When marking for replication, the snapshot collection must have been created by an existing replicating protection schedule and no newer snapshot collection for this volume collection should have already started to replicate. Often used to replicate a snapshot collection from previously downstream partner to another partner. Possible values: 'true', 'false'. | |
| is_complete | NsBoolean | boolean | Is complete. Possible values: 'true', 'false'. | |
| is_manual | NsBoolean | boolean | Is manual. Possible values: 'true', 'false'. | |
| is_external_trigger | NsBoolean | boolean | Is externally triggered. Possible values: 'true', 'false'. | |
| is_unmanaged | NsBoolean | boolean | Is snapshot collection unmanaged, so that it will not be automatically deleted. Possible values: 'true', 'false'. | |
| repl_status | NsSnapReplStatus | string enum | Replication status. Possible values: 'complete', 'in_progress', 'pending'. | |
| repl_start_time | NsTime | number | Replication start time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| repl_complete_time | NsTime | number | Replication complete time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| repl_bytes_transferred | NsUnsignedLong | number | Number of bytes transferred after replication completes. Unsigned 64-bit integer. Example: 1234. | |
| creation_time | NsTime | number | Time when this snapshot collection was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this snapshot collection was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| online_status | NsOnlineStatus | string enum | Online status of snapcoll. This is based on the online status of the individual snapshots. Online status based on that of the constituent entities. Possible values: 'online', 'offline' or 'partial'. | |
| snapshots_list | NsSnapshotListFromSnapshotCollections | Array of NsSnapshotFromSnapshotCollections | List of snapshots in the snapshot collection. Snapshot list as presented in snapshot collections object set. | |
| replicate | NsBoolean | boolean | True if this snapshot collection has been marked for replication. Possible values: 'true', 'false'. | |
| allow_writes | NsBoolean | boolean | Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots. Possible values: 'true', 'false'. | |
| sched_id | NsObjectID | string | ID of protection schedule of snapshot collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| sched_name | NsObjectName | string | Name of protection schedule of snapshot collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| metadata | NsKeyValues | Array of NsKeyValue | Key-value pairs that augment a snapshot collection'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. |
JSON Response
{
"data" : {
"repl_bytes_transferred" : 0,
"repl_status" : null,
"is_complete" : true,
"repl_start_time" : 0,
"replicate" : false,
"volcoll_id" : "0700000000000004d300000000000000000000000e",
"metadata" : [
{
"value" : "foo1",
"key" : "bar1"
},
{
"value" : "foo2",
"key" : "bar2"
}
],
"creation_time" : 1474223926,
"id" : "0500000000000004d300000000000000000000000a",
"repl_complete_time" : 0,
"is_replica" : false,
"volcoll_name" : "volcoll0.87600602212089",
"sched_id" : "",
"is_unmanaged" : true,
"last_modified" : 1474223926,
"name" : "snapcoll0.491625298539827",
"description" : "X1fN9Vt4ExFAPX29UaXxH5OGhx4xawWoqCwTyTbbrBfBgQl0YhiSfrgvlNMaEcye",
"origin_name" : "g1a1",
"sched_name" : "",
"is_manual" : true,
"online_status" : "offline",
"snapshots_list" : [
{
"snap_name" : "snapcoll0.491625298539827",
"snapcoll_id" : "0500000000000004d300000000000000000000000a",
"schedule_name" : "",
"name" : "snapcoll0.491625298539827",
"vol_id" : "0600000000000004d300000000000000000000000f",
"snap_id" : "0400000000000004d300000000000000100000000a",
"vol_name" : "vol10.315341341223125",
"id" : "0400000000000004d300000000000000100000000a",
"snapcoll_name" : "snapcoll0.491625298539827",
"schedule_id" : ""
},
{
"snap_name" : "snapcoll0.491625298539827",
"snapcoll_id" : "0500000000000004d300000000000000000000000a",
"schedule_name" : "",
"name" : "snapcoll0.491625298539827",
"vol_id" : "0600000000000004d3000000000000000000000010",
"snap_id" : "0400000000000004d300000000000000110000000a",
"vol_name" : "vol20.998995931762924",
"id" : "0400000000000004d300000000000000110000000a",
"snapcoll_name" : "snapcoll0.491625298539827",
"schedule_id" : ""
}
],
"is_external_trigger" : false
}
}