Set-SCStorageZoneAlias

Modifies an existing Fibre Channel zone alias.

Syntax

Set-SCStorageZoneAlias [-StorageZoneAlias] <StorageZoneAlias> [-AddZoneMembership <String[]>]
 [-Description <String>] [-JobVariable <String>] [-Name <String>] [-PROTipID <Guid>]
 [-RemoveZoneMembership <String[]>] [-RunAsynchronously] [<CommonParameters>]

Description

The Set-SCStorageZoneAlias cmdlet modifies an existing Fibre Channel zone alias.

Examples

Example 1: Add and remove members from a zone alias

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

The first command gets the zone alias object named ZoneAlias01, and then stores that object in the $ZoneAlias variable.

The second command assigns a value to the $AddMember variable.

The third command adds a member to the $RemoveMember variable.

The final command adds the member in $AddMember to, and removes the member in $RemoveMember from, the zone alias stored in $ZoneAlias.

Example 2: Modify the name and description of a zone alias

PS C:\> $ZoneAlias = Get-SCStorageZoneAlias -Name "ZoneAlias01"
PS C:\> Set-SCStorageZoneAlias -StorageZoneAlias $ZoneAlias -Name "New Name" -Description "New Description"

The first command gets the zone alias object named ZoneAlias01, and then stores that object in the $ZoneAlias variable.

The second command assigns the zone alias stored in $ZoneAlias a new name and a description.

Parameters

-AddZoneMembership

Specifies an array of zone members for this cmdlet to add.

Type:String[]
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description of the new zone alias.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

Specifies the name of a variable that you use to track and store job progress.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the Fibre Channel zone alias to modify.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemoveZoneMembership

Specifies an array of zone members for this cmdlet to remove.

Type:String[]
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.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StorageZoneAlias

Specifies the Fibre Channel zone alias that this cmdlet modifies.

Type:StorageZoneAlias
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Outputs

StorageZoneAlias

This cmdlet returns a **StorageZoneAlias** object.