Instance Communication & Interaction¶
yo console¶
View an instance’s serial console using an SSH connection
usage: yo console [-h] [--name NAME] [--exact-name] [--no-exact-name] [--refresh] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
- --refresh
refresh the local cache of serial consoles for this instance
Default: False
yo console-history¶
Fetch and print serial console history for an instance.
usage: yo console-history [-h] [--name NAME] [--exact-name] [--no-exact-name] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
yo copy-id¶
Copy an SSH public key onto an instance using ssh-copy-id.
usage: yo copy-id [-h] [--name NAME] [--exact-name] [--no-exact-name] [-i IDENTITY_FILE] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
- -i, --identity-file
Specify path to the public key file
yo ip¶
Print the IP address for one or more instances.
Yo tries to avoid making you remember an instance IP. For example, you can connect via SSH using “yo ssh”. However, in some cases you may need to get the IP address still.
usage: yo ip [-h] [--exact-name] [--no-exact-name] [instances ...]
Positional Arguments¶
- instances
Instance names to fetch IP for (if empty, fetch all)
Default: []
Named Arguments¶
- --exact-name, -E
Do not standardize the name by prefixing it with your system useranme if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
yo mosh¶
Connect to the instance via mosh.
usage: yo mosh [-h] [--name NAME] [--exact-name] [--no-exact-name] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
yo rdp¶
Connect to instance remote desktop using RDP.
usage: yo rdp [-h] [--name NAME] [--exact-name] [--no-exact-name] [--no-tunnel] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
- --no-tunnel, -T
Don’t tunnel the connection over SSH
Default: True
yo rsync¶
Synchronize files using the rsync command.
usage: yo rsync [-h] [--name NAME] [--exact-name] [--no-exact-name] [--raw] [rsync_args ...]
Positional Arguments¶
- rsync_args
Arguments to pass to rsync (use – to protect, :gets replaced with destination host)
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
- --raw
Do not use the rsync_args stored in the config, only use the ones provided on the command line.
Default: False
yo scp¶
Copy files to/from an instance using the scp command
usage: yo scp [-h] [--name NAME] [--exact-name] [--no-exact-name] [scp_args ...]
Positional Arguments¶
- scp_args
Arguments to pass to scp (use – to protect, :gets replaced with destination host)
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
yo vnc¶
Connect to instance remote desktop using VNC.
usage: yo vnc [-h] [--name NAME] [--exact-name] [--no-exact-name] [--no-tunnel] [name_pos]
Positional Arguments¶
- name_pos
Name of the instance to filter by
Named Arguments¶
- --name, -n
Name of the instance to filter by
- --exact-name, -E
Do not standardize the name by prefixing it with your system username if necessary.
- --no-exact-name
Standardize the name by prefixing it with your system username (this is the default, but can be used to override your Yo configuration file)
- --no-tunnel, -T
Don’t tunnel the connection over SSH
Default: True