Export (0) Print
Expand All

Set-WSManInstance

Set-WSManInstance

Modifies the management information that is related to a resource.

Syntax

Parameter Set: ComputerName
Set-WSManInstance [-ResourceURI] <Uri> [[-SelectorSet] <Hashtable> ] [-ApplicationName <String> ] [-Authentication <AuthenticationMechanism> ] [-CertificateThumbprint <String> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-Dialect <Uri> ] [-FilePath <String> ] [-Fragment <String> ] [-OptionSet <Hashtable> ] [-Port <Int32> ] [-SessionOption <SessionOption> ] [-UseSSL] [-ValueSet <Hashtable> ] [ <CommonParameters>]

Parameter Set: URI
Set-WSManInstance [-ResourceURI] <Uri> [[-SelectorSet] <Hashtable> ] [-Authentication <AuthenticationMechanism> ] [-CertificateThumbprint <String> ] [-ConnectionURI <Uri> ] [-Credential <PSCredential> ] [-Dialect <Uri> ] [-FilePath <String> ] [-Fragment <String> ] [-OptionSet <Hashtable> ] [-SessionOption <SessionOption> ] [-ValueSet <Hashtable> ] [ <CommonParameters>]




Detailed 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<String>

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:

<transport>://<server>:<port>/<ApplicationName>

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.


Aliases

none

Required?

false

Position?

named

Default Value

wsman

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Authentication<AuthenticationMechanism>

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.


Aliases

auth,am

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CertificateThumbprint<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

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.


Aliases

cn

Required?

false

Position?

named

Default Value

localhost

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionURI<Uri>

Specifies the connection endpoint. The format of this string is as follows:

<Transport>://<Server>:<Port>/<ApplicationName>

The following string is a correctly formatted value for this parameter:

http://Server01:8080/WSMAN

The URI must be fully qualified.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

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.


Aliases

cred,c

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Dialect<Uri>

Specifies the dialect to use in the filter predicate. This can be any dialect that is supported by the remote service. 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


Aliases

none

Required?

false

Position?

named

Default Value

http://schemas.microsoft.com/wbem/wsman/1/WQL

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FilePath<String>

Specifies the path of a file that is used to create a management resource. You specify the management resource by using the ResourceURI parameter and the SelectorSet parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Fragment<String>

Specifies a section inside the instance that is to be updated or retrieved for the specified operation. For example, to get the status of a spooler service, specify the following:

-Fragment Status


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OptionSet<Hashtable>

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}


Aliases

os

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ResourceURI<Uri>

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


Aliases

ruri

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SelectorSet<Hashtable>

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"}


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-SessionOption<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.


Aliases

so

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.


Aliases

ssl

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ValueSet<Hashtable>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

    This cmdlet does not accept any input.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    This cmdlet does not generate any output.


Examples

Example 1: Disable a listener on the local computer

This command disables the https listener on the local computer.

Important: The ValueSet parameter is case-sensitive when matching the properties specified.

For example, in this command,

This fails: -ValueSet @{enabled="False"}

This succeeds: -ValueSet @{Enabled="False"}


PS C:\> set-wsmaninstance -ResourceUri winrm/config/listener -SelectorSet @{address="*";transport="https"} -ValueSet @{Enabled="false"}

Example 2: Set the maximum envelope size on the local computer

This command sets the MaxEnvelopeSizekb value to 200 on the local computer.

Important: ValueSet is case-sensitive when matching the properties specified.


PS C:\> Set-WSManInstance -ResourceUri winrm/config -ValueSet @{MaxEnvelopeSizekb = "200"}

Example 3: Disable a listener on a remote computer

This command disables the https listener on the remote computer SERVER02.

Important: ValueSet is case-sensitive when matching the properties specified.


PS C:\> Set-WSManInstance -ResourceUri winrm/config/listener -ComputerName "SERVER02" -SelectorSet @{address="*";transport="https"} -ValueSet @{Enabled="false"}

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft