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. .. examples(websocket):: :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "keychaincredential.remote_ssh_semiautomatic_setup", "params": [{ "name": "Work SSH connection", "url": "https://work.freenas.org", "token": "8c8d5fd1-f749-4429-b379-9c186db4f834", "private_key": 12 }] } .. raw:: html
Configuration data for semi-automatic SSH credential setup.
No Additional PropertiesName for the SSH connection credential.
Must be at least 1 characters long
URL of the remote TrueNAS system for semi-automatic setup.
Must be at least 1 characters long
Must be at most 2083 characters long
Whether to verify SSL certificates when connecting to the remote system.
API token for authentication with the remote system or null.
Administrative username for the remote system.
Password for the administrative user or null.
One-time password token for 2FA authentication or null.
Username for the SSH connection.
ID of the existing private key credential to use for SSH authentication.
SSH connection timeout in seconds.
Whether the SSH user should use sudo for elevated privileges.
The created SSH credential configuration.
No Additional PropertiesUnique identifier for this keychain credential.
Distinguishes this Keychain Credential from others.
Must be at least 1 characters long
Keychain credential type identifier for SSH connection credentials.
Specific value:"SSH_CREDENTIALS"
    SSH connection attributes including host, authentication, and connection settings.
No Additional PropertiesSSH server hostname or IP address.
SSH server port number.
SSH username for authentication.
Keychain Credential ID.
Can be discovered with keychaincredential.remotesshhostkeyscan.
Connection timeout in seconds for SSH connections.