< Back
Remove-CimSession
Post
NAME Remove-CimSession
SYNOPSIS
Removes one or more CIM sessions.
SYNTAX
Remove-CimSession [-CimSession] <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession [-ComputerName] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession [-Id] <UInt32[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession -InstanceId <Guid[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-CimSession cmdlet removes one or more Common Information Model (CIM) session objects from the local Windows PowerShell???? session.
PARAMETERS
-CimSession <CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession
or Get-CimSession cmdlet. The default is the current session on the local computer.
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.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet accepts no input objects.
OUTPUTS
System.Object
This cmdlet returns an object that contains CIM session information.
Example 1: Remove all 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 specified 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 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.
RELATED LINKS
Online Version:
Get-CimSession
New-CimSessionOption
SYNOPSIS
Removes one or more CIM sessions.
SYNTAX
Remove-CimSession [-CimSession] <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession [-ComputerName] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession [-Id] <UInt32[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession -InstanceId <Guid[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-CimSession -Name <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-CimSession cmdlet removes one or more Common Information Model (CIM) session objects from the local Windows PowerShell???? session.
PARAMETERS
-CimSession <CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession
or Get-CimSession cmdlet. The default is the current session on the local computer.
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.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet accepts no input objects.
OUTPUTS
System.Object
This cmdlet returns an object that contains CIM session information.
Example 1: Remove all 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 specified 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 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.
RELATED LINKS
Online Version:
Get-CimSession
New-CimSessionOption