> 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-rdmentrydocumentation.md). # Get-RDMEntryDocumentation ### Synopsis Get documentation pages of entries ### Syntax #### Name (Default) ``` Get-RDMEntryDocumentation [-InputObject] [[-Name] ] [-Data ] [-CaseSensitive] [-Default] [-ForcePromptAnswer ] [] ``` #### Literal ``` Get-RDMEntryDocumentation [-InputObject] [[-LiteralName] ] [-Data ] [-CaseSensitive] [-Default] [-ForcePromptAnswer ] [] ``` ### Description Get documentations pages of entries. The entries must be fetched by Get-RDMEntry. There is two possibility to filter the pages: by their name and by their data (content). The workspace must support the documentation feature and be online. The user must have the rights to access the documentation. ### Examples #### Example 1 ```powershell PS C:\> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA; $page.Data ``` Get the documentation page named 'PageA' of the entry named 'EntryA' and see its content. #### Example 2 ```powershell PS C:\> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default; foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false } Set-RDMEntryDocumentation -InputObject $defaultPages ``` Remove the default status of the default documentation page of each entries in the system vault. #### Example 3 ```powershell PS C:\> Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Data '*Temporary*' -CaseSensitive | Remove-RDMEntryDocumentation ``` Delete all documentation pages of the entry 'EntryA' that contains the word 'Temporary' ### Parameters #### -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: '' ``` #### -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: '' ``` #### -InputObject Entry from which to extract the documentation. ```yaml Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[] 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 ```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 #### RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection Entries, obtained from Get-RDMEntry, containing the documentation. ### Notes For more information, type "Get-Help Get-RDMEntryDocumentation -detailed". For technical information, type "Get-Help Get-RDMEntryDocumentation -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-rdmentrydocumentation.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.