Import-RDMCustomVariable

Synopsis

Import custom variables from a .json file.

Syntax

__AllParameterSets

Import-RDMCustomVariable [-FilePath] <string> [-ImportAction] <ImportListOptionAction>
 [-VariableScope] <CustomVariableScope> [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Import custom variables from a .json file. Three types of custom variables are available: associated with the current workspace, associated with the current vault, and associated with the application's option settings. It's also possible to specify whether the imported variables should replace the existing list, exclusively add new variables, or add new variables and update existing variables.

Examples

Example 1

PS C:\> Import-RDMCustomVariable -FilePath "C:\Users\admin\Desktop\Custom_variables.json" -ImportAction ReplaceList -VariableType DataSource

Import all variables in the file Custom_variables.json into the workspace settings, replacing the existing custom variables.

Parameters

-FilePath

Path of .json file to import custom variables from.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  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 no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

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

-ImportAction

Action when a duplicate is found. Must be one of the following:

"ReplaceList", "AddNewItems", "AddAndUpdate"

Type: Devolutions.PowerShell.Enums.ImportListOptionAction
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VariableScope

Where to import the variables. Must be one of the following:

"DataSource", "Vault", "UserVault", "Option"

Type: Devolutions.PowerShell.Enums.CustomVariableScope
DefaultValue: ''
SupportsWildcards: false
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.

Notes

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