keychaincredential.remote_ssh_semiautomatic_setup

Perform semi-automatic SSH connection setup with other TrueNAS machine.

It creates an SSH_CREDENTIALS credential with specified name that can be used to connect to TrueNAS machine with specified url and temporary auth token. Other TrueNAS machine adds private_key to allowed username’s private keys. Other SSH_CREDENTIALS attributes such as connect_timeout can be specified as well.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

name Required

Name

Type: string

Must be at least 1 characters long

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"

private_key Required

Private Key

Type: integer

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