Remove-CimSession
Remove-CimSession
Removes one or more CIM sessions.
Syntax
Parameter Set: CimSessionSet
Remove-CimSession [-CimSession] <CimSession[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ComputerNameSet
Remove-CimSession [-ComputerName] <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InstanceIdSet
Remove-CimSession -InstanceId <Guid[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: NameSet
Remove-CimSession -Name <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SessionIdSet
Remove-CimSession [-Id] <UInt32[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-CimSession cmdlet removes one or more CIM session objects from the local Windows PowerShell® session.
Parameters
-CimSession<CimSession[]>
Runs the command using the specified CIM session. Enter a variable that contains the CIM session, or a command that creates or gets the CIM session, such as the New-CimSession or Get-CimSession cmdlets. For more information, see about_CimSessions.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies the name of the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) or a NetBIOS name.
If you specify this parameter, the cmdlet creates a temporary session to the specified computer using the WsMan protocol.
If you do not specify this parameter, the cmdlet performs the operation on the local computer using Component Object Model (COM).
If multiple operations are being performed on the same computer, connecting using a CIM session gives better performance.
Aliases |
cn, ServerName |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Id<UInt32[]>
Specifies the ID of the CIM session to remove. Specify one or more IDs separated by commas, or use the range operator (..) to specify a range of IDs.
An ID is an integer that uniquely identifies the CIM session in the current Windows PowerShell session. It is easier to remember and type than InstanceId, but it is unique only within the current Windows PowerShell session.
For more information about the range operator, see about_Operators.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InstanceId<Guid[]>
Specifies the instance ID of the CIM session to remove.
InstanceID is a Globally Unique Identifier (GUID) that uniquely identifies a CIM session. The InstanceID is unique, even when you have multiple sessions running in Windows PowerShell.
The InstanceID is stored in the InstanceID property of the object that represents a CIM session.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the friendly name of the CIM session to remove. You can use wildcard characters with this parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
None
This cmdlet accepts no input objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
System.Object
This cmdlet returns an object that contains CIM session information.
Examples
Example 1: Remove all the CIM sessions
This command retrieves all the available CIM sessions on the local computer using the Get-CimSession cmdlet, and then removes them using the Remove-CimSession.
PS C:\> Get-CimSession | Remove-CimSession
Example 2: Remove a specific CIM session
This command removes the CIM session that has an ID value of 5.
PS C:\> Remove-CimSession -Id 5
Example 3: Show the list of CIM sessions to remove by using the WhatIf parameterby the parameter
This command uses the common parameter WhatIf to specify that the removal should not be done, but only output what would happen if it were done.
PS C:\> Remove-CimSession -Name a* -WhatIf