Remove-​Cim​Session

Removes one or more CIM sessions.

Syntax

Remove-CimSession
      [-CimSession] <CimSession[]>
      [-Confirm]
      [-WhatIf]
Remove-CimSession
      [-ComputerName] <String[]>
      [-Confirm]
      [-WhatIf]
Remove-CimSession
      [-Id] <UInt32[]>
      [-Confirm]
      [-WhatIf]
Remove-CimSession
      -InstanceId <Guid[]>
      [-Confirm]
      [-WhatIf]
Remove-CimSession
      -Name <String[]>
      [-Confirm]
      [-WhatIf]

Description

The Remove-CimSession cmdlet removes one or more CIM session objects from the local wps_1 session.

Examples

Example 1: Remove all the CIM sessions

PS C:\> Get-CimSession | Remove-CimSession

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.

Example 2: Remove a specific CIM session

PS C:\> Remove-CimSession -Id 5

This command removes the CIM session that has an ID value of 5.

Example 3: Show the list of CIM sessions to remove by using the WhatIf parameterby the parameter

PS C:\>Remove-CimSession -Name a* -WhatIf

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.

Required Parameters

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

Type:CimSession[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-ComputerName

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.

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Id

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 wps_2 session. It is easier to remember and type than InstanceId, but it is unique only within the current wps_2 session.

For more information about the range operator, see about_Operators.

Type:UInt32[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InstanceId

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

The InstanceID is stored in the InstanceID property of the object that represents a CIM session.

Type:Guid[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the friendly name of the CIM session to remove. You can use wildcard characters with this parameter.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

psdx_confirmdesc

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

psdx_whatifdesc

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

This cmdlet accepts no input objects.

Outputs

System.Object

This cmdlet returns an object that contains CIM session information.