Set-RDMEntryPrivateKeyCertificateData

Synopsis

Set the embedded SSH certificate data on an entry

Syntax

__AllParameterSets

Set-RDMEntryPrivateKeyCertificateData -InputObject <PSConnection> [-CertificateData] <string>
 [-PassThru] [-Set] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

Set the embedded SSH certificate data for an entry that supports private key certificates. This cmdlet automatically sets the certificate type to 'Data' (embedded) and stores the certificate content securely.

For file-based certificates, you don't need this cmdlet - simply set the PrivateKeyCertificateType to 'File' and PrivateKeyCertificateFileName properties directly on the PSConnection object, then call Set-RDMEntry.

Certificate data should be the complete SSH certificate in OpenSSH format (e.g., [e-mail] or [e-mail]).

Required permissions: Edit permission.

Examples

Example 1

PS C:\> $cert = Get-Content "C:\keys\server-cert.pub" -Raw
PS C:\> $entry = Get-RDMEntry -Name "MySshEntry"
PS C:\> $entry | Set-RDMEntryPrivateKeyCertificateData -CertificateData $cert -Set

Set certificate data and save immediately

Example 2

PS C:\> $cert = Get-Content "cert.pub" -Raw
PS C:\> $entry = Get-RDMEntry -Name "MySshEntry"
PS C:\> $entry | Set-RDMEntryPrivateKeyCertificateData -CertificateData $cert -PassThru |
    Set-RDMEntryPassword -Password $pwd -PassThru |
    Set-RDMEntryUsername -Username "newuser" -PassThru |
    Set-RDMEntry

Chain with other cmdlets using PassThru

Example 3

PS C:\> $entry = Get-RDMEntry -Name "MySshEntry"
PS C:\> $entry | Set-RDMEntryPrivateKeyCertificateData -CertificateData $cert
PS C:\> # Make more modifications...
PS C:\> Set-RDMEntry -InputObject $entry

Modify locally without saving

Parameters

-CertificateData

Certificate content as text (OpenSSH certificate format)

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

-Confirm

Prompts for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- cf
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: ''

-InputObject

Entry to set certificate data on

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PassThru

Return the modified entry for further pipeline processing

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

-Set

Save the modified entry immediately

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

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

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
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

Entry to modify, obtained from Get-RDMEntry

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

PSConnection object returned when PassThru is used

Notes

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