Get-RDMEntryProperty

    2024-12-11

    Get-RDMEntryProperty

    SYNOPSIS

    Get the specified property's value of an entry.

    SYNTAX

    __AllParameterSets

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

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get the specified property's value of an entry. Protected values will always return null. Those values are those who are ignored when entries are exported. Non value types will always return ".ToString()".

    EXAMPLES

    EXAMPLE 1

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

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

    EXAMPLE 2

    PS C:> Get-RDMEntryProperty -ID "{00000000-0000-0000-0000-000000000000}" -Path "MetaInformation" -Property "OS"

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

    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 entry to get the property 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: ''

    -VaultMode

    Vault where the command will be applied. Three choices are offered:

    • Default: Current vault that has been set.
    • User: Vault specific to the current user.
    • Global: Global vault of the data source.
    Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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-RDMEntryProperty -detailed". For technical information, type "Get-Help Get-RDMEntryProperty -full".