Skip to content

Update Update-IscsiTargetPortal.md #2549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 29, 2021
Merged

Update Update-IscsiTargetPortal.md #2549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
366b04e
Update Update-IscsiTargetPortal.md
Rob-S Jul 16, 2021
1d4658e
Merge pull request #5 from MicrosoftDocs/master
Rob-S Jul 23, 2021
cfd307c
Update Update-IscsiTargetPortal.md
Rob-S Jul 26, 2021
708b3bb
Update Update-IscsiTargetPortal.md
Rob-S Jul 27, 2021
2db5cf5
Update Update-IscsiTargetPortal.md
Rob-S Jul 27, 2021
8144087
Cleanup formatting
sdwheeler Jul 29, 2021
4d5fdb9
Fix platyps schema violation
sdwheeler Jul 29, 2021
84c041a
format cleanup
sdwheeler Jul 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 59 additions & 28 deletions docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,37 +27,53 @@ Update-IscsiTargetPortal [-AsJob] [-CimSession <CimSession[]>] [-InitiatorInstan
```

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

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

## EXAMPLES

### Example 1
### 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.

```powershell
Get-IscsiTargetPortal
```
PS C:\>Get-IscsiTargetPortal

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


PS C:\>Get-IscsiTargetPortal | Update-IscsiTargetPortal
TargetPortalPortNumber : 3260
```

This example returns information about iSCSI target portals that have previously been added.
```powershell
Get-IscsiTargetPortal | Update-IscsiTargetPortal
```
The second command passes the same target portals to the current cmdlet to update them.

## PARAMETERS

### -AsJob
ps_cimcommon_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](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.

For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -67,8 +83,10 @@ 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.
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
The default is the current session on the local computer.

```yaml
Expand All @@ -85,11 +103,13 @@ 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.

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -99,12 +119,13 @@ Accept wildcard characters: False
```

### -InitiatorPortalAddress
Represents the IP address or DNS name associated with the portal.

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

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -114,12 +135,14 @@ Accept wildcard characters: False
```

### -InputObject
Accepts an object from the pipeline as input.

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

```yaml
Type: CimInstance[]
Parameter Sets: UNNAMED_PARAMETER_SET_2
Aliases:
Aliases:

Required: True
Position: Named
Expand All @@ -129,17 +152,14 @@ 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.
Returns an object representing the item with which you are working.
By default, this cmdlet does not generate any output.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -149,12 +169,13 @@ Accept wildcard characters: False
```

### -TargetPortalAddress
Represents the IP address or DNS name of the target portal.

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

```yaml
Type: String[]
Parameter Sets: UNNAMED_PARAMETER_SET_1
Aliases:
Aliases:

Required: True
Position: 1
Expand All @@ -164,13 +185,14 @@ Accept wildcard characters: False
```

### -TargetPortalPortNumber

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

```yaml
Type: UInt16
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -180,14 +202,16 @@ 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.
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.

```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Aliases:

Required: False
Position: Named
Expand All @@ -196,9 +220,14 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal

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.

Expand All @@ -210,6 +239,8 @@ The path after the pound sign (`#`) provides the namespace and class name for th

## RELATED LINKS

[iSCSI Target Server Overview](https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11))
[iSCSI on TechNet](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ee338476(v=ws.10))

[Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356)

[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md)
Loading