Merge branch '8784-dir-listings'

[arvados.git] / doc / api / methods / virtual_machines.html.textile.liquid

diff --git a/doc/api/methods/virtual_machines.html.textile.liquid b/doc/api/methods/virtual_machines.html.textile.liquid
index 790519be7949110872f9c17a072f84df949df455..89272a484a9e3aff2aca9a424599eefe2d56aef9 100644 (file)
--- a/doc/api/methods/virtual_machines.html.textile.liquid
+++ b/doc/api/methods/virtual_machines.html.textile.liquid
@@ -3,47 +3,48 @@ layout: default
 navsection: api
 navmenu: API Methods
 title: "virtual_machines"
-
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/virtual_machines@
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @2x53u@
 
+Example UUID: @zzzzz-2x53u-0123456789abcde@
 
-h2. create
+h2. Resource
 
-Create a new VirtualMachine.
+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).
 
-Arguments:
+Each VirtualMachine has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|virtual_machine|object||query||
-
-h2. delete
+|_. Attribute|_. Type|_. Description|_. Example|
+|hostname|string|||
 
-Delete an existing VirtualMachine.
+h2. Methods
 
-Arguments:
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. destroy
+h3. create
 
-destroy virtual_machines
+Create a new VirtualMachine.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|virtual_machine|object||query||
 
-h2. get
+h3. delete
 
-Gets a VirtualMachine's metadata by UUID.
+Delete an existing VirtualMachine.
 
 Arguments:
 
@@ -51,61 +52,52 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 
-h2. get_all_logins
+h3. get
 
-get_all_logins virtual_machines
+Gets a VirtualMachine's metadata by UUID.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
+{background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
 
-h2. index
+h3(#logins). logins
 
-index virtual_machines
+Get a list of SSH keys and account names that should be able to log in to a given virtual machine.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-|order|string||query||
-|where|object||query||
-
-h2. list
-
-List virtual_machines.
+{background:#ccffcc}.|uuid|string||path||
 
-Arguments:
+The response is an object with the field @items@ containing an array of objects in the following format:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
-|order|string|Order in which to return matching virtual_machines.|query||
-|pageToken|string|Page token.|query||
-|q|string|Query string for searching virtual_machines.|query||
-|where|object|Conditions for filtering virtual_machines.|query||
-
-h2. logins
+|_. Key|_. Value type|_. Description|_. Example|
+|username|string|Name of the Unix login account to which the user should be able to log in|@"jsmith"@|
+|hostname|string|Hostname of the virtual machine|@"shell.xyzzy.arvadosapi.com"@|
+|public_key|string|SSH public key|@"ssh-rsa AAAAB3NzaC1yc2E..."@|
+|user_uuid|string|UUID of the user who should be able to log in|@"xyzzy-tpzed-mv4d7dy7n91te11"@|
+|virtual_machine_uuid|string|UUID of the "virtual machine resource":{{site.baseurl}}/api/methods/virtual_machines.html|@"zzzzz-2x53u-kvszmclnbjuv8xc"@|
+|authorized_key_uuid|string|UUID of the "authorized key resource":{{site.baseurl}}/api/methods/authorized_keys.html|@"zzzzz-fngyi-v9p0cyfmjxbio64"@|
 
-logins virtual_machines
+h3. get_all_logins
 
-Arguments:
+Get a list of SSH keys and account names that should be able to log in for every virtual machine in the system.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+Arguments: none.
 
-h2. show
+The response has the same format as the response to the "logins method":#logins above.
 
-show virtual_machines
+h3. list
 
-Arguments:
+List virtual_machines.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
-h2. update
+h3. update
 
 Update attributes of an existing VirtualMachine.