GetCimSessionCommand Class

Definition

Namespace:

Microsoft.Management.Infrastructure.CimCmdlets

Assembly:

Microsoft.Management.Infrastructure.CimCmdlets.dll

Package:

Microsoft.Management.Infrastructure.CimCmdlets v7.4.0

The command returns zero, one or more CimSession objects that represent connections with remote computers established from the current PS Session.

[System.Management.Automation.Alias(new System.String[] { "gcms" })]
[System.Management.Automation.Cmdlet("Get", "CimSession", DefaultParameterSetName="ComputerNameSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227966")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.CimSession) })]
public sealed class GetCimSessionCommand : Microsoft.Management.Infrastructure.CimCmdlets.CimBaseCommand

[<System.Management.Automation.Alias(new System.String[] { "gcms" })>]
[<System.Management.Automation.Cmdlet("Get", "CimSession", DefaultParameterSetName="ComputerNameSet", HelpUri="https://go.microsoft.com/fwlink/?LinkId=227966")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.Management.Infrastructure.CimSession) })>]
type GetCimSessionCommand = class
    inherit CimBaseCommand

Public NotInheritable Class GetCimSessionCommand
Inherits CimBaseCommand

Inheritance

Object

InternalCommand

Cmdlet

CimBaseCommand

GetCimSessionCommand

Attributes

AliasAttribute CmdletAttribute OutputTypeAttribute

Constructors

GetCimSessionCommand()

Initializes a new instance of the GetCimSessionCommand class.

Properties

CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
ComputerName	The following is the definition of the input parameter "ComputerName". Specifies one or more connections by providing their ComputerName(s). The Cmdlet then gets CimSession(s) opened with those connections. This parameter is an alternative to using CimSession(s) that also identifies the remote computer(s). This is the only optional parameter of the Cmdlet. If not provided, the Cmdlet returns all CimSession(s) live/active in the runspace. If an instance of CimSession is pipelined to Get-CimSession, the ComputerName property of the instance is bound by name with this parameter.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Id	The following is the definition of the input parameter "Id". Specifies one or more numeric Id(s) for which to get CimSession(s).
InstanceId	The following is the definition of the input parameter "InstanceID". Specifies one or Session Instance IDs.
Name	The following is the definition of the input parameter "Name". Specifies one or more session Name(s) for which to get CimSession(s). The argument may contain wildcard characters.
Stopping	Is this command stopping? (Inherited from Cmdlet)

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
Dispose()	Dispose() calls Dispose(true). Implement IDisposable. Do not make this method virtual. A derived class should not be able to override this method. (Inherited from CimBaseCommand)
Dispose(Boolean)	Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. (Inherited from CimBaseCommand)
DisposeInternal()	Clean up resources. (Inherited from CimBaseCommand)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	StopProcessing method. (Inherited from CimBaseCommand)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)