NAME

isoho.st - remote management script for isoho.st virtual machines


SYNOPSIS

isoho.st help

isoho.st add KEY

isoho.st remove IDENTIFIER | ALIAS

isoho.st list

isoho.st alias ALIAS IDENTIFIER

isoho.st admin [NAME]

isoho.st display [NAME]

isoho.st remote [NAME]

isoho.st shortcut [NAME]


DESCRIPTION

This script is essentially a convenience wrapper for accessing the ssh(1) based management interface as well as the SPICE based remote keyboard, mouse and video display for isoho.st virtual machines. It maintains a local database of machine access keys and provides a useful alias facility for attaching meaningful names to machine identifiers.


COMMANDS

help

Displays a short help message that provides valid script syntax. Most of the commands also support the additional help parameter, although help is also displayed when erroneous syntax is provided by the user.

EXAMPLE

isoho.st add help

add

Adds an ssh(1) private KEY to the local credential store. Keys are distributed to clients by isoho.st and must not be renamed, as the machine identity is derived from the key's filename.

EXAMPLE

isoho.st add xc0d77e2.key

remove

Removes a machine key from the local credential store (based on its IDENTIFIER). Alternatively, an ALIAS mapping can also be removed using this command. Removing an alias does not also delete the associated key, however, removing a key will delete any associated alias mappings. To remove a machine key, the machine identifier must be given and not the original key filename that was provided to the add command. Use the list command to display a list of valid removal targets. External keys cannot be removed by the isho.st script.

EXAMPLES

isoho.st remove phobos

isoho.st remove xc0d77e2

list

Displays a listing of the keys stored in the local credential store along with any associated aliases. Aliases for machine identifiers with keys external to the isoho.st credential store are denoted "(external)" in the listing.

EXAMPLE

isoho.st list

alias

Associates a convenience ALIAS with a key stored in the local credential store. If the key does not exist within the credential store, then it is assumed that the ssh(1) identity associated with the machine account is maintained externally. In such cases, the ALIAS simply serves as a convenience handle so that the machine IDENTIFIER does not need to be remembered.

EXAMPLE

isoho.st alias phobos xc0d77e2

admin

The admin command presents a simple menu system via ssh(1) with the following capabilities:

A facility to obtain the connection details for manual configuration of a SPICE client is also provided, however, the display command automates this, thus making such manual configuration unnecessary.

The NAME parameter may be either an ALIAS or a machine IDENTIFIER and can be omitted entirely if there is only a single entry in the local credential store.

EXAMPLES

isoho.st admin

isoho.st admin phobos

isoho.st admin xc0d77e2

display

Launches a SPICE client and connects it to the given virtual machine's keyboard, mouse and video (KVM) display. Note that the machine must be in the powered up state using the admin interface in order to be able to connect to it.

The <SHIFT>-<F12> key can be handy in getting you out of trouble if the keyboard and mouse are grabbed exclusively by the client. It will also get you out of full screen mode where <SHIFT>-<F11> doesn't work.

The NAME parameter may be either an ALIAS or a machine IDENTIFIER and can be omitted entirely if there is only a single entry in the local credential store.

EXAMPLES

isoho.st display

isoho.st display phobos

isoho.st display xc0d77e2

remote

This command is essentially the admin and display commands combined into a single command that accepts the same parameters. Nothing more, nothing less.

It is also the default command executed by the desktop shortcut for a virtual machine.

EXAMPLES

isoho.st remote

isoho.st remote phobos

isoho.st remote xc0d77e2

shortcut

Adds a shortcut for the given virtual machine onto the user's desktop. The shortcut will execute the remote command.

Note the caveat regarding the need to have the machine powered on in order for the display component of the command to work. If the machine is powered off, first use the admin interface to power it on, then exit the admin interface and restart it again from the shortcut.

The NAME parameter may be either an ALIAS or a machine IDENTIFIER and can be omitted entirely if there is only a single entry in the local credential store.

EXAMPLES

isoho.st shortcut

isoho.st shortcut phobos

isoho.st shortcut xc0d77e2


AUTHOR

Edwin Peer