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 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/virtual_machines@
   9
  10 Object type: @2x53u@
  11
  12 Example UUID: @zzzzz-2x53u-0123456789abcde@
  13
  14 h2. Resource
  15
  16 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).
  17
  18 Each VirtualMachine has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Attribute|_. Type|_. Description|_. Example|
  22 |hostname|string|||
  23
  24 h2. Methods
  25
  26 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  27
  28 Required arguments are displayed in %{background:#ccffcc}green%.
  29
  30 h3. create
  31
  32 Create a new VirtualMachine.
  33
  34 Arguments:
  35
  36 table(table table-bordered table-condensed).
  37 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  38 |virtual_machine|object||query||
  39
  40 h3. delete
  41
  42 Delete an existing VirtualMachine.
  43
  44 Arguments:
  45
  46 table(table table-bordered table-condensed).
  47 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  48 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  49
  50 h3. get
  51
  52 Gets a VirtualMachine's metadata by UUID.
  53
  54 Arguments:
  55
  56 table(table table-bordered table-condensed).
  57 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  58 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  59
  60 h3(#logins). logins
  61
  62 Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 {background:#ccffcc}.|uuid|string||path||
  69
  70 The response is an object with the field @items@ containing an array of objects in the following format:
  71
  72 table(table table-bordered table-condensed).
  73 |_. Key|_. Value type|_. Description|_. Example|
  74 |username|string|Name of the Unix login account to which the user should be able to log in|@"jsmith"@|
  75 |hostname|string|Hostname of the virtual machine|@"shell.xyzzy.arvadosapi.com"@|
  76 |public_key|string|SSH public key|@"ssh-rsa AAAAB3NzaC1yc2E..."@|
  77 |user_uuid|string|UUID of the user who should be able to log in|@"xyzzy-tpzed-mv4d7dy7n91te11"@|
  78 |virtual_machine_uuid|string|UUID of the "virtual machine resource":{{site.baseurl}}/api/methods/virtual_machines.html|@"zzzzz-2x53u-kvszmclnbjuv8xc"@|
  79 |authorized_key_uuid|string|UUID of the "authorized key resource":{{site.baseurl}}/api/methods/authorized_keys.html|@"zzzzz-fngyi-v9p0cyfmjxbio64"@|
  80
  81 h3. get_all_logins
  82
  83 Get a list of SSH keys and account names that should be able to log in for every virtual machine in the system.
  84
  85 Arguments: none.
  86
  87 The response has the same format as the response to the "logins method":#logins above.
  88
  89 h3. list
  90
  91 List virtual_machines.
  92
  93 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  94
  95 h3. 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||