Skip to content

Commit bb97d6e

Browse files
authored
Merge pull request #11716 from MicrosoftDocs/main
1/21/2025 PM Publish
2 parents 61eda79 + ebd9e7f commit bb97d6e

File tree

76 files changed

+742
-453
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+742
-453
lines changed

reference/5.1/CimCmdlets/CimCmdlets.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,43 +18,57 @@ Management Instrumentation (WMI) service.
1818
## CimCmdlets Cmdlets
1919

2020
### [Export-BinaryMiLog](Export-BinaryMiLog.md)
21+
2122
Creates a binary encoded representation of an object or objects and stores it in a file.
2223

2324
### [Get-CimAssociatedInstance](Get-CimAssociatedInstance.md)
25+
2426
Retrieves the CIM instances that are connected to a specific CIM instance by an association.
2527

2628
### [Get-CimClass](Get-CimClass.md)
29+
2730
Gets a list of CIM classes in a specific namespace.
2831

2932
### [Get-CimInstance](Get-CimInstance.md)
33+
3034
Gets the CIM instances of a class from a CIM server.
3135

3236
### [Get-CimSession](Get-CimSession.md)
37+
3338
Gets the CIM session objects from the current session.
3439

3540
### [Import-BinaryMiLog](Import-BinaryMiLog.md)
41+
3642
Used to re-create the saved objects based on the contents of an export file.
3743

3844
### [Invoke-CimMethod](Invoke-CimMethod.md)
45+
3946
Invokes a method of a CIM class.
4047

4148
### [New-CimInstance](New-CimInstance.md)
49+
4250
Creates a CIM instance.
4351

4452
### [New-CimSession](New-CimSession.md)
53+
4554
Creates a CIM session.
4655

4756
### [New-CimSessionOption](New-CimSessionOption.md)
57+
4858
Specifies advanced options for the `New-CimSession` cmdlet.
4959

5060
### [Register-CimIndicationEvent](Register-CimIndicationEvent.md)
61+
5162
Subscribes to indications using a filter expression or a query expression.
5263

5364
### [Remove-CimInstance](Remove-CimInstance.md)
65+
5466
Removes a CIM instance from a computer.
5567

5668
### [Remove-CimSession](Remove-CimSession.md)
69+
5770
Removes one or more CIM sessions.
5871

5972
### [Set-CimInstance](Set-CimInstance.md)
73+
6074
Modifies a CIM instance on a CIM server by calling the **ModifyInstance** method of the CIM class.

reference/5.1/CimCmdlets/Export-BinaryMiLog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9696
9797
## RELATED LINKS
9898
99-
[Get-CimInstance](get-ciminstance.md)
99+
[Get-CimInstance](Get-CimInstance.md)
100100
101-
[Import-BinaryMiLog](import-binarymilog.md)
101+
[Import-BinaryMiLog](Import-BinaryMiLog.md)
102102
103-
[Import-Clixml](../microsoft.powershell.utility/import-clixml.md)
103+
[Import-Clixml](../Microsoft.Powershell.Utility/Import-Clixml.md)

reference/5.1/CimCmdlets/Get-CimAssociatedInstance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,6 @@ Windows PowerShell includes the following aliases for `Get-CimAssociatedInstance
327327

328328
## RELATED LINKS
329329

330-
[Get-CimClass](get-cimclass.md)
330+
[Get-CimClass](Get-CimClass.md)
331331

332-
[Get-CimInstance](get-ciminstance.md)
332+
[Get-CimInstance](Get-CimInstance.md)

reference/5.1/CimCmdlets/Get-CimInstance.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ the key property `@{ "Handle"=0 }` and stores it in a variable named `$x`. The v
142142
a CIM instance to the `Get-CimInstance` cmdlet to get a particular instance.
143143

144144
```powershell
145-
$x = New-CimInstance -ClassName Win32_Process -Namespace root\cimv2 -Property @{ "Handle"=0 } -Key Handle -ClientOnly
145+
$x = New-CimInstance -ClassName Win32_Process -Namespace root\cimv2 -Property @{"Handle"=0} -Key Handle -ClientOnly
146146
Get-CimInstance -CimInstance $x
147147
```
148148

@@ -154,7 +154,7 @@ the variables `$x` and `$y`. The variable `$x` is then formatted in a table cont
154154

155155
```powershell
156156
$x,$y = Get-CimInstance -ClassName Win32_Process
157-
$x | Format-Table -Property Name,KernelModeTime -AutoSize
157+
$x | Format-Table -Property Name, KernelModeTime -AutoSize
158158
```
159159

160160
```Output
@@ -169,7 +169,7 @@ This example retrieves the CIM instances of a class named **Win32_ComputerSystem
169169
computers named **Server01** and **Server02**.
170170

171171
```powershell
172-
Get-CimInstance -ClassName Win32_ComputerSystem -ComputerName Server01,Server02
172+
Get-CimInstance -ClassName Win32_ComputerSystem -ComputerName Server01, Server02
173173
```
174174

175175
### Example 8: Getting only the key properties, instead of all properties
@@ -188,8 +188,8 @@ This example retrieves only a subset of properties, which reduces the size of th
188188
traffic.
189189

190190
```powershell
191-
Get-CimInstance -Class Win32_Process -Property Name,KernelModeTime
192-
$x = Get-CimInstance -Class Win32_Process -Property Name,KernelModeTime
191+
Get-CimInstance -Class Win32_Process -Property Name, KernelModeTime
192+
$x = Get-CimInstance -Class Win32_Process -Property Name, KernelModeTime
193193
$x | Invoke-CimMethod -MethodName GetOwner
194194
```
195195

@@ -204,7 +204,7 @@ the variable are then passed to `Get-CimInstance` by using the **CimSession** pa
204204
CIM instances of the class named **Win32_ComputerSystem**.
205205

206206
```powershell
207-
$s = New-CimSession -ComputerName Server01,Server02
207+
$s = New-CimSession -ComputerName Server01, Server02
208208
Get-CimInstance -ClassName Win32_ComputerSystem -CimSession $s
209209
```
210210

@@ -214,7 +214,8 @@ Get-CimInstance -ClassName Win32_ComputerSystem -CimSession $s
214214

215215
Specifies the CIM session to use for this cmdlet. Enter a variable that contains the CIM session or
216216
a command that creates or gets the CIM session, such as the `New-CimSession` or `Get-CimSession`
217-
cmdlets. For more information, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md).
217+
cmdlets. For more information, see
218+
[about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md).
218219

219220
```yaml
220221
Type: Microsoft.Management.Infrastructure.CimSession[]
@@ -320,8 +321,8 @@ Accept wildcard characters: False
320321
Indicates that only objects with key properties populated are returned. Specifying the **KeyOnly**
321322
parameter reduces the amount of data transferred over the network.
322323

323-
Use the **KeyOnly** parameter to return only a small portion of the object, which can be used for other
324-
operations, such as the `Set-CimInstance` or `Get-CimAssociatedInstance` cmdlets.
324+
Use the **KeyOnly** parameter to return only a small portion of the object, which can be used for
325+
other operations, such as the `Set-CimInstance` or `Get-CimAssociatedInstance` cmdlets.
325326

326327
```yaml
327328
Type: System.Management.Automation.SwitchParameter
@@ -495,7 +496,8 @@ Accept wildcard characters: False
495496

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

500502
## INPUTS
501503

@@ -514,18 +516,18 @@ the CIM server.
514516

515517
## RELATED LINKS
516518

517-
[Format-Table](../microsoft.powershell.utility/format-table.md)
519+
[Format-Table](../Microsoft.Powershell.Utility/Format-Table.md)
518520

519521
[Get-CimAssociatedInstance](Get-CimAssociatedInstance.md)
520522

521523
[Get-CimClass](Get-CimClass.md)
522524

523-
[Invoke-CimMethod](invoke-cimmethod.md)
525+
[Invoke-CimMethod](Invoke-CimMethod.md)
524526

525527
[New-CimInstance](New-CimInstance.md)
526528

527529
[Register-CimIndicationEvent](Register-CimIndicationEvent.md)
528530

529-
[Remove-CimInstance](remove-ciminstance.md)
531+
[Remove-CimInstance](Remove-CimInstance.md)
530532

531533
[Set-CimInstance](Set-CimInstance.md)

reference/5.1/CimCmdlets/Get-CimSession.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ can use the parameters of `Get-CimSession` to get the sessions that are for part
4646
you can identify sessions by their names or other identifiers. `Get-CimSession` does not get CIM
4747
sessions that were created in other PowerShell sessions or that were created on other computers.
4848

49-
For more information about CIM sessions, see [about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md).
49+
For more information about CIM sessions, see
50+
[about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md).
5051

5152
## EXAMPLES
5253

@@ -56,7 +57,7 @@ This example creates CIM sessions using [New-CimSession](New-CimSession.md), and
5657
sessions using `Get-CimSession`.
5758

5859
```powershell
59-
New-CimSession -ComputerName Server01,Server02
60+
New-CimSession -ComputerName Server01, Server02
6061
Get-CimSession
6162
```
6263

@@ -96,7 +97,7 @@ This example gets all CIM sessions in the current PowerShell session and display
9697
only the **ComputerName** and **InstanceID** properties.
9798

9899
```powershell
99-
Get-CimSession | Format-Table -Property ComputerName,InstanceId
100+
Get-CimSession | Format-Table -Property ComputerName, InstanceId
100101
```
101102

102103
```Output
@@ -169,7 +170,8 @@ Specifies the identifier of the CIM session to get. For multiple IDs, use commas
169170
or use the range operator (`..`) to specify a range of IDs. An **Id** is an integer that uniquely
170171
identifies the CIM session within the current PowerShell session.
171172

172-
For more information about the range operator, see [about_Operators](../Microsoft.PowerShell.Core/About/about_Operators.md).
173+
For more information about the range operator, see
174+
[about_Operators](../Microsoft.PowerShell.Core/About/about_Operators.md).
173175

174176
```yaml
175177
Type: System.UInt32[]
@@ -223,6 +225,7 @@ Accept wildcard characters: True
223225
```
224226

225227
### CommonParameters
228+
226229
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
227230
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
228231
-WarningAction, and -WarningVariable. For more information, see
@@ -244,10 +247,10 @@ This cmdlet returns a CIM session object.
244247

245248
## RELATED LINKS
246249

247-
[Format-Table](../microsoft.powershell.utility/format-table.md)
250+
[Format-Table](../Microsoft.Powershell.Utility/Format-Table.md)
248251

249252
[New-CimSession](New-CimSession.md)
250253

251-
[Remove-CimSession](remove-cimsession.md)
254+
[Remove-CimSession](Remove-CimSession.md)
252255

253256
[about_CimSession](../Microsoft.PowerShell.Core/About/about_CimSession.md)

reference/5.1/CimCmdlets/Import-BinaryMiLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Accept wildcard characters: True
5454
```
5555
5656
### CommonParameters
57+
5758
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
5859
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
5960
-WarningAction, and -WarningVariable. For more information, see

reference/5.1/CimCmdlets/Invoke-CimMethod.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ to `Invoke-CimMethod`.
153153

154154
```powershell
155155
$c = Get-CimClass -ClassName Win32_Process
156-
Invoke-CimMethod -CimClass $c -MethodName "xyz" -Arguments @{ CommandLine = 'notepad.exe' }
156+
Invoke-CimMethod -CimClass $c -MethodName "xyz" -Arguments @{CommandLine='notepad.exe'}
157157
```
158158

159159
## PARAMETERS
@@ -467,9 +467,9 @@ This cmdlet returns an object.
467467

468468
## RELATED LINKS
469469

470-
[Get-CimClass](get-cimclass.md)
470+
[Get-CimClass](Get-CimClass.md)
471471

472-
[Get-CimInstance](get-ciminstance.md)
472+
[Get-CimInstance](Get-CimInstance.md)
473473

474474
[Get-CimSession](Get-CimSession.md)
475475

reference/5.1/CimCmdlets/New-CimInstance.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -275,10 +275,10 @@ Accept wildcard characters: False
275275

276276
Specifies the amount of time that the cmdlet waits for a response from the CIM server. By default,
277277
the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the
278-
server. If the **OperationTimeoutSec** parameter is set to a value less than the robust connection retry
279-
timeout of 3 minutes, network failures that last more than the value of the **OperationTimeoutSec**
280-
parameter are not recoverable, because the operation on the server times out before the client can
281-
reconnect.
278+
server. If the **OperationTimeoutSec** parameter is set to a value less than the robust connection
279+
retry timeout of 3 minutes, network failures that last more than the value of the
280+
**OperationTimeoutSec** parameter are not recoverable, because the operation on the server times
281+
out before the client can reconnect.
282282

283283
```yaml
284284
Type: System.UInt32
@@ -403,10 +403,10 @@ This cmdlet returns an object that contains the CIM instance information.
403403

404404
## RELATED LINKS
405405

406-
[Get-CimClass](get-cimclass.md)
406+
[Get-CimClass](Get-CimClass.md)
407407

408-
[Get-CimInstance](get-ciminstance.md)
408+
[Get-CimInstance](Get-CimInstance.md)
409409

410-
[Remove-CimInstance](remove-ciminstance.md)
410+
[Remove-CimInstance](Remove-CimInstance.md)
411411

412412
[Set-CimInstance](Set-CimInstance.md)

reference/5.1/CimCmdlets/New-CimSession.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ title: New-CimSession
1010
# New-CimSession
1111

1212
## SYNOPSIS
13-
1413
Creates a CIM session.
1514

1615
## SYNTAX
@@ -23,7 +22,7 @@ New-CimSession [-Authentication <PasswordAuthenticationMechanism>] [[-Credential
2322
[-Port <UInt32>] [-SessionOption <CimSessionOptions>] [<CommonParameters>]
2423
```
2524

26-
### CertificatePrameterSet
25+
### CertificateParameterSet
2726

2827
```
2928
New-CimSession [-CertificateThumbprint <String>] [[-ComputerName] <String[]>] [-Name <String>]
@@ -128,9 +127,9 @@ parameter are:
128127
- NtlmDomain
129128
- CredSsp
130129

131-
You cannot use the **NtlmDomain** authentication type for connection to the local computer. **CredSSP**
132-
authentication is available only in Windows Vista, Windows Server 2008, and later versions of
133-
Windows.
130+
You cannot use the **NtlmDomain** authentication type for connection to the local computer.
131+
**CredSSP** authentication is available only in Windows Vista, Windows Server 2008, and later
132+
versions of Windows.
134133

135134
> [!CAUTION]
136135
> Credential Security Service Provider (CredSSP) authentication is designed for commands that
@@ -164,11 +163,12 @@ To get a certificate thumbprint, use the
164163
[`Get-ChildItem`](../Microsoft.Powershell.Management/Get-ChildItem.md) cmdlets in the PowerShell
165164
Certificate Provider.
166165

167-
For more information, see [about_Certificate_Provider](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md).
166+
For more information, see
167+
[about_Certificate_Provider](../Microsoft.PowerShell.Security/About/about_Certificate_Provider.md).
168168

169169
```yaml
170170
Type: System.String
171-
Parameter Sets: CertificatePrameterSet
171+
Parameter Sets: CertificateParameterSet
172172
Aliases:
173173
174174
Required: False
@@ -215,7 +215,8 @@ Specify the value for **Credential** using one of the following formats:
215215
- A user name: "User01"
216216
- A domain name and a user name: "Domain01\User01"
217217
- A user principal name: "[email protected]"
218-
- A PSCredential object, such as one returned by the [`Get-Credential`](../Microsoft.PowerShell.Security/Get-Credential.md) cmdlet.
218+
- A PSCredential object, such as one returned by the
219+
[`Get-Credential`](../Microsoft.PowerShell.Security/Get-Credential.md) cmdlet.
219220

220221
When you type a user name, you are prompted for a password.
221222

@@ -235,7 +236,8 @@ Accept wildcard characters: False
235236

236237
Specifies a friendly name for the CIM session.
237238

238-
You can use the name to refer to the CIM session when using other cmdlets, such as the [`Get-CimSession`](Get-CimSession.md) cmdlet.
239+
You can use the name to refer to the CIM session when using other cmdlets, such as the
240+
[`Get-CimSession`](Get-CimSession.md) cmdlet.
239241
The name is not required to be unique to the computer or the current session.
240242

241243
```yaml
@@ -254,9 +256,13 @@ Accept wildcard characters: False
254256

255257
Duration for which the cmdlet waits for a response from the server.
256258

257-
By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server.
259+
By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout
260+
value for the server.
258261

259-
If the **OperationTimeoutSec** parameter is set to a value less than the robust connection retry timeout of 3 minutes, network failures that last more than the value of the **OperationTimeoutSec** parameter are not recoverable, because the operation on the server times out before the client can reconnect.
262+
If the **OperationTimeoutSec** parameter is set to a value less than the robust connection retry
263+
timeout of 3 minutes, network failures that last more than the value of the **OperationTimeoutSec**
264+
parameter are not recoverable, because the operation on the server times out before the client can
265+
reconnect.
260266

261267
```yaml
262268
Type: System.UInt32
@@ -272,12 +278,12 @@ Accept wildcard characters: False
272278

273279
### -Port
274280

275-
Specifies the network port on the remote computer that is used for this connection.
276-
To connect to a remote computer, the remote computer must be listening on the port that the connection uses.
277-
The default ports are 5985 (the WinRM port for HTTP) and 5986 (the WinRM port for HTTPS).
281+
Specifies the network port on the remote computer that is used for this connection. To connect to a
282+
remote computer, the remote computer must be listening on the port that the connection uses. The
283+
default ports are 5985 (the WinRM port for HTTP) and 5986 (the WinRM port for HTTPS).
278284

279-
Before using an alternate port, you must configure the WinRM listener on the remote computer to listen at that port.
280-
Use the following commands to configure the listener:
285+
Before using an alternate port, you must configure the WinRM listener on the remote computer to
286+
listen at that port. Use the following commands to configure the listener:
281287

282288
`winrm delete winrm/config/listener?Address=*+Transport=HTTP`
283289

0 commit comments

Comments
 (0)