Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaIgroup


NAME
Set-NaIgroup

SYNOPSIS
Sets an attribute for an initiator group.

SYNTAX
Set-NaIgroup [-Name] <String> [-Key] <String> [-Value] <String> [-Force] [-C
ontroller <NaController>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Sets an attribute for an initiator group.


PARAMETERS
-Name <String>
Name of initiator group.

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

-Key <String>
Name of the attribute, Currently supported attributes are: os-type, thro
ttle_reserve, throttle_borrow, alua

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

-Value <String>
Value for the attribute.

The valid values for "os-type" are "default", "solaris", "windows", "hpu
x", "aix", "linux", "netware" and "vmware". Setting the "os-type" attrib
ute will perform checks with the cluster partner if this filer is runnin
g in the 'single_image' fcp cfmode and this igroup is an FCP igroups. T
he optional -Force argument can be used to override these checks if the
cluster partner can not be reached. It is also strongly recommended the
"default" os-type not be used and for the caller of this API to always r
equire the proper OS type information to be obtained. Using "default" i
s dangerous because it could potentially cause problems with LUN access.

The valid values for "throttle_reserve" are 0-99

The valid values for "throttle_borrow" are true or false

The valid values for "alua" are true or false

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

-Force
Forcibly set the attribute, disabling conflict checks with the cluster p
artner where and when applicable. If not specified all conflict checks a
re performed.

Required? false
Position? named
Default value false
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

-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
NetApp.Ontapi.Filer.Lun.InitiatorGroupInfo


NOTES


Category: igroup
API: igroup-set-attribute

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

C:\PS>Set-NaIgroup igroup4 os-type windows


Set the OS Type attribute on igroup 'igroup4' to 'windows'.


InitiatorGroupName : igroup4
InitiatorGroupType : iscsi
Initiators : {iqn.1991-05.com.microsoft:xyratex02}
InitiatorGroupOsType : windows
InitiatorGroupPortsetName :
InitiatorGroupThrottleBorrow : False
InitiatorGroupThrottleReserve : 0
InitiatorGroupUsePartner :
InitiatorGroupAluaEnabled : False
InitiatorGroupVsaEnabled : False
LunId :



RELATED LINKS
Get-NaIgroup







 Data ONTAP® PowerShell Toolkit