Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcDiagnosisPolicyDefinition


NAME
Get-NcDiagnosisPolicyDefinition

SYNOPSIS
Get a list of Policy Definition objects.

SYNTAX
Get-NcDiagnosisPolicyDefinition [[-Node] <String[]>] [[-Monitor] <String[]>]
[[-PolicyId] <String[]>] [-Attributes <DiagnosisPolicyDefinitionInfo>] [-Co
ntroller <NcController[]>] [<CommonParameters>]

Get-NcDiagnosisPolicyDefinition -Template [-Controller <NcController[]>] [<C
ommonParameters>]

Get-NcDiagnosisPolicyDefinition -Query <DiagnosisPolicyDefinitionInfo> [-Att
ributes <DiagnosisPolicyDefinitionInfo>] [-Controller <NcController[]>] [<Co
mmonParameters>]


DESCRIPTION
Get a list of Policy Definition objects.


PARAMETERS
-Node <String[]>
One or more nodes hosting the health monitor. Data ONTAP wildcards are
permitted.

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

-Monitor <String[]>
One or more health monitors. Data ONTAP wildcards are permitted.

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

-PolicyId <String[]>
One or more policy ids. Data ONTAP wildcards are permitted.

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

-Attributes <DiagnosisPolicyDefinitionInfo>
For improved scalability in large clusters, provide a DiagnosisConfigInf
o object with various fields set to indicate which fields to return on a
ll objects. Undesired fields should remain set to null. Use "Get-NcDia
gnosisConfig -Template" to get the initially empty DiagnosisConfigInfo o
bject. If not specified, 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 DiagnosisConfigInfo object for use with advanced
queries involving the Query attribute.

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

-Query <DiagnosisPolicyDefinitionInfo>
For advanced queries, provide a DiagnosisConfigInfo object with various
fields set to indicate which records to retrieve. Other fields should r
emain set to null. Use "Get-NcDiagnosisConfig -Template" to get the ini
tially empty DiagnosisConfigInfo 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.Diagnosis.DiagnosisPolicyDefinitionInfo


NOTES


Category: diagnosis
API: diagnosis-policy-definition-get-iter
Family: cluster

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

C:\PS>Get-NcDiagnosisPolicyDefinition -PolicyId DualControllerHa_Policy


Get the diagnosis policy definition for the policy "DualControllerHa_Policy"
.


AlertCount :
AlertId : DualControllerHa_Alert
CreationTime :
Enable : True
Monitor : system_connect
NcController : 192.168.182.144
Node : vsim_cluster-01
PolicyId : DualControllerHa_Policy
ResponsibleResourceInfo : sschm_shelf_info.name
RuleExpression : sschm_shelf_info.num-nodes < 2 && sschm_node_info.
nchm-discovery-status == "discovery_done" &
& sschm_node_info.ha-pair-status == "true"
Where : sschm_node_info.owner-node =~ sschm_shelf_info.con
nected-nodes[]
AlertCountSpecified : False
EnableSpecified : True


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

C:\PS>$q = Get-NcDiagnosisPolicyDefinition -Template
$q.Enable = "true"
Get-NcDiagnosisPolicyDefinition -Query $q


Get all of the diagnosis policy definitions that are currently enabled.


Monitor PolicyId AlertId
Enable Node
------- -------- -------
------ ----
system_connect DualControllerNonHa_Policy DualControllerNonHa_Alert
True vsim_cluster-01



RELATED LINKS
Enable-NcDiagnosisPolicy
Disable-NcDiagnosisPolicy







 Data ONTAP® PowerShell Toolkit