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