TrueNAS SCALE Nightly Development DocumentationThis content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.
Keychain_Credential
8 minute read.
Last Modified 2024-03-15 13:07 EDTThe SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!
The keychain_credential namespace has nine commands and is based on SSH credential and keypair creation and management functions found in the SCALE API and web UI. It provides access to backup credential methods through the keychain_credential commands.
The following keychain_credential commands allow you to create new and manage existing SSH credentials and keypairs.
You can enter commands from the main CLI prompt or from the keychain_credential namespace prompt.
Enter the
--
flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).
Use the create
command to create a keypair or SSH credential. This command is very complex. Use the UI or the interactive argument editor to create a new keypair or SSH connection.
The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.
The delete
command removes the keypair or SSH credential matching the ID entered.
Use the system keychain_credential query
to obtain ID numbers for keypairs or SSH credentials on the system and to verify the command is successful.
The generate_ssh_key_pair
command generates a new private and public key to use when creating SSH keypairs.
Use the UI to download public and private key values.
The get_instance
command lists the properties for the keypair or SSH connection ID entered.
The query
command lists all keypairs and connections configured on the system.
Use the remote_ssh_host_key_scan
to discover a remote system host key.
The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.
Use the remote_ssh_semiautomatic_setup
to perform a semi-automatic SSH connection setup with another system.
The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.
Use the setup_ssh_connection
to create an SSH connection.
The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.
Use the update
command to update properties for the credential matching the ID entered.
Use system keychain_credential query
to get a list of all credentials on the system and the assigned ID numbers.
The used_by
command lists the objects using this credential for the ID entered. For example, a replication task to a remote system.