▶
SSH
This page is a placeholder
Jet can connect to remote nodes to manage them over parallel SSH.
First, see our CLI documentation for more information about launching playbooks, particularly notes about --batch-size (once available) and --threads.
Additional details about SSH connections continue below:
In SSH mode, a playbook will attempt to all connect to all hosts not named "localhost" using SSH, while "localhost" is treated as special, and still uses the Local connection.
The following variables affect connection behavior and can be set at playbook or inventory level:
Variable Name | Purpose | Default |
|---|---|---|
jet_ssh_hostname | what hostname or IP to connect to for this host | the name of the host in inventory |
jet_ssh_port | what SSH port to use | 22 |
jet_ssh_user | what user to login as | as described below |
The hostname to connect to, if these are not specified will be the currently logged in username from the control machine, unless overridden by --user username on the jetp command line or the parameter ssh_user in the playbook.
Jet intentionally does not support logging in with a password for security reasons - you do not know if a remote host is compromised.
To use ssh mode, start your session with ssh-agent like so:
$ ssh-agent bash
$ ssh-add ~/.ssh/id_rsa
<ENTER PASSWORD FOR YOUR PRIVATE KEY>
$ jetp ssh --inventory path/to/inventory --playbook path/to/playbook.yml --user remoteuser
Many CI/CD systems have plugins for working with SSH agent.
Last modified 3d ago