Merge "Add REST api to manage bare-metal nodes"

16 files changed, 188 insertions, 0 deletions

diff --git a/doc/api_samples/all_extensions/extensions-get-resp.json b/doc/api_samples/all_extensions/extensions-get-resp.json
index bd002c080..604ad6763 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.json
+++ b/doc/api_samples/all_extensions/extensions-get-resp.json
@@ -89,6 +89,14 @@
             "updated": "2012-08-09T00:00:00+00:00"
         },
         {
+            "alias": "os-baremetal-nodes",
+            "description": "Admin-only bare-metal node administration.",
+            "links": [],
+            "name": "BareMetalNodes",
+            "namespace": "http://docs.openstack.org/compute/ext/baremetal_nodes/api/v2",
+            "updated": "2013-01-04T00:00:00+00:00"
+        },
+        {
             "alias": "os-cells",
             "description": "Enables cells-related functionality such as adding neighbor cells,\n    listing neighbor cells, and getting the capabilities of the local cell.\n    ",
             "links": [],
diff --git a/doc/api_samples/all_extensions/extensions-get-resp.xml b/doc/api_samples/all_extensions/extensions-get-resp.xml
index ebb1c4302..d7f483745 100644
--- a/doc/api_samples/all_extensions/extensions-get-resp.xml
+++ b/doc/api_samples/all_extensions/extensions-get-resp.xml
@@ -37,6 +37,9 @@
   <extension alias="os-availability-zone" updated="2012-08-09T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/availabilityzone/api/v1.1" name="AvailabilityZone">
     <description>Add availability_zone to the Create Server v1.1 API.</description>
   </extension>
+  <extension alias="os-baremetal-nodes" updated="2013-01-04T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/baremetal_nodes/api/v2" name="BareMetalNodes">
+    <description>Admin-only bare-metal node administration.</description>
+  </extension>
   <extension alias="os-cells" updated="2011-09-21T00:00:00+00:00" namespace="http://docs.openstack.org/compute/ext/cells/api/v1.1" name="Cells">
     <description>Enables cells-related functionality such as adding child cells,
     listing child cells, getting the capabilities of the local cell,
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.json
new file mode 100644
index 000000000..2e795e483
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.json
@@ -0,0 +1,5 @@
+{
+    "add_interface": {
+        "address": "aa:aa:aa:aa:aa:aa"
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.xml
new file mode 100644
index 000000000..63ca9c21e
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-req.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<add_interface
+    address="aa:aa:aa:aa:aa:aa"
+/>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.json
new file mode 100644
index 000000000..d0b9cc3fb
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.json
@@ -0,0 +1,8 @@
+{
+    "interface": {
+        "address": "aa:aa:aa:aa:aa:aa",
+        "datapath_id": null,
+        "id": 1,
+        "port_no": null
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.xml
new file mode 100644
index 000000000..1da1dd284
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-add-interface-resp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<interface datapath_id="None" id="1" port_no="None" address="aa:aa:aa:aa:aa:aa"/>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.json
new file mode 100644
index 000000000..d8b9eb452
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.json
@@ -0,0 +1,14 @@
+{
+    "node": {
+        "service_host": "host",
+        "cpus": 8,
+        "memory_mb": 8192,
+        "local_gb": 128,
+        "pm_address": "10.1.2.3",
+        "pm_user": "pm_user",
+        "pm_password": "pm_pass",
+        "prov_mac_address": "12:34:56:78:90:ab",
+        "prov_vlan_id": 1234,
+        "terminal_port": 8000
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.xml
new file mode 100644
index 000000000..85c863a97
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-req.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<node
+    service_host="host"
+    cpus="8"
+    memory_mb="8192"
+    local_gb="128"
+    pm_address="10.1.2.3"
+    pm_user="pm_user"
+    prov_mac_address="12:34:56:78:90:ab"
+    prov_vlan_id="1234"
+    terminal_port="8000"
+/>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.json
new file mode 100644
index 000000000..b62a9e663
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.json
@@ -0,0 +1,16 @@
+{
+    "node": {
+        "cpus": 8,
+        "id": 1,
+        "instance_uuid": null,
+        "interfaces": [],
+        "local_gb": 128,
+        "memory_mb": 8192,
+        "pm_address": "10.1.2.3",
+        "pm_user": "pm_user",
+        "prov_mac_address": "12:34:56:78:90:ab",
+        "prov_vlan_id": 1234,
+        "service_host": "host",
+        "terminal_port": 8000
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.xml
new file mode 100644
index 000000000..9b8421f0f
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-create-resp.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<node
+  instance_uuid="None"
+  pm_address="10.1.2.3"
+  cpus="8"
+  prov_vlan_id="1234"
+  memory_mb="8192"
+  prov_mac_address="12:34:56:78:90:ab"
+  service_host="host"
+  local_gb="128"
+  id="1"
+  pm_user="pm_user"
+  terminal_port="8000">
+  <interfaces/>
+</node>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.json
new file mode 100644
index 000000000..d43d580ed
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.json
@@ -0,0 +1,25 @@
+{
+    "nodes": [
+        {
+            "cpus": 8,
+            "id": 1,
+            "instance_uuid": null,
+            "interfaces": [
+                {
+                    "address": "aa:aa:aa:aa:aa:aa",
+                    "datapath_id": null,
+                    "id": 1,
+                    "port_no": null
+                }
+            ],
+            "local_gb": 128,
+            "memory_mb": 8192,
+            "pm_address": "10.1.2.3",
+            "pm_user": "pm_user",
+            "prov_mac_address": "12:34:56:78:90:ab",
+            "prov_vlan_id": 1234,
+            "service_host": "host",
+            "terminal_port": 8000
+        }
+    ]
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.xml
new file mode 100644
index 000000000..7cd1b5d8a
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.xml
@@ -0,0 +1,23 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<nodes>
+  <node
+    instance_uuid="None"
+    pm_address="10.1.2.3"
+    cpus="8"
+    prov_vlan_id="1234"
+    memory_mb="8192"
+    prov_mac_address="12:34:56:78:90:ab"
+    service_host="host"
+    local_gb="128"
+    id="1"
+    pm_user="pm_user"
+    terminal_port="8000">
+    <interfaces>
+      <interface
+        datapath_id="None"
+        id="1"
+        port_no="None"
+        address="aa:aa:aa:aa:aa:aa"/>
+    </interfaces>
+  </node>
+</nodes>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.json
new file mode 100644
index 000000000..0ce85577d
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.json
@@ -0,0 +1,5 @@
+{
+    "remove_interface": {
+        "address": "aa:aa:aa:aa:aa:aa"
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.xml
new file mode 100644
index 000000000..6457b059b
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-remove-interface-req.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<remove_interface
+    address="aa:aa:aa:aa:aa:aa"
+/>
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.json b/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.json
new file mode 100644
index 000000000..d42365752
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.json
@@ -0,0 +1,23 @@
+{
+    "node": {
+        "cpus": 8,
+        "id": 1,
+        "instance_uuid": null,
+        "interfaces": [
+            {
+                "address": "aa:aa:aa:aa:aa:aa",
+                "datapath_id": null,
+                "id": 1,
+                "port_no": null
+            }
+        ],
+        "local_gb": 128,
+        "memory_mb": 8192,
+        "pm_address": "10.1.2.3",
+        "pm_user": "pm_user",
+        "prov_mac_address": "12:34:56:78:90:ab",
+        "prov_vlan_id": 1234,
+        "service_host": "host",
+        "terminal_port": 8000
+    }
+}
\ No newline at end of file
diff --git a/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.xml b/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.xml
new file mode 100644
index 000000000..6d5f9719f
--- /dev/null
+++ b/doc/api_samples/os-baremetal-nodes/baremetal-node-show-resp.xml
@@ -0,0 +1,21 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<node
+  instance_uuid="None"
+  pm_address="10.1.2.3"
+  cpus="8"
+  prov_vlan_id="1234"
+  memory_mb="8192"
+  prov_mac_address="12:34:56:78:90:ab"
+  service_host="host"
+  local_gb="128"
+  id="1"
+  pm_user="pm_user"
+  terminal_port="8000">
+  <interfaces>
+    <interface
+      datapath_id="None"
+      id="1"
+      port_no="None"
+      address="aa:aa:aa:aa:aa:aa"/>
+  </interfaces>
+</node>
\ No newline at end of file