> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell/powershell-commands/get-rdmentry.md). # Get-RDMEntry ### Synopsis Retrieve entries in the specified vault ### Syntax #### Name (Default) ``` Get-RDMEntry [[-Name] ] [[-GroupName] ] [-Type ] [-CaseSensitive] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists] [-IncludeSubFolders] [-IncludeUserSpecificSettings] [-VaultMode ] [-ForcePromptAnswer ] [] ``` #### Id ``` Get-RDMEntry [[-ID] ] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists] [-IncludeUserSpecificSettings] [-VaultMode ] [-ForcePromptAnswer ] [] ``` #### Literal ``` Get-RDMEntry [[-LiteralName] ] [[-LiteralGroupName] ] [-Type ] [-CaseSensitive] [-IncludeDocumentsStoredInDatabase] [-IncludeLocalPlaylists] [-IncludeSubFolders] [-IncludeUserSpecificSettings] [-VaultMode ] [-ForcePromptAnswer ] [] ``` ### 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 ```powershell 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 ```powershell 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 ```powershell 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. ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: '' SupportsWildcards: false 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 no "No" option. * Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option. ```yaml 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: '' ``` #### -GroupName Filter the entries by the group. Support wildcard characters. ```yaml Type: System.String[] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Name Position: 1 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -ID Filter the entries by their ID ```yaml Type: System.Guid[] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Id Position: 0 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -IncludeDocumentsStoredInDatabase Document entries returned will include attachment from documents ```yaml 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: '' ``` #### -IncludeLocalPlaylists PlayList entries will include dependable connections and local playlists from playlist connection ```yaml 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: '' ``` #### -IncludeSubFolders Filtering by group name will include entries in subfolders ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: '' SupportsWildcards: false 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 ```yaml 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: '' ``` #### -LiteralGroupName Filter the entries by the group. Support wildcard characters. ```yaml Type: System.String[] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Literal Position: 1 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -LiteralName Filter the entries by their name. No wildcard supports. ```yaml Type: System.String[] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Literal Position: 0 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Name Filter the entries by their name. Support wildcard characters. ```yaml Type: System.String[] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Name Position: 0 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -Type Filter the result by the connection type ```yaml Type: Devolutions.RemoteDesktopManager.ConnectionType[] DefaultValue: '' SupportsWildcards: false 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 workspace. ```yaml 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](https://go.microsoft.com/fwlink/?LinkID=113216). ### Notes For more information, type "Get-Help Get-RDMEntry -detailed". For technical information, type "Get-Help Get-RDMEntry -full". --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/powershell/powershell-commands/get-rdmentry.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.