CreateSnapshotRequest Class |
CreateSnapshotRequest
CreateSnapshot enables you to create a point-in-time copy of a volume. You can create a snapshot from any volume or from an existing snapshot. If you do not provide a SnapshotID with this API method, a snapshot is created from the volume's active branch.
If the volume from which the snapshot is created is being replicated to a remote cluster, the snapshot can also be replicated to the same target. Use the enableRemoteReplication parameter to enable snapshot replication.
Note: Creating a snapshot is allowed if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class CreateSnapshotRequest : RpcBase
The CreateSnapshotRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CreateSnapshotRequest | Initializes a new instance of the CreateSnapshotRequest class |
Properties| Name | Description | |
|---|---|---|
 | Attributes |
List of name-value pairs in JSON object format.
|
| EnableRemoteReplication |
Replicates the snapshot created to a remote cluster.
Possible values are:
true: The snapshot is replicated to remote storage.
false: Default. The snapshot is not replicated.
|
| EnsureSerialCreation |
Specify if the snapshot creation should be failed if a previous snapshot replication is in progress.
Possible values are:
true: This ensures only one snapshot is being replicated at a time by failing this snapshot creation.
false: Default. This allows creation of snapshot if another snapshot replication is still in progress.
|
| ExpirationTime |
Specify the time after which the snapshot can be removed. Cannot be used with retention.
If neither 'expirationTime' nor 'retention' is specified, the snapshot will be retained until
manually deleted.
The format is:
ISO 8601 date string for time based expiration, otherwise it will not expire.
'null' is the snapshot is to be retained permanently.
'fifo' causes the snapshot to be preserved on a First-In-First-Out basis, relative to other FIFO
snapshots on the volume. The API will fail if no FIFO space is available.
Warning: Due to a bug, 'expirationTime' does not work correctly prior to magnesium-patch5. Use 'retention' instead.
|
| Name |
Specifies a name for the snapshot. If unspecified, the date and time the snapshot was taken is used.
|
| Retention |
This operates the same as the expirationTime option, except the time format is HH:MM:SS.
If neither 'expirationTime' nor 'retention' is specified, the snapshot will be retained until
manually deleted.
|
| SnapMirrorLabel |
Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
|
| SnapshotID |
Specifies the unique ID of a snapshot from which the new snapshot
is made. The snapshotID passed must be a snapshot on the given volume.
|
| VolumeID |
Specifies the unique ID of the volume image from which to copy.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.) |
See Also