|
| 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 |
0 commit comments