Get-RDMEntry

2024-11-18

Get-RDMEntry

SYNOPSIS

Retrieve entries in the specified vault

SYNTAX

Name (Default)

Get-RDMEntry [[-Name] <string[]>] [[-GroupName] <string[]>] [-Type <ConnectionType[]>]
 [-CaseSensitive] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists] [-IncludeSubFolders]
 [-IncludeUserSpecificSettings] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Id

Get-RDMEntry [[-ID] <guid[]>] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists]
 [-IncludeUserSpecificSettings] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Literal

Get-RDMEntry [[-LiteralName] <string[]>] [[-LiteralGroupName] <string[]>] [-Type <ConnectionType[]>]
 [-CaseSensitive] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists] [-IncludeSubFolders]
 [-IncludeUserSpecificSettings] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Retrieve entries in the specified vault. The vault is specified by the VaultMode parameter. The parameter GroupName search for entries in a specific folder. The switch IncludeSubFolders is required to look in all subfolders of the specified groups. It is also possible to use the wildcard '*' at the end of the GroupName to look in the subfolders.

EXAMPLES

EXAMPLE 1

PS C:> Get-RDMEntry -IncludeDocumentsStoredInDatabase -IncludeLocalPlaylists -IncludeUserSpecificSettings

Retrieves all available entries in the current vault. Documents, playlists and user specific settings will be included in the returned entries.

EXAMPLE 2

PS C:> Get-RDMEntry -Name Folder?, *Folder -VaultMode Global -CaseSensitive

Retrieves all available entries whose name is Folder appended with a character or is ending with Folder in the system vault. The search is case sensitive.

EXAMPLE 3

PS C:> Get-RDMEntry -GroupName Folder\SubFolder -VaultMode User -IncludeSubFolders

Retrieves all available entries in the group named Folder\SubFolder and its subfolders.

PARAMETERS

-CaseSensitive

Filtering by name and group name will be case sensitive.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Literal
  Position: Named
  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: ''

-GroupName

Filter the entries by the group. Support wildcard characters.

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

-ID

Filter the entries by their ID

Type: System.Guid[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Id
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeDocumentsStoredInDatabase

Document entries returned will include attachment from documents

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

-IncludeLocalPlaylists

PlayList entries will include dependable connections and local playlists from playlist connection

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

-IncludeSubFolders

Filtering by group name will include entries in subfolders

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

-IncludeUserSpecificSettings

Entries returned will include user specific settings

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

-LiteralGroupName

Filter the entries by the group. Support wildcard characters.

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

-LiteralName

Filter the entries by their name. No wildcard supports.

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

-Name

Filter the entries by their name. Support wildcard characters.

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

-Type

Filter the result by the connection type

Type: Devolutions.RemoteDesktopManager.ConnectionType[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Literal
  Position: Named
  IsRequired: false
  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

OUTPUTS

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

NOTES

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

RELATED LINKS

• New-RDMEntry
• Remove-RDMEntry
• Set-RDMEntry