Invoke-NimSnapVolume

The Invoke-NimSnapVolume cmdlet creates a snapshot of one or more volumes or Windows volumes hosted on volumes. This cmdlet creates snapshots of volumes using a volume object, a name, or Windows volumes mounted on access paths.

This cmdlet returns a HPESnapshot object, which contains {GroupMgmtIP, Name, CreationTime, HPEVolumeName, SnapshotCollectionName, VSS, VerifyBackup, SkipDatabaseVerification, Application, AppConsistentObjects, CrashConsistentObjects, PoolName, OnlineSnapshot, and WritableSnapshot}.

Refer to General Best Practices for Using Cmdlets for general tips for working with cmdlets. The Invoke-NimSnapVolumeCollection cmdlet also has the following best practice:

Define a single initiator group with all the initiators of each node in the cluster.

The Invoke-NimSnapVolume cmdlet has the following limitations:

The volumes being passed in the cmdlet must all belong to the same group.
Your credentials must allow you to access the groups affected by the cmdlet. Use the Set-Configuration cmdlet to configure your credentials.

If you experience a problem using the Invoke-NimSnapVolume cmdlet, check the information in Troubleshooting Cmdlet Issues.

Options

The Invoke-NimSnapVolume cmdlet supports several command line options.

-HPEVolumeName <String[]> option. The name of the volume on the group where you want to take the snapshot.

-Suffix <String> option. This is the string that will be appended to a unique string to create a unique name for the snapshot on the group.

-SnapshotName <String> option. The name on the group that will be used to create snapshot.

-OnlineSnapshot [<SwitchParameter>] option. When included with the cmdlet, this option sets the snapshot to online.

WritableSnapshot [<SwitchParameter>] option. When included with the cmdlet, this option allows applications to write to the snapshots that are created.

-GroupMgmtIP <IPAddress> option. The IP address for the management group. If you do not specify a value for this option and only one group management IP is in the registry, that group management IP address is used. If multiple group management IPs are in the registry and this option is not specified, the cmdlet fails. If HPEVolume is passed as an option or pipeline value, the HPEVolume.GroupManagementIP property is used. You set the group management IP by running Set-Configuration. Only the Windows user who ran Set-Configuration can use the information.

-PoolName <String> option. The name of the pool where the volumes reside. If you do not specify this option and there are multiple volumes with same name within the group, the cmdlet fails.

-HPEVolume <HPEVolume[]> option. This is a pipeline option that creates snapshots for specified HPEVolume objects returned by the Get-NimVolume cmdlet.

-HPEVolumeAccessPath <String[]> option. The name of the windows volume access paths that are hosting the volumes.

-InformationAction <ActionPreference> option. This is a default PowerShell option and has no effect on the cmdlet execution.

-InformationVariable <String> option. This is a default PowerShell option and has no effect on the cmdlet execution.

-WhatIf [<SwitchParameter>] option. This option validates the parameter, but does not modify data. When used with the -Verbose option, it displays messages on the console.

-Confirm [<SwitchParameter>] option. This option is used to ensure that a confirmation message is displayed. It has no effect on the cmdlet execution.

<CommonParameters>. This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Syntax variants

The command line options you use with the Invoke-NimSnapVolume cmdlet vary depending on the type of object you want to remove.

NOTE: For more details about working with the cmdlet, view the cmdlet help by entering Get-Help <cmdlet_name>.

The cmdlet has the following basic format:

Invoke-NimSnapVolume -HPEVolumeName <String[]> [-Suffix <String>] [-SnapshotName <String>] [-OnlineSnapshot <SwitchParameter>] [-WritableSnapshot <SwitchParameter>] [-GroupMgmtIP <IPAddress>] [-PoolName <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] [<CommonParameters>]

Single volume snapshot using a volume name and a snapshot name example:

Invoke-NimSnapVolume -GroupMgmtIP 10.00.000.00 -HPEVolumeName test-2 -SnapshotName 1561631331

Multiple volume snapshot using a volume name and a snapshot name example:

Invoke-NimSnapVolume -GroupMgmtIP 10.00.000.00 -HPEVolumeName test-1 test-2 -SnapshotName 1561631335

Snapshot creation for a volume using the drive letter where the volume is mounted example:

Invoke-NimSnapVolume -HPEVolumeAccessPath h:\ -SnapshotName 1561631341

Snapshot creation for a volume using the directory where the volume is mounted example:

Invoke-NimSnapVolume -HPEVolumeAccessPath C:\temp\mountpoint\test1 -SnapshotName 1561631352

Snapshot creation that passes a volume object on the pipeline example:

Get-NimVolume | Invoke-NimSnapVolume -SnapshotName 1561631357

Single volume snapshot creation using a volume name and suffix example:

Invoke-NimSnapVolume -Suffix testfj8 -HPEVolumeName test-1 -GroupMgmtIP 10.00.000.00