Export (0) Print
Expand All

Get-CimSession

Updated: June 3, 2013

Applies To: Windows Server 2012

Get-CimSession

Gets the CIM session objects from the current session.

Syntax

Parameter Set: ComputerNameSet
Get-CimSession [[-ComputerName] <String[]> ] [ <CommonParameters>]

Parameter Set: InstanceIdSet
Get-CimSession -InstanceId <Guid[]> [ <CommonParameters>]

Parameter Set: NameSet
Get-CimSession -Name <String[]> [ <CommonParameters>]

Parameter Set: SessionIdSet
Get-CimSession [-Id] <UInt32[]> [ <CommonParameters>]




Detailed Description

The Get-CimSession cmdlet gets the CIM session objects created in the current Windows PowerShell® session.

If used without any parameters, the cmdlet gets all of the CIM sessions created in the current Windows PowerShell session. You can use the parameters of Get-CimSession to get the sessions that are for particular computers, or you can identify sessions by their names, IDs, or instance IDs.

For more information about Windows PowerShell sessions, see about_CimSessions

Parameters

-ComputerName<String[]>

Specifies the name of the computer from which to get CIM sessions. Wildcard characters are permitted.


Aliases

cn,ServerName

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

-Id<UInt32[]>

Specifies the identifier (ID) of the CIM session to get. For one or more IDs, use commas to separate the IDs, 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 IDs of the CIM session to get.

InstanceID is a 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[]>

Gets one or more CIM sessions which contain the specified friendly names. Wildcard characters are permitted.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

true

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimSession

Examples

Example 1: Get CIM sessions from the current Windows PowerShell session.

This command first creates CIM sessions by using New-CimSession, and then gets the CIM sessions by using Get-CimSession.


 

By default, Get-CimSession only gets information about the CIM sessions that exist in the current Windows PowerShell session. Get-CimSession does not get CIM sessions that were created in other Windows PowerShell sessions or that were created on other computers.


PS C:\> New-CimSession -ComputerName Server01,Server02

 

PS C:\> 
Get-CimSession
Id           : 1 
Name : CimSession1
InstanceId : d1413bc3-162a-4cb8-9aec-4d2c61253d59
ComputerName : Server01
Protocol : WSMAN
Id : 2

Name : CimSession2

InstanceId : c0095981-52c5-4e7f-a5bb-c4c680541710

ComputerName : Server02

Protocol : WSMAN

Example 2: Get the CIM sessions from a specific computer

This command gets the CIM sessions that are connected to the computer named Server02.


PS C:\> Get-CimSession -ComputerName Server02
Id           : 2 

Name : CimSession2

InstanceId : c0095981-52c5-4e7f-a5bb-c4c680541710

ComputerName : Server02

Protocol : WSMAN

Example 3: Get a list of CIM sessions and then format the list

This command gets all of the CIM sessions in the current Windows PowerShell session, and then formats the list in a table containing only the ComputerName and InstanceID parameters.


 

PS C:\> Get-CimSession | Format-Table -Property ComputerName,InstanceID

Example 4: Get all the CIM sessions that have specific names

This command gets all of the CIM sessions that have names that begin with the characters serv.


PS C:\> Get-CimSession -ComputerName Serv*
Id           : 1 

Name : CimSession1

InstanceId : d1413bc-162a-4cb8-9aec-4d2c61253d59

ComputerName : Server01

Protocol : WSMAN
Id : 2

Name : CimSession2

InstanceId : c0095981-52c5-4e7f-a5bb-c4c680541710

ComputerName : Server02

Protocol : WSMAN

Example 5: Get a specific CIM session

This command gets the CIM session that has an ID of 2.


PS C:\> Get-CimSession -ID 2

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft