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. .. raw:: html
SSH connection setup configuration (manual or semi-automatic).
SSH private key configuration (new or existing).
Indicates a new SSH key pair should be generated.
Specific value:true
    Name for the new SSH key credential.
Must be at least 1 characters long
Indicates an existing SSH key should be used.
Specific value:false
    ID of the existing SSH private key credential to use.
Name for the SSH connection credential.
Must be at least 1 characters long
Setup method for the SSH connection.
Specific value:"MANUAL"
    Manual SSH connection configuration parameters.
No Additional PropertiesSSH server hostname or IP address.
SSH server port number.
SSH username for authentication.
Can be discovered with keychaincredential.remotesshhostkeyscan.
Connection timeout in seconds for SSH connections.
SSH private key configuration (new or existing).
Indicates a new SSH key pair should be generated.
Specific value:true
    Name for the new SSH key credential.
Must be at least 1 characters long
Indicates an existing SSH key should be used.
Specific value:false
    ID of the existing SSH private key credential to use.
Name for the SSH connection credential.
Must be at least 1 characters long
Setup method for the SSH connection.
Specific value:"SEMI-AUTOMATIC"
    Semi-automatic SSH connection configuration parameters.
No Additional PropertiesURL 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.
SSH connection timeout in seconds.
Whether the SSH user should use sudo for elevated privileges.
The created SSH connection credential.
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.