Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Set-NaIscsiTargetPortalGroupAlua


NAME
Set-NaIscsiTargetPortalGroupAlua

SYNOPSIS
Change the ALUA parameters on an iSCSI target portal group.

SYNTAX
Set-NaIscsiTargetPortalGroupAlua [-Tag] <Int32> -Optimized [-Preferred] [-Co
ntroller <NaController>] [<CommonParameters>]

Set-NaIscsiTargetPortalGroupAlua [-Tag] <Int32> -Nonoptimized [-Preferred] [
-Controller <NaController>] [<CommonParameters>]


DESCRIPTION
Change the ALUA parameters on an iSCSI target portal group.

Data ONTAP supports SCSI ALUA functionality for managing multi-pathed SCSI d
evices. ALUA provides a standardized mechanism for path discovery and priori
tization. Devices are identified by target port IDs, which are then grouped
into target port groups. Each group has a state which, when configured, enab
les the host multipathing software to select the appropriate path priorities
when accessing a LUN.

For iSCSI, ALUA settings are controlled at the target portal group level usi
ng the Set-NaIscsiTargetPortalGroupAlua cmdlet. A target portal group can be
configured to be either "optimized" or "non-optimized"; a host typically us
es all the optimized paths before using any non-optimized paths it may find.
All target portal groups are optimized by default.

There is also an optional "preferred" setting that may be used on a target p
ortal group. Check your host's multi-pathing software documentation to see i
f it supports ALUA and the preferred setting.

ALUA is enabled on Initiator Groups using the Set-NaIgroup cmdlet. All LUNs
mapped to an ALUA enabled Initiator Group will support the ALUA functionali
ty.


PARAMETERS
-Tag <Int32>
Portal group tag.

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

-Optimized
Specify to set the ALUA state to optimized.

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

-Preferred
Specify this switch parameter to mark this target portal group as prefer
red.

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

-Nonoptimized
Specify to set the ALUA state to non-optimized.

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
DataONTAP.Types.Iscsi.IscsiTpgroupListEntryInfo


NOTES


Category: iscsi
API: iscsi-tpgroup-alua-set

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

C:\PS>Set-NaIscsiTargetPortalGroupAlua 1003 -Nonoptimized


Set ALUA state of iSCSI target portal group with tag 1003 to Non-optimized a
nd not Preferred.


TpgroupName : e0d_default
InterfaceListEntries : {e0d}
TpgroupTag : 1003
TpgroupAluaState : non-optimized
TpgroupAluaPreferred : False



RELATED LINKS
Get-NaIscsiTargetPortalGroup







 Data ONTAP® PowerShell Toolkit