Set-RDMPersonalSSHKey

    2025-02-17

    Set-RDMPersonalSSHKey

    SYNOPSIS

    Set 'My Personal SSH key' from 'My Account Settings'

    SYNTAX

    InputObject

    Set-RDMPersonalSSHKey -InputObject <PSConnection> [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

    Name

    Set-RDMPersonalSSHKey -Key <PSSSHKey> [-UserName <string>] [-Password <securestring>]
 [-Passphrase <securestring>] [-SavePassphrase <bool>] [-AutomaticallyLoadToKeyAgent]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    Filename

    Set-RDMPersonalSSHKey -Filename <string> [-UserName <string>] [-Password <securestring>]
 [-Passphrase <securestring>] [-SavePassphrase <bool>] [-AutomaticallyLoadToKeyAgent]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Set 'My Personal SSH key' from 'My Account Settings'. It can be updated in three ways:

    1. InputObject: From a PSConnection object obtained from Get-RDMPersonalSSHKey.
    2. Key: From a new SSH key obtained from New-RDMSSHKey.
    3. Filename: From a private key file ('.pri', '.ppk', '.key')

    EXAMPLES

    EXAMPLE 1

    PS C:> $sshKey = Get-RDMPersonalSSHKey; $sshKey.Credentials.PrivateKeyAutomaticallyLoadToKeyAgent = $true Set-RDMPersonalSSHKey -InputObject $sshKey

    Modify 'My Personal SSH Key' to automatically load to SSH key agent

    EXAMPLE 2

    PS C:> New-RDMSSHKey -Algorithm ED25519 -Format OpenSSH -Comment 'asdf' -Size 1024 -Round 12 | Set-RDMPersonalSSHKey

    Create a new PSSHKey and save it as 'My Personal SSH Key'

    EXAMPLE 3

    PS C:> Set-RDMPersonalSSHKey -Filename 'C:\my\path\filea.ppk'

    Change the private key file for 'My Personal SSH Key'

    PARAMETERS

    -AutomaticallyLoadToKeyAgent

    Automatically load to SSH key agent

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Filename
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Filename

    Private key file ('.pri', '.ppk', '.key

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Filename
  Position: Named
  IsRequired: true
  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 not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -InputObject

    Entry representing 'My Personal SSH Key'

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

    -Key

    SSH key generated with New-RDMSSHKey

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

    -Passphrase

    Passphrase for the private key

    Type: System.Security.SecureString
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Filename
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Password

    Overrides the password

    Type: System.Security.SecureString
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Filename
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -SavePassphrase

    Save the passphrase in the credential

    Type: System.Boolean
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Filename
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -UserName

    Overrides the username

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Filename
  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

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSSSHKey

    OUTPUTS

    NOTES

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