virtual_machines

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/virtual_machines

Object type: 2x53u

Example UUID: zzzzz-2x53u-0123456789abcde

Resource

The virtual_machines resource lists compute resources in the Arvados cluster to which a user may log in to get an interactive shell (via ssh or webshell).

Each VirtualMachine has, in addition to the Common resource fields:

Attribute	Type	Description	Example
hostname	string

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new VirtualMachine.

Arguments:

Argument	Type	Description	Location	Example
virtual_machine	object		query

delete

Delete an existing VirtualMachine.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the VirtualMachine in question.	path

get

Gets a VirtualMachine’s metadata by UUID.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the VirtualMachine in question.	path

logins

Get a list of SSH keys and account names that should be able to log in to a given virtual machine.

Arguments:

Argument	Type	Description	Location	Example
uuid	string		path

The response is an object with the field items containing an array of objects in the following format:

Key	Value type	Description	Example
username	string	Name of the Unix login account to which the user should be able to log in	"jsmith"
hostname	string	Hostname of the virtual machine	"shell.xyzzy.arvadosapi.com"
public_key	string	SSH public key	"ssh-rsa AAAAB3NzaC1yc2E..."
user_uuid	string	UUID of the user who should be able to log in	"xyzzy-tpzed-mv4d7dy7n91te11"
virtual_machine_uuid	string	UUID of the virtual machine resource	"zzzzz-2x53u-kvszmclnbjuv8xc"
authorized_key_uuid	string	UUID of the authorized key resource	"zzzzz-fngyi-v9p0cyfmjxbio64"

get_all_logins

Get a list of SSH keys and account names that should be able to log in for every virtual machine in the system.

Arguments: none.

The response has the same format as the response to the logins method above.

list

List virtual_machines.

See common resource list method.

update

Update attributes of an existing VirtualMachine.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the VirtualMachine in question.	path
virtual_machine	object		query

---

Previous: nodes Next: keep_disks (deprecated)