Remove-WSManInstance
Deletes a management resource instance.
Syntax
Remove-WSManInstance
[-ApplicationName <String>]
[-ComputerName <String>]
[-OptionSet <Hashtable>]
[-Port <Int32>]
[-ResourceURI] <Uri>
[-SelectorSet] <Hashtable>
[-SessionOption <SessionOption>]
[-UseSSL]
[-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[-CertificateThumbprint <String>]
[<CommonParameters>]
Remove-WSManInstance
[-ConnectionURI <Uri>]
[-OptionSet <Hashtable>]
[-ResourceURI] <Uri>
[-SelectorSet] <Hashtable>
[-SessionOption <SessionOption>]
[-Credential <PSCredential>]
[-Authentication <AuthenticationMechanism>]
[-CertificateThumbprint <String>]
[<CommonParameters>]
Description
The Remove-WSManInstance
cmdlet deletes an instance of a management resource that's specified in
the ResourceURI and SelectorSet parameters.
This cmdlet uses the WinRM connection transport layer to delete the management resource instance.
Examples
Example 1: Delete a listener
Remove-WSManInstance -ResourceUri winrm/config/Listener -SelectorSet @{
Address = 'test.fabrikam.com'
Transport = 'http'
}
This command deletes the WS-Management HTTP listener on a computer.
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 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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | AuthenticationMechanism |
Aliases: | auth, am |
Accepted values: | None, Default, Digest, Negotiate, Basic, Kerberos, ClientCertificate, Credssp |
Position: | Named |
Default value: | None |
Required: | False |
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. Certificates don't work with domain accounts.
To get a certificate thumbprint, use the Get-Item
or Get-ChildItem
command in the PowerShell
Cert:
drive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | String |
Aliases: | cn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionURI
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.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | PSCredential |
Aliases: | cred, c |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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}
Type: | Hashtable |
Aliases: | os |
Position: | Named |
Default value: | None |
Required: | False |
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: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
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
Type: | Uri |
Aliases: | ruri |
Position: | 0 |
Default value: | None |
Required: | True |
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 SelectorSet must be a hash table.
The following example shows how to enter a value for this parameter:
-SelectorSet @{Name="WinRM";ID="yyy"}
Type: | Hashtable |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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
.
Type: | SessionOption |
Aliases: | so |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | SwitchParameter |
Aliases: | ssl |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
None
This cmdlet returns no output.
Notes
The cmdlets in the CimCmdlets module are similar. They use the DCOM connection/transport layer to create or update WMI instances.