Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcPerfPreset


NAME
New-NcPerfPreset

SYNOPSIS
Create a single Performance Preset configuration and all of its details.

SYNTAX
New-NcPerfPreset [-Name] <String> [-Comment <String>] [-Privilege <String>]
[-Archived] [-ExpirationLengthMinutes <Int32>] [-Detail <PresetDetailInfo[]>
] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Create a single Performance Preset configuration and all of its details.


PARAMETERS
-Name <String>
Name of the performance preset.

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

-Comment <String>
Preset description.

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

-Privilege <String>
Privilege level. Possible values: admin, advanced, diagnostic.

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

-Archived
If specified, enable performance preset archival.

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

-ExpirationLengthMinutes <Int32>
Default expiration time in minutes until the performance preset will be
automatically disabled.

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

-Detail <PresetDetailInfo[]>
Details of the performance preset. Use Get-NcPerfPresetDetailInfo to bu
ild PresetDetailInfo objects.

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

<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-create
Family: cluster

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

C:\PS>$presetDetails = @()
$presetDetails += Get-NcPerfPresetDetailInfo -Object volume -Counter read_da
ta, write_data -SamplePeriod 5m
$presetDetails += Get-NcPerfPresetDetailInfo -Object volume -Counter write_o
ps, write_latency, read_ops, read_latency -SamplePeriod 1m
New-NcPerfPreset -Name powershell_volume -Comment "Collect perf data for vol
umes." -Detail $presetDetails


Create a new performance preset for volume perf data.


Preset Privilege IsReadOnly IsArchiveEnabled Comment
------ --------- ---------- ---------------- -------
powershell_volume diagnostic False False Collect pe
rf data for volumes.



RELATED LINKS
Get-NcPerfPreset
Get-NcPerfPresetDetailInfo
Set-NcPerfPreset
Remove-NcPerfPreset







 Data ONTAP® PowerShell Toolkit