New-WSManInstance
SYNOPSIS
Creates a new instance of a management resource.
SYNTAX
ComputerName (Default)
New-WSManInstance [-ApplicationName <String>] [-ComputerName <String>] [-FilePath <String>]
[-OptionSet <Hashtable>] [-Port <Int32>] [-ResourceURI] <Uri> [-SelectorSet] <Hashtable>
[-SessionOption <SessionOption>] [-UseSSL] [-ValueSet <Hashtable>] [-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>] [-CertificateThumbprint <String>] [<CommonParameters>]
URI
New-WSManInstance [-ConnectionURI <Uri>] [-FilePath <String>] [-OptionSet <Hashtable>] [-ResourceURI] <Uri>
[-SelectorSet] <Hashtable> [-SessionOption <SessionOption>] [-ValueSet <Hashtable>]
[-Credential <PSCredential>] [-Authentication <AuthenticationMechanism>] [-CertificateThumbprint <String>]
[<CommonParameters>]
DESCRIPTION
> This cmdlet is only available on the Windows platform. The `New-WSManInstance` cmdlet creates a new instance of a management resource. It uses a resource URI and a value set or input file to create the new instance of the management resource.
This cmdlet uses the WinRM connection/transport layer to create the management resource instance.
EXAMPLES
Example 1: Create a HTTPS listener
New-WSManInstance winrm/config/Listener -SelectorSet @{Transport='HTTPS'; Address='*'} -ValueSet @{Hostname="HOST";CertificateThumbprint="XXXXXXXXXX"}
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:
`\<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 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.
Type: System.String
Parameter Sets: ComputerName
Aliases:
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 username 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 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 the Kerberos protocol or NTLM is used. - CredSSP: Use Credential Security Support 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 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.
Type: Microsoft.WSMan.Management.AuthenticationMechanism
Parameter Sets: (All)
Aliases: auth, am
Accepted values: None, Default, Digest, Negotiate, Basic, Kerberos, ClientCertificate, Credssp
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 PowerShell Cert: drive.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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 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.
Type: System.String
Parameter Sets: ComputerName
Aliases: cn
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:
`\<Transport>://\<Server>:\<Port>/\<ApplicationName>`
The following string is a properly formatted value for this parameter:
`http://Server01:8080/WSMAN`
The URI must be fully qualified.
Type: System.Uri
Parameter Sets: URI
Aliases: CURI, CU
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, you will be prompted for a password.
Type: System.Management.Automation.PSCredential
Parameter Sets: (All)
Aliases: cred, c
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 create a management resource. You specify the management resource using the ResourceURI parameter and the SelectorSet parameter . For example, the following command uses the File parameter:
`Invoke-WSManAction -Action stopservice -ResourceUri wmi/cimv2/Win32_Service -SelectorSet @{Name="spooler"} -File c:\input.xml -Authentication Default`
This command calls the StopService method on the Spooler service using input from a file. The file, `Input.xml`, contains the following content:
`\<p:StopService_INPUT xmlns:p="http://schemas.microsoft.com/wbem/wsman/1/wmi/root/cimv2/Win32_Service" />`
Type: System.String
Parameter Sets: (All)
Aliases: Path
Required: False
Position: Named
Default value: None
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 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}`
Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases: os
Required: False
Position: Named
Default value: None
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 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.
Type: System.Int32
Parameter Sets: ComputerName
Aliases:
Required: False
Position: Named
Default value: None
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`
Type: System.Uri
Parameter Sets: (All)
Aliases: ruri
Required: True
Position: 0
Default value: None
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 SelectorSet 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"}`
Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SessionOption
Defines a set of extended options for the WS-Management session. Enter a SessionOption object that you create using the `New-WSManSessionOption` cmdlet. For more information about the options that are available, see `New-WSManSessionOption`.
Type: Microsoft.WSMan.Management.SessionOption
Parameter Sets: (All)
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 should be 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.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: ComputerName
Aliases:
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 using the ResourceURI parameter and the SelectorSet parameter. The value of the ValueSet parameter must be a hash table.
Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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
None
This cmdlet does not accept any input.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
The `Set-WmiInstance` cmdlet, a Windows Management Instrumentation (WMI) cmdlet, is similar. `Set-WmiInstance` uses the DCOM connection/transport layer to create or update WMI instances.