|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Set-NcIscsiTargetAlias
NAME
Set-NcIscsiTargetAlias
SYNOPSIS
Set the current iscsi target alias.
SYNTAX
Set-NcIscsiTargetAlias [-Alias] <String> [-VserverContext <String>] [-Contro
ller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Set the current iscsi target alias.
PARAMETERS
-Alias <String>
New iscsi target alias to set; must be 128 bytes or less. Free form form
at otherwise, although a string of all blanks will be rejected. An empt
y string will clear the alias.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
DataONTAP.C.Types.Iscsi.TargetAlias
NOTES
Category: iscsi
API: iscsi-target-alias-set-alias, iscsi-target-alias-clear-alias
Family: vserver
-------------- Example 1 --------------
C:\PS>Set-NcIscsiTargetAlias iscsi_target
Change the target alias to iscsi_target.
AliasName
IsAliasAssigned
---------
---------------
iscsi_target
True
-------------- Example 2 --------------
C:\PS>Set-NcIscsiTargetAlias ""
Clear the target alias.
AliasName
IsAliasAssigned
---------
---------------
False
RELATED LINKS
Get-NcIscsiTargetAlias
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|