Edit

Share via

Update-IscsiTargetPortal

  • Reference
Module:
iSCSI

Updates information about the specified iSCSI target portal.

Syntax

Update-IscsiTargetPortal
      [-TargetPortalAddress] <String[]>
      [-InitiatorInstanceName <String>]
      [-InitiatorPortalAddress <String>]
      [-TargetPortalPortNumber <UInt16>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]
Update-IscsiTargetPortal
      -InputObject <CimInstance[]>
      [-InitiatorInstanceName <String>]
      [-InitiatorPortalAddress <String>]
      [-TargetPortalPortNumber <UInt16>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]

Description

The Update-IscsiTargetPortal cmdlet refreshes cached information about an iSCSI target portal.

Examples

Example 1: Update information about an iSCSI target portal

This command updates information about the specified iSCSI target portal. The first command displays target portals by using the Get-IscsiTargetPortal cmdlet.

Get-IscsiTargetPortal

InitiatorInstanceName      : 
InitiatorNodeAddress       : 
InitiatorPortalAddress     : 
InititorIPAdressListNumber : 4294967295 
IsDataDigest               : False 
IsHeaderDigest             : False 
TargetPortalAddress        : testiSCSI-deepcore 
TargetPortalPortNumber     : 3260

Get-IscsiTargetPortal | Update-IscsiTargetPortal

The second command passes the same target portals to the current cmdlet to update them.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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-CimSession or Get-CimSession 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

-InitiatorInstanceName

Specifies the name of the initiator instance that the iSCSI initiator service uses to send SendTargets requests to the target portal. If no instance name is specified, the iSCSI initiator service chooses the initiator instance.

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

-InitiatorPortalAddress

Specifies the IP address or DNS name that is associated with the portal.

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

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-TargetPortalAddress

Specifies the IP address or DNS name of the target portal.

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

-TargetPortalPortNumber

Specifies the TCP/IP port number for the target portal. By default, the port number is 3260.

Type:UInt16
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

Inputs

CimInstance

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.

Outputs

None