Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcQosPolicy


NAME
Get-NcQosPolicy

SYNOPSIS
Get a list of policies.

SYNTAX
Get-NcQosPolicy [[-Name] <String[]>] [[-PolicyUuid] <String[]>] [-Attributes
<QosPolicyInfo>] [-Controller <NcController[]>] [<CommonParameters>]

Get-NcQosPolicy -Template [-Controller <NcController[]>] [<CommonParameters>
]

Get-NcQosPolicy -Query <QosPolicyInfo> [-Attributes <QosPolicyInfo>] [-Contr
oller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Get a list of policies.


PARAMETERS
-Name <String[]>
The QoS policy name(s) to get. Data ONTAP wildcards are permitted.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PolicyUuid <String[]>
Unique identifier(s) of the policy. Data ONTAP wildcards are permitted.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Attributes <QosPolicyInfo>
For improved scalability in large clusters, provide a QosPolicyInfo obje
ct with various fields set to indicate which fields to return on all obj
ects. Undesired fields should remain set to null. Use "Get-NcQosPolicy
-Template" to get the initially empty QosPolicyInfo object. If not spe
cified, all data is returned for each object.

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 QosPolicyInfo object for use with advanced queri
es involving the Query attribute.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Query <QosPolicyInfo>
For advanced queries, provide a QosPolicyInfo object with various fields
set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcQosPolicy -Template" to get the initially empty
QosPolicyInfo 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.Qos.QosPolicyInfo


NOTES


Category: qos
API: qos-policy-get-iter
Family: cluster

-------------- Example 1 --------------

C:\PS>Get-NcQosPolicy


Get all quality of service policies on the current cluster.


CachePolicyName : Default
PolicyClass : preset
PolicyName : Default
PolicyUuid : 700169c0-eae7-11e0-8b1e-123478563412
ReadAheadPolicyName : Default

CachePolicyName : Default
PolicyClass : user_defined
PolicyName : test-policy
PolicyUuid : e052c86e-6de3-11e1-a794-123478563412
ReadAheadPolicyName : Default


-------------- Example 2 --------------

C:\PS>$q = Get-NcQosPolicy -Template
$q.PolicyClass = "preset"
Get-NcQosPolicy -Query $q


Get all of the preset quality of service policy objects.


CachePolicyName : Default
PolicyClass : preset
PolicyName : Default
PolicyUuid : 700169c0-eae7-11e0-8b1e-123478563412
ReadAheadPolicyName : Default



RELATED LINKS
Set-NcQosPolicy
Remove-NcQosPolicy
Update-NcQosPolicy
New-NcQosPolicy







 Data ONTAP® PowerShell Toolkit