Skip to main content

Create a consistency group Snapshot copy

Contributors
PDFs

POST /application/consistency-groups/{consistency_group.uuid}/snapshots

Introduced In: 9.10

Creates a Snapshot copy of an existing consistency group.

Required properties

  • consistency_group.uuid - Existing consistency group UUID in which to create the Snapshot copy.

Parameters

Name Type In Required Description

consistency_group.uuid

string

path

True

The unique identifier of the consistency group to retrieve.

action

string

query

False

Initiates the Snapshot copy create operation. The start of the Snapshot copy operation can optionally use a timeout value specified by "action_timeout". The Snapshot copy is committed by calling PATCH on the Snapshot copy href link with action specified as "commit".

  • Introduced in: 9.11

  • enum: ["start"]

action_timeout

integer

query

False

Duration to complete the 2-phase Snapshot copy operation. This also specifies the maximum duration that the write-fence remains in effect on the volumes associated with this consistency group. Default is 7 seconds with a valid range of 5 to 120 seconds.

  • Introduced in: 9.11

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

self_link

comment

string

Comment for the Snapshot copy.

consistency_group

consistency_group

The consistency group of the Snapshot copy.

consistency_type

string

Consistency type. This is for categorization purposes only. A Snapshot copy should not be set to 'application consistent' unless the host application is quiesced for the Snapshot copy. Valid in POST.

create_time

string

Time the snapshot copy was created

is_partial

boolean

Indicates whether the Snapshot copy taken is partial or not.

luns

luns

The list of LUNs in this Snapshot copy.

missing_volumes

array[volume_reference]

List of volumes which are not in the Snapshot copy.

name

string

Name of the Snapshot copy.

namespaces

namespaces

The list of NVMe namespaces in this Snapshot copy.

reclaimable_space

integer

Space reclaimed when the Snapshot copy is deleted, in bytes.

restore_size

integer

Size of the consistency group if this Snapshot copy is restored.

size

integer

Size of the active file system at the time the Snapshot copy is captured. The actual size of the Snapshot copy also includes those blocks trapped by other Snapshot copies. On a Snapshot copy deletion, the "size" amount of blocks is the maximum number of blocks available. On a Snapshot copy restore, the "afs-used size" value will match the Snapshot copy "size" value.

snaplock_expiry_time

string

SnapLock expiry time for the Snapshot copy, if the Snapshot copy is taken on a SnapLock consistency group. A Snapshot copy is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond its retention time. This option can be set during Snapshot copy POST and Snapshot copy PATCH on Snapshot copy locking enabled consistency groups.

snapmirror_label

string

Snapmirror Label for the Snapshot copy.

snapshot_volumes

array[consistency_group_volume_snapshot]

List of volume and snapshot identifiers for each volume in the Snapshot copy.

svm

svm_reference

SVM, applies only to SVM-scoped objects.

svm_dr

svm_dr

SVM DR attributes.

uuid

string

The unique identifier of the Snapshot copy. The UUID is generated by ONTAP w