< Back

Set-InitiatorPort

Wed Jan 30, 2019 6:04 pm

NAME Set-InitiatorPort



SYNOPSIS

Sets properties on the InitiatorPort object.





SYNTAX

Set-InitiatorPort [-NodeAddress] <String[]> [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewNodeAddress <String> [-Confirm]

[-WhatIf] [<CommonParameters>]



Set-InitiatorPort [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewNodeAddress <String> -ObjectId <String[]> [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-InitiatorPort [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] -NewNodeAddress <String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-InitiatorPort cmdlet sets properties on the InitiatorPort object.





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



-NewNodeAddress <String>

Specifies the new node address for the initiator port.



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-NodeAddress <String[]>

Specifies the node address for the initiator.



Required? true

Position? 1

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ObjectId <String[]>

Specifies the ObjectID of the initiator.



Required? true

Position? named

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output.





To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.



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_InitiatorPort

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





You can pipe an InitiatorPort object to the InputObject parameter.





OUTPUTS

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

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





This cmdlet returns an object that represents the initiator port you specified.





Example 1: Change the node address



PS C:\\> $address = (Get-InitiatorPort)

PS C:\\> $address | Select NodeAddress

PS C:\\> Set-InitiatorPort -NodeAddress $address.NodeAddress -NewNodeAddress "iqn.test2"

NodeAddress

-----------

iqn.1991-05.com.contoso:test-pc2.contoso.com



This example uses a node address from the Get-InitiatorPort cmdlet as input.







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=816481

Get-InitiatorPort