|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcSnapmirrorPolicy
NAME
Get-NcSnapmirrorPolicy
SYNOPSIS
Get a list of SnapMirror policies.
SYNTAX
Get-NcSnapmirrorPolicy [[-Name] <String[]>] [-Vserver <String[]>] [-Attribut
es <SnapmirrorPolicyInfo>] [-VserverContext <String>] [-Controller <NcContro
ller[]>] [<CommonParameters>]
Get-NcSnapmirrorPolicy -Template [-VserverContext <String>] [-Controller <Nc
Controller[]>] [<CommonParameters>]
Get-NcSnapmirrorPolicy -Query <SnapmirrorPolicyInfo> [-Attributes <Snapmirro
rPolicyInfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<Co
mmonParameters>]
DESCRIPTION
Get a list of SnapMirror policies.
PARAMETERS
-Name <String[]>
The name of one or more snapmirror policies. Data ONTAP wildcards are p
ermitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
The name of one or more vservers for the snapmirror policies. Data ONTA
P wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <SnapmirrorPolicyInfo>
For improved scalability in large clusters, provide a SnapmirrorPolicyIn
fo object with various fields set to indicate which fields to return on
all objects. Undesired fields should remain set to null. Use "Get-NcSn
apmirrorPolicy -Template" to get the initially empty SnapmirrorPolicyInf
o object. If not specified, all data is returned for each object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Template
Specify to get an empty SnapmirrorPolicyInfo object for use with advance
d queries involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <SnapmirrorPolicyInfo>
For advanced queries, provide a SnapmirrorPolicyInfo object with various
fields set to indicate which records to retrieve. Other fields should
remain set to null. Use "Get-NcSnapmirrorPolicy -Template" to get the i
nitially empty SnapmirrorPolicyInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
OUTPUTS
DataONTAP.C.Types.SnapmirrorPolicy.SnapmirrorPolicyInfo
NOTES
Category: snapmirror policy
API: snapmirror-policy-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcSnapmirrorPolicy -Name XDPDefault
Get the XDPDefault snapmirror policy.
Name TotalRules TotalKeep Tries TransferPriority Resta
rt Vserver
---- ---------- --------- ----- ---------------- -----
-- -------
XDPDefault 2 59 8 normal alway
s beam01
-------------- Example 2 --------------
C:\PS>$q = Get-NcSnapmirrorPolicy -Template
$q.TotalRules = ">0"
Get-NcSnapmirrorPolicy -Query $q
Get all of the snapmirror policies that have defined at least one rule.
Name TotalRules TotalKeep Tries TransferPriority Resta
rt Vserver
---- ---------- --------- ----- ---------------- -----
-- -------
XDPDefault 2 59 8 normal alway
s beam01
RELATED LINKS
New-NcSnapmirrorPolicy
Add-NcSnapmirrorPolicyRule
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|