Get-RDMEntryPrivateKeyCertificateData

Synopsis

Get the embedded SSH certificate data from an entry

Syntax

ID

Get-RDMEntryPrivateKeyCertificateData [-ID] <guid> [-AsPlainText] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObject

Get-RDMEntryPrivateKeyCertificateData [-InputObject] <PSConnection> [-AsPlainText]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Get the embedded SSH certificate data from an entry. This cmdlet only works when the certificate type is set to 'Data' (embedded). For file-based certificates, access the PrivateKeyCertificateFileName property directly on the PSConnection object. Required permissions: Edit and Reveal password.

Examples

Example 1

PS C:\> Get-RDMEntry -Name MySshEntry | Get-RDMEntryPrivateKeyCertificateData

Get the certificate data as SecureString

Example 2

PS C:\> Get-RDMEntry -Name MySshEntry | Get-RDMEntryPrivateKeyCertificateData -AsPlainText

Get the certificate data as plain text

Example 3

PS C:\> Get-RDMEntryPrivateKeyCertificateData -ID '00000000-0000-0000-0000-000000000000' -AsPlainText

Get certificate data by entry ID

Parameters

-AsPlainText

Return certificate data as plain text instead of SecureString

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.

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

-ID

ID of the entry

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

-InputObject

Entry to get certificate data from

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Session
ParameterSets:
- Name: InputObject
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  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.

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.

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

PSConnection object of the entry obtained from Get-RDMEntry

Outputs

System.Security.SecureString

Certificate data as SecureString (default)

System.String

Certificate data as plain text when -AsPlainText is used

Notes

For more information, type "Get-Help Get-RDMEntryPrivateKeyCertificateData -detailed". For technical information, type "Get-Help Get-RDMEntryPrivateKeyCertificateData -full".