Add-TargetPortToMaskingSet

Add-TargetPortToMaskingSet

Adds one or more target ports to a specified masking set, allowing a connection between the target ports, and any virtual disks and initiator IDs that the masking set contains.

Syntax

Parameter Set: ByFriendlyName
Add-TargetPortToMaskingSet [-MaskingSetFriendlyName] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-TargetPortAddresses <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByUniqueId
Add-TargetPortToMaskingSet -MaskingSetUniqueId <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-TargetPortAddresses <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Add-TargetPortToMaskingSet -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-TargetPortAddresses <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-TargetPortToMaskingSet cmdlet adds one or more target ports to a specified masking set, allowing a connection between the target ports, and any virtual disks and initiator IDs that the masking set contains. All target ports must use the same connection type (for example iSCSI or Fibre Channel).

Note: This cmdlet works only on storage subsystems that support multi-port per view selection (MaskingPortsPerView = 3). To view the MaskingPortsPerView property, type the following cmdlets: Get-StorageSubSystem | Format-Table -Property FriendlyName, MaskingPortsPerView

Parameters

-AsJob

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases	Session
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InputObject<CimInstance[]>

Accepts a MaskingSet object from the pipeline as input.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-MaskingSetFriendlyName<String[]>

Specifies the friendly name of the masking set to which you want to assign a target port.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaskingSetUniqueId<String[]>

Specifies the UniqueID of the masking set to which you want to assign a target port.

Aliases	Id
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-PassThru

Specifies that the cmdlet should output an object representing the masking set to which it added target ports. By default, this cmdlet does not generate any output.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TargetPortAddresses<String[]>

Specifies one or more target port addresses, which you can view by looking at the PortAddress property returned by the Get-TargetPort cmdlet. The target port addresses will be added to the masking set.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
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.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

  You can pipe a MaskingSet object to the InputObject parameter.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_MaskingSet

  If you specify the Passthru parameter, this cmdlet outputs an object that represents the masking set to which you added a target port.

Notes

• The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

Example 1: Add a target port

This example demonstrates enumerating the Fibre Channel target ports on a given storage subsystem, and adding one of the target ports to an existing masking set.

PS C:\> $TargetPortObject = Get-TargetPort

PS C:\> $subSystem = Get-StorageSubSystem SANArray1

PS C:\> $maskingSet = Get-MaskingSet "Cluster1MaskingSet"

PS C:\> $subSystem | Get-TargetPort | Where-Object ConnectionType -eq "Fibre Channel" | Format-Table -AutoSize FriendlyName, PortAddress

PS C:\> $maskingSet | Add-TargetPortToMaskingSet -TargetPortAddresses "500A098187995A75"

Related topics

Get-MaskingSet

Get-TargetPort

New-MaskingSet