Get-NimSnapshotCollection

The Get-NimSnapshotCollection cmdlet enables you to perform an application object based query for snapshot collections. Returned objects are sorted in reverse chronological order (latest first), based on the time they were created (CreateTime).

Syntax Variants

-VolumeCollectionName option

When this option is used, the query returns only the snapshots for the named volume collection.

Get-NimSnapshotCollection [-VolumeCollectionName] <string> [-GroupMgmtIP] <IPAddress> [-From <datetime>] [-To <datetime>] [-MaxObjects <uint32>] [-AppObject <string>] [-Compare <string>] [-Application <string>] [-AppConsistentOnly]

-AppObject option

When this option is used, the query returns snapshot collections that match the object name and identifier, for example, database, mailbox name, or ID that is stored in the object metadata.

Get-NimSnapshotCollection <-MaxObjects <uint32>> <string> [-GroupMgmtIP] <IPAddress> [-From <datetime>] [-To <datetime>] [-AppObject <string>] [-Compare <string>] [-Application <string>] [-AppConsistentOnly]

NOTE:

The -AppConsistentOnly option is a switch parameter used to specify whether to include only application consistent snapshots. The default is to include both application consistent and crash consistent snapshots.

The behavior of the cmdlet with the -AppConsistentOnly option depends on how the -AppObject is specified:
  • When the -AppObject option is specified and -AppConsistentOnly is false, the cmdlet includes VSS snapshots taken by VSS requestor that are either in 'ns_app_consistent_objects_*' or 'ns_crash_consistent_objects_*'.
  • When the -AppObject option is specified and -AppConsistentOnly is true, the cmdlet includes VSS snapshots taken by VSS requestor that are only in 'ns_app_consistent_objects_*'.
  • When the -AppObject option is not specified and the -AppConsistentOnly option is false, the cmdlet includes VSS or crash consistent snapshots.
  • When the -AppObject option is not specified and the -AppConsistentOnly option is true, the cmdlet includes any VSS snapshots taken by the VSS requestor or a third-party VSS aware backup that uses the VSS hardware provider.

Get a specific number of snapshot collections for a volume collection

Use the -MaxObjects option to return the number of snapshot collections you want to view for a specific volume collection.
NOTE: Be aware that if you request a very large number of snapshot collections without filter parameters, the search may return a large number of objects, which could impact the array group resource consumption and performance.

Get the latest single snapshot collection for the "TestVolcoll" volume collection.

Example
PS C:\Users\Administrator> Get-NimSnapshotCollection -VolumeCollectionName TestVolcoll -MaxObjects 1
GroupMgmtIP            : 10.18.236.77
Name                   : c32-tc3-sql1-weekly-2016-04-22::13:01:32.550
VolumeCollectionName   : c32-tc3-sql1
CreationTime           : 4/22/2016 1:01:32 PM
Snapshots              : {c32-tc3-sql1-weekly-2016-04-22::13:01:32.550, c32-tc3-sql1-weekly-2016-04-22::13:01:32.550}

Get the last ten snapshots for the specified volume collection and show the expanded snapshot properties.

Example

PS C:\Users\Administrator> Get-NimSnapshotCollection -VolumeCollectionName TestVolcoll -MaxObjects 10 | Select-Object -ExpandProperty Snapshots

Get a maximum of ten snapshot collections for each volume collection and expand the NimbleSnapshot properties.

Example

PS C:\Users\Administrator> Get-NimSnapshotCollection -MaxObjects 10 | Select-Object -ExpandProperty Snapshots