Files
d929b9fc7666d601894771c8f39f95c04d79fbd1
nova /api-ref /source /os-agents.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase 
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016年04月20日 16:21:58 -04:00

163 lines
3.5 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
==========================
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: 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
- hypervisor: hypervisor_type
- architecture: architecture
- os: os
- url: url
- md5hash: md5hash
- version: version
**Example Create Agent Build: JSON request**
.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- hypervisor: hypervisor_type
- architecture: architecture
- os: os
- url: url
- md5hash: md5hash
- version: version
- agent_id: agent_id
**Example Create Agent Build: JSON response**
.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-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_type
- url: url
- md5hash: md5hash
- version: version
Response
--------
**Example List Agent Builds: JSON response**
.. literalinclude:: ../../doc/api_samples/os-agents/agents-get-resp.json
:language: javascript
Delete Agent Build
==================
.. rest_method:: DELETE /v2.1/{tenant_id}/os-agents
Deletes an existing 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
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-put-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- agent_id: agent_id_str
- url: url
- md5hash: md5hash
- version: version
**Example Update Agent Build: JSON response**
.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-put-resp.json
:language: javascript