PowerShell Cmdlet Help for Set-WSManInstanceNAME Set-WSManInstance SYNOPSIS Modifies the management information that is related to a resource. SYNTAX Set-WSManInstance [-ApplicationName -ResourceURI ] Set-WSManInstance [-ConnectionURI hentication tion DESCRIPTION The Set-WSManInstance cmdlet modifies the management information that is related to a resource. This cmdlet uses the WinRM connection/transport layer to modify the information. PARAMETERS -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 speci fied application. This default setting of "WSMAN" is appropriate for most uses. This parameter is designed to b e used when numerous 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 wsman Accept pipeline input? false Accept wildcard characters? false -Authentication Specifies the authentication mechanism to be used at the server. Possible values 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 negotiation to determine whether th e Kerberos protocol or NTLM is used. - CredSSP: Use Credential Security Service Provider (CredSSP) authentication, which allows the user to 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's credentials from the local computer to a remote computer. This practice i ncreases 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 Accept pipeline input? false Accept wildcard characters? false -ComputerName Specifies the computer against which you want to run the management operation. The value can be a fully qualifi ed 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 do main from the user, you must use a fully qualified domain name must be used. You can pipe a value for this para meter to the cmdlet. Required? false Position? named Default value localhost Accept pipeline input? false Accept wildcard characters? false -ConnectionURI Specifies the connection endpoint. The format of this string is: The following string is a properly formatted value for this parameter: http://Server01:8080/WSMAN The URI must be fully qualified . Required? false Position? named Default value 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 us er name, such as "User01", "Domain01\User01", or "User@Domain.com". Or, enter a PSCredential object, such as on e returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false -Dialect Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote s ervice. The following aliases can be used for the dialect URI: - WQL: http://schemas.microsoft.com/wbem/wsman/1/WQL - Selector: http://schemas.microsoft.com/wbem/wsman/1/wsman/SelectorFilter - Association: http://schemas.dmtf.org/wbem/wsman/1/cimbinding/associationFilter Required? false Position? named Default value http://schemas.microsoft.com/wbem/wsman/1/WQL Accept pipeline input? false 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"} -File Path:c:\input.xml -authentication default This command calls the StopService method on the Spooler service by using input from a file. The file, Input.xm l, contains the following content: Required? false Position? named Default value Accept pipeline input? true (ByPropertyName) Accept wildcard characters? false -Fragment Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For exa mple, to get the status of a spooler service, specify "-Fragment Status". Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false -OptionSet Passes a set of switches to a service to modify or refine the nature of the request. These are similar to swi tches 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? Position? named Default value Accept pipeline input? false Accept wildcard characters? false -Port Specifies the port to use when the client connects to the WinRM service. When the transport is HTTP, the defaul t port is 80. When the transport is HTTPS, the default port is 443. When you use HTTPS as the transport, the va lue of the ComputerName parameter must match the server's certificate common name (CN). However, if the SkipCNC heck parameter is specified as part of the SessionOption parameter, then the certificate common name of the ser ver does not have to match the host name of the server. The SkipCNCheck parameter should be used only for trust ed machines. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false -ResourceURI Contains the Uniform Resource Identifier (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 to 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? named Default value Accept pipeline input? false Accept wildcard characters? false -SelectorSet Specifies a set of value pairs that are used to select particular management resource instances. The SelectorSe t parameter is used when more than one instance of the resource exists. The value of the SelectorSet parameter 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 Accept pipeline input? true (ByValue, ByPropertyName) Accept wildcard characters? false -SessionOption Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create b y using the New-WSManSessionOption cmdlet. For more information about the options that are available, see New-W SManSessionOption. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false -UseSSL [ Specifies that the Secure Sockets Layer (SSL) protocol should be used to establish a connection to the remote c omputer. By default, SSL is not used. WS-Management encrypts all the Windows PowerShell content that is transmitted over the network. The UseSSL para meter 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 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 th e ResourceURI parameter and the SelectorSet parameter. The value of the ValueSet parameter must be a hash table . Required? false Position? named Default value Accept pipeline input? true (ByPropertyName) Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, type, "get-help about_commonparameters". INPUTS None This cmdlet does not accept any input. OUTPUTS None This cmdlet does not generate any output. NOTES -------------------------- EXAMPLE 1 -------------------------- C:\PS>set-wsmaninstance -resourceuri winrm/config/listener -selectorset @{address="*";transport="https"} -valueset @{Enabled="false"} cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener xsi : http://www.w3.org/2001/XMLSchema-instance lang : en-US Address : * Transport : HTTPS Port : 443 Hostname : Enabled : false URLPrefix : wsman CertificateThumbprint : ListeningOn : {127.0.0.1, 172.30.168.171, ::1, 2001:4898:0:fff:0:5efe:172.30.168.171...} Description ----------- This command disables the https listener on the local computer. Important: The ValueSet parameter is case-sensitive when matching the properties specified. For example, using the above command. This fails: -ValueSet @{enabled="False"} This succeeds: -ValueSet @{Enabled="False"} -------------------------- EXAMPLE 2 -------------------------- C:\PS>set-wsmaninstance -resourceuri winrm/config -ValueSet @{MaxEnvelopeSizekb = "200"} cfg : http://schemas.microsoft.com/wbem/wsman/1/config lang : en-US MaxEnvelopeSizekb : 200 MaxTimeoutms : 60000 MaxBatchItems : 32000 MaxProviderRequests : 4294967295 Client : Client Service : Service Winrs : Winrs Description ----------- This command sets the MaxEnvelopeSizekb value to 200 on the local computer. Important: The ValueSet parameter is case-sensitive when matching the properties specified. For example, using the above command. This fails: -ValueSet @{MaxEnvelopeSizeKB ="200"} This succeeds: -ValueSet @{MaxEnvelopeSizekb ="200"} -------------------------- EXAMPLE 3 -------------------------- C:\PS>set-wsmaninstance -resourceuri winrm/config/listener -computername SERVER02 -selectorset @{address="*";transp ort="https"} -valueset @{Enabled="false"} cfg : http://schemas.microsoft.com/wbem/wsman/1/config/listener xsi : http://www.w3.org/2001/XMLSchema-instance lang : en-US Address : * Transport : HTTPS Port : 443 Hostname : Enabled : false URLPrefix : wsman CertificateThumbprint : ListeningOn : {127.0.0.1, 172.30.168.172, ::1, 2001:4898:0:fff:0:5efe:172.30.168.172...} Description ----------- This command disables the https listener on the remote computer SERVER02. Important: The ValueSet parameter is case-sensitive when matching the properties specified. For example, using the above command. This fails: -ValueSet @{enabled="False"} This succeeds: -ValueSet @{Enabled="False"} RELATED LINKS Online version: http://go.microsoft.com/fwlink/?LinkId=141458 Connect-WSMan Disable-WSManCredSSP Disconnect-WSMan Enable-WSManCredSSP Get-WSManCredSSP Get-WSManInstance Invoke-WSManAction New-WSManInstance New-WSManSessionOption Remove-WSManInstance Set-WSManQuickConfig Test-WSMan |