volume snapshot create
Create a snapshot
Availability: This command is available to cluster and Vserver administrators at the admin privilege level.
Description
The volume snapshot create
command creates a snapshot of a specified volume.
Parameters
-vserver <vserver name>
- Vserver-
This specifies the Vserver that contains the volume on which the snapshot is to be created.
-volume <volume name>
- Volume-
This specifies the volume where a snapshot is to be created.
-snapshot <snapshot name>
- Snapshot-
This specifies the name of the snapshot that is to be created.
[-comment <text>]
- Comment-
This optionally specifies a comment for the snapshot.
[-foreground {true|false}]
- Foreground Process-
If you use this option and select
false
, the snapshot creation process runs in the background. If you use this option and selecttrue
, the snapshot creation process runs in the foreground. The default istrue
. [-snapmirror-label <text>]
- Label for SnapMirror Operations-
If you specify this option, the snapshot is created with the SnapMirror Label that you specify. If this option is not specified, the snapshot is created with no SnapMirror Label. The SnapMirror Label is used by the Vaulting subsystem when you back up snapshots to the Vault Destination.
[-expiry-time <MM/DD/YYYY HH:MM:SS>]
- Expiry Time-
If you specify this option, the snapshot is created with the expiry time that you specify. The expiry time indicates the time at which the snapshot becomes eligible for deletion.
[-snaplock-expiry-time {MM/DD/YYYY HH:MM:SS [{+|-}hh:mm] | infinite}]
- SnapLock Expiry Time-
This optionally specifies an expiry time for the snapshot. A snapshot with an expiry time cannot be deleted until the expiry time has elapsed. This option takes effect only on volumes with
snapshot-locking-enabled
set to true. If this option is not specified, the snapshot will not be under retention.
Examples
The following example creates a snapshot named vol3_snap on a volume named vol3 on a Vserver named vs0. The snapshot is given the comment "Single snapshot" and the operation runs in the background.
cluster1::> volume snapshot create -vserver vs0 -volume vol3 -snapshot vol3_snapshot -comment "Single snapshot" -foreground false