IBlockStorageProviderCreateSnapshot Method |
Creates a new snapshot.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax Snapshot CreateSnapshot(
string volumeId,
bool force = false,
string displayName = "None",
string displayDescription = null,
string region = null,
CloudIdentity identity = null
)
Function CreateSnapshot (
volumeId As String,
Optional force As Boolean = false,
Optional displayName As String = "None",
Optional displayDescription As String = Nothing,
Optional region As String = Nothing,
Optional identity As CloudIdentity = Nothing
) As Snapshot
Snapshot^ CreateSnapshot(
String^ volumeId,
bool force = false,
String^ displayName = L"None",
String^ displayDescription = nullptr,
String^ region = nullptr,
CloudIdentity^ identity = nullptr
)
abstract CreateSnapshot :
volumeId : string *
?force : bool *
?displayName : string *
?displayDescription : string *
?region : string *
?identity : CloudIdentity
(* Defaults:
let _force = defaultArg force false
let _displayName = defaultArg displayName "None"
let _displayDescription = defaultArg displayDescription null
let _region = defaultArg region null
let _identity = defaultArg identity null
*)
-> Snapshot
Parameters
- volumeId
- Type: SystemString
The ID of the volume to snapshot. The value should be obtained from Volume.Id. - force (Optional)
- Type: SystemBoolean
If , the snapshot is created even if the volume is currently attached. - displayName (Optional)
- Type: SystemString
Name of the snapshot. - displayDescription (Optional)
- Type: SystemString
Description of snapshot. - region (Optional)
- Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used. - identity (Optional)
- Type: net.openstack.Core.DomainCloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.
Return Value
Type:
SnapshotA
Snapshot object containing the details about the snapshot.
Exceptions Remarks
The snapshot operation is performed asynchronously. After this call returns,
WaitForSnapshotAvailable(String, Int32, NullableTimeSpan, String, CloudIdentity) may be called to wait until the snapshot
process is complete and the snapshot is available.
Creating a snapshot makes a point-in-time copy of the volume.
All writes to the volume should be flushed before creating the snapshot, either by un-mounting any file systems on the volume, or by detaching the volume before creating the snapshot.
Snapshots are incremental, so each time you create a new snapshot, you are appending the incremental changes for the new snapshot to the previous one.
The previous snapshot is still available. Note that you can create a new volume from the snapshot if desired.
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also