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
  16 h2. create
  17
  18 Create a new VirtualMachine.
  19
  20 Arguments:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  24 |virtual_machine|object||query||
  25
  26 h2. delete
  27
  28 Delete an existing VirtualMachine.
  29
  30 Arguments:
  31
  32 table(table table-bordered table-condensed).
  33 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  34 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  35
  36 h2. get
  37
  38 Gets a VirtualMachine's metadata by UUID.
  39
  40 Arguments:
  41
  42 table(table table-bordered table-condensed).
  43 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  44 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  45
  46 h2. get_all_logins
  47
  48 Get a list, for every virtual machine in the system, of SSH keys and account names that should be able to log in.
  49
  50 Arguments: none.
  51
  52 h2. list
  53
  54 List virtual_machines.
  55
  56 Arguments:
  57
  58 table(table table-bordered table-condensed).
  59 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  60 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
  61 |order|string|Order in which to return matching virtual_machines.|query||
  62 |filters|array|Conditions for filtering virtual_machines.|query||
  63
  64 h2. logins
  65
  66 Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 {background:#ccffcc}.|uuid|string||path||
  73
  74 h2. update
  75
  76 Update attributes of an existing VirtualMachine.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  83 |virtual_machine|object||query||