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

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options

One of

• SetupSSHConnectionManual
• SetupSSHConnectionSemiautomatic

SetupSSHConnectionManual

Type: object
No Additional Properties

private_key Required

Private Key

One of

• KeychainCredentialSetupSSHConnectionKeyNew
• KeychainCredentialSetupSSHConnectionKeyExisting

KeychainCredentialSetupSSHConnectionKeyNew

Type: object
No Additional Properties

generate_key

Generate Key

Type: const Default: true

Must be one of:

• true

Specific value: true

name Required

Name

Type: string

Must be at least 1 characters long

KeychainCredentialSetupSSHConnectionKeyExisting

Type: object
No Additional Properties

generate_key

Generate Key

Type: const Default: false

Must be one of:

• false

Specific value: false

existing_key_id Required

Existing Key Id

Type: integer

connection_name Required

Connection Name

Type: string

Must be at least 1 characters long

setup_type

Setup Type

Type: const Default: "MANUAL"

Must be one of:

• "MANUAL"

Specific value: "MANUAL"

manual_setup Required

SetupSSHConnectionManualSetup

Type: object
No Additional Properties

host Required

Host

Type: string

port

Port

Type: integer Default: 22

username

Username

Type: string Default: "root"

remote_host_key Required

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

connect_timeout

Connect Timeout

Type: integer Default: 10

SetupSSHConnectionSemiautomatic

Type: object
No Additional Properties

private_key Required

Private Key

One of

• KeychainCredentialSetupSSHConnectionKeyNew
• KeychainCredentialSetupSSHConnectionKeyExisting

KeychainCredentialSetupSSHConnectionKeyNew

Type: object
No Additional Properties

generate_key

Generate Key

Type: const Default: true

Must be one of:

• true

Specific value: true

name Required

Name

Type: string

Must be at least 1 characters long

KeychainCredentialSetupSSHConnectionKeyExisting

Type: object
No Additional Properties

generate_key

Generate Key

Type: const Default: false

Must be one of:

• false

Specific value: false

existing_key_id Required

Existing Key Id

Type: integer

connection_name Required

Connection Name

Type: string

Must be at least 1 characters long

setup_type

Setup Type

Type: const Default: "SEMI-AUTOMATIC"

Must be one of:

• "SEMI-AUTOMATIC"

Specific value: "SEMI-AUTOMATIC"

semi_automatic_setup Required

KeychainCredentialSetupSSHConnectionSemiAutomaticSetup

Type: object
No Additional Properties

url Required

Url

Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long

verify_ssl

Verify Ssl

Type: boolean Default: true

token

Token

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

admin_username

Admin Username

Type: string Default: "root"

password

Password

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

otp_token

Otp Token

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

username

Username

Type: string Default: "root"

connect_timeout

Connect Timeout

Type: integer Default: 10

sudo

Sudo

Type: boolean Default: false

Return value

SSHCredentialsEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

name Required

Name

Type: string

Distinguishes this Keychain Credential from others.

Must be at least 1 characters long

type Required

Type

Type: const

Must be one of:

• "SSH_CREDENTIALS"

Specific value: "SSH_CREDENTIALS"

attributes Required

Attributes

Type: object
No Additional Properties

host Required

Host

Type: string

port

Port

Type: integer Default: 22

username

Username

Type: string Default: "root"

private_key Required

Private Key

Type: integer

Keychain Credential ID.

remote_host_key Required

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

connect_timeout

Connect Timeout

Type: integer Default: 10

Required roles: KEYCHAIN_CREDENTIAL_WRITE