keychaincredential.setup_ssh_connection

Creates an SSH Connection performing the following steps:

  1. Generate SSH Key Pair if required 2) Set up SSH Credentials based on setup_type

In case (2) fails, it will be ensured that SSH Key Pair generated (if applicable) in the process is removed.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options


SetupSSHConnectionManual

Type: object
No Additional Properties

Private Key


Type: object
Type: object

Connection Name

Type: string

Must be at least 1 characters long

Setup Type

Type: const Default: "MANUAL"
Must be one of:
  • "MANUAL"
Specific value: "MANUAL"

Type: object

SetupSSHConnectionSemiautomatic

Type: object
No Additional Properties

Private Key


Type: object
Type: object

Connection Name

Type: string

Must be at least 1 characters long

Setup Type

Type: const Default: "SEMI-AUTOMATIC"
Must be one of:
  • "SEMI-AUTOMATIC"
Specific value: "SEMI-AUTOMATIC"

Type: object

SSHCredentialsEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

Type

Type: const
Must be one of:
  • "SSH_CREDENTIALS"
Specific value: "SSH_CREDENTIALS"

Attributes

Type: object


Required roles: KEYCHAIN_CREDENTIAL_WRITE