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

PS C:\> Get-DSEntryDocumentation $entryId

Get the documentation for the entry identified by $entryId.

Example 2

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

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

Example 3

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

Get an entry's default documentation page.

Example 4

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.

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.

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.

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.

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.

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.

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.

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.

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".