Skip to content

Commit 08792df

Browse files
Fix incorrect case/capitalization in ref docs (#11935)
This ensures the following components have the correct/consistent case throughout the reference documentation: Preference variable, PS environment variable, PS drive, PS provider, PS command name, PS command argument, PS module, PS file extension, PS host name/application, #Requires statement, parameter name, about_* topic, member name, scope modifier, keyword, operator, calculated property key/value, attribute, type accelerator, type literal/name, WMI namespace/class, variable name, special character, comment-based help keyword, product/company name, Windows drive letter/directory, Windows/Unix environment variable In addition, changes include fixes to incorrect terminology (e.g., referring to a keyword as a command) and formatting of PS syntax elements (non-exhaustive).
1 parent 7f6c9ed commit 08792df

40 files changed

+200
-200
lines changed

reference/5.1/Microsoft.WSMan.Management/About/about_WSMan_Provider.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ WSMan:\localhost
9999
--------- InitializationParameters
100100
--------- Resources
101101
------------ Security
102-
------ Microsoft.Powershell
102+
------ Microsoft.PowerShell
103103
--------- InitializationParameters
104104
--------- Resources
105105
------------ Security
@@ -151,57 +151,57 @@ Set-Location -Path WSMan:\SERVER01
151151
152152
## Displaying the Contents of the WSMan: Drive
153153

154-
This command uses the `Get-Childitem` cmdlet to display the WS-Management stores
154+
This command uses the `Get-ChildItem` cmdlet to display the WS-Management stores
155155
in the Localhost store location.
156156

157157
```powershell
158-
Get-ChildItem -path WSMan:\Localhost
158+
Get-ChildItem -Path WSMan:\Localhost
159159
```
160160

161161
If you are in the `WSMan:` drive, you can omit the drive name.
162162

163-
This command uses the `Get-Childitem` cmdlet to display the WS-Management
163+
This command uses the `Get-ChildItem` cmdlet to display the WS-Management
164164
stores in the remote computer "SERVER01" store location.
165165

166166
```powershell
167-
Get-ChildItem -path WSMan:\SERVER01
167+
Get-ChildItem -Path WSMan:\SERVER01
168168
```
169169

170170
> [!NOTE]
171171
> The above command assume that a connection to the remote system already
172172
> exists.
173173
174-
## Setting the value of items in the WSMAN: drive
174+
## Setting the value of items in the WSMan: drive
175175

176176
You can use the `Set-Item` cmdlet to change configuration settings in the
177-
`WSMAN` drive. The following example sets the **TrustedHosts** value to
177+
`WSMan:` drive. The following example sets the **TrustedHosts** value to
178178
accept all hosts with the suffix "contoso.com".
179179

180180
```powershell
181181
# You do not need to specify the -Path parameter name when using Set-Item.
182-
PS WSMAN:\localhost\Client> Set-Item .\TrustedHosts -Value "*.contoso.com"
182+
PS WSMan:\localhost\Client> Set-Item .\TrustedHosts -Value "*.contoso.com"
183183
```
184184

185185
The `Set-Item` cmdlet supports an additional parameter `-Concatenate` that
186186
appends a value instead of changing it. The following example will append a
187187
new value "*.domain2.com" to the old value stored in `TrustedHost:`
188188

189189
```powershell
190-
Set-Item WSMAN:\localhost\Client\TrustedHosts *.domain2.com -Concatenate
190+
Set-Item WSMan:\localhost\Client\TrustedHosts *.domain2.com -Concatenate
191191
```
192192

193-
## Creating items in the WSMAN: drive
193+
## Creating items in the WSMan: drive
194194

195195
### Creating a new listener
196196

197197
The `New-Item` cmdlet creates items within a provider drive. Each provider
198-
has different item types that you can create. In the `WSMAN:` drive, you can
198+
has different item types that you can create. In the `WSMan:` drive, you can
199199
create *Listeners* which you configure to receive and respond to remote
200200
requests. The following command creates a new HTTP listener using the `New-Item`
201201
cmdlet.
202202

203203
```powershell
204-
New-Item -Path WSMan:\localhost\Listener -Address * -Transport HTTP -force
204+
New-Item -Path WSMan:\localhost\Listener -Address * -Transport http -Force
205205
```
206206

207207
### Creating a new plug-in
@@ -211,7 +211,7 @@ This command creates (registers) a plug-in for the WS-Management service.
211211
```powershell
212212
New-Item -Path WSMan:\localhost\Plugin `
213213
-Plugin TestPlugin `
214-
-FileName %systemroot%\system32\WsmWmiPl.dll `
214+
-FileName $Env:SystemRoot\system32\WsmWmiPl.dll `
215215
-Resource http://schemas.dmtf.org/wbem/wscim/2/cim-schema `
216216
-SDKVersion 1 `
217217
-Capability "Get","Put","Invoke","Enumerate" `
@@ -255,7 +255,7 @@ certificate.
255255
$cred = Get-Credential
256256
New-Item -Path WSMan:\localhost\ClientCertificate `
257257
-Issuer 1b3fd224d66c6413fe20d21e38b304226d192dfe `
258-
-URI wmicimv2/* `
258+
-Uri wmicimv2/* `
259259
-Credential $cred;
260260
```
261261

@@ -513,7 +513,7 @@ Specifies the entity that is identified by the certificate.
513513
### Transport \<String\>
514514

515515
Specifies the transport to use to send and receive WS-Management protocol
516-
requests and responses. The value must be either HTTP or HTTPS.
516+
requests and responses. The value must be either **http** or **https**.
517517

518518
Note: The Transport value is set when creating a Listener.
519519

@@ -590,7 +590,7 @@ Get-Help Get-ChildItem
590590
```
591591

592592
```powershell
593-
Get-Help Get-ChildItem -Path wsman:
593+
Get-Help Get-ChildItem -Path WSMan:
594594
```
595595

596596
## See also

reference/5.1/Microsoft.WSMan.Management/Connect-WSMan.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For information about how to disconnect from the WinRM service on a remote compu
5151

5252
```powershell
5353
PS C:\> Connect-WSMan -ComputerName "server01"
54-
PS C:\> cd wsman:
54+
PS C:\> cd WSMan:
5555
PS WSMan:\>
5656
PS WSMan:\> dir
5757
```
@@ -77,7 +77,7 @@ the **ComputerName** list.
7777
```powershell
7878
PS C:\> $cred = Get-Credential Administrator
7979
PS C:\> Connect-WSMan -ComputerName "server01" -Credential $cred
80-
PS C:\> cd wsman:
80+
PS C:\> cd WSMan:
8181
PS WSMan:\>
8282
PS WSMan:\> dir
8383
```
@@ -106,7 +106,7 @@ Administrator credentials.
106106

107107
```powershell
108108
PS C:\> Connect-WSMan -ComputerName "server01" -Port 80
109-
PS C:\> cd wsman:
109+
PS C:\> cd WSMan:
110110
PS WSMan:\>
111111
PS WSMan:\> dir
112112
```
@@ -126,7 +126,7 @@ This command creates a connection to the remote server01 computer over port 80.
126126
```powershell
127127
PS C:\> $a = New-WSManSessionOption -OperationTimeout 30000
128128
PS C:\> Connect-WSMan -ComputerName "server01" -SessionOption $a
129-
PS C:\> cd wsman:
129+
PS C:\> cd WSMan:
130130
PS WSMan:\> dir
131131
```
132132

reference/5.1/Microsoft.WSMan.Management/Disconnect-WSMan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For more information about how to connect to the WinRM service on a remote compu
3636
### Example 1: Delete a connection to a remote computer
3737

3838
```powershell
39-
PS C:\> Disconnect-WSMan -computer server01
39+
PS C:\> Disconnect-WSMan -Computer server01
4040
PS C:\> cd WSMan:
4141
PS WSMan:\> dir
4242
```

reference/5.1/Microsoft.WSMan.Management/Get-WSManInstance.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This cmdlet uses the WS-Management connection/transport layer to retrieve inform
4848
### Example 1: Get all information from WMI
4949

5050
```powershell
51-
Get-WSManInstance -ResourceURI wmicimv2/win32_service -SelectorSet @{name="winrm"} -ComputerName "Server01"
51+
Get-WSManInstance -ResourceURI wmicimv2/Win32_Service -SelectorSet @{name="winrm"} -ComputerName "Server01"
5252
```
5353

5454
This command returns all of the information that Windows Management Instrumentation (WMI) exposes
@@ -57,23 +57,23 @@ about the **WinRM** service on the remote server01 computer.
5757
### Example 2: Get the status of the Spooler service
5858

5959
```powershell
60-
Get-WSManInstance -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -Fragment Status -ComputerName "Server01"
60+
Get-WSManInstance -ResourceURI wmicimv2/Win32_Service -SelectorSet @{name="spooler"} -Fragment Status -ComputerName "Server01"
6161
```
6262

6363
This command returns only the status of the **Spooler** service on the remote server01 computer.
6464

6565
### Example 3: Get endpoint references for all services
6666

6767
```powershell
68-
Get-WSManInstance -Enumerate -ResourceURI wmicimv2/win32_service -ReturnType EPR
68+
Get-WSManInstance -Enumerate -ResourceURI wmicimv2/Win32_Service -ReturnType EPR
6969
```
7070

7171
This command returns endpoint references that correspond to all the services on the local computer.
7272

7373
### Example 4: Get services that meet specified criteria
7474

7575
```powershell
76-
Get-WSManInstance -Enumerate -ResourceURI wmicimv2/* -Filter "select * from win32_service where StartMode = 'Auto' and State = 'Stopped'" -ComputerName "Server01"
76+
Get-WSManInstance -Enumerate -ResourceURI wmicimv2/* -Filter "select * from Win32_Service where StartMode = 'Auto' and State = 'Stopped'" -ComputerName "Server01"
7777
```
7878

7979
This command lists all of the services that meet the following criteria on the remote Server01
@@ -103,7 +103,7 @@ listener that matches the criteria in the selector set.
103103
### Example 7: Get associated instances related to a specified instance
104104

105105
```powershell
106-
Get-WSManInstance -Enumerate -Dialect Association -Filter "{Object=win32_service?name=winrm}" -ResourceURI wmicimv2/*
106+
Get-WSManInstance -Enumerate -Dialect Association -Filter "{Object=Win32_Service?name=winrm}" -ResourceURI wmicimv2/*
107107
```
108108

109109
This command gets the associated instances that are related to the specified instance (winrm).
@@ -113,7 +113,7 @@ You must enclose the filter in quotation marks, as shown in the example.
113113
### Example 8: Get association instances related to a specified instance
114114

115115
```powershell
116-
Get-WSManInstance -Enumerate -Dialect Association -Associations -Filter "{Object=win32_service?name=winrm}" -ResourceURI wmicimv2/*
116+
Get-WSManInstance -Enumerate -Dialect Association -Associations -Filter "{Object=Win32_Service?name=winrm}" -ResourceURI wmicimv2/*
117117
```
118118

119119
This command gets association instances that are related to the specified instance (winrm). Because

reference/5.1/Microsoft.WSMan.Management/Invoke-WSManAction.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This cmdlet uses the WSMan connection/transport layer to run the action.
4545
### Example 1: Invoke a method
4646

4747
```powershell
48-
Invoke-WSManAction -Action startservice -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -Authentication default
48+
Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/Win32_Service -SelectorSet @{name="spooler"} -Authentication Default
4949
```
5050

5151
```Output
@@ -56,16 +56,16 @@ lang : en-US
5656
ReturnValue : 0
5757
```
5858

59-
This command calls the StartService method of the Win32_Service WMI class instance that corresponds
60-
to the Spooler service.
59+
This command calls the StartService method of the **Win32_Service** WMI class instance that
60+
corresponds to the Spooler service.
6161

6262
The return value indicates whether the action was successful. In this case, a return value of 0
6363
indicates success. A return value of 5 indicates that the service is already started.
6464

6565
### Example 2: Invoke a method
6666

6767
```powershell
68-
Invoke-WSManAction -Action stopservice -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:input.xml -Authentication default
68+
Invoke-WSManAction -Action StopService -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:input.xml -Authentication Default
6969
```
7070

7171
```Output
@@ -86,7 +86,7 @@ indicates success. A return value of 5 indicates that the service is already sta
8686
### Example 3: Invoke a method with specified parameter values
8787

8888
```powershell
89-
Invoke-WSManAction -Action create -ResourceURI wmicimv2/win32_process -ValueSet @{commandline="notepad.exe";currentdirectory="C:\"}
89+
Invoke-WSManAction -Action Create -ResourceURI wmicimv2/Win32_Process -ValueSet @{commandline="notepad.exe";currentdirectory="C:\"}
9090
```
9191

9292
```Output
@@ -98,14 +98,14 @@ ProcessId : 6356
9898
ReturnValue : 0
9999
```
100100

101-
This command calls the **Create** method of the Win32_Process class. It passes the method two
101+
This command calls the **Create** method of the **Win32_Process** class. It passes the method two
102102
parameter values, `Notepad.exe` and `C:\`. As a result, a new process is created to run Notepad, and
103103
the current directory of the new process is set to `C:\`.
104104

105105
### Example 4: Invoke a method on a remote computer
106106

107107
```powershell
108-
Invoke-WSManAction -Action startservice -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -ComputerName server01 -Authentication default
108+
Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/Win32_Service -SelectorSet @{name="spooler"} -ComputerName server01 -Authentication Default
109109
```
110110

111111
```Output
@@ -116,9 +116,9 @@ lang : en-US
116116
ReturnValue : 0
117117
```
118118

119-
This command calls the StartService method of the Win32_Service WMI class instance that corresponds
120-
to the Spooler service. Because the ComputerName parameter is specified, the command runs against
121-
the remote server01 computer.
119+
This command calls the StartService method of the **Win32_Service** WMI class instance that
120+
corresponds to the Spooler service. Because the ComputerName parameter is specified, the command
121+
runs against the remote server01 computer.
122122

123123
The return value indicates whether the action was successful. In this case, a return value of 0
124124
indicates success. A return value of 5 indicates that the service is already started.
@@ -299,7 +299,7 @@ Specifies the path of a file that is used to update a management resource. You s
299299
management resource by using the ResourceURI parameter and the SelectorSet parameter. For example,
300300
the following command uses the FilePath parameter:
301301

302-
`Invoke-WSManAction -Action stopservice -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath c:\input.xml -Authentication default`
302+
`Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath C:\input.xml -Authentication Default`
303303

304304
This command calls the **StopService** method on the Spooler service by using input from a file. The
305305
file, `Input.xml`, contains the following content:

reference/5.1/Microsoft.WSMan.Management/New-WSManInstance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ Specifies the path of a file that is used to create a management resource. You s
211211
management resource using the **ResourceURI** parameter and the **SelectorSet** parameter . For
212212
example, the following command uses the **File** parameter:
213213

214-
`Invoke-WSManAction -Action stopservice -ResourceUri wmi/cimv2/Win32_Service -SelectorSet @{Name="spooler"} -File c:\input.xml -Authentication Default`
214+
`Invoke-WSManAction -Action StopService -ResourceUri wmi/cimv2/Win32_Service -SelectorSet @{Name="spooler"} -File C:\input.xml -Authentication Default`
215215

216216
This command calls the **StopService** method on the Spooler service using input from a file. The
217217
file, `Input.xml`, contains the following content:

reference/5.1/Microsoft.WSMan.Management/New-WSManSessionOption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ WSMan cmdlets:
3838
```powershell
3939
PS C:\> $a = New-WSManSessionOption -OperationTimeout 30000
4040
PS C:\> Connect-WSMan -ComputerName "server01" -SessionOption $a
41-
PS C:\> cd wsman:
41+
PS C:\> cd WSMan:
4242
PS WSMan:\> dir
4343
```
4444

reference/5.1/Microsoft.WSMan.Management/Set-WSManInstance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ Specifies the path of a file that is used to update a management resource. You s
317317
management resource by using the **ResourceURI** parameter and the **SelectorSet** parameter. For
318318
example, the following command uses the **FilePath** parameter:
319319

320-
`Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:c:\input.xml -authentication default`
320+
`Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:C:\input.xml -Authentication Default`
321321

322322
This command calls the **StopService** method on the Spooler service by using input from a file.
323323
The file, `Input.xml`, contains the following content:

reference/5.1/Microsoft.WSMan.Management/Test-WSMan.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,24 @@ This command determines whether the WinRM service is running on the server01 com
4949
### Example 3: Determine the status of the WinRM service and the operating system version
5050

5151
```powershell
52-
Test-WSMan -Authentication default
52+
Test-WSMan -Authentication Default
5353
```
5454

5555
This command tests to see whether the WS-Management (WinRM) service is running on the local computer
56-
by using the authentication parameter.
56+
by using the **Authentication** parameter.
5757

58-
Using the authentication parameter enables `Test-WSMan` to return the operating system version.
58+
Using the **Authentication** parameter enables `Test-WSMan` to return the operating system version.
5959

6060
### Example 4: Determine the status of the WinRM service and the OS version on a remote computer
6161

6262
```powershell
63-
Test-WSMan -ComputerName "server01" -Authentication default
63+
Test-WSMan -ComputerName "server01" -Authentication Default
6464
```
6565

6666
This command tests to see whether the WS-Management (WinRM) service is running on the computer named
67-
server01 using the authentication parameter.
67+
server01 using the **Authentication** parameter.
6868

69-
Using the authentication parameter enables `Test-WSMan` to return the operating system version.
69+
Using the **Authentication** parameter enables `Test-WSMan` to return the operating system version.
7070

7171
## PARAMETERS
7272

reference/5.1/PSDiagnostics/Start-Trace.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ You must run this cmdlet from an elevated PowerShell session.
3939
$parameters = @{
4040
SessionName = 'wsmlog'
4141
ETS = $true
42-
OutputFilePath = "$env:windir\system32\wsmtraces.log"
42+
OutputFilePath = "$Env:windir\system32\wsmtraces.log"
4343
Format = 'bincirc'
4444
MinBuffers = 16
4545
MaxBuffers = 256
4646
BufferSizeInKb = 64
4747
MaxLogFileSizeInMB = 256
48-
ProviderFilePath = "$env:windir\system32\wsmtraceproviders.txt"
48+
ProviderFilePath = "$Env:windir\system32\wsmtraceproviders.txt"
4949
}
5050
Start-Trace @parameters
5151
```
@@ -160,7 +160,7 @@ Accept wildcard characters: False
160160
### -OutputFilePath
161161

162162
Path of the output log file or the DSN and log set name in a SQL database. The default path is
163-
`$env:systemdrive\PerfLogs\Admin`.
163+
`$Env:SystemDrive\PerfLogs\Admin`.
164164

165165
```yaml
166166
Type: System.String
@@ -169,7 +169,7 @@ Aliases:
169169
170170
Required: False
171171
Position: 1
172-
Default value: $env:systemdrive\PerfLogs\Admin
172+
Default value: $Env:SystemDrive\PerfLogs\Admin
173173
Accept pipeline input: False
174174
Accept wildcard characters: False
175175
```

0 commit comments

Comments
 (0)