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

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Url

Type: stringFormat: uri

Must be at least 1 characters long

Must be at most 2083 characters long

Verify Ssl

Type: boolean Default: true

Token

Default: null

Type: string
Type: null

Admin Username

Type: string Default: "root"

Password

Default: null

Type: string
Type: null

Otp Token

Default: null

Type: string
Type: null

Username

Type: string Default: "root"

Private Key

Type: integer

Connect Timeout

Type: integer Default: 10

Sudo

Type: boolean Default: false

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
No Additional Properties

Host

Type: string

Port

Type: integer Default: 22

Username

Type: string Default: "root"

Private Key

Type: integer

Keychain Credential ID.

Remote Host Key

Type: string

Can be discovered with keychaincredential.remotesshhostkeyscan.

Connect Timeout

Type: integer Default: 10


Required roles: KEYCHAIN_CREDENTIAL_WRITE