doc/api/methods/virtual_machines.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "virtual_machines"
   6 navorder: 19
   7 ---
   8
   9 h1. virtual_machines
  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. destroy
  35
  36 destroy virtual_machines
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||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. get_all_logins
  55
  56 get_all_logins virtual_machines
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62
  63 h2. index
  64
  65 index virtual_machines
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 |order|string||query||
  72 |where|object||query||
  73
  74 h2. list
  75
  76 List virtual_machines.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
  83 |order|string|Order in which to return matching virtual_machines.|query||
  84 |pageToken|string|Page token.|query||
  85 |q|string|Query string for searching virtual_machines.|query||
  86 |where|object|Conditions for filtering virtual_machines.|query||
  87
  88 h2. logins
  89
  90 logins virtual_machines
  91
  92 Arguments:
  93
  94 table(table table-bordered table-condensed).
  95 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  96 {background:#ccffcc}.|uuid|string||path||
  97
  98 h2. show
  99
 100 show virtual_machines
 101
 102 Arguments:
 103
 104 table(table table-bordered table-condensed).
 105 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 106 {background:#ccffcc}.|uuid|string||path||
 107
 108 h2. update
 109
 110 Update attributes of an existing VirtualMachine.
 111
 112 Arguments:
 113
 114 table(table table-bordered table-condensed).
 115 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 116 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 117 |virtual_machine|object||query||