Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcPerfPreset


NAME
Get-NcPerfPreset

SYNOPSIS
Get performance presets.

SYNTAX
Get-NcPerfPreset [[-Name] <String[]>] [-Attributes <PresetInfo>] [-Controlle
r <NcController[]>] [<CommonParameters>]

Get-NcPerfPreset [[-Name] <String[]>] -Detailed [-Controller <NcController[]
>] [<CommonParameters>]

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

Get-NcPerfPreset -Query <PresetInfo> [-Attributes <PresetInfo>] [-Controller
<NcController[]>] [<CommonParameters>]


DESCRIPTION
Get performance presets.


PARAMETERS
-Name <String[]>
Name of one or more presets. Data ONTAP wildcards are accepted if the D
etailed switch is not present.

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

-Attributes <PresetInfo>
For improved scalability in large clusters, provide an PresetInfo object
with various fields set to indicate which fields to return on all objec
ts. Undesired fields should remain set to null. Use "Get-NcPerfPreset
-Template" to get the initially empty PresetInfo object. If not specifi
ed, 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? true

-Detailed
If specified, get more detailed information about the performance preset
s.

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

-Template
Specify to get an empty PresetInfo 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 <PresetInfo>
For advanced queries, provide an PresetInfo object with various fields s
et to indicate which records to retrieve. Other fields should remain se
t to null. Use "Get-NcPerfPreset -Template" to get the initially empty
PresetInfo 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.PresetInfo


NOTES


Category: perf
API: perf-preset-get-iter
Family: cluster

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

C:\PS>Get-NcPerfPreset


Get all of the performance presets.


Preset Privilege IsReadOnly IsArchiveEnabled Comment
------ --------- ---------- ---------------- -------
asup-event diagnostic True False The event-
based AutoSupport Data ONTAP Performance...
asup-hourly diagnostic True True The hourly
AutoSupport Data ONTAP Performance Arch...
default diagnostic True True The defaul
t Data ONTAP Performance Archive preset ...
diagnostic diagnostic True False The diagno
stic Data ONTAP Performance Archive pres...


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

C:\PS>$q = Get-NcPerfPreset -Template
$q.IsArchiveEnabled = $true
Get-NcPerfPreset -Query $q


Get all of the performance presets that have archival enabled.


Preset Privilege IsReadOnly IsArchiveEnabled Comment
------ --------- ---------- ---------------- -------
asup-hourly diagnostic True True The hourly
AutoSupport Data ONTAP Performance Arch...
default diagnostic True True The defaul
t Data ONTAP Performance Archive preset ...


-------------- Example 3 --------------

C:\PS>Get-NcPerfPreset default -Detailed


Get detailed information about the default performance preset.


ExpirationLengthMinutes :
ExpirationLength :
ExpirationEndDate :
ExpirationEndDateDT :
PresetDetails : {aggregate:5s, aggregate:5m, aggregate:config, a
udit_ng:5s...}
Comment : The default Data ONTAP Performance Archive prese
t configuration. This preset configuration
includes essential counters to assist in general
troubleshooting of system performance.
GenerationId : 0
IsArchiveEnabled : True
IsReadOnly : True
Preset : default
Privilege : diagnostic
Uuid : 87af64db-706a-11e2-9600-123478563412
GenerationIdSpecified : True
IsArchiveEnabledSpecified : True
IsReadOnlySpecified : True



RELATED LINKS
New-NcPerfPreset
Set-NcPerfPreset
Remove-NcPerfPreset







 Data ONTAP® PowerShell Toolkit