New-RDMDataSourceCustomVariable

2024-11-18

New-RDMDataSourceCustomVariable

SYNOPSIS

Create a new custom variable stored in the current data source

SYNTAX

__AllParameterSets

New-RDMDataSourceCustomVariable [-Name] <string> [-Value] <string> [[-Description] <string>]
 [-SetCustomVariable] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Create a new custom variable 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:> New-RDMDataSourceCustomVariable -Name MyVarName -Value MyVarValue -Description MyVarDesc -SetCustomVariable

Create or update a custom variable in the data source settings.

PARAMETERS

-Description

Description of the custom variable

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

-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

Name of the variable. Two special characters can be used: '_' everywhere and '$' at the start and the end. Other characters are not allowed. All lower letters will be converted to upper characters.

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

-SetCustomVariable

Save the new custom variable in the data source

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

-Value

Value of the variable

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

OUTPUTS

Devolutions.RemoteDesktopManager.Business.DataSourceVariable

NOTES

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

RELATED LINKS