starlingx/integ
Code Issues Proposed changes

Add REST API documentation for dcmanager API (Distributed Cloud)

Browse Source 
Change-Id: I00d114c80f4638c4a148df6d074eab4f0f79464e
Signed-off-by: Tyler Smith <tyler.smith@windriver.com>
This commit is contained in:
Kevin Smith 2018-05-22 08:22:55 -04:00 committed by Tyler Smith
parent a64f6c303b
commit e0f87c889d
33 changed files with 1882 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
restapi-doc/centos/build_srpm.data
View File

@ -3,5 +3,5 @@ COPY_LIST="$SRC_DIR/* \
$CGCS_BASE/downloads/mvn.repo.tgz \ $CGCS_BASE/downloads/mvn.repo.tgz \
" "
TIS_PATCH_VER=22 TIS_PATCH_VER=24
BUILD_IS_SLOW=3 BUILD_IS_SLOW=3

2
restapi-doc/centos/restapi-doc.spec
View File

@ -1,6 +1,6 @@
Summary: RestAPI-Doc Summary: RestAPI-Doc
Name: restapi-doc Name: restapi-doc
Version: 1.8.0 Version: 1.8.1
Release: %{tis_patch_ver}%{?_tis_dist} Release: %{tis_patch_ver}%{?_tis_dist}
License: Apache-2.0 License: Apache-2.0
Group: devel Group: devel

2
restapi-doc/restapi-doc/Makefile
View File

@ -1,5 +1,5 @@
# increment this every release # increment this every release
API_VERSION := "1.8.0" API_VERSION := "1.8.1"
build: build:
@git status > /dev/null ; \ @git status > /dev/null ; \

11
restapi-doc/restapi-doc/api-ref-guides/pom.xml
View File

@ -110,6 +110,17 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilenameBase>api-ref-sysinv-v1</pdfFilenameBase> <pdfFilenameBase>api-ref-sysinv-v1</pdfFilenameBase>
</configuration> </configuration>
</execution> </execution>
<execution>
<id>os-api-ref-dcmanager-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-dcmanager-v1.xml </includes>
<pdfFilenameBase>api-ref-dcmanager-v1</pdfFilenameBase>
</configuration>
</execution>
<execution> <execution>
<id>os-api-ref-patching-v1</id> <id>os-api-ref-patching-v1</id>
<goals> <goals>

56
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-dcmanager-v1.xml Normal file
View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE book[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<book 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="api.openstack.org-dcmanager-pdf">
<info>
<title>Titanium Dcmanager API v1</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2018</year>
<holder>Wind River</holder>
</copyright>
<productname>Titanium Cloud</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include
href="../../api-ref/src/docbkx/ch_dcmanager-api-v1.xml"/>
</book>

1
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml
View File

@ -48,4 +48,5 @@ SPDX-License-Identifier: Apache-2.0
<xi:include href="../../api-ref/src/docbkx/ch_sysinv-api-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_sysinv-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_patching-api-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_patching-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_nfv-vim-api-v1.xml"/> <xi:include href="../../api-ref/src/docbkx/ch_nfv-vim-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_dcmanager-api-v1.xml"/>
</book> </book>

11
restapi-doc/restapi-doc/api-ref/pom.xml
View File

@ -65,6 +65,17 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilename>bk-sysinv-api-v1</pdfFilename> <pdfFilename>bk-sysinv-api-v1</pdfFilename>
</configuration> </configuration>
</execution> </execution>
<execution>
<id>os-api-ref-dcmanager-api-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-dcmanager-v1.xml</includes>
<pdfFilename>bk-dcmanager-api-v1</pdfFilename>
</configuration>
</execution>
<execution> <execution>
<id>os-api-ref-compute-v2-cgcs-ext</id> <id>os-api-ref-compute-v2-cgcs-ext</id>
<goals> <goals>

29
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-dcmanager-v1.xml Executable file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<book 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="api.openstack.org-patching-v1" status="CURRENT">
<info>
<title>Dcmanager API v1</title>
<copyright>
<year>2018</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="Wind River">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_dcmanager-api-v1.xml"/>
</book>

178
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_dcmanager-api-v1.xml Normal file
View File

@ -0,0 +1,178 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<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="dcmanager-v1"
role="api-reference">
<title>Dcmanager API v1</title>
<para>Manage distributed cloud operations with the dcmanager API. </para>
<para>The typical port used for the dcmanager REST API is 8119.
However, proper technique would be to look up the dcmanager service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-dcmanager-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#versions">
<wadl:method href="#listVersions-dcmanager-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SUBCLOUDS -->
<!--*******************************************************-->
<section xml:id="subclouds-v1">
<title>Subclouds</title>
<para>Subclouds are systems managed by a central System Controller.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subclouds">
<wadl:method href="#listSubclouds"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subclouds">
<wadl:method href="#addSubcloud"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subcloud">
<wadl:method href="#getSubcloud"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subcloud">
<wadl:method href="#updateSubcloud"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subcloud">
<wadl:method href="#deleteSubcloud"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#subcloud_config">
<wadl:method href="#generateConfig"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SUBCLOUD ALARMS -->
<!--*******************************************************-->
<section xml:id="subclouds-alarms-v1">
<title>Subcloud Alarms</title>
<para>Subcloud alarms are aggregated on the System Controller.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#alarms">
<wadl:method href="#summarizeAlarms"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PATCH STRATEGY -->
<!--*******************************************************-->
<section xml:id="dcmanager-patch-strategy-v1">
<title>Subcloud Patch Strategy</title>
<para>The Subcloud patch strategy is configurable.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy">
<wadl:method href="#getSwUpdateStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy">
<wadl:method href="#createSwUpdateStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy">
<wadl:method href="#deleteSwUpdateStrategy"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PATCH STRATEGY ACTIONS -->
<!--*******************************************************-->
<section xml:id="dcmanager-patch-strategy-actions-v1">
<title>Subcloud Patch Strategy Actions</title>
<para>Subcloud patch strategy can be actioned.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy-actions">
<wadl:method href="#actionSwUpdateStrategy"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PATCH STRATEGY STEPS -->
<!--*******************************************************-->
<section xml:id="dcmanager-patch-strategy-steps-v1">
<title>Subcloud Patch Strategy Steps</title>
<para>Subcloud patch strategy steps can be retrieved.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy-steps">
<wadl:method href="#listSwUpdateStrategySteps"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-strategy-steps-cloud">
<wadl:method href="#getSwUpdateStrategySteps"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PATCH OPTIONS -->
<!--*******************************************************-->
<section xml:id="dcmanager-patch-options-v1">
<title>Subcloud Patch Options</title>
<para>Subcloud Patch Options are configurable.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-options">
<wadl:method href="#listSwUpdateOptions"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-options_subcloud">
<wadl:method href="#getSwUpdateOptions"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-options_subcloud">
<wadl:method href="#updateSwUpdateOptions"/>
</wadl:resource>
<wadl:resource
href="../wadls/dcmanager-api/v1/dcmanager-api-v1.wadl#sw-update-options_subcloud">
<wadl:method href="#deleteSwUpdateOptions"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

13
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/alarm_summary-response.json Normal file
View File

@ -0,0 +1,13 @@
{
"alarm_summary": [
{
"cloud_status": "disabled",
"region_name": "subcloud6",
"warnings": -1,
"minor_alarms": -1,
"critical_alarms": -1,
"major_alarms": -1,
"uuid": "32b9233e-d993-45fb-96eb-5bfa9b1cad5d"
}
]
}

16
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/dcmanager-versions-response.json Normal file
View File

@ -0,0 +1,16 @@
{
"versions": [
{
"status": "CURRENT",
"updated": "2017-10-2",
"id": "v1.0",
"links": [
{
"href": "http://192.168.204.2:8119/v1.0/",
"rel": "self"
}
]
}
]
}

3
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_abort-request.json Normal file
View File

@ -0,0 +1,3 @@
{
"action": "abort",
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_action-response.json Normal file
View File

@ -0,0 +1,10 @@
{
"max-parallel-subclouds": 2,
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"subcloud-apply-type": "serial",
"state": "applying",
"stop-on-failure": True,
"type": "patch",
"id": 2
}

3
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_apply-request.json Normal file
View File

@ -0,0 +1,3 @@
{
"action": "apply",
}

28
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_config_list-response.json Normal file
View File

@ -0,0 +1,28 @@
{
"sw-update-options": [
{
"name": "all clouds default",
"compute-apply-type": "parallel",
"subcloud-id": None,
"updated-at": "2018-02-25 23:34:03.099691",
"created-at": None,
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel",
"max-parallel-computes": 3,
"default-instance-action": "migrate",
"id": 1
},
{
"name": "subcloud6",
"compute-apply-type": "parallel",
"subcloud-id": 1,
"updated-at": "2018-02-25 23:41:42.877013",
"created-at": "2018-02-25 19:07:20.767609",
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel",
"max-parallel-computes": 3,
"default-instance-action": "migrate",
"id": 1
}
]
}

12
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_config_show-response.json Normal file
View File

@ -0,0 +1,12 @@
{
"name": "subcloud6",
"compute-apply-type": "parallel",
"subcloud-id": 1,
"updated-at": "2018-02-25 23:41:42.877013",
"created-at": "2018-02-25 19:07:20.767609",
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel",
"max-parallel-computes": 3,
"default-instance-action": "migrate",
"id": 1
}

7
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_config_update-request.json Normal file
View File

@ -0,0 +1,7 @@
{
"max-parallel-computes": 3,
"default-instance-action": "migrate",
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel",
"compute-apply-type": "parallel"
}

12
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_config_update-response.json Normal file
View File

@ -0,0 +1,12 @@
{
"name": "all clouds default",
"compute-apply-type": "parallel",
"subcloud-id": None,
"updated-at": "2018-02-25 23:34:03.099691",
"created-at": None,
"alarm-restriction-type": "relaxed",
"storage-apply-type": "parallel",
"max-parallel-computes": 3,
"default-instance-action": "migrate",
"id": 1
}

6
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_create-request.json Normal file
View File

@ -0,0 +1,6 @@
{
"subcloud-apply-type": "serial",
"type": "patch",
"stop-on-failure": "true",
"max-parallel-subclouds": 2
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_create-response.json Normal file
View File

@ -0,0 +1,10 @@
{
"max-parallel-subclouds": 2,
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"subcloud-apply-type": "serial",
"state": "initial",
"stop-on-failure": True,
"type": "patch",
"id": 2
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_show-response.json Normal file
View File

@ -0,0 +1,10 @@
{
"max-parallel-subclouds": 2,
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"subcloud-apply-type": "serial",
"state": "initial",
"stop-on-failure": True,
"type": "patch",
"id": 2
}

34
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_steps_list-response.json Normal file
View File

@ -0,0 +1,34 @@
{
"strategy-steps": [
{
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"state": "initial",
"details": "",
"id": 1,
"cloud": "subcloud6",
"stage": 1
},
{
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"state": "initial",
"details": "",
"id": 2,
"cloud": "subcloud7",
"stage": 1
},
{
"updated-at": None,
"created-at": "2018-02-25T23:23:53.852473",
"state": "initial",
"details": "",
"id": 3,
"cloud": "subcloud8",
"stage": 1
},
]
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/patch_strategy_steps_show-response.json Normal file
View File

@ -0,0 +1,10 @@
{
"updated-at": None,
"created-at": None,
"state": "initial",
"details": "",
"id": 1,
"cloud": "subcloud6",
"stage": 1
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_add-request.json Normal file
View File

@ -0,0 +1,10 @@
{
"name": "subcloud7",
"management-start-ip": "192.168.205.110",
"systemcontroller-gateway-ip": "192.168.204.102",
"location": "West Ottawa",
"management-subnet": "192.168.205.0/24",
"management-gateway-ip": "192.168.205.1",
"management-end-ip": "192.168.205.160",
"description": "new subcloud"
}

16
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_add-response.json Normal file
View File

@ -0,0 +1,16 @@
{
"description": None,
"management-start-ip": "192.168.205.110",
"created-at": "2018-02-25T22:17:11.845596",
"updated-at": None,
"software-version": "18.01",
"management-state": "unmanaged",
"availability-status": "offline",
"systemcontroller-gateway-ip": "192.168.204.102",
"location": None,
"management-subnet": "192.168.205.0/24",
"management-gateway-ip": "192.168.205.1",
"management-end-ip": "192.168.205.160",
"id": 4,
"name": "subcloud7"
}

15
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_generate_config-request.json Normal file
View File

@ -0,0 +1,15 @@
{
"oam-gateway-ip": "10.10.20.1",
"oam-interface-mtu": "1500",
"oam-subnet": "10.10.20.0/24",
"management-interface-port": "enp0s3",
"system-mode": "duplex",
"management-interface-mtu": "1500",
"oam-unit-1-ip": "10.10.20.4",
"oam-interface-port": "enp0s8",
"management-vlan": "10",
"pxe-subnet": "192.168.205.0/24",
"oam-unit-0-ip": "10.10.20.3",
"oam-floating-ip": "10.10.20.2"
}

5
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_generate_config-response.json Normal file
View File

@ -0,0 +1,5 @@
{
"config": "[SYSTEM]\nSYSTEM_MODE=duplex\n[REGION2_PXEBOOT_NETWORK]\nPXEBOOT_CIDR = 192.168.205.0/24\n[MGMT_NETWORK]\nVLAN = 10\nCIDR = 192.168.204.0/24\nGATEWAY = 192.168.204.1\nIP_START_ADDRESS = 192.168.204.50\nIP_END_ADDRESS = 192.168.204.100\nDYNAMIC_ALLOCATION = Y\nLOGICAL_INTERFACE = LOGICAL_INTERFACE_1\n[LOGICAL_INTERFACE_1]\nLAG_INTERFACE = N\nINTERFACE_MTU = 1500\nINTERFACE_PORTS = enp0s3\n[OAM_NETWORK]\nCIDR = 10.10.20.0/24\nGATEWAY = 10.10.20.1\nIP_FLOATING_ADDRESS = 10.10.20.2\nIP_UNIT_0_ADDRESS = 10.10.20.3\nIP_UNIT_1_ADDRESS = 10.10.20.4\nLOGICAL_INTERFACE = LOGICAL_INTERFACE_2\n[LOGICAL_INTERFACE_2]\nLAG_INTERFACE = N\nINTERFACE_MTU = 1500\nINTERFACE_PORTS = enp0s8\n[SHARED_SERVICES]\nSYSTEM_CONTROLLER_SUBNET = 192.168.204.0/24\nSYSTEM_CONTROLLER_FLOATING_ADDRESS = 192.168.204.2\nREGION_NAME = RegionOne\nADMIN_PROJECT_NAME = admin\nADMIN_USER_NAME = admin\nADMIN_PASSWORD = Li69nux*\nKEYSTONE_ADMINURL = http://192.168.204.2:5000/v3\nKEYSTONE_SERVICE_NAME = keystone\nKEYSTONE_SERVICE_TYPE = identity\nGLANCE_SERVICE_NAME = glance\nGLANCE_SERVICE_TYPE = image\nGLANCE_CACHED = True\n[REGION_2_SERVICES]\nREGION_NAME = subcloud6\n[VERSION]\nRELEASE = 18.01\n"
}

83
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_list-response.json Normal file
View File

@ -0,0 +1,83 @@
{
"subclouds": [
{
"description": None,
"management-start-ip": "192.168.204.50",
"sync_status": "unknown",
"updated-at": None,
"software-version": "18.01",
"management-state": "unmanaged",
"availability-status": "offline",
"management-subnet": "192.168.204.0/24",
"systemcontroller-gateway-ip": "192.168.204.101",
"subcloud_id": 1,
"location": None,
"endpoint_sync_status": [
{
"sync_status": "unknown",
"endpoint_type": "platform"
},
{
"sync_status": "unknown",
"endpoint_type": "volume"
},
{
"sync_status": "unknown",
"endpoint_type": "compute"
},
{
"sync_status": "unknown",
"endpoint_type": "network"
},
{
"sync_status": "unknown",
"endpoint_type": "patching"
},
"created-at": u"2018-02-25 19:06:35.208505",
"management-gateway-ip": u"192.168.204.1",
"management-end-ip": u"192.168.204.100",
"id": 1,
"name": "subcloud6"
},
{
"description": "test subcloud",
"management-start-ip": "192.168.205.50",
"sync_status": "in-sync",
"updated-at": None,
"software-version": "18.01",
"management-state": "managed",
"availability-status": "online",
"management-subnet": "192.168.205.0/24",
"systemcontroller-gateway-ip": "192.168.205.101",
"subcloud_id": 2,
"location": "Ottawa,
"endpoint_sync_status": [
{
"sync_status": "in-sync",
"endpoint_type": "platform"
},
{
"sync_status": "in-sync",
"endpoint_type": "volume"
},
{
"sync_status": "in-sync",
"endpoint_type": "compute"
},
{
"sync_status": "in-sync",
"endpoint_type": "network"
},
{
"sync_status": "out-of-sync",
"endpoint_type": "patching"
},
"created-at": "2018-02-25 19:06:35.208505",
"management-gateway-ip": "192.168.205.1",
"management-end-ip": "192.168.205.100",
"id": 2,
"name": "subcloud7"
},
]
}

38
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_show-response.json Normal file
View File

@ -0,0 +1,38 @@
{
"description": "test subcloud",
"management-start-ip": "192.168.204.50",
"created-at": "2018-02-25 19:06:35.208505",
"updated-at": "2018-02-25 21:35:59.771779",
"software-version": "18.01",
"management-state": "unmanaged",
"availability-status": "offline",
"management-subnet": "192.168.204.0/24",
"systemcontroller-gateway-ip": "192.168.204.101",
"location": "ottawa",
"endpoint_sync_status": [
{
"sync_status": "in-sync",
"endpoint_type": "compute"
},
{
"sync_status": "in-sync",
"endpoint_type": "network"
},
{
"sync_status": "in-sync",
"endpoint_type": "patching"
},
{
"sync_status": "in-sync",
"endpoint_type": "platform"
},
{
"sync_status": "in-sync",
"endpoint_type": "volume"
}
],
"management-gateway-ip": "192.168.204.1",
"management-end-ip": "192.168.204.100",
"id": 1,
"name": "subcloud6"
}

5
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_update-request.json Normal file
View File

@ -0,0 +1,5 @@
{
"description": "new description",
"location": "new location",
"management-state": "managed"
}

16
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/api_samples/subcloud_update-response.json Normal file
View File

@ -0,0 +1,16 @@
{
"description": "new description",
"management-start-ip": "192.168.204.50",
"created-at": "2018-02-25T19:06:35.208505",
"updated-at": "2018-02-25T23:01:17.490090",
"software-version": "18.01",
"management-state": "unmanaged",
"availability-status": "offline",
"systemcontroller-gateway-ip": "192.168.204.101",
"location": "new location",
"management-subnet": "192.168.204.0/24",
"management-gateway-ip": "192.168.204.1",
"management-end-ip": "192.168.204.100",
"id": 1,
"name": "subcloud6"
}

390
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/common.ent Normal file
View File

@ -0,0 +1,390 @@
<!--
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
<response status="500" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:internalServerError"/>
<representation mediaType="application/json"/>
</response>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults on GET
-->
<!ENTITY getFaults
'
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults on POST/PUT
-->
<!ENTITY postPutFaults
'
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>
'>
<!ENTITY rebootFaults
'
<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
'>
<!-- COMMON List Show Parameters -->
<!ENTITY commonListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The unique identifier for this object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="created_at" style="plain" type="xsd:dateTime" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The time when the object was created.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="updated_at" style="plain" type="xsd:dateTime" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The time when the object was last updated.</para>
</wadl:doc>
</param>
'>
<!-- COMMON Subcloud List/Show Parameters -->
<!ENTITY commonSubcloudListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name provisioned for the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Management state of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Availability status of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-subnet" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Management subnet for subcloud in CIDR format.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-start-ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Start of management IP address range for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-end-ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>End of management IP address range for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="systemcontroller-gateway-ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Systemcontroller gateway IP Address.</para>
</wadl:doc>
</param>
'>
<!-- Subcloud List Parameters -->
<!ENTITY subcloudListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="endpoint_sync_status" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of endpoint sync statuses.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="platform_sync_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The platform sync status of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_sync_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The volume sync status of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="compute_sync_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The compute sync status of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="network_sync_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The network sync status of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="patching_sync_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The patching sync status of the subcloud.</para>
</wadl:doc>
</param>
'>
<!-- Alarm List/Show Parameters -->
<!ENTITY alarmListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uuid" style="plain" type="csapi:UUID" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The unique identifier for this object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="region_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name provisioned for the subcloud (synonym for subcloud name).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="cloud_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The overall alarm status of the cloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="warnings" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of warnings for the cloud (-1 when the cloud_status is disabled).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minor_alarms" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of minor alarms for the cloud (-1 when the cloud_status is disabled).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="critical_alarms" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of critical alarms for the cloud (-1 when the cloud_status is disabled).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="major_alarms" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of major alarms for the cloud (-1 when the cloud_status is disabled).</para>
</wadl:doc>
</param>
'>
<!-- sw Update Options List/Show Parameters -->
<!ENTITY swUpdateOptionsListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the cloud to which the patch options apply.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="compute-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Compute host apply type, <code>parallel</code> or <code>serial</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="subcloud-id" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The id of the cloud (will be 0 for the all clouds default).</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max-parallel-computes" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of compute hosts to patch in parallel.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm-restriction-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Whether to allow patching if subcloud alarms are present or not, <code>strict</code> or <code>relaxed</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="storage-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Storage host apply type, <code>parallel</code> or <code>serial</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="default-instance-action" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>How instances should be handled, <code>stop-start</code> or <code>migrate</code>.</para>
</wadl:doc>
</param>
'>
<!-- sw Update Strategy List/Show Parameters -->
<!ENTITY swUpdateStrategyListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="subcloud-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud apply type</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The state of patching.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="stop-on-failure" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Whether to stop patching on failure or not.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Will be set to: <code>patch</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max-parallel-subclouds" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of subclouds to patch in parallel.</para>
</wadl:doc>
</param>
'>
<!-- sw Update Strategy Steps List/Show Parameters -->
<!ENTITY swUpdateStrategyStepsListShowParameters
'
<param xmlns="http://wadl.dev.java.net/2009/02"
name="cloud" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the cloud to which the patch strategy steps apply.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The state of patching.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="details" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Details about patching.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="stage" style="plain" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The stage of patching.</para>
</wadl:doc>
</param>
'>

841
restapi-doc/restapi-doc/api-ref/src/wadls/dcmanager-api/v1/dcmanager-api-v1.wadl Normal file
View File

@ -0,0 +1,841 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%common;]>
<application
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
>
<!--*******************************************************-->
<!-- RESOURCES -->
<!--*******************************************************-->
<resources base="https://windriver.com/cgcs-restapi/dcmanager/" xml:id="dcmanager-v1.0">
<!-- / -->
<resource id="versions" path="/">
<method href="#listVersions-dcmanager-v1"/>
<!-- /v1.0 -->
<resource id="version" type="#VersionDetails" path="v1.0">
<!-- /v1.0/subclouds -->
<resource id="subclouds" path="subclouds">
<method href="#listSubclouds"/>
<method href="#addSubcloud"/>
<!-- /v1.0/subclouds/{subcloud} -->
<resource id="subcloud" path="{subcloud}" >
<param name="subcloud" style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The subcloud reference, name or id.</para>
</wadl:doc>
</param>
<method href="#getSubcloud"/>
<method href="#updateSubcloud"/>
<method href="#deleteSubcloud"/>
<!-- /v1.0/subclouds/{subcloud}/config -->
<resource id="subcloud_config" path="config" >
<method href="#generateConfig"/>
</resource>
</resource>
</resource>
<!-- /v1.0/alarms -->
<resource id="alarms" path="alarms">
<method href="#summarizeAlarms"/>
</resource>
<!-- /v1.0/sw-update-strategy -->
<resource id="sw-update-strategy" path="sw-update-strategy">
<method href="#getSwUpdateStrategy"/>
<method href="#createSwUpdateStrategy"/>
<method href="#deleteSwUpdateStrategy"/>
<!-- /v1.0/sw-update-strategy/actions -->
<resource id="sw-update-strategy-actions" path="actions">
<method href="#actionSwUpdateStrategy"/>
</resource>
<!-- /v1.0/sw-update-strategy/steps -->
<resource id="sw-update-strategy-steps" path="steps">
<method href="#listSwUpdateStrategySteps"/>
<!-- /v1.0/sw-update-strategy/steps/{cloud_name} -->
<resource id="sw-update-strategy-steps-cloud" path="{cloud_name}">
<method href="#getSwUpdateStrategySteps"/>
</resource>
</resource>
</resource>
<!-- /v1.0/sw-update-options -->
<resource id="sw-update-options" path="sw-update-options">
<method href="#listSwUpdateOptions"/>
<!-- /v1.0/sw-update-options/{subcloud} -->
<resource id="sw-update-options_subcloud" path="{subcloud}" >
<param name="subcloud" style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The subcloud reference, name or id.</para>
</wadl:doc>
</param>
<method href="#getSwUpdateOptions"/>
<method href="#updateSwUpdateOptions"/>
<method href="#deleteSwUpdateOptions"/>
</resource>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- METHODS -->
<!--*******************************************************-->
<!-- ..................................................... -->
<!-- .. Versions .. -->
<!-- ..................................................... -->
<method name="GET" id="listVersions-dcmanager-v1">
<wadl:doc xml:lang="EN" title="List API versions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all dcmanager API versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/dcmanager-versions-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<!-- ..................................................... -->
<!-- .. subclouds .. -->
<!-- ..................................................... -->
<method name="GET" id="listSubclouds">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Subclouds">
<para role="shortdesc">Lists all subclouds.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="subclouds" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of subclouds.</para>
</wadl:doc>
</param>
&commonListShowParameters;
&commonSubcloudListShowParameters;
&subcloudListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_list-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="GET" id="getSubcloud">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show subcloud">
<para role="shortdesc">Shows detailed information about a specific subcloud.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
&commonSubcloudListShowParameters;
&subcloudListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_show-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="POST" id="addSubcloud">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create subcloud">
<para role="shortdesc">Creates a subcloud.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the subcloud. Must be a unique name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The description of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The location of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-subnet" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Management subnet for subcloud in CIDR format. Must be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-start-ip" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Start of management IP address range for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-end-ip" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>End of management IP address range for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="systemcontroller-gateway-ip" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Systemcontroller gateway IP Address.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
&commonSubcloudListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_add-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="PATCH" id="updateSubcloud">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Subcloud">
<para role="shortdesc">Modifies a specific subcloud.</para>
<para>The attributes of a subcloud which are modifiable:</para>
<itemizedlist>
<listitem><para>description</para></listitem>
<listitem><para>location</para></listitem>
<listitem><para>management-state</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The description of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The location of the subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The management-state of the subcloud, <code>managed</code> or <code>unmanaged</code>.
The subcloud must be online before this can be modified to managed.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_update-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
&commonSubcloudListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_update-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="DELETE" id="deleteSubcloud">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Subcloud">
<para role="shortdesc">Deletes a specific subcloud.</para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="generateConfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Generate Subcloud Configuration">
<para role="shortdesc">Generates the configuration of a specific subcloud.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="pxe-subnet" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>PXE boot boot subnet for subcloud in CIDR format.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-vlan" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>VLAN for subcloud management network.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-interface-port" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud management interface port.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="management-interface-mtu" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud management interface mtu.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-subnet" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>OAM subnet for subcloud in CIDR format.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-gateway-ip" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>OAM gateway IP for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-floating-ip" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>OAM floating IP address for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-unit-0-ip" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>OAM unit 0 IP address for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-unit-1-ip" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>OAM unit 1 IP address for subcloud.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-interface-port" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud OAM interface port.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam-interface-mtu" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud OAM interface mtu.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="system-mode" style="plain" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>System mode, <code>simplex, duplex, or duplex-direct</code>.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_generate_config-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/subcloud_generate_config-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<!-- ..................................................... -->
<!-- .. alarms .. -->
<!-- ..................................................... -->
<method name="GET" id="summarizeAlarms">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Subcloud Alarms">
<para role="shortdesc">Summarizes alarms from all subclouds.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_summary" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of alarm summaries.</para>
</wadl:doc>
</param>
&alarmListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/alarm_summary-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<!-- ..................................................... -->
<!-- .. sw-update-options .. -->
<!-- ..................................................... -->
<method name="GET" id="listSwUpdateOptions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Patch Options">
<para role="shortdesc">Lists all patch options.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sw-update-options" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of patch options.</para>
</wadl:doc>
</param>
&swUpdateOptionsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_config_list-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="GET" id="getSwUpdateOptions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Patch options">
<para role="shortdesc">Shows patch options, defaults or per subcloud. Use <code>RegionOne</code> as subcloud for default options which are pre-configured.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateOptionsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_config_show-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="POST" id="updateSwUpdateOptions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Update Patch Options">
<para role="shortdesc">Updates patch options, defaults or per subcloud. Use <code>RegionOne</code> as subcloud for default options.</para>
<itemizedlist>
<listitem><para>storage-apply-type,</para></listitem>
<listitem><para>compute-apply-type,</para></listitem>
<listitem><para>max-parallel-computes,</para></listitem>
<listitem><para>alarm-restriction-type,</para></listitem>
<listitem><para>default-instance-action,</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="storage-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Storage host apply type, <code>parallel</code> or <code>serial</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="compute-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Compute host apply type, <code>parallel</code> or <code>serial</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max-parallel-computes" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The number of compute hosts to patch in parallel.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm-restriction-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Whether to allow patching if subcloud alarms are present or not,
<code>strict</code> or <code>relaxed</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="default-instance-action" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>How instances should be handled, <code>stop-start</code> or <code>migrate</code>.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_config_update-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateOptionsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_config_update-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="DELETE" id="deleteSwUpdateOptions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete patch options">
<para role="shortdesc">Delete per subcloud patch options.</para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<!-- ..................................................... -->
<!-- .. sw-update-strategy .. -->
<!-- ..................................................... -->
<method name="GET" id="getSwUpdateStrategy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Patch Strategy">
<para role="shortdesc">Shows the details of the patch strategy.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateStrategyListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_show-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="POST" id="createSwUpdateStrategy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create Patch Strategy">
<para role="shortdesc">Creates the patch strategy.</para>
<itemizedlist>
<listitem><para>subcloud-apply-type,</para></listitem>
<listitem><para>max-parallel-subclouds,</para></listitem>
<listitem><para>stop-on-failure,</para></listitem>
<listitem><para>cloud_name,</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="subcloud-apply-type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Subcloud apply type, <code>parallel</code> or <code>serial</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="max-parallel-subclouds" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Maximum number of parallel subclouds.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="stop-on-failure" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Whether stop patching any additional subclouds after a failure or not, <code>True</code> or <code>False</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="cloud_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Name of a single cloud to patch.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Must be set to: <code>patch</code>.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_create-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateStrategyListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_create-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="DELETE" id="deleteSwUpdateStrategy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Patch Strategy">
<para role="shortdesc">Deletes the patch strategy from the database.</para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="actionSwUpdateStrategy">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Patch Strategy Action">
<para role="shortdesc">Executes an action on a patch strategy.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="action" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Perform one of the following actions on the patch strategy:
Valid values are: <code>apply</code>,
or <code>abort</code>.
</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_apply-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateStrategyListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_action-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="GET" id="listSwUpdateStrategySteps">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List Patch Strategy Steps">
<para role="shortdesc">Lists all patch strategy steps for all clouds.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="strategy-steps" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of patch strategy steps.</para>
</wadl:doc>
</param>
&swUpdateStrategyStepsListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_steps_list-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
<method name="GET" id="getSwUpdateStrategySteps">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Patch Strategy Steps">
<para role="shortdesc">Shows the details of patch strategy steps for a particular cloud.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&swUpdateStrategyStepsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/patch_strategy_steps_show-response.json"/>
</wadl:doc>
</representation>
</response>
&getFaults;
&commonFaults;
</method>
</application>