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
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new VirtualMachine.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |virtual_machine|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing VirtualMachine.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  33
  34 h2. get
  35
  36 Gets a VirtualMachine's metadata by UUID.
  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_all_logins
  45
  46 get_all_logins virtual_machines
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52
  53 h2. list
  54
  55 List virtual_machines.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
  62 |order|string|Order in which to return matching virtual_machines.|query||
  63 |filters|array|Conditions for filtering virtual_machines.|query||
  64
  65 h2. logins
  66
  67 logins virtual_machines
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 {background:#ccffcc}.|uuid|string||path||
  74
  75 h2. update
  76
  77 Update attributes of an existing VirtualMachine.
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  84 |virtual_machine|object||query||