Get-RDMDataSourceCustomVariable

2025-02-17

Get-RDMDataSourceCustomVariable

SYNOPSIS

Get the custom variables stored in the current data source

SYNTAX

__AllParameterSets

Get-RDMDataSourceCustomVariable [[-Name] <string>] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Get the custom variables stored in the current data source. The path to access those variables in Remote Desktop Manager is Administration -> System Settings -> Common -> Custom Variables. The user must have the rights to access the data source settings. Only advanced data source have settings.

EXAMPLES

EXAMPLE

PS C:> $customVars = Get-RDMDataSourceCustomVariable -Name $VAR*

Obtain all custom variables stored in the data source whose name start with $Var.

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: ''

-Name

Filter the custom variables by their name.

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

OUTPUTS

Devolutions.RemoteDesktopManager.Business.DataSourceVariable

NOTES

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

RELATED LINKS