|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcPerfInstance
NAME
Get-NcPerfInstance
SYNOPSIS
Get a list of perf object instances.
SYNTAX
Get-NcPerfInstance [-Name] <String> [-FilterData <String>] [-Instance <Strin
g[]>] [-Uuid <String[]>] [-Attributes <InstanceInfo>] [-VserverContext <Stri
ng>] [-Controller <NcController[]>] [<CommonParameters>]
Get-NcPerfInstance [-Name] <String> [-FilterData <String>] [-Instance <Strin
g[]>] [-Uuid <String[]>] -Template [-VserverContext <String>] [-Controller <
NcController[]>] [<CommonParameters>]
Get-NcPerfInstance [-Name] <String> [-FilterData <String>] [-Instance <Strin
g[]>] [-Uuid <String[]>] -Query <InstanceInfo> [-Attributes <InstanceInfo>]
[-VserverContext <String>] [-Controller <NcController[]>] [<CommonParameters
>]
DESCRIPTION
Get a list of perf object instances.
PARAMETERS
-Name <String>
Object name to get instance info for.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-FilterData <String>
A string, representing filter-data, in the format of key=value supportin
g multiple key-value pairs via comma separation.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Instance <String[]>
The instance(s) to get. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Uuid <String[]>
The instance uuid(s) to get. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <InstanceInfo>
For improved scalability in large clusters, provide an InstanceInfo 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-NcPerfInsta
nce -Template" to get the initially empty InstanceInfo object. If not s
pecified, 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 InstanceInfo object for use with advanced querie
s involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <InstanceInfo>
For advanced queries, provide an InstanceInfo object with various fields
set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcPerfInstance -Template" to get the initially em
pty InstanceInfo 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.Perf.InstanceInfo
NOTES
Category: perf
API: perf-object-instance-list-info-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcPerfInstance -Name aggregate
Get instances for the aggregate perf object.
Name Uuid
---- ----
aggr1 VxeRubble-01:kernel:aggr1
aggr2 VxeRubble-01:kernel:aggr2
aggr0 VxeRubble-01:kernel:aggr0
aggr0_VxeRubble_02_0 VxeRubble-02:kernel:aggr0_VxeRubble_
...
-------------- Example 2 --------------
C:\PS>Get-NcPerfInstance aggregate -FilterData node_name=VxeRubble-01
Get the instances of the aggregate performance object for the VxeRubble-01 n
ode.
Name Uuid
---- ----
aggr2 VxeRubble-01:kernel:aggr2
aggr1 VxeRubble-01:kernel:aggr1
aggr0 VxeRubble-01:kernel:aggr0
RELATED LINKS
Get-NcPerfData
Get-NcPerfCounter
Get-NcPerfObject
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|