openstack/api-site
Code Issues Proposed changes
Files
e6983aa1fd1c66a5cf115a67ffb05c210a6c38b9
api-site/api-ref/src/docbkx/ch_compute-v2-ext.xml
Diane Fleming e6983aa1fd Clean up WADL and XML files in prep for generating PDFs on api-site 
Cleaned up servers and extension WADL files to resolve some errors
Ensured all PDFs build successfully.

The api-ref-guides only publish PDF files.

Partial-Bug: #1243631

Change-Id: Iab24d2a1845475449977786b84b974c085bae6da
author: diane fleming
2014-03-28 09:59:59 +01:00

480 lines
23 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter[
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-ext-v2" role="api-reference">
<title>Compute API v2 extensions</title>
<para>Extensions add features, MIME types, actions, states,
headers, parameters, and resources to the core Compute API.
Query the Compute API to list available extensions with a
&GET; request to v2/extensions.</para>
<section xml:id="ext-action">
<title>Server admin actions (action)</title>
<para>Administrator only. Perform actions on a server. Specify
the action in the request body.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-admin-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-console-output">
<title>Server console output (os-console-output)</title>
<para>Get console output for a server instance.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2/ext/os-console-output.wadl"
/>
</section>
<section xml:id="ext-os-consoles">
<title>Server console (os-consoles)</title>
<para>Get a console for a server instance.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-consoles.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-deferred-delete">
<title>Server deferred delete (os-deferred-delete)</title>
<para>Force-delete a server or restore a deleted
server.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-deferred-delete.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-diagnostics">
<title>Server diagnostics (diagnostics)</title>
<para>Get the usage data for a server.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-diagnostics.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-access">
<title>Flavor access (flavors)</title>
<para>Create and get details for private flavors. Also, list,
add, and remove tenants' access to private flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flavor-access.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="os-flv-disabled">
<title>Flavors with FlavorDisabled attribute (flavors)</title>
<para>Get details for a flavor, and list details for available
flavors. Includes the
<literal>OS-FLV-DISABLED:disabled</literal> extended
attribute.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flv-disabled.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-extra-specs">
<title>Flavor extra-specs (os-extra-specs)</title>
<para>List, create, and update the extra-specs or keys for a
flavor.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flavor-extra-specs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavor-rxtx">
<title>Flavors with rxtx_factor extended attribute
(flavors)</title>
<para>Create a flavor, get details for a specified flavor, and
list details for available flavors. Includes the
<literal>rxtx_factor</literal> extended attribute,
related to configured bandwidth cap values.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flavor-rxtx.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavorextradata">
<title>Flavors with extended attributes (flavors)</title>
<para>Create a flavor, get details for a flavor, and list
details for available flavors. Includes the
<literal>rxtx_factor</literal>,
<literal>OS-FLV-EXT-DATA:ephemeral</literal>, and
<literal>swap</literal> extended attributes.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flavorextradata.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-flavormanage">
<title>Flavors create or delete (flavors)</title>
<para>Create or delete flavors.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-flavormanage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-ext-img-size">
<title>Images with size attribute (images)</title>
<para>List details for available images or get details for a
specified image. Includes the
<code>OS-EXT-IMG-SIZE:size</code> extended attribute,
which shows the image size.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-ext-img-size.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-limits">
<title>Limits with project usage (limits)</title>
<para>Extend limits to show the project usage. Show
information such as RAM or instance quotas usage.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-used-limits.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-compute_limits_admins">
<title>Limits with project usage for administrators
(limits)</title>
<para>Extend limits to enable administrators to show the
project usage for a specified customer project ID. Show
information such as RAM or instance quotas usage.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2/ext/os-used-limits-for-admins.wadl"
/>
</section>
<section xml:id="ext-os-agents">
<title>Guest agents (os-agents)</title>
<para>Create, update, and delete guest agents. Use guest
agents to access files on the disk, configure networking,
or run other applications or scripts in the guest while it
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.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-agents.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-aggregates">
<title>Host aggregates (os-aggregates)</title>
<para>Create and manage host aggregates. An aggregate assigns
metadata to groups of compute nodes. Aggregates are only
visible to the cloud provider.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-aggregates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-attach-interfaces">
<title>Attach interfaces (os-attach-interfaces)</title>
<para>Create, list, and get details for port
interfaces.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-attach-interfaces.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-certificates">
<title>Root certificates (os-certificates)</title>
<para>Creates and show details for a root certificate.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-certificates.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-cloudpipe">
<title>Cloudpipe (os-cloudpipe)</title>
<para>Manage virtual VPNs for projects.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-cloudpipe.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-coverage">
<title>Coverage reports (os-coverage)</title>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-coverage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-fixed-ips">
<title>Fixed IPs (os-fixed-ips)</title>
<para>Shows data for a specified fixed IP, such as host name,
CIDR, and address. Also, reserve or free a fixed
IP.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-fixed-ips.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-floating-ip-dns">
<title>Floating IP DNS records (os-floating-ip-dns)</title>
<para>Manage DNS records associated with IP addresses
allocated by the floating IPs extension. Requests are
dispatched to a DNS driver selected at startup.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-floating-ip-dns.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-floating-ip-pools">
<title>Floating IP pools (os-floating-ip-pools)</title>
<para>Manage groups of floating IPs.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-floating-ip-pools.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-floating-ips">
<title>Floating IPs (os-floating-ips)</title>
<para>Assign and allocate floating IP addresses to instances
that run in an OpenStack cloud.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-floating-ips.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-floating-ips-bulk">
<title>Floating IPs bulk (os-floating-ips-bulk)</title>
<para>Bulk create, delete, and list floating IPs. By default,
the pool is named nova. Use the
<literal>os-floating-ip-pools</literal> extension to
view available pools.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-floating-ips-bulk.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-hosts">
<title>Hosts (os-hosts)</title>
<para>Manage physical hosts.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-hosts.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-hypervisors">
<title>Hypervisors (os-hypervisors)</title>
<para>Display extra statistical information from the machine
that hosts the hypervisor through the API for the
hypervisor (XenAPI or KVM/libvirt).</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#os-hypervisors">
<wadl:method href="#listHypervisors"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#detail">
<wadl:method href="#showHypervisor"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#statistics">
<wadl:method href="#getHypervisorStats"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#hypervisor_hostname">
<wadl:method href="#getHypervisorUptime"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/src/v2/ext/os-hypervisors.wadl#servers">
<wadl:method href="#listHypervisorInstances"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="ext-os-instance-actions">
<title>Server actions (os-instance-actions)</title>
<para>List available actions for a specified server.
Administrators can get details for a specified action for
a specified server.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-instance-actions.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-keypairs">
<title>Keypairs (os-keypairs)</title>
<para>Generate, import, and delete SSH keys.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-keypairs.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-migrations">
<title>Migrations (os-migrations)</title>
<para>Administrators only. Fetch in-progress migrations for a
region or a specified cell in a region.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-migrations.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-networks">
<title>Networks (os-networks)</title>
<para>Show network information for or delete networks. Also,
disassociate a network from a project if you use vlan
mode.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-networks.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-quota-sets">
<title>Quota sets (os-quota-sets)</title>
<para>Administrators only, depending on policy settings. View
quotas for a tenant and view and update default
quotas.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-quota-sets.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-rescue">
<title>Server rescue and unrescue (os-rescue)</title>
<para>Put a server into rescue mode or unrescue a server in
rescue mode.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-rescue.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-security-group-default-rules">
<title>Rules for default security group
(os-security-group-default-rules)</title>
<para>List, show information for, and create default security
group rules.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-security-group-default-rules.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-security-groups">
<title>Security groups (os-security-groups)</title>
<para>List, show information for, create, and delete security
groups.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-security-groups.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-password">
<title>Server password (os-server-password)</title>
<para>Get and reset the encrypted admin password set through
the metadata service.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-server-password.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-shelve">
<title>Server shelve (os-server-shelve)</title>
<para>Shelve a running server.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-server-shelve.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-start-stop">
<title>Server start and stop (os-server-start-stop)</title>
<para>Start a stopped server or stop a running server.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-server-start-stop.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-services">
<title>Manage services (os-services)</title>
<para>List, enable, and disable Compute services in all
hosts.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-services.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-simple-tenant-usage">
<title>Usage reports (os-simple-tenant-usage)</title>
<para>Report usage statistics on compute and storage
resources.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-simple-tenant-usage.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-virtual-interfaces">
<title>Virtual interfaces (os-virtual-interfaces)</title>
<para>List the virtual interfaces for a specified server
instance.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-virtual-interfaces.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-volume">
<title>Volume extension (os-volumes, os-snapshots)</title>
<para>Manage volumes and snapshots for use with the Compute
API.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-volume.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-volume_attachments">
<title>Volume attachments (os-volume_attachments)</title>
<para>Attach volumes created through the volume API to server
instances. Also, list volume attachments for a server
instance, get volume details for a volume attachment, and
delete a volume attachment.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-volume_attachments.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-block-device-mapping-v2-boot">
<title>Servers with block device mapping format
(servers)</title>
<para>Create a server with a block device mapping.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-block-device-mapping-v2-boot.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-server-os-ext-ips-mac">
<title>Server OS-EXT-IPS-MAC:mac_addr extended attribute
(servers)</title>
<para>Add OS-EXT-IPS-MAC:mac_addr extended attribute when you
create, show information for, or list servers.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-server-OS-EXT-IPS-MAC.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-createserverext">
<title>Configuration drive (servers)</title>
<para>Extend servers and images with a configuration
drive.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-createserverext.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-ext-az">
<title>Servers with extended availability zones
(servers)</title>
<para>Show the instance availability zone for compute nodes
(nova-compute). Internal services appear in their own
<emphasis role="italic">internal</emphasis>
availability zone.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-ext-az.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-disk-config-servers">
<title>Servers and images with disk config (servers,
images)</title>
<para>Extend servers with the diskConfig attribute.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"
href="../wadls/compute-api/src/v2/ext/os-disk-config.wadl"
/>
</section>
<section xml:id="ext-os-ext-ips">
<title>Server IP type (servers)</title>
<para>Show the type of the IP addresses assigned to an
instance. Type is either fixed or floating.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-ext-ips.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-extended-server-attributes">
<title>Server extended attributes (servers)</title>
<para>Show metadata for servers.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-extended-server-attributes.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-extended-status">
<title>Server extended status (servers)</title>
<para>Show extended status information, vm_state, task_state,
and power_state, in detailed server responses.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-extended-status.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-multi-server-create">
<title>Servers multiple create (servers)</title>
<para>Create one or more servers with an optional reservation
ID. The request and response examples show how to create
multiple servers with or without a reservation ID.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-multi-server-create.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
<section xml:id="ext-os-scheduler-hints">
<title>Servers with scheduler hints (servers)</title>
<para>Create a server with scheduler hints.</para>
<wadl:resources
href="../wadls/compute-api/src/v2/ext/os-scheduler-hints.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
</section>
</chapter>
View Git Blame Copy Permalink