Skip to content

Commit 6c34220

Browse files
author
Sean Wheeler
authored
final pass on About_ topic reformat (#2011)
1 parent c4bc861 commit 6c34220

34 files changed

+1198
-184
lines changed

reference/3.0/Microsoft.PowerShell.Core/About/about_Environment_Variables.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,11 +244,11 @@ The environment variables that store preferences include:
244244
The default value of $Env:PSModulePath is:
245245

246246
```
247-
$home\Documents\WindowsPowerShell\Modules; $pshome\Modules
247+
$HOME\Documents\WindowsPowerShell\Modules; $PSHOME\Modules
248248
```
249249

250-
Windows PowerShell sets the value of "\$pshome\\Modules" in the registry. It
251-
sets the value of "\$home\\Documents\\WindowsPowerShell\\Modules" each time you
250+
Windows PowerShell sets the value of "\$PSHOME\\Modules" in the registry. It
251+
sets the value of "\$HOME\\Documents\\WindowsPowerShell\\Modules" each time you
252252
start Windows PowerShell.
253253

254254
In addition, setup programs that install modules in other directories, such as
@@ -294,7 +294,7 @@ $path = [System.Environment]::GetEnvironmentVariable("PSModulePath",
294294
```
295295

296296
For more information about the methods of the System.Environment class, see
297-
[Environment Methods](http://go.microsoft.com/fwlink/?LinkId=242783) in
297+
[Environment Methods](https://go.microsoft.com/fwlink/?LinkId=242783) in
298298
MSDN.
299299

300300
You can add also add a command that changes the value to your profile or use

reference/3.0/Microsoft.PowerShell.Core/About/about_For.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ all the values in an array, consider using a Foreach statement.
2525
The following shows the For statement syntax.
2626

2727
```powershell
28-
for (>init>; <condition>; <repeat>)
28+
for (<init>; <condition>; <repeat>)
2929
{<statement list>}
3030
```
3131

reference/3.0/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Methods.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ the following methods:
2727

2828
All the methods and properties of the `PSCmdlet` class are available to
2929
advanced functions. For more information about these methods and properties,
30-
see `System.Management.Automation.PSCmdlet` in the MSDN (Microsoft Developer
31-
Network) library at http://go.microsoft.com/fwlink/?LinkId=142139.
30+
see [`System.Management.Automation.PSCmdlet`](http://go.microsoft.com/fwlink/?LinkId=142139) in the MSDN library.
3231

3332
### Input Processing Methods
3433

reference/3.0/Microsoft.PowerShell.Core/About/about_Language_Keywords.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ Syntax:
516516
do {<statement list>} while (<condition>)
517517
```
518518

519-
# SEE ALSO
519+
## SEE ALSO
520520

521521
- [about_Special_Characters](about_Special_Characters.md)
522522
- [about_Wildcards](about_Wildcards.md)

reference/3.0/Microsoft.PowerShell.Core/About/about_Modules.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -486,18 +486,13 @@ NOTE: Remote sessions, including sessions that are started by using the
486486
commands are packaged in snap-ins.
487487

488488
The following modules (or snap-ins) are installed with PowerShell.
489-
* Microsoft.PowerShell.Archive
490489
* Microsoft.PowerShell.Core
491490
* Microsoft.PowerShell.Diagnostics
492491
* Microsoft.PowerShell.Host
493492
* Microsoft.PowerShell.Management
494-
* Microsoft.PowerShell.ODataUtils
495493
* Microsoft.PowerShell.Security
496494
* Microsoft.PowerShell.Utility
497495
* Microsoft.WSMan.Management
498-
* OneGet
499-
* PowerShellGet
500-
* PSDesiredStateConfiguration
501496
* PSScheduledJob
502497
* PSWorkflow
503498
* PSWorkflowUtility

reference/3.0/Microsoft.PowerShell.Core/About/about_Parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ title: about_Parameters
1010

1111
## SHORT DESCRIPTION
1212

13-
Describes how to work with command parameters in Windows PowerShell®.
13+
Describes how to work with command parameters in PowerShell.
1414

1515
## LONG DESCRIPTION
1616

17-
Most Windows PowerShell commands, such as cmdlets, functions, and scripts,
17+
Most PowerShell commands, such as cmdlets, functions, and scripts,
1818
rely on parameters to allow users to select options or provide input. The
1919
parameters follow the command name and have the following form:
2020

reference/3.0/Microsoft.PowerShell.Core/About/about_Switch.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
ms.date: 2017-12-01
2+
ms.date: 2017-12-06
33
schema: 2.0.0
44
locale: en-us
55
keywords: powershell,cmdlet
@@ -167,9 +167,9 @@ Switch has the following parameters:
167167
| |condition. Wildcard and Exact are ignored. Also, if the |
168168
| |match clause is not a string, this parameter is ignored. |
169169

170+
In this example, there is no matching case so there is no output.
170171

171172
```powershell
172-
Example:
173173
PS> switch ("fourteen")
174174
{
175175
1 {"It is one."; Break}
@@ -179,7 +179,12 @@ Example:
179179
3 {"Three again."; Break}
180180
"fo*" {"That's too many."}
181181
}
182+
```
183+
184+
For the word "fourteen" to match a case you must use the **-Wildcard** or
185+
**-Regex** parameter.
182186

187+
```powershell
183188
PS> switch -Regex ("fourteen")
184189
{
185190
1 {"It is one."; Break}
@@ -189,6 +194,11 @@ Example:
189194
3 {"Three again."; Break}
190195
"fo*" {"That's too many."}
191196
}
197+
```
198+
199+
Result:
200+
201+
```Output
192202
That's too many.
193203
```
194204

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
---
2+
ms.date: 2018-01-04
3+
schema: 2.0.0
4+
locale: en-us
5+
keywords: powershell,cmdlet
6+
title: about_WS Management_Cmdlets
7+
---
8+
9+
# About WS-Management Cmdlets
10+
11+
## SHORT DESCRIPTION
12+
13+
Provides an overview of Web Services for Management (WS-Management) as
14+
background for using the WS-Management cmdlets in Windows PowerShell.
15+
16+
## LONG DESCRIPTION
17+
18+
This topic provides an overview of Web Services for Management (WS-Management)
19+
as background for using the WS-Management cmdlets in Windows PowerShell. This
20+
topic also provides links to more information about WS-Management. The
21+
Microsoft implementation of WS-Management is also known as Windows Remote
22+
Management (WinRM).
23+
24+
### About WS-Management
25+
26+
Windows Remote Management is the Microsoft implementation of the WS-Management
27+
protocol, a standard SOAP-based, firewall-friendly protocol that allows
28+
hardware and operating systems from different vendors to interoperate. The
29+
WS-Management protocol specification provides a common way for systems to
30+
access and exchange management information across an information technology
31+
(IT) infrastructure. WS-Management and Intelligent Platform Management
32+
Interface (IPMI), along with the Event Collector, are components of the
33+
Windows Hardware Management features.
34+
35+
The WS-Management protocol is based on the following standard Web service
36+
specifications: HTTPS, SOAP over HTTP (WS-I profile), SOAP 1.2, WS-Addressing,
37+
WS-Transfer, WS-Enumeration, and WS-Eventing.
38+
39+
### WS-Management and WMI
40+
41+
WS-Management can be used to retrieve data exposed by Windows Management
42+
Instrumentation (WMI). You can obtain WMI data with scripts or applications
43+
that use the WS-Management Scripting API or through the WinRM command-line
44+
tool. WS-Management supports most of the familiar WMI classes and operations,
45+
including embedded objects. WS-Management can leverage WMI to collect data
46+
about resources or to manage resources on a Windows-based computers. That
47+
means that you can obtain data about objects such as disks, network adapters,
48+
services, or processes in your enterprise through the existing set of WMI
49+
classes. You can also access the hardware data that is available from the
50+
standard WMI IPMI provider.
51+
52+
### WS-Management Windows PowerShell Provider (WSMan)
53+
54+
The WSMan provider provides a hierarchical view into the available
55+
WS-Management configuration settings. The provider allows you to explore and
56+
set the various WS-Management configuration options.
57+
58+
### WS-Management Configuration
59+
60+
If WS-Management is not installed and configured, Windows PowerShell remoting
61+
is not available, the WS-Management cmdlets do not run, WS-Management scripts
62+
do not run, and the WSMan provider cannot perform data operations. The
63+
WS-Management command-line tool, WinRM, and event forwarding also depend on
64+
the WS-Management configuration.
65+
66+
### WS-Management Cmdlets
67+
68+
WS-Management functionality is implemented in Windows PowerShell through a
69+
module that contains a set of cmdlets and the WSMan provider. You can use
70+
these cmdlets to complete the end-to-end tasks necessary to manage
71+
WS-Management settings on local and remote computers.
72+
73+
The following WS-Management cmdlets are available.
74+
75+
### Connection Cmdlets
76+
77+
- Connect-WSMan: Connects the local computer to the WS-Management (WinRM)
78+
service on a remote computer.
79+
80+
- Disconnect-WSMan: Disconnects the local computer from the WS-Management
81+
(WinRM) service on a remote computer.
82+
83+
### Management-Data Cmdlets
84+
85+
- Get-WSManInstance: Displays management information for a resource instance
86+
that is specified by a resource URI.
87+
88+
- Invoke-WSManAction: Invokes an action on the target object that is specified
89+
by the resource URI and by the selectors.
90+
91+
- New-WSManInstance: Creates a new management resource instance.
92+
93+
- Remove-WSManInstance: Deletes a management resource instance.
94+
95+
- Set-WSManInstance: Modifies the management information that is related to a
96+
resource.
97+
98+
### Setup and Configuration Cmdlets
99+
100+
- Set-WSManQuickConfig: Configures the local computer for remote management.
101+
You can use the Set-WSManQuickConfig cmdlet to configure WS-Management to
102+
allow remote connections to the WS-Management (WinRM) service. The
103+
Set-WSManQuickConfig cmdlet performs the following operations:
104+
- It determines whether the WS-Management (WinRM) service is running. If the
105+
WinRM service is not running, the Set-WSManQuickConfig cmdlet starts the
106+
service.
107+
- It sets the WS-Management (WinRM) service startup type to automatic.
108+
- It creates a listener that accepts requests from any IP address. The
109+
default transport protocol is HTTP.
110+
- It enables a firewall exception for WS-Management traffic.
111+
112+
Note: To run this cmdlet in Windows Vista, Windows Server 2008, and later
113+
versions of Windows, you must start Windows PowerShell with the "Run as
114+
administrator" option.
115+
116+
- Test-WSMan: Verifies that WS-Management is installed and configured. The
117+
Test-WSMan cmdlet tests whether the WS-Management (WinRM) service is running
118+
and configured on a local or remote computer.
119+
120+
- Disable-WSManCredSSP: Disables CredSSP authentication on a client computer.
121+
122+
- Enable-WSManCredSSP: Enables CredSSP authentication on a client computer.
123+
124+
- Get-WSManCredSSP: Gets the CredSSP-related configuration for a client
125+
computer.
126+
127+
### WS-Management-Specific Cmdlets
128+
129+
- New-WSManSessionOption: Creates a WSManSessionOption object to use as input
130+
to one or more parameters of a WS-Management cmdlet.
131+
132+
### Additional WS-Management Information
133+
134+
For more information about WS-Management, see the following topics in the
135+
MSDN (Microsoft Developer Network) library.
136+
137+
"Windows Remote Management"
138+
http://go.microsoft.com/fwlink/?LinkId=142321
139+
140+
"About Windows Remote Management"
141+
http://go.microsoft.com/fwlink/?LinkId=142322
142+
143+
"Installation and Configuration for Windows Remote Management"
144+
http://go.microsoft.com/fwlink/?LinkId=142323
145+
146+
"Windows Remote Management Architecture"
147+
http://go.microsoft.com/fwlink/?LinkId=142324
148+
149+
"WS-Management Protocol"
150+
http://go.microsoft.com/fwlink/?LinkId=142325
151+
152+
"Windows Remote Management and WMI"
153+
http://go.microsoft.com/fwlink/?LinkId=142326
154+
155+
"Resource URIs"
156+
http://go.microsoft.com/fwlink/?LinkId=142327
157+
158+
"Remote Hardware Management"
159+
http://go.microsoft.com/fwlink/?LinkId=142328
160+
161+
"Events"
162+
http://go.microsoft.com/fwlink/?LinkId=142329
163+
164+
## SEE ALSO
165+
166+
[Connect-WSMan](../../Microsoft.WSMan.Management/Connect-WSMan.md)
167+
168+
[Disable-WSManCredSSP](../../Microsoft.WSMan.Management/Disable-WSManCredSSP.md)
169+
170+
[Disconnect-WSMan](../../Microsoft.WSMan.Management/Disconnect-WSMan.md)
171+
172+
[Enable-WSManCredSSP](../../Microsoft.WSMan.Management/Enable-WSManCredSSP.md)
173+
174+
[Get-WSManCredSSP](../../Microsoft.WSMan.Management/Get-WSManCredSSP.md)
175+
176+
[Get-WSManInstance](../../Microsoft.WSMan.Management/Get-WSManInstance.md)
177+
178+
[Invoke-WSManAction](../../Microsoft.WSMan.Management/Invoke-WSManAction.md)
179+
180+
[New-WSManInstance](../../Microsoft.WSMan.Management/New-WSManInstance.md)
181+
182+
[Remove-WSManInstance](../../Microsoft.WSMan.Management/Remove-WSManInstance.md)
183+
184+
[Set-WSManInstance](../../Microsoft.WSMan.Management/Set-WSManInstance.md)
185+
186+
[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)
187+
188+
[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)
189+
190+
[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)
191+
192+
# KEYWORDS
193+
194+
about_WSMAN
195+
196+
about_WinRM

reference/3.0/Microsoft.PowerShell.Core/About/about_Wildcards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ following command gets services in which the ServiceType property value
6060
includes "Interactive".
6161

6262
```powershell
63-
Get-Service | Where-Object {$_.ServiceType -like "Interactive"}
63+
Get-Service | Where-Object {$_.ServiceType -like "*Interactive*"}
6464
```
6565

6666
In the following example, wildcard characters are used to find property
@@ -71,7 +71,7 @@ value of the CreationTime property of the restore point to a log file.
7171
```powershell
7272
$p = Get-ComputerRestorePoint
7373
foreach ($point in $p) {
74-
if ($point.description -like "PowerShell") {
74+
if ($point.description -like "*PowerShell*") {
7575
add-content -path C:\TechDocs\RestoreLog.txt "$($point.CreationTime)"
7676
}
7777
}

reference/4.0/Microsoft.PowerShell.Core/About/about_Environment_Variables.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,11 +244,11 @@ The environment variables that store preferences include:
244244
The default value of $Env:PSModulePath is:
245245

246246
```
247-
$home\Documents\WindowsPowerShell\Modules; $pshome\Modules
247+
$HOME\Documents\WindowsPowerShell\Modules; $PSHOME\Modules
248248
```
249249

250-
Windows PowerShell sets the value of "\$pshome\\Modules" in the registry. It
251-
sets the value of "\$home\\Documents\\WindowsPowerShell\\Modules" each time you
250+
Windows PowerShell sets the value of "\$PSHOME\\Modules" in the registry. It
251+
sets the value of "\$HOME\\Documents\\WindowsPowerShell\\Modules" each time you
252252
start Windows PowerShell.
253253

254254
In addition, setup programs that install modules in other directories, such as
@@ -294,7 +294,7 @@ $path = [System.Environment]::GetEnvironmentVariable("PSModulePath",
294294
```
295295

296296
For more information about the methods of the System.Environment class, see
297-
[Environment Methods](http://go.microsoft.com/fwlink/?LinkId=242783) in
297+
[Environment Methods](https://go.microsoft.com/fwlink/?LinkId=242783) in
298298
MSDN.
299299

300300
You can add also add a command that changes the value to your profile or use

0 commit comments

Comments
 (0)