Get-SnapshotPolicy
SYNOPSIS
Gets details of the snapshot policies on a PowerMax array.
SYNTAX
All (Default)
Get-SnapshotPolicy [-Unisphere] <UnisphereServer> [-ArrayId] <String> [-Identify] [<CommonParameters>]
ById
Get-SnapshotPolicy [-Unisphere] <UnisphereServer> [-ArrayId] <String> [-Id] <String[]> [-StorageGroup]
[<CommonParameters>]
ByStorageGroupId
Get-SnapshotPolicy [-Unisphere] <UnisphereServer> [-ArrayId] <String> [-Id] <String>
[-StorageGroupId] <String> [<CommonParameters>]
DESCRIPTION
Gets details of the snapshot policies on a PowerMax array. The options include listing all policies on the array, listing storage groups associated with a policy, and getting details of a storage group’s snapshots and policy information.
This command is only supported on systems running Unisphere 9.2.0 or greater.
EXAMPLES
Example 1
PS C:\> Get-SnapshotPolicy -Unisphere $unisphere -ArrayId 000123456789
Where $unisphere is a Unisphere server instance. Returns all snapshot policies on the PowerMax array.
Example 2
PS C:\> Get-SnapshotPolicy -Unisphere $unisphere -ArrayId 000123456789 -Id policy1
Where $unisphere is a Unisphere server instance. Returns details of the snapshot policy named policy1.
Example 3
PS C:\> Get-SnapshotPolicy -Unisphere $unisphere -ArrayId 000123456789 -Id policy1 -StorageGroup
Where $unisphere is a Unisphere server instance. Lists the storage groups associated with the snapshot policy named policy1.
Example 4
PS C:\> Get-SnapshotPolicy -Unisphere $unisphere -ArrayId 000123456789 -Id policy1 -StorageGroupId sg1
Where $unisphere is a Unisphere server instance. Returns snapshot policy information for storage group sg1. The return object is of type SnapshotPolicyStorageGroup and contains details on the number of snapshots and compliance information.
PARAMETERS
-Unisphere
The Unisphere server object.
Type: UnisphereServer
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ArrayId
The PowerMax array ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Id
The snapshot policy ID.
Type: String[]
Parameter Sets: ById, ByStorageGroupId
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Identify
Returns IDs instead of objects.
Type: SwitchParameter
Parameter Sets: All
Aliases: List
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StorageGroup
When specified will list the storage groups associated with the policy.
Type: SwitchParameter
Parameter Sets: ById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StorageGroupId
The storage group ID.
Type: String
Parameter Sets: ByStorageGroupId
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.