doc/api/methods/virtual_machines.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "virtual_machines"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/virtual_machines@
  12
  13 UUID type: @2x53u@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 The virtual_machines resource lists nodes in the Arvados cluster to which a user may log in to get an interactive shell (via ssh or webshell).
  20
  21 Each VirtualMachine has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |hostname|string|||
  26
  27
  28 h2. create
  29
  30 Create a new VirtualMachine.
  31
  32 Arguments:
  33
  34 table(table table-bordered table-condensed).
  35 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  36 |virtual_machine|object||query||
  37
  38 h2. delete
  39
  40 Delete an existing VirtualMachine.
  41
  42 Arguments:
  43
  44 table(table table-bordered table-condensed).
  45 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  46 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  47
  48 h2. get
  49
  50 Gets a VirtualMachine's metadata by UUID.
  51
  52 Arguments:
  53
  54 table(table table-bordered table-condensed).
  55 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  56 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  57
  58 h2(#logins). logins
  59
  60 Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
  61
  62 Arguments:
  63
  64 table(table table-bordered table-condensed).
  65 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  66 {background:#ccffcc}.|uuid|string||path||
  67
  68 The response is a "resource list":{{site.baseurl}}/api/resources.html#resourceList with @kind@ set to @"arvados#HashList"@. Each item is a hash with the following keys:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Key|_. Value type|_. Description|_. Example|
  72 |username|string|Name of the Unix login account to which the user should be able to log in|@"jsmith"@|
  73 |hostname|string|Hostname of the virtual machine|@"shell.xyzzy.arvadosapi.com"@|
  74 |public_key|string|SSH public key|@"ssh-rsa AAAAB3NzaC1yc2E..."@|
  75 |user_uuid|string|UUID of the user who should be able to log in|@"xyzzy-tpzed-mv4d7dy7n91te11"@|
  76 |virtual_machine_uuid|string|UUID of the "VirtualMachine resource":{{site.baseurl}}/api/schema/VirtualMachine.html|@"xyzzy-2x53u-kvszmclnbjuv8xc"@|
  77 |authorized_key_uuid|string|UUID of the "AuthorizedKey resource":{{site.baseurl}}/api/schema/AuthorizedKey.html|@"xyzzy-fngyi-v9p0cyfmjxbio64"@|
  78
  79 h2. get_all_logins
  80
  81 Get a list, for every virtual machine in the system, of SSH keys and account names that should be able to log in.
  82
  83 Arguments: none.
  84
  85 The response has the same format as the response to the "logins method":#logins above.
  86
  87 h2. list
  88
  89 List virtual_machines.
  90
  91 Arguments:
  92
  93 table(table table-bordered table-condensed).
  94 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  95 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
  96 |order|string|Order in which to return matching virtual_machines.|query||
  97 |filters|array|Conditions for filtering virtual_machines.|query||
  98
  99 h2. update
 100
 101 Update attributes of an existing VirtualMachine.
 102
 103 Arguments:
 104
 105 table(table table-bordered table-condensed).
 106 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 107 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 108 |virtual_machine|object||query||