CreateGroupSnapshotRequest Class

CreateGroupSnapshotRequest CreateGroupSnapshot enables you to create a point-in-time copy of a group of volumes. You can use this snapshot later as a backup or rollback to ensure the data on the group of volumes is consistent for the point in time that you created the snapshot. Note: Creating a group 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 Hierarchy

SystemObject
SolidFire.CoreRpcBase
SolidFire.Element.ApiCreateGroupSnapshotRequest

Namespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0

Syntax

Copy

public class CreateGroupSnapshotRequest : RpcBase

The CreateGroupSnapshotRequest type exposes the following members.

Constructors

	Name	Description
	CreateGroupSnapshotRequest	Initializes a new instance of the CreateGroupSnapshotRequest class

Top

Properties

	Name	Description
	Attributes	List of name-value pairs in JSON object format.
	EnableRemoteReplication	Replicates the snapshot created to remote storage. 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 group 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	Name for the group snapshot. If unspecified, the date and time the group 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 group snapshot will be retained until manually deleted.
	SnapMirrorLabel	Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint.
	Volumes	Unique ID of the volume image from which to copy.

Top

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.)

Top

Reference

SolidFire.Element.Api Namespace