|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NaPerfObject
NAME
Get-NaPerfObject
SYNOPSIS
Get list of performance objects in the system.
SYNTAX
Get-NaPerfObject [-Controller <NaController>] [<CommonParameters>]
DESCRIPTION
Get list of performance objects in the system.
The perf APIs enable monitoring of system performance. They provide a single
interface to data across various subsystems in the appliance. Data are org
anized hierarchically, with objects, instances, and counters. An object gene
rally represents a subsystem, an instance represents a single physical or lo
gical entity within the subsystem, and a counter is a datum specific to the
instance.
An example of the object-instance-counter hierarchy is processor:processor0:
processor_busy. Each CPU in the system is an instance of the 'processor' ob
ject. The processor_busy counter of the processor0 instance reports the tim
e during which this processor has been active since an arbitrary point in th
e past. A second counter, processor_elapsed_time, reports the total time, so
the change in processor_busy divided by the change in processor_elapsed_tim
e over an interval can be used to compute the average utilization of the pro
cessor. Processor_elapsed_time is referred to as the 'base counter' of proc
essor_busy since it is needed to compute a useful value from processor_busy.
A typical user of these APIs will initially request a list of objects using
Get-NaPerfObject. The user may then request a list of counters available for
instances of an object by calling Get-NaPerfCounter for each interesting ob
ject. The sets of objects and counters are static, so these calls will not n
eed to be made again.
The core perf API call is Get-NaPerfData. This API returns the names and raw
counter values of instances of an object at the time of the call. Unlike ob
jects and counters, the set of instances is not always fixed, and the values
of counters will vary across calls. Typically this API must be called at le
ast twice over some interval in order to evaluate subsystem performance duri
ng that interval. Depending on counter properties, the user may need to perf
orm additional computation on the raw value in order to correctly interpret
it.
Each counter has a property which indicates how it's raw value should be int
erpreted. This property is available as part of the static counter metadata
returned by a call to Get-NaPerfCounter. Possible properties are 'raw', 'ra
te', 'delta', 'average', 'percent', 'string', and 'no-display'. String count
ers report textual information, such as volume or disk identifiers. No-displ
ay counters are not intended for direct use, and this property is typically
assigned to base counters. The other properties are interpreted as follows:
* raw: single counter value is used
* delta: change in counter value between two samples is used
* rate: delta divided by the time in seconds between samples is used
* average: delta divided by the delta of a base counter is used
* percent: 100*average is used
For 'average' and 'percent' counters, the 'base-counter' element will be set
to the name of the base counter. Some counters are multidimensional, and fo
r these the counter description includes a list of labels of the counter sub
elements, and a 'type' element indicating the counter is an array.
For example, again consider the processor::processor_busy counter. The descr
iption and properties of this counter state that it is a percentage, but a c
all to Get-NaPerfData will return a raw number which must be further process
ed by the user. Because the counter is a percentage, the user must note the
value of its base counter, (processor::processor_elapsed_time) and then mak
e a second call to Get-NaPerfData and again note the raw value of the counte
r and base counter. Suppose the user made the calls at time T1 and later at
time T2, and these raw values were returned (the object and instance name a
re not shown):
* (T1) processor_busy=2000000, processor_elapsed_time=3000000
* (T2) processor_busy=2400000 ,processor_elapsed_time=4000000
The user must then perform the following computation to determine processor
utilization: 100*(2400000-2000000)/(4000000-3000000) = 40%
The Get-NaPerfInstance API may be used to list the names of current instance
s of an object. It does not return any counter values.
PARAMETERS
-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.
Required? false
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.Types.Perf.ObjectInfo
NOTES
Category: perf
API: perf-object-list-info
-------------- Example 1 --------------
C:\PS>Get-NaPerfObject
List the available performance objects.
Name PrivilegeLevel
---- --------------
system basic
disk basic
processor basic
nvram diag
ifnet basic
nfsv3 basic
nfsv4 diag
readahead diag
target basic
lun basic
volume basic
sparse diag
flexcache diag
nrv diag
wafl diag
raid diag
raid_stripe diag
cifs basic
cifsdomain diag
cifs_ops diag
cifs_stats diag
vscan_server_stat diag
vscan_stats diag
fpolicy_global diag
fpolicy_stats_server diag
fpolicy_stats_policy diag
ldap diag
fcp basic
iscsi basic
perf diag
replication diag
volume_snapmirror_source diag
volume_snapmirror_destination diag
rsm_src_global diag
rsm_dst_global diag
rsm_src_relation diag
rsm_dst_relation diag
lmem diag
aggregate basic
compression diag
qtree basic
quota basic
vfiler basic
sis diag
priorityqueue advanced
prisched advanced
ext_cache basic
ext_cache_obj basic
bufcache diag
cachequeue diag
cacheeject diag
partial_file_restore diag
cpdump diag
cpdump_rvol diag
cpdump_rg diag
cpdump_disk diag
cpdump_fvol diag
logical_replication_destination basic
logical_replication_source basic
dump basic
ndmp basic
hostadapter basic
iomem diag
zodiac diag
fal diag
flashmgmt diag
flashmgmt_core diag
RELATED LINKS
Get-NaPerfCounter
Get-NaPerfData
Get-NaPerfInstance
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|