< Back

Add-InitiatorIdToMaskingSet

Wed Jan 30, 2019 6:01 pm

NAME Add-InitiatorIdToMaskingSet



SYNOPSIS

Adds an initiator ID to an existing masking set, granting the host associated with the initiator ID access to the virtual disk and target port resources

defined in the masking set.





SYNTAX

Add-InitiatorIdToMaskingSet [-MaskingSetFriendlyName] <String[]> [-CimSession <CimSession[]>] [-HostType {Unknown | Other | Standard | Solaris | HPUX |

OpenVMS | Tru64 | Netware | Sequent | AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux | MicrosoftWindows | OS400 | TRESPASS | HIUX |

VMwareESXi | MicrosoftWindowsServer2008 | MicrosoftWindowsServer2003}] [-InitiatorIds <String[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm]

[-WhatIf] [<CommonParameters>]



Add-InitiatorIdToMaskingSet [-CimSession <CimSession[]>] [-HostType {Unknown | Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent |

AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux | MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 |

MicrosoftWindowsServer2003}] [-InitiatorIds <String[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]



Add-InitiatorIdToMaskingSet [-CimSession <CimSession[]>] [-HostType {Unknown | Other | Standard | Solaris | HPUX | OpenVMS | Tru64 | Netware | Sequent |

AIX | DGUX | Dynix | Irix | CiscoISCSIStorageRouter | Linux | MicrosoftWindows | OS400 | TRESPASS | HIUX | VMwareESXi | MicrosoftWindowsServer2008 |

MicrosoftWindowsServer2003}] [-InitiatorIds <String[]>] [-PassThru] [-ThrottleLimit <Int32>] -MaskingSetUniqueId <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Add-InitiatorIdToMaskingSet cmdlet adds an initiator ID to an existing masking set, granting the host associated with the initiator ID access to the

virtual disk and target port resources defined in the masking set.



ps_storage_spacesubsystem_not_remark





PARAMETERS

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



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-HostType [<HostType>]

Specifies the host operating system or other host environmental factors that may influence the behavior that the storage system should have when

showing a virtual disk to an initiator.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-InitiatorIds [<String[]>]

Specifies one or more initiator IDs on which this cmdlet acts. The initiator IDs will be added to this masking set. Note: The initiator IDs do not

need to be displayed in the output of the Get-InitiatorId cmdlet to be added to a masking set.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-MaskingSetFriendlyName <String[]>

Specifies the friendly name of the masking set to which you want to add an initiator ID.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MaskingSetUniqueId <String[]>

Specifies the unique ID of the masking set to which you want to add an initiator ID.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Specifies that the cmdlet should output an object representing the masking setto which it added an initiator ID. By default, this cmdlet does not

generate any output.



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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

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

http://msdn.microsoft.com/library/windo ... 30509.aspx





You can pipe one or more MSFT_MaskingSet objects to the InputObject parameter.





OUTPUTS

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

http://msdn.microsoft.com/library/windo ... 30509.aspx





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





Example 1: Adding an InitiatorID to a masking set by masking set object



PS C:\\> $fcPorts = Get-InitiatorPort -CimSession Srv1 -ConnectionType FibreChannel

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

PS C:\\> $fcPorts.NodeAddress 2000001b328d33cd2001001b32ad33cd

PS C:\\> $maskingSet | Add-InitiatorIdToMaskingSet -InitiatorIds $fcPorts.NodeAddress



This example shows getting Fibre Channel initiator ports from the Srv1 computer, then getting the masking set object for the Cluster1MaskingSet, then

enabling Srv1 access to all virtual disks defined in the masking set.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=809326

Get-InitiatorId

Get-InitiatorPort