Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcPerfData


NAME
Get-NcPerfData

SYNOPSIS
Get a list of current counter values of instances of an object.

SYNTAX
Get-NcPerfData [-Name] <String> -Instance <String[]> [-Counter <String[]>] [
-PrivilegeLevel <String>] [-FilterData <String>] [-Controller <NcController[
]>] [<CommonParameters>]

Get-NcPerfData [-Name] <String> -InstanceUuid <String[]> [-Counter <String[]
>] [-PrivilegeLevel <String>] [-FilterData <String>] [-Controller <NcControl
ler[]>] [<CommonParameters>]


DESCRIPTION
Get a list of current counter values of instances of an object. This will re
turn the values of all specified counters and instances of the specified obj
ect with one call.


PARAMETERS
-Name <String>
Name of the object to get counter values for.

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

-Instance <String[]>
List of instance names for which to get counter values. This element can
be used to limit data collection to a specified subset of the instances
of the object.

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

-Counter <String[]>
List of counters whose values will be retrieved. This element can be use
d to limit data collection to a specified subset of the counters of inst
ances of the object. If this element is absent, values of all counters
will be retrieved.

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

-PrivilegeLevel <String>
Name of the privilege level. Possible values: "basic", "admin", "advance
d", "diag". If the element is absent, the default privilege of the objec
t will be used.

Required? false
Position? named
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. The applied filter is
a combination of ANDing the key-value pairs.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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

-InstanceUuid <String[]>
List of instance UUIDs for which to get counter values. This element can
be used to limit data collection to a specified subset of the instances
of the object.

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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.InstanceData


NOTES


Category: perf
API: perf-object-get-instances
Family: cluster

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

C:\PS>Get-NcPerfData -Name volume -Instance luns -Counter avg_latency, total
_ops


Get the volume perf counters avg_latency and total_ops for the volume "luns"
.


NcController : 10.60.189.172
Aggregation : DataONTAP.C.Types.Perf.AggregationData
Counters : {avg_latency, total_ops}
Name : luns
Uuid : f4cce431-574d-11e1-a865-123478563412



RELATED LINKS
Get-NcPerfCounter
Get-NcPerfInstance
Get-NcPerfObject







 Data ONTAP® PowerShell Toolkit