Skip to content

Commit 84c041a

Browse files
committed
format cleanup
1 parent 4d5fdb9 commit 84c041a

File tree

5 files changed

+207
-109
lines changed

5 files changed

+207
-109
lines changed

docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md

Lines changed: 59 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,37 +27,53 @@ Update-IscsiTargetPortal [-AsJob] [-CimSession <CimSession[]>] [-InitiatorInstan
2727
```
2828

2929
## DESCRIPTION
30-
The **Update-IscsiTargetPortal** cmdlet refreshes cached information about an iSCSI target portal.
30+
31+
The `Update-IscsiTargetPortal` cmdlet refreshes cached information about an iSCSI target portal.
3132

3233
## EXAMPLES
3334

34-
### Example 1
35+
### Example 1: Update information about an iSCSI target portal
36+
37+
This command updates information about the specified iSCSI target portal.
38+
The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet.
39+
40+
```powershell
41+
Get-IscsiTargetPortal
3542
```
36-
PS C:\>Get-IscsiTargetPortal
43+
44+
```Output
3745
InitiatorInstanceName :
3846
InitiatorNodeAddress :
3947
InitiatorPortalAddress :
4048
InititorIPAdressListNumber : 4294967295
4149
IsDataDigest : False
4250
IsHeaderDigest : False
4351
TargetPortalAddress : testiSCSI-deepcore
44-
TargetPortalPortNumber : 3260
45-
46-
47-
PS C:\>Get-IscsiTargetPortal | Update-IscsiTargetPortal
52+
TargetPortalPortNumber : 3260
4853
```
4954

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

5260
## PARAMETERS
5361

5462
### -AsJob
55-
ps_cimcommon_asjob
63+
64+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
65+
66+
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
67+
You can continue to work in the session while the job completes.
68+
To manage the job, use the `*-Job` cmdlets.
69+
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
70+
71+
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5672

5773
```yaml
5874
Type: SwitchParameter
5975
Parameter Sets: (All)
60-
Aliases:
76+
Aliases:
6177

6278
Required: False
6379
Position: Named
@@ -67,8 +83,10 @@ Accept wildcard characters: False
6783
```
6884
6985
### -CimSession
86+
7087
Runs the cmdlet in a remote session or on a remote computer.
71-
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.
88+
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
89+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
7290
The default is the current session on the local computer.
7391
7492
```yaml
@@ -85,11 +103,13 @@ Accept wildcard characters: False
85103
86104
### -InitiatorInstanceName
87105
106+
Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal.
107+
If no instance name is specified, the iSCSI initiator service chooses the initiator instance.
88108
89109
```yaml
90110
Type: String
91111
Parameter Sets: (All)
92-
Aliases:
112+
Aliases:
93113

94114
Required: False
95115
Position: Named
@@ -99,12 +119,13 @@ Accept wildcard characters: False
99119
```
100120
101121
### -InitiatorPortalAddress
102-
Represents the IP address or DNS name associated with the portal.
122+
123+
Specifies the IP address or DNS name that is associated with the portal.
103124
104125
```yaml
105126
Type: String
106127
Parameter Sets: (All)
107-
Aliases:
128+
Aliases:
108129

109130
Required: False
110131
Position: Named
@@ -114,12 +135,14 @@ Accept wildcard characters: False
114135
```
115136
116137
### -InputObject
117-
Accepts an object from the pipeline as input.
138+
139+
Specifies the input to this cmdlet.
140+
You can use this parameter, or you can pipe the input to this cmdlet.
118141
119142
```yaml
120143
Type: CimInstance[]
121144
Parameter Sets: UNNAMED_PARAMETER_SET_2
122-
Aliases:
145+
Aliases:
123146

124147
Required: True
125148
Position: Named
@@ -129,17 +152,14 @@ Accept wildcard characters: False
129152
```
130153
131154
### -PassThru
132-
Sends items from the interactive window down the pipeline as input to other cmdlets.
133-
By default, this cmdlet does not generate any output.
134155
135-
136-
To send items from the interactive window down the pipeline, click to select the items and then click OK.
137-
Shift-click and Ctrl-click are supported.
156+
Returns an object representing the item with which you are working.
157+
By default, this cmdlet does not generate any output.
138158
139159
```yaml
140160
Type: SwitchParameter
141161
Parameter Sets: (All)
142-
Aliases:
162+
Aliases:
143163

144164
Required: False
145165
Position: Named
@@ -149,12 +169,13 @@ Accept wildcard characters: False
149169
```
150170
151171
### -TargetPortalAddress
152-
Represents the IP address or DNS name of the target portal.
172+
173+
Specifies the IP address or DNS name of the target portal.
153174
154175
```yaml
155176
Type: String[]
156177
Parameter Sets: UNNAMED_PARAMETER_SET_1
157-
Aliases:
178+
Aliases:
158179

159180
Required: True
160181
Position: 1
@@ -164,13 +185,14 @@ Accept wildcard characters: False
164185
```
165186
166187
### -TargetPortalPortNumber
188+
167189
Specifies the TCP/IP port number for the target portal.
168190
By default, the port number is `3260`.
169191

170192
```yaml
171193
Type: UInt16
172194
Parameter Sets: (All)
173-
Aliases:
195+
Aliases:
174196
175197
Required: False
176198
Position: Named
@@ -180,14 +202,16 @@ Accept wildcard characters: False
180202
```
181203

182204
### -ThrottleLimit
205+
183206
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
184-
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.
207+
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
208+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
185209
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
186210

187211
```yaml
188212
Type: Int32
189213
Parameter Sets: (All)
190-
Aliases:
214+
Aliases:
191215
192216
Required: False
193217
Position: Named
@@ -196,9 +220,14 @@ Accept pipeline input: False
196220
Accept wildcard characters: False
197221
```
198222

223+
### CommonParameters
224+
225+
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).
226+
199227
## INPUTS
200228

201229
### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal
230+
202231
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
203232
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
204233

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

211240
## RELATED LINKS
212241

213-
[iSCSI Target Server Overview](https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11))
242+
[iSCSI on TechNet](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ee338476(v=ws.10))
243+
244+
[Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356)
214245

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

0 commit comments

Comments
 (0)