Fix wrong variable assigned. refs #3824
[arvados.git] / 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(#logins). logins
47
48 Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
49
50 Arguments:
51
52 table(table table-bordered table-condensed).
53 |_. Argument |_. Type |_. Description |_. Location |_. Example |
54 {background:#ccffcc}.|uuid|string||path||
55
56 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:
57
58 table(table table-bordered table-condensed).
59 |_. Key|_. Value type|_. Description|_. Example|
60 |username|string|Name of the Unix login account to which the user should be able to log in|@"jsmith"@|
61 |hostname|string|Hostname of the virtual machine|@"shell.xyzzy.arvadosapi.com"@|
62 |public_key|string|SSH public key|@"ssh-rsa AAAAB3NzaC1yc2E..."@|
63 |user_uuid|string|UUID of the user who should be able to log in|@"xyzzy-tpzed-mv4d7dy7n91te11"@|
64 |virtual_machine_uuid|string|UUID of the "VirtualMachine resource":{{site.baseurl}}/api/schema/VirtualMachine.html|@"xyzzy-2x53u-kvszmclnbjuv8xc"@|
65 |authorized_key_uuid|string|UUID of the "AuthorizedKey resource":{{site.baseurl}}/api/schema/AuthorizedKey.html|@"xyzzy-fngyi-v9p0cyfmjxbio64"@|
66
67 h2. get_all_logins
68
69 Get a list, for every virtual machine in the system, of SSH keys and account names that should be able to log in.
70
71 Arguments: none.
72
73 The response has the same format as the response to the "logins method":#logins above.
74
75 h2. list
76
77 List virtual_machines.
78
79 Arguments:
80
81 table(table table-bordered table-condensed).
82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
83 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
84 |order|string|Order in which to return matching virtual_machines.|query||
85 |filters|array|Conditions for filtering virtual_machines.|query||
86
87 h2. update
88
89 Update attributes of an existing VirtualMachine.
90
91 Arguments:
92
93 table(table table-bordered table-condensed).
94 |_. Argument |_. Type |_. Description |_. Location |_. Example |
95 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
96 |virtual_machine|object||query||