Get-RDMEntryParameter

Synopsis

Get the parameters of a command-type entry.

Syntax

__AllParameterSets

Get-RDMEntryParameter -InputObject <PSConnection> [-IncludeUnused] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Get the parameters of a command-type entry. Parameters are addressed by their Position, which equals the {n} token used in the command line. Applies to CommandLine, PowerShell, ReportTool, and SessionTool entries. By default, only in-use parameters are returned (Type != Unused). Use -IncludeUnused to include unused parameters.

Examples

Example 1

PS C:\> Get-RDMEntry -Name 'MyCmdEntry' | Get-RDMEntryParameter

Get all in-use parameters of the entry MyCmdEntry.

Example 2

PS C:\> Get-RDMEntry -Name 'MyCmdEntry' | Get-RDMEntryParameter -IncludeUnused

Get all parameters, including unused ones.

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

-IncludeUnused

Include unused parameters.

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

-InputObject

Entry to get parameters from. Obtained from Get-RDMEntry.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  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 workspace.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
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

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

PSConnection of the entry. Obtained from Get-RDMEntry.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSParameterData

PSParameterData objects, each carrying Position, Label, Type, and Value.

Notes

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