Skip to content

final pass on About_ topic reformat #2011

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.

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 1 commit into from
Jan 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,11 @@ The environment variables that store preferences include:
The default value of $Env:PSModulePath is:

```
$home\Documents\WindowsPowerShell\Modules; $pshome\Modules
$HOME\Documents\WindowsPowerShell\Modules; $PSHOME\Modules
```

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

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

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

You can add also add a command that changes the value to your profile or use
Expand Down
2 changes: 1 addition & 1 deletion reference/3.0/Microsoft.PowerShell.Core/About/about_For.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ all the values in an array, consider using a Foreach statement.
The following shows the For statement syntax.

```powershell
for (>init>; <condition>; <repeat>)
for (<init>; <condition>; <repeat>)
{<statement list>}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ the following methods:

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

### Input Processing Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ Syntax:
do {<statement list>} while (<condition>)
```

# SEE ALSO
## SEE ALSO

- [about_Special_Characters](about_Special_Characters.md)
- [about_Wildcards](about_Wildcards.md)
Original file line number Diff line number Diff line change
Expand Up @@ -486,18 +486,13 @@ NOTE: Remote sessions, including sessions that are started by using the
commands are packaged in snap-ins.

The following modules (or snap-ins) are installed with PowerShell.
* Microsoft.PowerShell.Archive
* Microsoft.PowerShell.Core
* Microsoft.PowerShell.Diagnostics
* Microsoft.PowerShell.Host
* Microsoft.PowerShell.Management
* Microsoft.PowerShell.ODataUtils
* Microsoft.PowerShell.Security
* Microsoft.PowerShell.Utility
* Microsoft.WSMan.Management
* OneGet
* PowerShellGet
* PSDesiredStateConfiguration
* PSScheduledJob
* PSWorkflow
* PSWorkflowUtility
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ title: about_Parameters

## SHORT DESCRIPTION

Describes how to work with command parameters in Windows PowerShell®.
Describes how to work with command parameters in PowerShell.

## LONG DESCRIPTION

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

Expand Down
14 changes: 12 additions & 2 deletions reference/3.0/Microsoft.PowerShell.Core/About/about_Switch.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
ms.date: 2017-12-01
ms.date: 2017-12-06
schema: 2.0.0
locale: en-us
keywords: powershell,cmdlet
Expand Down Expand Up @@ -167,9 +167,9 @@ Switch has the following parameters:
| |condition. Wildcard and Exact are ignored. Also, if the |
| |match clause is not a string, this parameter is ignored. |

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

```powershell
Example:
PS> switch ("fourteen")
{
1 {"It is one."; Break}
Expand All @@ -179,7 +179,12 @@ Example:
3 {"Three again."; Break}
"fo*" {"That's too many."}
}
```

For the word "fourteen" to match a case you must use the **-Wildcard** or
**-Regex** parameter.

```powershell
PS> switch -Regex ("fourteen")
{
1 {"It is one."; Break}
Expand All @@ -189,6 +194,11 @@ Example:
3 {"Three again."; Break}
"fo*" {"That's too many."}
}
```

Result:

```Output
That's too many.
```

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
---
ms.date: 2018-01-04
schema: 2.0.0
locale: en-us
keywords: powershell,cmdlet
title: about_WS Management_Cmdlets
---

# About WS-Management Cmdlets

## SHORT DESCRIPTION

Provides an overview of Web Services for Management (WS-Management) as
background for using the WS-Management cmdlets in Windows PowerShell.

## LONG DESCRIPTION

This topic provides an overview of Web Services for Management (WS-Management)
as background for using the WS-Management cmdlets in Windows PowerShell. This
topic also provides links to more information about WS-Management. The
Microsoft implementation of WS-Management is also known as Windows Remote
Management (WinRM).

### About WS-Management

Windows Remote Management is the Microsoft implementation of the WS-Management
protocol, a standard SOAP-based, firewall-friendly protocol that allows
hardware and operating systems from different vendors to interoperate. The
WS-Management protocol specification provides a common way for systems to
access and exchange management information across an information technology
(IT) infrastructure. WS-Management and Intelligent Platform Management
Interface (IPMI), along with the Event Collector, are components of the
Windows Hardware Management features.

The WS-Management protocol is based on the following standard Web service
specifications: HTTPS, SOAP over HTTP (WS-I profile), SOAP 1.2, WS-Addressing,
WS-Transfer, WS-Enumeration, and WS-Eventing.

### WS-Management and WMI

WS-Management can be used to retrieve data exposed by Windows Management
Instrumentation (WMI). You can obtain WMI data with scripts or applications
that use the WS-Management Scripting API or through the WinRM command-line
tool. WS-Management supports most of the familiar WMI classes and operations,
including embedded objects. WS-Management can leverage WMI to collect data
about resources or to manage resources on a Windows-based computers. That
means that you can obtain data about objects such as disks, network adapters,
services, or processes in your enterprise through the existing set of WMI
classes. You can also access the hardware data that is available from the
standard WMI IPMI provider.

### WS-Management Windows PowerShell Provider (WSMan)

The WSMan provider provides a hierarchical view into the available
WS-Management configuration settings. The provider allows you to explore and
set the various WS-Management configuration options.

### WS-Management Configuration

If WS-Management is not installed and configured, Windows PowerShell remoting
is not available, the WS-Management cmdlets do not run, WS-Management scripts
do not run, and the WSMan provider cannot perform data operations. The
WS-Management command-line tool, WinRM, and event forwarding also depend on
the WS-Management configuration.

### WS-Management Cmdlets

WS-Management functionality is implemented in Windows PowerShell through a
module that contains a set of cmdlets and the WSMan provider. You can use
these cmdlets to complete the end-to-end tasks necessary to manage
WS-Management settings on local and remote computers.

The following WS-Management cmdlets are available.

### Connection Cmdlets

- Connect-WSMan: Connects the local computer to the WS-Management (WinRM)
service on a remote computer.

- Disconnect-WSMan: Disconnects the local computer from the WS-Management
(WinRM) service on a remote computer.

### Management-Data Cmdlets

- Get-WSManInstance: Displays management information for a resource instance
that is specified by a resource URI.

- Invoke-WSManAction: Invokes an action on the target object that is specified
by the resource URI and by the selectors.

- New-WSManInstance: Creates a new management resource instance.

- Remove-WSManInstance: Deletes a management resource instance.

- Set-WSManInstance: Modifies the management information that is related to a
resource.

### Setup and Configuration Cmdlets

- Set-WSManQuickConfig: Configures the local computer for remote management.
You can use the Set-WSManQuickConfig cmdlet to configure WS-Management to
allow remote connections to the WS-Management (WinRM) service. The
Set-WSManQuickConfig cmdlet performs the following operations:
- It determines whether the WS-Management (WinRM) service is running. If the
WinRM service is not running, the Set-WSManQuickConfig cmdlet starts the
service.
- It sets the WS-Management (WinRM) service startup type to automatic.
- It creates a listener that accepts requests from any IP address. The
default transport protocol is HTTP.
- It enables a firewall exception for WS-Management traffic.

Note: To run this cmdlet in Windows Vista, Windows Server 2008, and later
versions of Windows, you must start Windows PowerShell with the "Run as
administrator" option.

- Test-WSMan: Verifies that WS-Management is installed and configured. The
Test-WSMan cmdlet tests whether the WS-Management (WinRM) service is running
and configured on a local or remote computer.

- Disable-WSManCredSSP: Disables CredSSP authentication on a client computer.

- Enable-WSManCredSSP: Enables CredSSP authentication on a client computer.

- Get-WSManCredSSP: Gets the CredSSP-related configuration for a client
computer.

### WS-Management-Specific Cmdlets

- New-WSManSessionOption: Creates a WSManSessionOption object to use as input
to one or more parameters of a WS-Management cmdlet.

### Additional WS-Management Information

For more information about WS-Management, see the following topics in the
MSDN (Microsoft Developer Network) library.

"Windows Remote Management"
http://go.microsoft.com/fwlink/?LinkId=142321

"About Windows Remote Management"
http://go.microsoft.com/fwlink/?LinkId=142322

"Installation and Configuration for Windows Remote Management"
http://go.microsoft.com/fwlink/?LinkId=142323

"Windows Remote Management Architecture"
http://go.microsoft.com/fwlink/?LinkId=142324

"WS-Management Protocol"
http://go.microsoft.com/fwlink/?LinkId=142325

"Windows Remote Management and WMI"
http://go.microsoft.com/fwlink/?LinkId=142326

"Resource URIs"
http://go.microsoft.com/fwlink/?LinkId=142327

"Remote Hardware Management"
http://go.microsoft.com/fwlink/?LinkId=142328

"Events"
http://go.microsoft.com/fwlink/?LinkId=142329

## SEE ALSO

[Connect-WSMan](../../Microsoft.WSMan.Management/Connect-WSMan.md)

[Disable-WSManCredSSP](../../Microsoft.WSMan.Management/Disable-WSManCredSSP.md)

[Disconnect-WSMan](../../Microsoft.WSMan.Management/Disconnect-WSMan.md)

[Enable-WSManCredSSP](../../Microsoft.WSMan.Management/Enable-WSManCredSSP.md)

[Get-WSManCredSSP](../../Microsoft.WSMan.Management/Get-WSManCredSSP.md)

[Get-WSManInstance](../../Microsoft.WSMan.Management/Get-WSManInstance.md)

[Invoke-WSManAction](../../Microsoft.WSMan.Management/Invoke-WSManAction.md)

[New-WSManInstance](../../Microsoft.WSMan.Management/New-WSManInstance.md)

[Remove-WSManInstance](../../Microsoft.WSMan.Management/Remove-WSManInstance.md)

[Set-WSManInstance](../../Microsoft.WSMan.Management/Set-WSManInstance.md)

[Set-WSManQuickConfig](../../Microsoft.WSMan.Management/Set-WSManQuickConfig.md)

[Set-WSManSessionOption](../../Microsoft.WSMan.Management/Set-WSManSessionOption.md)

[Test-WSMan](../../Microsoft.WSMan.Management/Test-WSMan.md)

# KEYWORDS

about_WSMAN

about_WinRM
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ following command gets services in which the ServiceType property value
includes "Interactive".

```powershell
Get-Service | Where-Object {$_.ServiceType -like "Interactive"}
Get-Service | Where-Object {$_.ServiceType -like "*Interactive*"}
```

In the following example, wildcard characters are used to find property
Expand All @@ -71,7 +71,7 @@ value of the CreationTime property of the restore point to a log file.
```powershell
$p = Get-ComputerRestorePoint
foreach ($point in $p) {
if ($point.description -like "PowerShell") {
if ($point.description -like "*PowerShell*") {
add-content -path C:\TechDocs\RestoreLog.txt "$($point.CreationTime)"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,11 @@ The environment variables that store preferences include:
The default value of $Env:PSModulePath is:

```
$home\Documents\WindowsPowerShell\Modules; $pshome\Modules
$HOME\Documents\WindowsPowerShell\Modules; $PSHOME\Modules
```

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

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

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

You can add also add a command that changes the value to your profile or use
Expand Down
2 changes: 1 addition & 1 deletion reference/4.0/Microsoft.PowerShell.Core/About/about_For.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ all the values in an array, consider using a Foreach statement.
The following shows the For statement syntax.

```powershell
for (>init>; <condition>; <repeat>)
for (<init>; <condition>; <repeat>)
{<statement list>}
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ the following methods:

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

### Input Processing Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,6 @@ The following modules (or snap-ins) are installed with PowerShell.
* Microsoft.PowerShell.Security
* Microsoft.PowerShell.Utility
* Microsoft.WSMan.Management
* OneGet
* PowerShellGet
* PSDesiredStateConfiguration
* PSScheduledJob
Expand Down
Loading