Edit

Set-InitiatorPort

  • Reference
Module:
Storage

Sets properties on the InitiatorPort object.

Syntax

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

Description

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

Examples

Example 1: Change the node address

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



PS C:\>$address | Select NodeAddress
NodeAddress 
----------- 
iqn.1991-05.com.contoso:test-pc2.contoso.com 


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

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

Parameters

-AsJob

ps_cimcommon_asjob

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

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-InputObject

Specifies the InitiatorPort object for which you want to get the initiator port. Enter an InitiatorPort CIM object, which is exposed by the Get-InitiatorPort cmdlet.

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NewNodeAddress

Specifies the new node address for the initiator port.

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

-NodeAddress

Specifies the node address for the initiator.

Type:String[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

Specifies the ObjectID of the initiator.

Type:String[]
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

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.

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

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

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

Inputs

CimInstance

You can pipe an InitiatorPort object to the InputObject parameter.

Outputs

CimInstance

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