Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: New-NaAggr


NAME
New-NaAggr

SYNOPSIS
Create a new aggregate.

SYNTAX
New-NaAggr [-Name] <String> [-Use32Bit] [-Use64Bit] -DiskCount <Int64> [-Dis
kSize <Int64>] [-DiskType <String>] [-ForceSparePool] [-Mirrored] [-SnapLock
] [-LanguageCode <String>] [-RaidSize <Int64>] [-RPM <Int64>] [-Controller <
NaController>] [-RaidType <String>] [-SnapLockType <String>] [-Type <String>
] [-WhatIf] [-Confirm] [<CommonParameters>]

New-NaAggr [-Name] <String> [-Use32Bit] [-Use64Bit] -Disks <Object[]> [-Forc
eSparePool] [-Mirrored] [-SnapLock] [-LanguageCode <String>] [-MirrorDisks <
Object[]>] [-RaidSize <Int64>] [-Controller <NaController>] [-RaidType <Stri
ng>] [-SnapLockType <String>] [-Type <String>] [-WhatIf] [-Confirm] [<Common
Parameters>]


DESCRIPTION
Create a new aggregate with the given name. Up to 200 aggregates can be cre
ated on each filer (including the aggregates that are "embedded" in traditio
nal volumes, which must be created as a side effect of a traditional volume
creation). The aggregate may not yet be operational immediately after the A
PI returns. Use "Get-NaAggr" to query the status of the newly-created aggre
gate to determine when it is fully operational.

NOTE: If ECANT_USE_ALL_DISKS is returned, then the requested aggregate was i
ndeed created, just not with all the disks that were specified.


PARAMETERS
-Name <String>
Name of the aggregate to create. The aggregate name can contain letters
, numbers, and the underscore character(_), but the first character must
be a letter or underscore.

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

-Use32Bit
If specified, a 32-bit aggregate will be created (requires Data ONTAP 8.
0 or later). If specified and the controller is not 8.0 or later, the s
witch will be ignored.

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

-Use64Bit
If specified, a 64-bit aggregate will be created (requires Data ONTAP 8.
0 or later). If specified and the controller is not 8.0 or later, the s
witch will be ignored.

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

-DiskCount <Int64>
Number of disks to place into the aggregate, including parity disks. Th
e disks in this newly-created aggregate come from the spare disk pool. T
he smallest disks in this pool join the aggregate first, unless the "dis
k-size" argument is provided. Either "disk-count" or "disks" must be sup
plied. Range [0..2^31-1].

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

-DiskSize <Int64>
Disk size in bytes. Disks that are within 10% of the specified size wil
l be selected for use in the aggregate. If not specified, existing gro
ups are appended with disks that are the best match for the largest disk
in the group. When starting new groups, the smallest disks are selecte
d first. This option is ignored if a specific list of disks to use is s
pecified through the "disks" parameter.

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

-DiskType <String>
Type of disks to use: ATA, EATA, FCAL, LUN, SAS, SATA, SCSI, XATA, or XS
AS. This option is needed only when disks of different types are connect
ed to the filer. It is not allowed if a list of disks to use is specif
ied through the "disks" parameter. An aggregate can never be created usi
ng a mix of disks of different types.

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

-ForceSparePool
Disks in a plex are not normally permitted to span spare pools. This be
havior is overridden with this option when it is set to "true".

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

-Mirrored
Specifies that the new aggregate be mirrored (have two plexes). If set
to "true", then the indicated disks will be split across the two plexes.
By default, the new aggregate will not be mirrored.

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

-SnapLock
Specifies the creation of a SnapLock aggregate. By default, is-snaplock
is not specified.

When SnapLock is "true" the type of snaplock aggregate is determined in
the following way
1> If SnapLockType is set, create the type specified in SnapLockType (se
e SnapLockType for more details)
2> Otherwise, create a Snaplock enterprise aggregate if a Snaplock enter
prise license has been installed.
3> Otherwise, create a Snaplock compliance aggregate.

ESERVICENOTLICENSED is returned if the required Snaplock Compliance or E
nterprise license is not installed.

EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not run
ning.

If you need to create a snaplock aggregate, the suggested method is to s
pecify SnapLockType as "compliance" or "enterprise" and not specify Snap
Lock at all. If you want to create a non-snaplock aggregate, the suggest
ed method is to specify neither SnapLockType nor SnapLock.

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

-LanguageCode <String>
Specifies the language to use for the new traditional volume via a langu
age code. The default language is the one used by the filer's root vol
ume. This option may be used only when creating a traditional volume, i
.e. when "Type" is "trad." Available language codes are:

C (POSIX)
da (Danish)
de (German)
en (English)
en_US (English (US))
es (Spanish)
fi (Finnish)
fr (French)
he (Hebrew)
it (Italian)
ja (Japanese euc-j)
ja_JP.PCK (Japanese PCK (sjis))
ko (Korean)
no (Norwegian)
nl (Dutch)
pt (Portuguese)
sv (Swedish)
zh (Simplified Chinese)
zh.GBK (Simplified Chinese (GBK))
zh_TW (Traditional Chinese euc-tw)
zh_TW.BIG5 (Traditional Chinese Big 5)

To use UTF-8 as the NFS character set, append '.UTF-8'.

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

-RaidSize <Int64>
Specifies the maximum number of disks in each RAID group in the aggregat
e. The maximum value for this parameter is 28. The default value is pl
atform-dependent. The valid range of values is also platform-dependent,
but never wider than [2..28].

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

-RPM <Int64>
Rotational speed of disks in revolutions per minute. Possible values are
: 5400, 7200, 10000, and 15000. This option is needed only when disks wi
th different rotational speeds are connected to the filer. It is not al
lowed if a list of disks to use is specified through the "Disks" paramet
er.

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

-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

-RaidType <String>
Specifies the type of RAID groups to use in the new aggregate. Possible
values: raid4, raid_dp. The default value is raid4 on most platforms.

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

-SnapLockType <String>
Specifies the type of Snaplock aggregate to be created. Possible values
- "compliance" or "enterprise"

ESERVICENOTLICENSED is returned if the necessary Snaplock compliance or
enterprise license has not been installed.

EINVALIDINPUT is returned if snaplock-type has an illegal value or if Sn
apLock has been set to "false".

EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not run
ning.

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

-Type <String>
The type of the aggregate. Possible values: aggr, trad.
- "aggr" (aggregate contains flexible volumes)
- "trad" (aggregate contains exactly one traditional volume)
If not specified, the default is "aggr."

Required? false
Position? named
Default value aggr
Accept pipeline input? false
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

-Disks <Object[]>
Specific list of disks to use for the new aggregate. If "Mirrored" is se
t to true and a specific list of disks is supplied, the "MirrorDisks" li
st with the same number of disks must also be supplied. Either "DisksCou
nt" or "Disks" must be supplied.

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

-MirrorDisks <Object[]>
List of mirror disks to use. It must contain the same number of disks s
pecified in "Disks".

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
NetApp.Ontapi.Filer.Aggr.AggrInfo


NOTES


Category: aggr
API: aggr-create

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

C:\PS>New-NaAggr aggr1 -DiskCount 3 -DiskSize 73gb


Simple invocation to create a new aggregate with 3 disks.


BlockType :
ChecksumStatus : active
ChecksumStyle : block
DiskCount : 3
FilesTotal : 31142
FilesUsed : 98
IsChecksumEnabled : True
IsInconsistent : False
IsSnaplock : False
MirrorStatus : unmirrored
Name : aggr1
PlexCount : 1
Plexes : {/aggr1/plex0}
RaidSize : 16
RaidStatus : raid_dp
SizeAvailable : 60945756160
SizePercentageUsed : 0
SizeTotal : 60945833984
SizeUsed : 77824
SnaplockType :
State : online
Type : aggr
Uuid : 723cf282-9019-11df-b5ca-00a098052d0c
VolumeCount : 0
Volumes : {}
SizePercentageUsedSpecified : True



RELATED LINKS
Add-NaAggr
Remove-NaAggr
Get-NaAggr







 Data ONTAP® PowerShell Toolkit