diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml
index 803d3bdf7..4c4a48afd 100644
--- a/api-ref-guides/pom.xml
+++ b/api-ref-guides/pom.xml
@@ -103,8 +103,8 @@
bk-api-ref-compute-v2.1.xml
api-ref-compute-v2.1
-
-
+
+
os-api-ref-database-v1
generate-pdf
diff --git a/api-ref/src/docbkx/ch_compute-v2-ext.xml b/api-ref/src/docbkx/ch_compute-v2-ext.xml
index 21f173d05..8702d1c84 100644
--- a/api-ref/src/docbkx/ch_compute-v2-ext.xml
+++ b/api-ref/src/docbkx/ch_compute-v2-ext.xml
@@ -1,5 +1,7 @@
+ %common;
%common_project;
]>
@@ -12,11 +14,15 @@
version="5.0-extension RackBook-2.0" xml:id="compute-v2-ext"
role="api-reference">
Compute API v2 extensions (SUPPORTED)
- Extensions add features, MIME types, actions, states,
- headers, parameters, and resources to the core Compute API
- without requiring a version change.
- XML support in requests and responses has been
- deprecated for the Compute API v2.
+
+ Extensions add features, MIME types, actions, states, headers,
+ parameters, and resources to the core Compute API without requiring a
+ version change.
+
+
+ XML support in requests and responses has been deprecated for the
+ Compute API v2.
+
The Compute API returns the 403 forbidden error code if
you exceed your allotted quota for the operation.
@@ -262,9 +268,11 @@
Hypervisors (os-hypervisors)
- Displays extra statistical information from the machine
- that hosts the hypervisor through the API for the
- hypervisor (XenAPI and KVM/libvirt).
+
+ Display extra statistical information from the machine that hosts
+ the hypervisor through the API for the hypervisor (XenAPI or
+ KVM/libvirt).
+
@@ -288,6 +296,20 @@
+
+ Hypervisor with status (os-hypervisor-status)
+
+ Display extra statistical information including status from the
+ machine that hosts the hypervisor through the API for the
+ hypervisor (XenAPI or KVM/libvirt).
+
+
+
+
+
+
+
Server actions (os-instance-actions)
Lists available actions for a specified server.
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-detail-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-detail-resp.json
new file mode 100644
index 000000000..bd08c118e
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-detail-resp.json
@@ -0,0 +1,42 @@
+{
+ "hypervisors": [
+ {
+ "cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
+ "state": "up",
+ "status": "enabled",
+ "current_workload": 0,
+ "disk_available_least": 0,
+ "host_ip": "1.1.1.1",
+ "free_disk_gb": 1028,
+ "free_ram_mb": 7680,
+ "hypervisor_hostname": "fake-mini",
+ "hypervisor_type": "fake",
+ "hypervisor_version": 1000,
+ "id": 1,
+ "local_gb": 1028,
+ "local_gb_used": 0,
+ "memory_mb": 8192,
+ "memory_mb_used": 512,
+ "os-pci:pci_stats": [
+ {
+ "count": 5,
+ "extra_info": {
+ "key1": "value1",
+ "phys_function": "[[\"0x0000\", \"0x04\", \"0x00\", \"0x1\"]]"
+ },
+ "keya": "valuea",
+ "product_id": "1520",
+ "vendor_id": "8086"
+ }
+ ],
+ "running_vms": 0,
+ "service": {
+ "host": "043b3cacf6f34c90a7245151fc8ebcda",
+ "id": 2,
+ "disabled_reason": null
+ },
+ "vcpus": 1,
+ "vcpus_used": 0
+ }
+ ]
+}
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-show-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-show-resp.json
new file mode 100644
index 000000000..83379ae64
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/hypervisors-pci-show-resp.json
@@ -0,0 +1,40 @@
+{
+ "hypervisor": {
+ "cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
+ "current_workload": 0,
+ "disk_available_least": 0,
+ "host_ip": "1.1.1.1",
+ "state": "up",
+ "status": "enabled",
+ "free_disk_gb": 1028,
+ "free_ram_mb": 7680,
+ "hypervisor_hostname": "fake-mini",
+ "hypervisor_type": "fake",
+ "hypervisor_version": 1000,
+ "id": 1,
+ "local_gb": 1028,
+ "local_gb_used": 0,
+ "memory_mb": 8192,
+ "memory_mb_used": 512,
+ "os-pci:pci_stats": [
+ {
+ "count": 5,
+ "extra_info": {
+ "key1": "value1",
+ "phys_function": "[[\"0x0000\", \"0x04\", \"0x00\", \"0x1\"]]"
+ },
+ "keya": "valuea",
+ "product_id": "1520",
+ "vendor_id": "8086"
+ }
+ ],
+ "running_vms": 0,
+ "service": {
+ "host": "043b3cacf6f34c90a7245151fc8ebcda",
+ "id": 2,
+ "disabled_reason": null
+ },
+ "vcpus": 1,
+ "vcpus_used": 0
+ }
+}
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-detail-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-detail-resp.json
new file mode 100644
index 000000000..61cb17c6b
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-detail-resp.json
@@ -0,0 +1,36 @@
+{
+ "pci_devices": [
+ {
+ "address": "0000:04:10.0",
+ "compute_node_id": 1,
+ "dev_id": "pci_0000_04_10_0",
+ "dev_type": "type-VF",
+ "extra_info": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "id": 1,
+ "server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
+ "label": "label_8086_1520",
+ "product_id": "1520",
+ "status": "available",
+ "vendor_id": "8086"
+ },
+ {
+ "address": "0000:04:10.1",
+ "compute_node_id": 1,
+ "dev_id": "pci_0000_04_10_1",
+ "dev_type": "type-VF",
+ "extra_info": {
+ "key3": "value3",
+ "key4": "value4"
+ },
+ "id": 2,
+ "server_uuid": "d5b446a6-a1b4-4d01-b4f0-eac37b3a62fc",
+ "label": "label_8086_1520",
+ "product_id": "1520",
+ "status": "available",
+ "vendor_id": "8086"
+ }
+ ]
+}
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-index-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-index-resp.json
new file mode 100644
index 000000000..359744425
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-index-resp.json
@@ -0,0 +1,20 @@
+{
+ "pci_devices": [
+ {
+ "address": "0000:04:10.0",
+ "compute_node_id": 1,
+ "id": 1,
+ "product_id": "1520",
+ "status": "available",
+ "vendor_id": "8086"
+ },
+ {
+ "address": "0000:04:10.1",
+ "compute_node_id": 1,
+ "id": 2,
+ "product_id": "1520",
+ "status": "available",
+ "vendor_id": "8086"
+ }
+ ]
+}
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-show-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-show-resp.json
new file mode 100644
index 000000000..997776988
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/pci-show-resp.json
@@ -0,0 +1,18 @@
+{
+ "pci_device": {
+ "address": "0000:04:10.0",
+ "compute_node_id": 1,
+ "dev_id": "pci_0000_04_10_0",
+ "dev_type": "type-VF",
+ "extra_info": {
+ "key1": "value1",
+ "key2": "value2"
+ },
+ "id": 1,
+ "server_uuid": "69ba1044-0766-4ec0-b60d-09595de034a1",
+ "label": "label_8086_1520",
+ "product_id": "1520",
+ "status": "available",
+ "vendor_id": "8086"
+ }
+}
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/server-get-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/server-get-resp.json
index 140a65c1c..33b88e9f4 100644
--- a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/server-get-resp.json
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/server-get-resp.json
@@ -4,8 +4,8 @@
"private": [
{
"addr": "192.168.0.3",
- "mac_addr": "aa:bb:cc:dd:ee:ff",
- "type": "fixed",
+ "OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
+ "OS-EXT-IPS:type": "fixed",
"version": 4
}
]
@@ -20,13 +20,13 @@
}
]
},
- "host_id": "b7e88944272df30c113572778bcf5527f02e9c2a745221214536c1a2",
+ "hostId": "b7e88944272df30c113572778bcf5527f02e9c2a745221214536c1a2",
"id": "9dafa6bc-7a9f-45b2-8177-11800ceb7224",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
- "href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
+ "href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/servers-detail-resp.json b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/servers-detail-resp.json
index 4b622993c..01e0b64e5 100644
--- a/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/servers-detail-resp.json
+++ b/api-ref/src/wadls/compute-api/src/v2.1/api_samples/os-pci/servers-detail-resp.json
@@ -5,8 +5,8 @@
"private": [
{
"addr": "192.168.0.3",
- "mac_addr": "aa:bb:cc:dd:ee:ff",
- "type": "fixed",
+ "OS-EXT-IPS-MAC:mac_addr": "aa:bb:cc:dd:ee:ff",
+ "OS-EXT-IPS:type": "fixed",
"version": 4
}
]
@@ -21,13 +21,13 @@
}
]
},
- "host_id": "416f83c758ea0f9271018b278a9dcedb91b1190deaa598704b87219b",
+ "hostId": "416f83c758ea0f9271018b278a9dcedb91b1190deaa598704b87219b",
"id": "ef440f98-04e8-46ea-ae74-e24d437040ea",
"image": {
"id": "70a599e0-31e7-49b7-b260-868f441e862b",
"links": [
{
- "href": "http://glance.openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
+ "href": "http://openstack.example.com/images/70a599e0-31e7-49b7-b260-868f441e862b",
"rel": "bookmark"
}
]
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl
index 3a82220a6..6f5366df2 100644
--- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl
+++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-hypervisors-v2.1.wadl
@@ -1,5 +1,5 @@
-
+
%common;]>
+
+
+ Filters the search
+ results by the specified
+ ?query={filter} query
+ parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
@@ -57,7 +83,25 @@
+ &x-openstack-request-idHeader;
+
+
+
+
+
+ Shows server details for a specified
+ hypervisor.
+
+
+
+
+
+
&x-openstack-request-idHeader;
@@ -117,4 +161,59 @@
+
+
+
+ Lists hypervisors with payment card industry (PCI) details.
+
+
+
+
+
+
+
+ &x-openstack-request-idHeader;
+
+
+
+
+
+
+ Lists PCIs.
+
+
+
+
+
+
+
+ &x-openstack-request-idHeader;
+
+
+
+
+
+ Shows PCI details for a specified hypervisor.
+
+
+
+
+
+
+ &x-openstack-request-idHeader;
+
+
+
diff --git a/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json b/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json
index 44af92c43..fefc207ad 100644
--- a/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json
+++ b/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.json
@@ -1,6 +1,6 @@
{
"hypervisor": {
- "cpu_info": "?",
+ "cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
"current_workload": 0,
"disk_available_least": 0,
"free_disk_gb": 1028,
diff --git a/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.xml b/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.xml
deleted file mode 100644
index dbfec700c..000000000
--- a/api-ref/src/wadls/compute-api/src/v2/api_samples/os-hypervisor-status/hypervisors-show-with-status-resp.xml
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
diff --git a/api-ref/src/wadls/compute-api/src/v2/common.ent b/api-ref/src/wadls/compute-api/src/v2/common.ent
index 930f51eb7..9b1a65b5b 100644
--- a/api-ref/src/wadls/compute-api/src/v2/common.ent
+++ b/api-ref/src/wadls/compute-api/src/v2/common.ent
@@ -73,10 +73,11 @@
- Returns a unique identifier to provide tracking for the request.
- The request-id associated with the request appears in the log lines for
- that request. By default, the middleware configuration ensures the
- request_id appears in the log files.
+
+ Returns a unique identifier to provide tracking for the request. The
+ request ID that is associated with the request appears in the log lines for that
+ request. By default, the middleware configuration ensures that the request ID
+ appears in the log files.
'>
diff --git a/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisor-status.wadl b/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisor-status.wadl
new file mode 100644
index 000000000..a25a46a91
--- /dev/null
+++ b/api-ref/src/wadls/compute-api/src/v2/ext/os-hypervisor-status.wadl
@@ -0,0 +1,50 @@
+
+
+
+
+
+
+
+
+ The ID for the tenant or account in a
+ multi-tenancy cloud.
+
+
+
+
+
+
+
+
+
+
+
+
+ Shows information for a specified hypervisor. Includes the
+ hypervisor status.
+
+
+ Typically configured as an admin-only extension by using
+ policy.json settings.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl b/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
index b9500d7b6..4877ba308 100644
--- a/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
+++ b/api-ref/src/wadls/compute-api/src/v2/wadl/os-compute-2.wadl
@@ -3,7 +3,7 @@
-
+
@@ -39,14 +39,12 @@
-
+
- An alias, which is a name for a pointer to a resource. For
- example, a named extension.
+ The extension name.
-
+
@@ -158,10 +156,10 @@
-
- A list of supported extensions.
+
+ Lists supported extensions.
-
+
@@ -196,8 +194,10 @@
- A list of images. Each image contains IDs, names, and links. Other attributes are
- omitted.
+
+ A list of images. Each image contains IDs, names, and links.
+ Other attributes are omitted.
+
@@ -209,8 +209,10 @@
- A list of flavors. Each flavor contains IDs, names, and links; other attributes
- are omitted.
+
+ A list of flavors. Each flavor contains IDs, names, and links;
+ other attributes are omitted.
+
@@ -257,57 +259,74 @@
- &x-compute-request-idHeader;
+ &x-compute-request-idHeader; &absoluteLimits; &rateLimits;
- &absoluteLimits; &rateLimits;
&commonFaults;
-
+
- Lists available extensions.
+ Lists extensions.
- &x-compute-request-idHeader;
-
-
-
-
+ &x-compute-request-idHeader;
- Moves to the
- next metadata item.
+ path="/capi:extensions/atom:link[@rel='next']/@href">
+
+ Moves to the next item in the list.
+
- Moves to the
- previous metadata item.
+ path="/capi:extensions/atom:link[@rel='previous']/@href">
+
+ Moves to the previous item in the list.
+
- &commonFaults;
-
+
+ &commonFaults;
+
+
Gets details about the specified extension.
- Extensions introduce features and vendor-specific functionality to the API without
- requiring a version change.
+
+ Extensions introduce features and vendor-specific
+ functionality to the API without requiring a version change.
+
+
+
+
+
+
+ An alias, which is a name for a pointer to a resource.
+ For example, a named extension.
+
+
+
+
+
- &x-compute-request-idHeader;
+
+ &x-compute-request-idHeader;
@@ -505,14 +524,17 @@
still persists.
- SUSPENDED. The server is suspended, either by request or
- necessity. This status appears for only the following hypervisors:
- XenServer/XCP, KVM, and ESXi. Administrative users may suspend an instance
+
+ SUSPENDED. The server is suspended,
+ either by request or necessity. This status appears
+ for only the following hypervisors: XenServer/XCP,
+ KVM, and ESXi. Administrative users may suspend an instance
if it is infrequently used or to perform system maintenance. When you
suspend an instance, its VM state is stored on disk, all memory is written
to disk, and the virtual machine is stopped. Suspending an instance is
similar to placing a device in hibernation; memory and vCPUs become
- available to create other instances.
+ available to create other instances.
+
UNKNOWN. The state of the server is unknown. Contact your
@@ -1327,7 +1349,6 @@
&commonFaults; &getFaults;
-
Shows metadata for a specified image.
@@ -1404,7 +1425,6 @@
&commonFaults; &getFaults; &postPutFaults;
&inProgressFault;
-
@@ -1566,7 +1586,6 @@
&commonFaults; &getFaults;
-