summaryrefslogtreecommitdiff
path: root/api-ref/source/os-agents.inc
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2016-04-12 09:03:46 -0400
committerSean Dague <sean@dague.net>2016-04-13 07:34:45 -0400
commitd4e27714405e064ba8f62070e8c48d7fa71b6996 (patch)
treebd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/os-agents.inc
parentf1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff)
downloadnova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/os-agents.inc')
-rw-r--r--api-ref/source/os-agents.inc143
1 files changed, 143 insertions, 0 deletions
diff --git a/api-ref/source/os-agents.inc b/api-ref/source/os-agents.inc
new file mode 100644
index 0000000000..4393d51790
--- /dev/null
+++ b/api-ref/source/os-agents.inc
@@ -0,0 +1,143 @@
+.. -*- rst -*-
+
+==========================
+ Guest agents (os-agents)
+==========================
+
+Creates, lists, updates, and deletes guest agent builds. Use guest
+agents to access files on the disk, configure networking, or run other
+applications or scripts in the guest while the agent runs. This
+hypervisor-specific extension is not currently enabled for KVM. Use of
+guest agents is possible only if the underlying service provider uses
+the Xen driver.
+
+Create Agent Build
+==================
+
+.. rest_method:: POST /v2.1/{tenant_id}/os-agents
+
+Creates an agent build.
+
+Normal response codes: 201
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+
+**Example Create Agent Build: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-agents/agent-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Create Agent Build: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-agents/agent-create-resp.json
+ :language: javascript
+
+List Agent Builds
+=================
+
+.. rest_method:: GET /v2.1/{tenant_id}/os-agents
+
+Lists agent builds.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - agent_id: agent_id
+ - architecture: architecture
+ - hypervisor: hypervisor
+ - url: url
+ - md5hash: md5hash
+ - version: version
+
+Response
+^^^^^^^^
+
+**Example List Agent Builds: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-agents/agents-list-resp.json
+ :language: javascript
+
+Delete Agent Build
+==================
+
+.. rest_method:: DELETE /v2.1/{tenant_id}/os-agents
+
+Deletes an existing agent build.
+
+Normal response codes: 202
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+
+Response
+^^^^^^^^
+
+Update Agent Build
+==================
+
+.. rest_method:: PUT /v2.1/{tenant_id}/os-agents/{agent_build_id}
+
+Updates an agent build.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - agent_build_id: agent_build_id
+ - url: url
+ - md5hash: md5hash
+ - version: version
+
+**Example Update Agent Build: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - agent_id: agent_id
+ - url: url
+ - md5hash: md5hash
+ - version: version
+
+**Example Update Agent Build: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-resp.json
+ :language: javascript
+