Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Rename-NcAggr


NAME
Rename-NcAggr

SYNOPSIS
Rename the specified aggregate.

SYNTAX
Rename-NcAggr [-Name] <String> [-NewName] <String> [-Controller <NcControlle
r[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Rename the specified aggregate.


PARAMETERS
-Name <String>
Name of the aggregate to rename.

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

-NewName <String>
The new name desired for the aggregate.

Required? true
Position? 2
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

-WhatIf


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

-Confirm


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.C.Types.Aggr.AggrAttributes


NOTES


Category: aggr
API: aggr-rename
Family: cluster

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

C:\PS>Rename-NcAggr aggr2 aggr3


Rename aggregate 'aggr2' to 'aggr3'.


Name State TotalSize Used Available Disks RaidType RaidSize Volumes
---- ----- --------- ---- --------- ----- -------- -------- -------
aggr3 online 717.1 GB 0% 717.1 GB 8 raid_dp,normal 16 0



RELATED LINKS
Get-NcAggr







 Data ONTAP® PowerShell Toolkit