> 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-dsentrydocumentation.md).

# Get-DSEntryDocumentation

## Synopsis

Return the documentation for a given entry or vault root connection.

## Syntax

### Name (Default)

```
Get-DSEntryDocumentation [-ID] <guid> [[-Name] <string[]>] [-Data <string[]>] [-CaseSensitive]
 [-Default] [-AsLegacyResponse] [<CommonParameters>]
```

### Literal

```
Get-DSEntryDocumentation [-ID] <guid> [[-LiteralName] <string[]>] [-Data <string[]>]
 [-CaseSensitive] [-Default] [-AsLegacyResponse] [<CommonParameters>]
```

## Description

Returns the documentation for a given entry or vault root connection.

## Examples

### Example 1

```powershell
PS C:\> Get-DSEntryDocumentation $entryId
```

Get the documentation for the entry identified by $entryId.

### Example 2

```powershell
PS C:\> Get-DSEntryDocumentation $entryId -Name "PageName"
```

Get a specific documentation page from an entry, filtered by its name.

### Example 3

```powershell
PS C:\> Get-DSEntryDocumentation $entryId -Default
```

Get an entry's default documentation page.

### Example 4

```powershell
PS C:\> Get-DSRootSession -VaultID $vaultId | Select-Object -ExpandProperty id | Get-DSEntryDocumentation
```

Get the documentation for the vault root connection of a vault identified by `$vaultId`.

## Parameters

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

### -CaseSensitive

Filtering will be case sensitive.

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

### -Data

Filter the handbook pages by their content.

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

### -Default

Obtain only the default page. Maximum one default page per entry.

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

### -ID

ID of the entry or vault root connection.

```yaml
Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
```

### -LiteralName

Filter the handbook pages by their name. No characters are interpreted as wildcards.

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

### -Name

Filter the handbook pages by their name.

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

### 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).

## Inputs

### System.Guid

## Outputs

### Devolutions.RemoteDesktopManager.Business.ConnectionHandbookPage

## Notes

For more information, type "Get-Help Get-DSEntryDocumentation -detailed". For technical information, type "Get-Help Get-DSEntryDocumentation -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:

```
GET https://docs.devolutions.net/powershell/powershell-commands/get-dsentrydocumentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.