Windows Integration Guide Search

Using Nimble Windows Toolkit PowerShell Cmdlets

For FC (and iSCSI) arrays, Nimble Windows Toolkit PowerShell cmdlets can be used to display volume information, disk mapping, and for configuring group management IPs to communicate with service providers, for example, to perform off-host backups.

Beginning with Nimble Windows Toolkit (NWT) 4.1, additional cmdlets are available to create clones of Nimble volumes, volume collections or snapshots; connect Nimble volumes or clones to the local host; disconnect Nimble volumes from a host and remove the initiator ACL; perform application object queries on Nimble snapshots or snapshot collections; and disconnect and remove Nimble volumes from the array.

Help information for each cmdlet can be displayed using the Get-Help function. For example, enter Get-Help Get-NimSnapshot to show the syntax and description of the Get-NimSnapshot cmdlet.

Examples for each cmdlet can also be displayed using the Get-Help function with the --Examples option. For example, enter Get-Help Clear-NWTConfiguration -- Examples to show examples of the Clear-NWTConfiguration cmdlet.

Note: You must have NimbleOS 4.1.0.0 or later installed to take advantage of these additional cmdlets.

To begin using the NWT PowerShell cmdlets, do one of the following:

  • Launch the Nimble PowerShell cmdlets using the shortcut created by the NWT installer
    Note: The PowerShell window must be opened with elevated privileges (Run As Administrator).
  • Open a PowerShell window and enter the command Import-Module <NWT_install_location> \Nimble.PowerShellCmdlest.psd1

    For example:

    PS C:\Administrator> Import-Module'C:\Program Files\Nimble Storage\bin\NimblePowerShellCmdlets.psd1'

After the NWT PowerShell cmdlets are imported, run the Set-NWTConfiguration cmdlet to set the IP address and credentials for the Nimble group you want to work in.

PowerShell Cmdlets Summary
Cmdlet Description
Set-NWTConfiguration Sets the Nimble group management IP address to be used by the VSS provider for discovery and snapshot processes. Should be executed on a backup host.

Used to configure group credentials on the host, which is a prerequisite to perform restore operations through the Nimble VSS Hardware Provider.

Note: The Set-NWTConfiguration cmdlet is required to run all the application aware data management cmdlets.
Get-NWTConfiguration Shows the IP address and credentials that were set using the Set-NWTConfiguration cmdlet.
Clear-NWTConfiguration Clears the settings made with the Set-NWTConfiguration cmdlet. Using this cmdlet, you can clear all group management IP addresses and their credentials from the registry, and remove the settings pertaining to the given Group Management IP address.
Get-NimVolume Displays all iSCSI and FC Nimble volumes connected to the host. For volumes accessed using FC, provides detailed mapping information (source and target WWPN).

Use this cmdlet with the -verbose option to list any orphan mappings. Orphan mappings are valid, but do not map to any physical disk device in Windows.

Set-NimVolume Manipulates various Windows disk and volume attributes associated with a specified Nimble volume. This command can be used to reset the Windows VDS flags and attributes on a volume cloned or restored from a VSS snapshot so that it can be mounted as a disk. The disk to be manipulated is specified using the Disk identifier (DiskID) or Nimble volume serial number. Either the DiskID or serial number must be specified.
Connect-NimVolume Connects any Nimble volume or clone to the local host.

Use this cmdlet to assign a drive letter or directory path as an access path to the volume, add a new disk signature, reset the VSS flags (if necessary), and add the volume to a cluster as either a cluster resource or CSV.

Disconnect-NimVolume Disconnects the specified Nimble volume from the Windows host and removes associated initiator groups from the volume Access Control List (ACL).

If the Windows host is part of a Windows 2012 or later failover cluster, the disconnect is performed on all nodes of the cluster.

Note: A best effort is made to disconnect even if an operation fails and as many volumes as possible are disconnected. If errors are encountered, the exceptions are listed and you are instructed to manually clean up those connections.

This cmdlet closes all connections, deletes Favorites (for iSCSI), and deletes any cluster resources associated with the volume.

Note: In a Windows 2008 R2 cluster, all operations are performed only on the local node. If volumes are connected through iSCSI, connections must be manually removed from nodes other than the local note. Cluster resources also must be manually removed from other nodes.
Invoke-CloneNimVolume Creates clones of Nimble volumes, Nimble snapshots, or Windows volumes hosted on Nimble volumes using access paths.

Use this cmdlet to optionally assign a drive letter or specify a directory path to the Windows volumes, and add the cloned volumes to a cluster as an available disk resource or a CSV.

Invoke-CloneNimVolumeCollection Creates clones of Nimble volumes in a Nimble volume collection or of snapshots in a snapshot collection.

You can use this cmdlet to optionally assign a drive letter or specify a directory path to the Windows volumes, and add the cloned volumes to a cluster as an available disk resource or a CSV.

Get-NimSnapshotCollection Queries application object metadata on Nimble snapshots and returns snapshot collections. The returned snapshot collection object can be used as a unit to clone a volume or a volume collection. Returned objects are sorted in reverse chronological order (latest first) based on CreateTime.
Get-NimSnapshot Provides the capability to query snapshots based on a Nimble volume or a specific snapshot collection.
Remove-NimVolume Disconnects Nimble volumes from the Windows host and deletes the volumes from the Nimble array.

If the -DeleteBaseSnap parameter is specified and the volume is a clone, the base snapshot is deleted.

If the Windows host is part of a Windows 2012 or above failover cluster, the disconnect is performed on all nodes of the cluster.
Note: A best effort is made to disconnect even if an operation fails and as many volumes as possible are disconnected. If errors are encountered, the exceptions are listed and you are instructed to manually clean up those connections.

This cmdlet closes all connections and deletes Favorites (for iSCSI), and deletes any cluster resources associated with the volume.

Note: In a Windows 2008 R2 cluster, all operations are performed only on the local node. If volumes are connected through iSCSI, connections must be manually removed from nodes other than the local note. Cluster resources also must be manually removed from other nodes.