|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NaAggr
NAME
Set-NaAggr
SYNOPSIS
Set the specified aggregate or plex online, offline, or restricted.
SYNTAX
Set-NaAggr [-Name] <String> -Offline [-CifsDelaySeconds <Int64>] [-UnmountVo
lumes] [-Controller <NaController>] [-WarningAction <ActionPreference>] [-Wa
rningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-NaAggr [-Name] <String> -Online [-Controller <NaController>] [-WarningAc
tion <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<
CommonParameters>]
Set-NaAggr [-Name] <String> -Restricted [-CifsDelaySeconds <Int64>] [-Unmoun
tVolumes] [-Controller <NaController>] [-WarningAction <ActionPreference>] [
-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Set the specified aggregate or plex online, offline, or restricted. This co
mmand takes effect immediately.
Online: All volumes on the aggregate are brought to whatever state they were
in before the aggregate was restricted or taken offline. If there are CIFS
shares associated with the any of the aggregate's volumes that were also onl
ined, they are enabled.
Offline: Except in maintenance mode, the current root aggregate may not be t
aken offline. An aggregate marked to become the root aggregate cannot be ta
ken offline. An aggregate containing one or more flexible volumes cannot be
taken offline; its contained volumes must first be destroyed.
A number of operations being performed on the given aggregate can prevent th
is operation from succeeding, either at all or for various lengths of time.
If such operations are found, the system waits up to one second for them to
finish. If they don't, the command is aborted.
A check is also made for files in the aggregate opened by internal ONTAP pr
ocesses. The command is aborted if any are found.
Restricted: If the aggregate is embedded in a traditional volume, the entire
traditional volume will be restricted. An aggregate with one or more flexi
ble volumes cannot be restricted; all of its contained volumes must first be
destroyed.
PARAMETERS
-Name <String>
Name of the aggregate to set online/offline/restricted.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Offline
Set the aggregate offline.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CifsDelaySeconds <Int64>
The number of seconds to wait before offlining/restricting any volumes t
hat are hosted in the given aggregate that have active CIFS shares (if a
ny). A value of 0 means that all such volumes are to be offlined immedi
ately with no warning. CIFS users can lose data if they aren't given a
chance to terminate applications gracefully. By default, "CifsDelaySeco
nds" is 0. NOTE: This argument may ONLY appear if the "UnmountVolumes" a
rgument also appears and is set to "true".
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-UnmountVolumes
If set to "true", this option specifies that all of the volumes hosted b
y the given aggregate are to be unmounted before the offline/restrict op
eration is executed. By default, the system will reject any attempt to o
ffline/restrict an aggregate that hosts one or more online volumes.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NaController>
The DataONTAP controller object, embodied by an NaController object. Th
is parameter is returned by the Connect-NaController cmdlet. If not spe
cified, the value in the global variable CurrentNaController is used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WarningAction <ActionPreference>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WarningVariable <String>
Required? false
Position? named
Default value
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
-Online
Set the aggregate online.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Restricted
Set the aggregate restricted.
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
NetApp.Ontapi.Filer.Aggr.AggrInfo
NOTES
Category: aggr
API: aggr-online, aggr-offline, aggr-restrict
-------------- Example 1 --------------
C:\PS>Set-NaAggr aggr1 -Online
Set aggregate 'aggr1' online.
-------------- Example 2 --------------
C:\PS>Set-NaAggr aggr1 -Offline | Remove-NaAggr
Destroy aggregate 'aggr1' after setting it offline.
RELATED LINKS
| Copyright © 2010 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|