Get-RDMSessionStatus

Synopsis

Get the status from the specified session.

Syntax

ID

Get-RDMSessionStatus [-ID] <guid> [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

PSConnection

Get-RDMSessionStatus [-Session] <PSConnection> [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Description

Get the status from the specified session.

Examples

Example 1

PS C:\> Get-RDMSessionStatus "{00000000-0000-0000-0000-000000000000}"

Get the status from the session with ID = "{00000000-0000-0000-0000-000000000000}".

Example 2

PS C:\> $list = Get-RDMSession; Get-RDMSessionStatus $list[1]

Retrieves the list of available sessions and gets the status from the the second element in the list.

Parameters

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

  • Yes: Accept the prompt. Cover the OK and Automatic value.

  • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.

  • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

Specifies the ID of the session to get the status from.

Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ID
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Session

Specifies the session to set the status to

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: PSConnection
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Get-RDMSessionStatus -detailed". For technical information, type "Get-Help Get-RDMSessionStatus -full".

Devolutions Forum logo Give us Feedback