> 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-dsentry.md). # Get-DSEntry ### Synopsis Get entry(ies) from your Devolutions Server instance. ### Syntax #### GetAll (Default) ``` Get-DSEntry [[-VaultID] ] [-All] [-SearchAllVaults] [-AsLegacyResponse] [] ``` #### GetById ``` Get-DSEntry [[-VaultID] ] [-EntryId] [[-VaultPassword] ] [-AsRDMConnection] [-SearchAllVaults] [-AsLegacyResponse] [] ``` #### Filter ``` Get-DSEntry [[-VaultID] ] [-FilterValue] [[-FilterBy] ] [[-FilterMatch] ] [-SearchAllVaults] [-AsLegacyResponse] [] ``` #### GetPage ``` Get-DSEntry [[-VaultID] ] [[-PageSize] ] [[-PageNumber] ] [[-FolderID] ] [-SearchAllVaults] [-AsLegacyResponse] [] ``` ### Description Using different parameter sets, returns either all entries (from one or all vaults), a specific entry by filter (Get-Help Get-DSEntry -Parameter FilterBy) or paginated results. ### Examples #### Example 1 ```powershell PS C:\> Get-DSEntry ``` Get the first page containing 25 entries directly in the root of the default vault. #### Example 2 ```powershell PS C:\> Get-DSEntry -SearchAllVaults -EntryId $entryId -AsRDMConnection ``` Get the entry by its ID. The search covers all vaults. The #### Example 3 ```powershell PS C:\> Get-DSEntry -VaultID $vaultID -All ``` Get all entries of the specified vault. #### Example 4 ```powershell PS C:\> Get-DSEntry -Filter Name -FilterMatch StartsWith -FilterValue ABC -SearchAllVaults ``` Get all entries whose name starts with "ABC" in all the vaults. ### Parameters #### -All Get all entries. ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetAll Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -AsLegacyResponse In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly. ```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: '' ``` #### -AsRDMConnection Return a ConnectionInfoEntity instead of a partial connection ```yaml Type: System.Management.Automation.SwitchParameter DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetById Position: Named IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -EntryId ID of the desired entry ```yaml Type: System.Guid DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetById Position: 1 IsRequired: true ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -FilterBy Field on which the filter will be applied. It will be on the Name by default. ```yaml Type: Devolutions.RemoteDesktopManager.SearchItemType DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Filter Position: 2 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -FilterMatch Determine the condition of the search. Default condition is Contains. ```yaml Type: Devolutions.RemoteDesktopManager.SearchItemText DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Filter Position: 3 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -FilterValue Value used in the filter ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: Filter Position: 1 IsRequired: true ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -FolderID Folder where the entries will be fetched. The default value will the root. ```yaml Type: System.Nullable`1[System.Guid] DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetPage Position: 3 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -PageNumber Determine which page is fetched. ```yaml Type: System.Int32 DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetPage Position: 2 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -PageSize Number of entries in a page. Default value is 25 entries per page. ```yaml Type: System.Int32 DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetPage Position: 1 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -SearchAllVaults All vaults will bew considered for the search. ```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: '' ``` #### -VaultID ID of the vault to be searched ```yaml Type: System.Guid DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: (All) Position: 0 IsRequired: false ValueFromPipeline: false ValueFromPipelineByPropertyName: false ValueFromRemainingArguments: false DontShow: false AcceptedValues: [] HelpMessage: '' ``` #### -VaultPassword Password of the vault ```yaml Type: System.String DefaultValue: '' SupportsWildcards: false Aliases: [] ParameterSets: - Name: GetById Position: 2 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-DSEntry -detailed". For technical information, type "Get-Help Get-DSEntry -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-dsentry.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.