Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Set-NaIscsiTargetAlias


NAME
Set-NaIscsiTargetAlias

SYNOPSIS
Set or clear the current iSCSI target alias.

SYNTAX
Set-NaIscsiTargetAlias [-Alias] <String> [-Controller <NaController>] [<Comm
onParameters>]


DESCRIPTION
Set or clear the current iSCSI target alias.


PARAMETERS
-Alias <String>
New iSCSI target alias to set; must be 128 bytes or less. Free form for
mat. Pass an empty string to clear the target alias.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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

<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.TargetAlias


NOTES


Category: iscsi
API: iscsi-target-alias-set-alias, iscsi-target-alias-clear-alias

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

C:\PS>Set-NaIscsiTargetAlias


Clear the iSCSI target alias.


AliasName :
IsAliasAssigned : False


-------------- Example 2 --------------

C:\PS>Set-NaIscsiTargetAlias target1


Set the iSCSI target alias to 'target1'.


AliasName : target1
IsAliasAssigned : True



RELATED LINKS
Get-NaIscsiTargetAlias







 Data ONTAP® PowerShell Toolkit