Set-SCStorageZoneAlias
Set-SCStorageZoneAlias
Modifies an existing Fibre Channel zone alias.
Syntax
Parameter Set: Default
Set-SCStorageZoneAlias [-StorageZoneAlias] <StorageZoneAlias> [-AddZoneMembership <String[]> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RemoveZoneMembership <String[]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Set-SCStorageZoneAlias cmdlet modifies an existing Fibre Channel zone alias.
Parameters
-AddZoneMembership<String[]>
Specifies an array of zone members for the cmdlet to add.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveZoneMembership<String[]>
Specifies an array of zone members for the cmdlet to remove.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StorageZoneAlias<StorageZoneAlias>
Specifies a fibre channel zone alias.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- StorageZoneAlias
Examples
Example 1: Add and remove members from a zone alias
The first command gets the zone alias object named ZoneAlias01, and then stores the object in the $zonealias variable.
The second command adds a member to the $addmember variable.
The third command adds a member to the $removemember variable.
The last command adds the member in $addmember to, and removes the member in $removemember from, the zone alias stored in $zonealias.
PS C:\> $zonealias = Get-SCStorageZoneAlias -Name "ZoneAlias01"
PS C:\> $addmember = "C003FF3B8A610000"
PS C:\> $removemember += "D113EF3A8F411234"
PS C:\> Set-SCStorageZoneAlias -StorageZoneAlias $zonealias -AddZoneMembership $addmember -RemoveZoneMembership $removemember
Example 2: Modify name and description of a zone alias
The first command gets the zone alias object named ZoneAlias01, and then stores the object in the $zonealias variable.
The second command gives the zone alias stored in $zonealias a new name and a description.
PS C:\> $zonealias = Get-SCStorageZoneAlias -Name "ZoneAlias01"
PS C:\> Set-SCStorageZoneAlias -StorageZoneAlias $zonealias -Name "New Name" -Description "New Description"