Get-RDMSessionProperty

    2025-01-21

    Get-RDMSessionProperty

    SYNOPSIS

    Get the value of property given a session ID and path.

    SYNTAX

    __AllParameterSets

    Get-RDMSessionProperty [-ID] <guid> [[-Path] <string>] [-Property] <string>
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Protected values will always return null.

    Non value types will always return ".ToString()".

    EXAMPLES

    EXAMPLE 1

    PS C:> Get-RDMSessionProperty -ID "{00000000-0000-0000-0000-000000000000}" -Property "Group"

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

    EXAMPLE 2

    PS C:> Get-RDMSessionProperty "{00000000-0000-0000-0000-000000000000}" "MetaInformation" "OS"

    Get the MetaInformation.OS value from the session with ID = "{00000000-0000-0000-0000-000000000000}".

    EXAMPLE 3

    PS C:> $list = Get-RDMSession; Get-RDMSessionProperty -ID $list[1].ID -Path "MetaInformation" -Property "OS"

    Retrieves the list of available sessions and then returns MetaInformation.OS value of 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
ParameterValue: []
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 password from.

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

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Path

    The path to the property being read (refernce RDM export xml). If top level property do not sepcify parameter or pass empty string [""] or $null

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Property

    Property to read(get).

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 3
  IsRequired: true
  ValueFromPipeline: false
  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.

    INPUTS

    System.Guid

    OUTPUTS

    NOTES

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