]
Invoke-WSManAction [-ResourceURI] [-Action] [[-SelectorSet] ] [-Authentication {None |
Default | Digest | Negotiate | Basic | Kerberos | ClientCertificate | Credssp}] [-CertificateThumbprint ]
[-ConnectionURI ] [-Credential ] [-FilePath ] [-OptionSet ] [-SessionOption
] [-ValueSet ] []
DESCRIPTION
The Invoke-WSManAction runs an action on the object that is specified by RESOURCE_URI, where parameters are
specified by key value pairs.
This cmdlet uses the WSMan connection/transport layer to run the action.
PARAMETERS
-Action
Specifies the method to run on the management object specified by the ResourceURI and selectors.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ApplicationName
Specifies the application name in the connection. The default value of the ApplicationName parameter is WSMAN.
The complete identifier for the remote endpoint is in the following format:
://:/
For example: `http://server01:8080/WSMAN`
Internet Information Services (IIS), which hosts the session, forwards requests with this endpoint to the
specified application. This default setting of WSMAN is appropriate for most uses. This parameter is designed
to be used if many computers establish remote connections to one computer that is running Windows PowerShell.
In this case, IIS hosts Web Services for Management (WS-Management) for efficiency.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Authentication
Specifies the authentication mechanism to be used at the server. The acceptable values for this parameter are:
- Basic. Basic is a scheme in which the user name and password are sent in clear text to the server or proxy.
- Default. Use the authentication method implemented by the WS-Management protocol. This is the default. -
Digest. Digest is a challenge-response scheme that uses a server-specified data string for the challenge. -
Kerberos. The client computer and the server mutually authenticate by using Kerberos certificates. -
Negotiate. Negotiate is a challenge-response scheme that negotiates with the server or proxy to determine the
scheme to use for authentication. For example, this parameter value allows for negotiation to determine
whether the Kerberos protocol or NTLM is used. - CredSSP. Use Credential Security Support Provider (CredSSP)
authentication, which lets the user delegate credentials. This option is designed for commands that run on one
remote computer but collect data from or run additional commands on other remote computers.
Caution: CredSSP delegates the user credentials from the local computer to a remote computer. This practice
increases the security risk of the remote operation. If the remote computer is compromised, when credentials
are passed to it, the credentials can be used to control the network session.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateThumbprint
Specifies the digital public key certificate (X509) of a user account that has permission to perform this
action. Enter the certificate thumbprint of the certificate.
Certificates are used in client certificate-based authentication. They can be mapped only to local user
accounts; they do not work with domain accounts.
To get a certificate thumbprint, use the Get-Item or Get-ChildItem command in the Windows PowerShell Cert:
drive.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ComputerName
Specifies the computer against which to run the management operation. The value can be a fully qualified
domain name, a NetBIOS name, or an IP address. Use the local computer name, use localhost, or use a dot (.) to
specify the local computer. The local computer is the default. When the remote computer is in a different
domain from the user, you must use a fully qualified domain name must be used. You can pipe a value for this
parameter to the cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ConnectionURI
Specifies the connection endpoint. The format of this string is as follows:
://:/
The following string is a correctly formatted value for this parameter:
`http://Server01:8080/WSMAN`
The URI must be fully qualified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential
Specifies a user account that has permission to perform this action. The default is the current user. Type a
user name, such as User01, Domain01\User01, or User@Domain.com. Or, enter a PSCredential object, such as one
returned by the Get-Credential cmdlet. When you type a user name, this cmdlet prompts you for a password.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-FilePath
Specifies the path of a file that is used to update a management resource. You specify the management resource
by using the ResourceURI parameter and the SelectorSet parameter. For example, the following command uses the
FilePath parameter:
`Invoke-WSManAction -Action stopservice -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"}
-FilePath c:\input.xml -Authentication default`
This command calls the StopService method on the Spooler service by using input from a file. The file,
Input.xml, contains the following content:
``
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OptionSet
Specifies a set of switches to a service to modify or refine the nature of the request. These resemble
switches used in command-line shells because they are service specific. Any number of options can be specified.
The following example demonstrates the syntax that passes the values 1, 2, and 3 for the a, b, and c
parameters:
`-OptionSet @{a=1;b=2;c=3}`
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Port
Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the
default port is 80. When the transport is HTTPS, the default port is 443.
When you use HTTPS as the transport, the value of the ComputerName parameter must match the server's
certificate common name (CN). However, if the SkipCNCheck parameter is specified as part of the SessionOption
parameter, the certificate common name of the server does not have to match the host name of the server. The
SkipCNCheck parameter should be used only for trusted computers.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceURI
Specifies the URI of the resource class or instance. The URI is used to identify a specific type of resource,
such as disks or processes, on a computer.
A URI consists of a prefix and a path of a resource. For example:
`http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_LogicalDisk`
`http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_NumericSensor`
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SelectorSet
Specifies a set of value pairs that are used to select particular management resource instances. SelectorSet
is used when more than one instance of the resource exists. The value of SelectorSet must be a hash table.
The following example shows how to enter a value for this parameter:
`-SelectorSet @{Name="WinRM";ID="yyy"}`
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SessionOption
Specifies extended options for the WS-Management session. Enter a SessionOption object that you create by
using the New-WSManSessionOption cmdlet. For more information about the options that are available, type
`Get-Help New-WSManSessionOption`.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseSSL []
Specifies that the Secure Sockets Layer (SSL) protocol is used to establish a connection to the remote
computer. By default, SSL is not used.
WS-Management encrypts all the Windows PowerShell content that is transmitted over the network. The UseSSL
parameter lets you specify the additional protection of HTTPS instead of HTTP. If SSL is not available on the
port that is used for the connection, and you specify this parameter, the command fails.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ValueSet
Specifies a hash table that helps modify a management resource. You specify the management resource by using
ResourceURI and SelectorSet . The value of the ValueSet parameter must be a hash table.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
Example 1: Invoke a method
PS C:\>Invoke-WSManAction -Action "StartService" -ResourceURI wmicimv2/win32_service -SelectorSet
@{name="spooler"} -Authentication default
xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
lang : en-US
ReturnValue : 0
This command calls the StartService method of the Win32_Service WMI class instance that corresponds to the Spooler
service.
The return value indicates whether the action was successful. In this case, a return value of 0 indicates success.
A return value of 5 indicates that the service is already started.
Example 2: Invoke a method by using input from a file
PS C:\>Invoke-WSManAction -Action "StopService" -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"}
-FilePath:input.xml -Authentication default
xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
lang : en-US
ReturnValue : 0
This command calls the StopService method on the Spooler service by using input from a file. The file, Input.xml,
contains the following content:
``
Example 3: Invoke a method with specified parameter values
PS C:\>Invoke-WSManAction -Action "Create" -ResourceURI wmicimv2/win32_process -ValueSet
@{commandline="notepad.exe";currentdirectory="C:\"}
xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Process
cim : http://schemas.dmtf.org/wbem/wscim/1/common
lang : en-US
ProcessId : 6356
ReturnValue : 0
This command calls the Create method of the Win32_Process class. It passes the method two parameter values,
Notepad.exe and C:\. As a result, a new process is created to run Notepad, and the current directory of the new
process is set to C:\.
Example 4: Invoke a method on a remote computer
PS C:\>Invoke-WSManAction -Action "StartService" -ResourceURI wmicimv2/win32_service -SelectorSet
@{name="spooler"} -ComputerName "server01" -Authentication default
xsi : http://www.w3.org/2001/XMLSchema-instance
p : http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service
cim : http://schemas.dmtf.org/wbem/wscim/1/common
lang : en-US
ReturnValue : 0
This command calls the StartService method of the Win32_Service WMI class instance that corresponds to the Spooler
service. Because the ComputerName parameter is specified, the command runs against the remote server01 computer.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821731
Connect-WSMan
Disable-WSManCredSSP
Disconnect-WSMan
Enable-WSManCredSSP
Get-WSManCredSSP
Get-WSManInstance
New-WSManInstance
New-WSManSessionOption
Remove-WSManInstance
Set-WSManInstance
Set-WSManQuickConfig
Test-WSMan