starlingx/integ
Code Issues Proposed changes

[Doc] restapi-doc wadl based package removal

Browse Source 
Previous StarlingX API Reference documentation was hosted under restapi-doc
package and managed using maven and wadl files.

StarlingX has enabled the OpenStack API guideline to manage REST API services
allowing all previous restapi-doc references to be removed.

Depends-On: https://review.openstack.org/#/c/609714/

Change-Id: I8b17c3b8212ec2a444c466df90dcc858599a52f8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Abraham Arce 2018-10-10 09:19:17 -05:00
parent 9d1287f97a
commit 9ac9c6d4e9
464 changed files with 0 additions and 41918 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
centos_pkg_dirs
View File

@ -40,7 +40,6 @@ base/net-snmp
ldap/openldap
networking/mellanox/mlx4-config
networking/openvswitch
restapi-doc
base/libevent
security/wrs-ssl
security/tss2

252
restapi-doc/centos/build_srpm
View File

@ -1,252 +0,0 @@
#!/bin/bash
# set -x
source "$SRC_BASE/build-tools/spec-utils"
source "$SRC_BASE/build-tools/srpm-utils"
CUR_DIR=`pwd`
BUILD_DIR="$RPMBUILD_BASE"
if [ "x$DATA" == "x" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): Environment variable 'DATA' not defined."
exit 1
fi
srpm_source_build_data $DATA
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): Failed to source build data from $DATA"
exit 1
fi
if [ "x$VERSION" == "x" ]; then
for SPEC in `find $SPECS_BASE -name '*.spec' | sort -V`; do
SPEC_PATH="$SPEC"
VERSION_DERIVED=`spec_evaluate '%{version}' "$SPEC_PATH" 2>> /dev/null`
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): '%{version}' not found in '$PKG_BASE/$SPEC_PATH'"
VERSION_DERIVED=""
fi
if [ "x$VERSION_DERIVED" != "x" ]; then
if [ "x$VERSION" == "x" ]; then
VERSION=$VERSION_DERIVED
else
if [ "x$SRC_DIR" != "x" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): multiple spec files found, can't set VERSION automatically"
exit 1
fi
fi
fi
done
if [ "x$VERSION" == "x" ]; then
if [ -f $SRC_DIR/PKG-INFO ]; then
VERSION=$(grep '^Version:' $SRC_DIR/PKG-INFO | awk -F ': ' '{print $2}' | sed -e 's/^[[:space:]]*//')
fi
fi
if [ "x$VERSION" != "x" ]; then
echo "Derived VERSION=$VERSION"
else
echo "ERROR: restapi_build_srpm (${LINENO}): Failed to derive a good VERSION from SPEC file, and none provided."
exit 1
fi
fi
if [ "x$TAR_NAME" == "x" ]; then
for SPEC in `find $SPECS_BASE -name '*.spec' | sort -V`; do
SPEC_PATH="$SPEC"
SERVICE=`spec_find_global service "$SPEC_PATH" 2>> /dev/null`
if [ $? -eq 0 ]; then
if [ "x$TAR_NAME" == "x" ]; then
TAR_NAME=$SERVICE
else
if [ "x$SRC_DIR" != "x" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): multiple spec files found, can't set TAR_NAME automatically"
exit 1
fi
fi
else
NAME=`spec_find_tag Name "$SPEC_PATH" 2>> /dev/null`
if [ $? -eq 0 ]; then
if [ "x$TAR_NAME" == "x" ]; then
TAR_NAME=$NAME
else
if [ "x$SRC_DIR" != "x" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): multiple spec files found, can't set TAR_NAME automatically"
exit 1
fi
fi
else
echo "WARNING: restapi_build_srpm (${LINENO}): 'Name' not found in '$PKG_BASE/$SPEC_PATH'"
NAME=""
fi
fi
done
if [ "x$TAR_NAME" == "x" ]; then
if [ -f $SRC_DIR/PKG-INFO ]; then
TAR_NAME=$(grep '^Name:' $SRC_DIR/PKG-INFO | awk -F ': ' '{print $2}' | sed -e 's/^[[:space:]]*//')
fi
fi
if [ "x$TAR_NAME" != "x" ]; then
echo "Derived TAR_NAME=$TAR_NAME"
else
echo "ERROR: restapi_build_srpm (${LINENO}): Failed to derive a good TAR_NAME from SPEC file, and none provided."
exit 1
fi
fi
if [ "x$TAR" == "x" ]; then
TAR="$TAR_NAME-$VERSION.tar.gz"
fi
SOURCE_PATH="$BUILD_DIR/SOURCES"
TAR_PATH="$SOURCE_PATH/$TAR"
STAGING=""
if [ "x$COPY_LIST_TO_TAR" != "x" ] || [ "x$EXCLUDE_LIST_FROM_TAR" != "x" ]; then
STAGING="$BUILD_DIR/staging"
mkdir -p $STAGING
fi
mkdir -p "$BUILD_DIR/SRPMS"
mkdir -p "$SOURCE_PATH"
if [ "x$SRC_DIR" == "x" -a "x$COPY_LIST" == "x" -a "$ALLOW_EMPTY_RPM" != "true" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): '$PWD/$DATA' failed to provide at least one of 'SRC_DIR' or 'COPY_LIST'"
exit 1
fi
if [ "x$SRC_DIR" != "x" ]; then
if [ ! -d "$SRC_DIR" ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): directory not found: '$SRC_DIR'"
exit 1
fi
fi
if [ "x$COPY_LIST" != "x" ]; then
echo "COPY_LIST: $COPY_LIST"
for p in $COPY_LIST; do
# echo "COPY_LIST: $p"
cp -L -u -r -v $p $SOURCE_PATH
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): COPY_LIST: file not found: '$p'"
exit 1
fi
done
fi
if [ "x$STAGING" != "x" ]; then
cp -L -u -r -v $SRC_DIR $STAGING
echo "COPY_LIST_TO_TAR: $COPY_LIST_TO_TAR"
for p in $COPY_LIST_TO_TAR; do
# echo "COPY_LIST_TO_TAR: $p"
cp -L -u -r -v $p $STAGING/$SRC_DIR
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): COPY_LIST_TO_TAR: file not found: '$p'"
exit 1
fi
done
echo "EXCLUDE_LIST_FROM_TAR: $EXCLUDE_LIST_FROM_TAR"
for p in $EXCLUDE_LIST_FROM_TAR; do
# echo "EXCLUDE_LIST_FROM_TAR: $p"
rm -rf $STAGING/$SRC_DIR/$p
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): EXCLUDE_LIST_FROM_TAR: could not remove file: '$p'"
exit 1
fi
done
fi
TRANSFORM=`echo "$SRC_DIR" | sed 's/^\./\\./' | sed 's:^/::'`
if [ "x$STAGING" != "x" ]; then
pushd $STAGING
fi
TAR_NEEDED=0
if [ "x$SRC_DIR" != "x" ]; then
echo "SRC_DIR=$SRC_DIR"
if [ -f $TAR_PATH ]; then
n=`find . -cnewer $TAR_PATH -and ! -path './.git*' \
-and ! -path './build/*' \
-and ! -path './.pc/*' \
-and ! -path './patches/*' \
-and ! -path "./$DISTRO/*" \
-and ! -path './pbr-*.egg/*' \
| wc -l`
if [ $n -gt 0 ]; then
TAR_NEEDED=1
fi
else
TAR_NEEDED=1
fi
fi
if [ $TAR_NEEDED -gt 0 ]; then
echo "Creating tar file: $TAR_PATH ..."
tar chzf $TAR_PATH $SRC_DIR --exclude '.git*' --exclude 'build' --exclude='.pc' --exclude='patches' --exclude="$SRC_DIR/$DISTRO" --exclude='pbr-*.egg' --transform "s,^$TRANSFORM,$TAR_NAME-$VERSION,"
if [ $? -ne 0 ]; then
if [ "x$STAGING" != "x" ]; then
popd
fi
echo "ERROR: restapi_build_srpm (${LINENO}): failed to create tar file, cmd: tar chzf $TAR_PATH $SRC_DIR --exclude '.git*' --exclude 'build' --exclude='.pc' --exclude='patches' --exclude="$SRC_DIR/$DISTRO" --exclude='pbr-*.egg' --transform \"s,^$TRANSFORM,$TAR_NAME-$VERSION,\""
exit 1
fi
echo "Created tar file: $TAR_PATH"
else
echo "Tar file not needed."
fi
if [ "x$STAGING" != "x" ]; then
popd
fi
for SPEC in `ls $BUILD_DIR/SPECS`; do
SPEC_PATH="$BUILD_DIR/SPECS/$SPEC"
RELEASE=`spec_find_tag Release "$SPEC_PATH" 2>> /dev/null`
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): 'Release' not found in '$SPEC_PATH'"
fi
NAME=`spec_find_tag Name "$SPEC_PATH" 2>> /dev/null`
if [ $? -ne 0 ]; then
echo "ERROR: restapi_build_srpm (${LINENO}): 'Name' not found in '$SPEC_PATH'"
fi
SRPM="$NAME-$VERSION-$RELEASE.src.rpm"
SRPM_PATH="$BUILD_DIR/SRPMS/$SRPM"
spec_validate_tis_release $SPEC_PATH
if [ $? -ne 0 ]; then
echo "TIS Validation of $SPEC_PATH failed"
exit 1
fi
BUILD_NEEDED=0
if [ -f $SRPM_PATH ]; then
n=`find . -cnewer $SRPM_PATH | wc -l`
if [ $n -gt 0 ]; then
BUILD_NEEDED=1
fi
else
BUILD_NEEDED=1
fi
if [ $BUILD_NEEDED -gt 0 ]; then
echo "SPEC file: $SPEC_PATH"
echo "SRPM build directory: $BUILD_DIR"
echo "TIS_PATCH_VER: $TIS_PATCH_VER"
sed -i -e "1 i%define _tis_build_type $BUILD_TYPE" $SPEC_PATH
sed -i -e "1 i%define tis_patch_ver $TIS_PATCH_VER" $SPEC_PATH
rpmbuild -bs $SPEC_PATH --define="%_topdir $BUILD_DIR" --undefine=dist --define="_tis_dist .tis"
else
echo "SRPM build not needed"
fi
done

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

@ -1,7 +0,0 @@
SRC_DIR=restapi-doc
COPY_LIST="$SRC_DIR/* \
$CGCS_BASE/downloads/mvn.repo.tgz \
"
TIS_PATCH_VER=27
BUILD_IS_SLOW=3

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

@ -1,32 +0,0 @@
Summary: RestAPI-Doc
Name: restapi-doc
Version: 1.9.1
Release: %{tis_patch_ver}%{?_tis_dist}
License: Apache-2.0
Group: devel
Packager: Wind River <info@windriver.com>
URL: unknown
BuildRequires: git maven
Source0: %{name}-%{version}.tar.gz
Source1: mvn.repo.tgz
%define cgcs_sdk_deploy_dir /opt/deploy/cgcs_sdk
%define debug_package %{nil}
%description
RestAPI-doc files
%prep
%setup
cp %{SOURCE1} %{_builddir}/%{name}-%{version}
%build
make -j"%(nproc)"
%install
install -D -m 644 wrs-%{name}-%{version}.tgz %{buildroot}%{cgcs_sdk_deploy_dir}/wrs-%{name}-%{version}.tgz
%files
%{cgcs_sdk_deploy_dir}/wrs-%{name}-%{version}.tgz

21
restapi-doc/restapi-doc/.gitignore vendored
View File

@ -1,21 +0,0 @@
.DS_Store
*.xpr
*.tgz
# Build results
publish-docs/
target/
/build-*.log.gz
/generated
# Packages
*.egg
*.egg-info
# Testenvironment
.tox
# Editors
*~
.*.swp
.bak

202
restapi-doc/restapi-doc/LICENSE
View File

@ -1,202 +0,0 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

32
restapi-doc/restapi-doc/Makefile
View File

@ -1,32 +0,0 @@
# increment this every release
API_VERSION := "1.9.1"
build:
@git status > /dev/null ; \
if [ $$? -ne 0 ] ; then \
echo CREATING DUMMY GIT ; \
git init ; \
fi
if [ ! -e mvn.repo.tgz ]; then \
echo "Maven Cache Not Found!" ; \
exit 1 ; \
fi
mkdir -p mvn.repo
tar -xvzf ./mvn.repo.tgz -C ./mvn.repo/
mvn clean generate-sources -o -Dmaven.repo.local=./mvn.repo/
mkdir -p target/wrs-restapi-doc-$(API_VERSION)/
cp rest-api-usage-example.pdf target/wrs-restapi-doc-$(API_VERSION)/
cp -R api-ref-guides/target/docbkx/pdf target/wrs-restapi-doc-$(API_VERSION)/
cp -R api-ref/target/docbkx/html target/wrs-restapi-doc-$(API_VERSION)/
cd target; tar -czvf ../wrs-restapi-doc-$(API_VERSION).tgz wrs-restapi-doc-$(API_VERSION)
@echo 'wrs-restapi-doc-$(API_VERSION).tgz' is ready
clean:
mvn clean -o -Dmaven.repo.local=./mvn.repo/
rm -f wrs-restapi-doc-*.tgz
rm -rf target
rm -rf mvn.repo

26
restapi-doc/restapi-doc/Makefile.cache
View File

@ -1,26 +0,0 @@
# increment this every release
API_VERSION := "1.6.0"
build:
@git status > /dev/null ; \
if [ $$? -ne 0 ] ; then \
echo CREATING DUMMY GIT ; \
git init ; \
fi
mvn clean generate-sources dependency:go-offline -Dmaven.repo.local=./mvn.repo/
cd mvn.repo && tar -czvf ../mvn.repo.tgz . && cd ..
mkdir -p target/wrs-restapi-doc-$(API_VERSION)/
cp rest-api-usage-example.pdf target/wrs-restapi-doc-$(API_VERSION)/
cp -R api-ref-guides/target/docbkx/pdf target/wrs-restapi-doc-$(API_VERSION)/
cp -R api-ref/target/docbkx/html target/wrs-restapi-doc-$(API_VERSION)/
cd target; tar -czvf ../wrs-restapi-doc-$(API_VERSION).tgz wrs-restapi-doc-$(API_VERSION)
@echo 'wrs-restapi-doc-$(API_VERSION).tgz' is ready
clean:
mvn clean -o -Dmaven.repo.local=./mvn.repo/
rm -f wrs-restapi-doc-*.tgz
rm -rf target
rm -rf mvn.repo

17
restapi-doc/restapi-doc/README.mvn_cache
View File

@ -1,17 +0,0 @@
Steps to produce mvn.repo.tgz [Maven cache]
===================
cd $MY_REPO/stx/stx-integ/restapi-doc/restapi-doc
cp Makefile Makefile.backup
cp Makefile.mvn_cache Makefile
build-srpms restapi-doc
mock -r $MY_BUILD_CFG_STD "FILE_NAME_TO_THE_BUILT_SRPM"
mock -r $MY_BUILD_CFG_STD --copyout /builddir/build/BUILD/restapi-doc-1.9.1/mvn.repo.tgz ~/
cp ~/mvn.repo.tgz $MY_REPO/stx/downloads/
# only the first time
# ln -s ../../../downloads/mvn.repo.tgz mvn.repo.tgz
cp Makefile.backup Makefile

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

@ -1,192 +0,0 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<!--
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>titanium-api-ref-guides</artifactId>
<packaging>jar</packaging>
<name>Titanium REST API Reference Guide</name>
<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name>local</release.path.name>
<comments.enabled>0</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<build>
<!--
Setting the source and resource directories is not required for building the
project, but it provides certain IDEs with information necessary to show the
proper folder structure when the pom.xml is opened as a project.
-->
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<directory>locale</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<!-- Configuration for OpenStack API Guide -->
<execution>
<id>os-api-ref</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref.xml </includes>
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2-cgcs-ext</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-compute-v2-cgcs-ext.xml </includes>
<pdfFilenameBase>api-ref-compute-v2-cgcs-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-networking-v2-cgcs-ext</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-networking-v2-cgcs-ext.xml </includes>
<pdfFilenameBase>api-ref-networking-v2-cgcs-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-image-v2-cgcs-ext</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-image-v2-cgcs-ext.xml </includes>
<pdfFilenameBase>api-ref-image-v2-cgcs-ext</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-sysinv-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-sysinv-v1.xml </includes>
<pdfFilenameBase>api-ref-sysinv-v1</pdfFilenameBase>
</configuration>
</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>
<id>os-api-ref-patching-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-patching-v1.xml </includes>
<pdfFilenameBase>api-ref-patching-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v2</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>bk-api-ref-blockstorage-v2-cgcs-ext.xml</includes>
<pdfFilenameBase>bk-api-ref-blockstorage-v2</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-nfv-vim-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-nfv-vim-v1.xml </includes>
<pdfFilenameBase>api-ref-nfv-vim-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-smapi-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>bk-api-ref-smapi-v1.xml</includes>
<pdfFilenameBase>api-ref-smapi-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-fm-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>bk-api-ref-fm-v1.xml</includes>
<pdfFilenameBase>api-ref-fm-v1</pdfFilenameBase>
</configuration>
</execution>
</executions>
<configuration>
<webhelpDirname>api-ref-guides</webhelpDirname>
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title
part toc,title
qandadiv toc
qandaset to
reference toc,title
set toc,title</generateToc>
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src</sourceDirectory>
<branding>openstack</branding>
<trimWadlUriCount>1</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
<highlightSource>false</highlightSource>
<security>external</security>
<suppressFooterNavigation>0</suppressFooterNavigation>
</configuration>
</plugin>
</plugins>
</build>
</project>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-blockstorage-v2-cgcs-ext.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2015-2017 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-blockstorage-v2-cgcs-ext-pdf">
<info>
<title>OpenStack Block Storage API v2 Titanium Extensions</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2015</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_blockstorage-api-v2-cgcs-ext.xml"/>
</book>

56
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-compute-v2-cgcs-ext.xml
View File

@ -1,56 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-compute-v2-cgcs-ext-pdf">
<info>
<title>OpenStack Compute API v2 Titanium extensions</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014</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_compute-v2-cgcs-ext.xml"/>
</book>

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

@ -1,56 +0,0 @@
<?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>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-fm-v1.xml
View File

@ -1,57 +0,0 @@
<?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-sysinv-pdf">
<info>
<title>Titanium Fault Management 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_fm-api-v1.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-image-v2-cgcs-ext.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-image-v2-cgcs-ext-pdf">
<info>
<title>OpenStack Image API v2 cgcs extensions</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2016</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_image-v2-cgcs-ext.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-networking-v2-cgcs-ext.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-networking-v2-cgcs-ext-pdf">
<info>
<title>OpenStack Networking API v2 Titanium extensions</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014</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_networking-v2-cgcs-ext.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-nfv-vim-v1.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016-2017 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-nfv-vim-pdf">
<info>
<title>Titanium NFV VIM API v1</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2016</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_nfv-vim-api-v1.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-patching-v1.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-patching-pdf">
<info>
<title>Titanium Patching API v1</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014</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_patching-api-v1.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-smapi-v1.xml
View File

@ -1,57 +0,0 @@
<?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-sysinv-pdf">
<info>
<title>Service Management 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_smapi-v1.xml"/>
</book>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-sysinv-v1.xml
View File

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-sysinv-pdf">
<info>
<title>Titanium SysInv API v1</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014</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_sysinv-api-v1.xml"/>
</book>

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

@ -1,53 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-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-pdf">
<info>
<title>Titanium Cloud REST API </title>
<titleabbrev>Titanium Cloud REST API </titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2014-2016</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_cgcs-rest-api-intro.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_compute-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_networking-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_blockstorage-api-v2-cgcs-ext.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_image-v2-cgcs-ext.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_nfv-vim-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_dcmanager-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_smapi-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_fm-api-v1.xml"/>
</book>

35
restapi-doc/restapi-doc/api-ref-guides/src/preface.xml
View File

@ -1,35 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE preface[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY nbsp "&#160;">
]>
<preface 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="Overview">
<title>Preface</title>
<para>Use the Titanium System Inventory APIs and the Titanium
extensions to OpenStack APIs to manager your Titnaium Server
cloud.</para>
<xi:include
href="../../api-ref/src/docbkx/itemizedlist-service-list.xml"/>
<para>After you authenticate through the <link
xlink:href="api-ref-identity.html">Identity API</link>,
you can use the other APIs and extensions to manage controller/compute/storage
nodes, launch server instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your Titanium Cloud cloud. To get started with the APIs,
see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para>
<para>&nbsp;</para>
</preface>

0
restapi-doc/restapi-doc/api-ref/.htaccess
View File

1796
restapi-doc/restapi-doc/api-ref/locale/api-ref.pot
View File

File diff suppressed because it is too large Load Diff

2246
restapi-doc/restapi-doc/api-ref/locale/fr.po
View File

File diff suppressed because it is too large Load Diff

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

@ -1,207 +0,0 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!--
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!-- POM Build file for api.openstack.org/api-ref.html -->
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>titanium-api-ref</artifactId>
<packaging>jar</packaging>
<name>Titanium Cloud API Complete Reference</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<!--
Setting the source and resource directories is not required for building the
project, but it provides certain IDEs with information necessary to show the
proper folder structure when the pom.xml is opened as a project.
-->
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<directory>locale</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<execution>
<id>os-api-ref</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref.xml</includes>
<pdfFilename>bk-api-ref</pdfFilename>
</configuration>
</execution>
<execution>
<id>sysinv-api-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-sysinv-v1.xml</includes>
<pdfFilename>bk-sysinv-api-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>sm-api-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-smapi-v1.xml</includes>
<pdfFilename>bk-sm-api-v1</pdfFilename>
</configuration>
</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>
<id>fm-api-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-fm-v1.xml</includes>
<pdfFilename>bk-fm-api-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-compute-v2-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-compute-v2-cgcs-ext.xml</includes>
<pdfFilename>bk-api-ref-compute-v2-cgcs-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-networking-v2-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-networking-v2-cgcs-ext.xml</includes>
<pdfFilename>bk-api-ref-networking-v2-cgcs-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-image-v2-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-image-v2-cgcs-ext.xml</includes>
<pdfFilename>bk-api-ref-image-v2-cgcs-ext</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-patching-v1-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-patching-v1.xml</includes>
<pdfFilename>bk-api-ref-patching-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-blockstorage-v2-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-blockstorage-v2-cgcs-ext.xml</includes>
<pdfFilename>bk-api-ref-blockstorage-v2</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-nfv-vim-v1-cgcs-ext</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-nfv-vim-v1.xml</includes>
<pdfFilename>bk-api-ref-nfv-vim-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-smapi-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-smapi-v1.xml</includes>
<pdfFilename>bk-api-ref-smapi-v1</pdfFilename>
</configuration>
</execution>
<!-- Configuration for OpenStack API References (pdf) -->
<!-- see ../api-ref-guides/pom.xml -->
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title
chapter toc,title
section toc,title
part toc,title
qandadiv toc
qandaset toc
reference toc,title
set toc,title</generateToc>
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/docbkx</sourceDirectory>
<branding>openstack</branding>
<trimWadlUriCount>1</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
<profileSecurity>reviewer</profileSecurity>
<highlightSource>false</highlightSource>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
</configuration>
</plugin>
</plugins>
</build>
</project>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-blockstorage-v2-cgcs-ext.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2015-2017 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-blockstorage-v2-cgcs-ext" status="CURRENT">
<info xreflabel="api-ref-blockstorage-v2-cgcs-ext.html">
<title>Block Storage V2-TITANIUM-Extensions API</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_blockstorage-api-v2-cgcs-ext.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-compute-v2-cgcs-ext.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-compute-v2-cgcs-ext" status="CURRENT">
<info>
<title>Compute V2-TITANIUM-Extensions API</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_compute-v2-cgcs-ext.xml"/>
</book>

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

@ -1,29 +0,0 @@
<?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>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-fm-v1.xml
View File

@ -1,30 +0,0 @@
<?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-sysinv-v1" status="CURRENT">
<info>
<title>Titanium Fault Management API v1</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_fm-api-v1.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-image-v2-cgcs-ext.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-image-v2-cgcs-ext" status="CURRENT">
<info>
<title>Image V2-TITANIUM-Extensions API</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_image-v2-cgcs-ext.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-networking-v2-cgcs-ext.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-networking-v2-cgcs-ext" status="CURRENT">
<info>
<title>Networking V2-TITANIUM-Extensions API</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_networking-v2-cgcs-ext.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-nfv-vim-v1.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016-2017 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-nfv-vim-v1" status="CURRENT">
<info>
<title>Titanium NFV VIM API v1</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_nfv-vim-api-v1.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-patching-v1.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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>Titanium Patching API v1</title>
<copyright>
<year>2017</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_patching-api-v1.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-smapi-v1.xml
View File

@ -1,30 +0,0 @@
<?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-smapi-v1" status="CURRENT">
<info>
<title>Titanium Service Management API v1</title>
<copyright>
<year>2018</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_smapi-v1.xml"/>
</book>

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-sysinv-v1.xml
View File

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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-sysinv-v1" status="CURRENT">
<info>
<title>Titanium System Inventory API v1</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_sysinv-api-v1.xml"/>
</book>

29
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref.xml
View File

@ -1,29 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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"
xml:id="api.openstack.org">
<info>
<title>Titanium API Reference</title>
<copyright>
<year>2017</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
</book>

75
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_blockstorage-api-v2-cgcs-ext.xml
View File

@ -1,75 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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="blockstorage-v2-cgcs-ext" role="api-reference">
<title>Block Storage API v2
Titanium extensions</title>
<para>Titanium extensions to the OpenStack Block Storage API such as backup
status and export/import actions for volumes and snapshots.</para>
<para>The typical port used for the Block Storage REST API is 8776.
However, proper technique would be to look up the cinderv2 service endpoint in keystone.</para>
<section xml:id="volumes-ext-list">
<title>Extensions</title>
<para>The Extensions entity lists all available extensions</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#extensionget">
<wadl:method href="#getExtension"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="volumes-v2-cgcs-ext">
<title>Volumes</title>
<para>Titanium extensions include export and import actions for
performing backup and restores of volumes, and a backup status
attribute to indicate the status of the new actions. </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#volumedetail">
<wadl:method href="#getAllvolumeDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#volume_id">
<wadl:method href="#getVolumeDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#volumeaction">
<wadl:method href="#actionVolume"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="snapshot-v2-cgcs-ext">
<title>Snapshots</title>
<para>Titanium extensions include export actions for
performing backup volumes already attached to a VM, and a backup status
attribute to indicate the status of the new actions. </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#snapshotdetail">
<wadl:method href="#getAllSnapshotDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#snapshot_id">
<wadl:method href="#getSnapshotDetail"/>
</wadl:resource>
<wadl:resource href="../wadls/volume-api/v2/cgcs-ext/volume-v2-cgcs-ext.wadl#snapshotaction">
<wadl:method href="#actionSnapshot"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

61
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_cgcs-rest-api-intro.xml
View File

@ -1,61 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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="cgcs-rest-overview-v1"
role="api-reference">
<title>Titanium Cloud REST API Overview</title>
<para>The Wind River Systems Titanium Cloud is a high-performance, high-availability, NFV-enabled cloud operating platform that enables telecommunication and industrial operators to deploy and maintain next generation communication services. It brings together the flexibility and scalability of the IT cloud, and the high-availability and performance demanded by these industry verticals, into a unique industry-leading solution. The CG Comms Server leverages the power of Commercial Off-The-Shelf (COTS) server hardware to deliver a price-performance ratio well above alternative solutions.</para>
<para>The Titanium Cloud Platform leverages core Wind River virtualization and carrier-grade technologies, Intel DPDK high-performance packet processing, open architectures, cutting edge security features, and the OpenStack software suite. It extends the OpenStack software suite to implement a unique carrier-grade, high-availability architecture, on which high-performance production systems can be deployed.</para>
<section xml:id="cgcs-rest-overview-openstack-v1">
<title>OpenStack REST API Documentation</title>
<para>The OpenStack REST API Documentation is open-source; both the published formats (PDF and HTML pages) as well as the docbook/wadl source documents. The published formats can be found at http://developer.openstack.org/api-ref.html .</para>
<para>Although some of the general open-source OpenStack Documentation (e.g. Admin Guide) is versioned based on OpenStack Releases (e.g. Havana), the open-source OpenStack REST API Documentation is currently NOT versioned. There is only a master/current version of the OpenStack REST API Documentation containing updates from 'all' versions of OpenStack.</para>
</section>
<section xml:id="cgcs-rest-overview-strategy-v1">
<title>Strategy for Titanium Cloud REST API Documentation</title>
<para>Due to the lack of versioning on the open-source OpenStack REST API Documentation, Titanium Cloud REST API Documentation will not build on top of open-source documents. Instead, Titanium Cloud REST API Documenation will provide a description of the delta between the Titanium Cloud REST API and the open-source OpenStack REST API. For existing OpenStack Components (e.g. Nova, Neutron, ...), any modified APIs will be re-documented with any modified or additional request parameters, response attributes and/or behaviour. For any new Titanium Components (e.g. SysInv), all APIs will be fully documented.</para>
<para>Additionally, only high-level description of the semantics around objects and parameters are described in this REST API Documentation. For full description of objects and parameters, please refer to the Wind River Titanium Cloud Administration Guide.</para>
</section>
<section xml:id="cgcs-rest-overview-extensions-v1">
<title>Titanium-specific Extensions and Titanium REST API Header</title>
<para>By default, Titanium Cloud does not send 'Titanium Cloud'-specific extensions (attributes) as a part of any REST API responses. In order to have 'Titanium Cloud'-specific extended attributes appear in the REST API responses, the Titanium Cloud header 'wrs-header' must be present in the REST API request. As a result, vanilla Openstack clients will not get any 'Titanium Cloud'-specific extended attributes as a part of the REST API response. Titanium Cloud clients will automatically send the Titanium Cloud header, and thus contain 'Titanium Cloud'-specific extensions as a part of the REST API response. The components affected by the Titanium Cloud header are Compute, Networking, and Block Storage.</para>
</section>
<section xml:id="cgcs-rest-overview-sections-v1">
<title>Overview of Document</title>
<para>The sections of this document consist of:</para>
<itemizedlist>
<listitem>
<para>TITANIUM-Extensions to Compute REST API</para>
</listitem>
<listitem>
<para>TITANIUM-Extensions to Networking REST API</para>
</listitem>
<listitem>
<para>TITANIUM-Extensions to Block Storage REST API</para>
</listitem>
<listitem>
<para>TITANIUM-Extensions to Telemetry REST API</para>
</listitem>
<listitem>
<para>TITANIUM-Extensions to Image REST API</para>
</listitem>
<listitem>
<para>TITANIUM System Inventory (SysInv) REST API</para>
</listitem>
<listitem>
<para>TITANIUM Patching REST API</para>
</listitem>
</itemizedlist>
<para>There are no TITANIUM-Extensions to Identity REST API (Keystone) and Orchestration REST API (Heat).</para>
</section>
</chapter>

258
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_compute-v2-cgcs-ext.xml
View File

@ -1,258 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE chapter[
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="compute-v2-cgcs-ext"
role="api-reference">
<title>Compute API v2 Titanium extensions</title>
<para>Titanium extensions to the OpenStack Compute API include:</para>
<itemizedlist>
<listitem>
<para>Adding capability to specify VIF-Model on a per-NIC basis when
creating/launching/booting a VM Server.</para>
</listitem>
<listitem>
<para>Adding capability to specify VIF-PCI Address on a per-NIC basis when
creating/launching/booting a VM Server.</para>
</listitem>
<listitem>
<para>Adding an attribute to allow sorting of a VM Server's IP Addresses
in order of network attachment(NIC).</para>
</listitem>
<listitem>
<para>Adding the ability to scale the resources (currently only
vCPUs) of a VM Server up and down without requiring a restart
of the VM Server.</para>
</listitem>
<listitem>
<para>Adding a number of new attributes and behavior to VM Server Groups;
a project_id attribute for ownership, an affinity-hyperthread policy and
best_effort and max group_size metadata attribute values. </para>
</listitem>
<listitem>
<para> Support for various new Flavor Extra Specs to enable
Titanium-specific optimizations and capabilities for compute servers.</para>
</listitem>
<listitem>
<para>Adding the capability of displaying details about Provider
Network with regards to Nova usage.</para>
</listitem>
</itemizedlist>
<para>The typical port used for the Compute REST API is 8774.
However, proper technique would be to look up the nova service endpoint in keystone.</para>
<!--*******************************************************-->
<!-- EXTENSIONS -->
<!--*******************************************************-->
<section xml:id="compute-ext-list">
<title>Extensions</title>
<para>The Extensions entity lists all available extensions</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#computeExtensions">
<wadl:method href="#listComputeExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#computeExtensionget">
<wadl:method href="#getComputeExtension"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVERS -->
<!--*******************************************************-->
<section xml:id="compute-servers">
<title>Server</title>
<para>The Titanium extensions to the server entity are:</para>
<itemizedlist>
<listitem>
<para>Adding capability to specify VIF-Model on a per-NIC basis when
creating/launching/booting a VM Server.</para>
</listitem>
<listitem>
<para>Adding capability to specify VIF-PCI Address on a per-NIC basis when
creating/launching/booting a VM Server.</para>
</listitem>
<listitem>
<para>Adding the ability to scale the resources (currently only
vCPUs) of a server up and down without requiring a restart of
the VM Server.</para>
</listitem>
<listitem>
<para>Adding an attribute to allow sorting of a VM Server's IP Addresses
in order of network attachment(NIC).</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#Servers">
<wadl:method href="#createServer"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#ServersDetail">
<wadl:method href="#listServersDetail"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#server_id">
<wadl:method href="#getServerDetail"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#action">
<wadl:method href="#scaleServer"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#os-interface">
<wadl:method href="#createInterface"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVER GROUPS -->
<!--*******************************************************-->
<section xml:id="ext-os-server-group">
<title>Server Groups (os-server-groups)</title>
<para>The Titanium extensions to the Server Groups entity are:</para>
<itemizedlist>
<listitem>
<para>Added a 'wrs-sg:project_id' attribute to assign tenant ownership to a
Server Group.</para>
</listitem>
<listitem>
<para>Added a 'wrs-sg:affinity-hyperthread' policy to indicate that members
of the Server Group are allowed to share hyperthread siblings.</para>
</listitem>
<listitem>
<para>Added a boolean 'wrs-sg:best_effort' metadata key/value in order to
specify whether the policy should be strictly enforced or not.</para>
</listitem>
<listitem>
<para>Added an integer 'wrs-sg:group_size' metadata key/value in order to
specify the maximum number of members in the group.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#os-server-groups">
<wadl:method href="#listServerGroups"/>
<wadl:method href="#createServerGroup"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#ServerGroup_id">
<wadl:method href="#showServerGroup"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- FLAVOR EXTRA SPECS -->
<!--*******************************************************-->
<section xml:id="compute-flavorextraspec">
<title>Flavor Extra Specs</title>
<para>Titanium Cloud has added several flavor extra specs, e.g.
<code>sw:wrs:guest:heartbeat</code>, <code>hw:wrs:shared_vcpu</code>,
<code>hw:wrs:min_vcpus</code>, <code>sw:wrs:vtpm</code> and many more.
For the complete list of additional flavor extra specs added by Titanium
Cloud, and an explanation of how to use them, please refer to the Wind River
Titanium Cloud Administration guide set.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#os-extra-specs">
<wadl:method href="#listExtra-specs"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#key_id">
<wadl:method href="#detailExtra-spec"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#os-extra-specs">
<wadl:method href="#createExtra-spec"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PROVIDER NETWORK -->
<!--*******************************************************-->
<section xml:id="wrs-providernet">
<title>Provider Network</title>
<para>The Titanium extensions to the Provider Network entity are:</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#providerNet">
<wadl:method href="#listProviderNet"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#providerNetGet">
<wadl:method href="#getProviderNetworkDetail"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- PCI DEVICE USAGE -->
<!--*******************************************************-->
<section xml:id="wrs-pci">
<title>PCI</title>
<para>The Titanium extensions to the PCI device entity are:</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#pciDevice">
<wadl:method href="#listPciDevice"/>
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#pciDeviceGet">
<wadl:method href="#getPciDeviceDetail"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- HYPERVISOR -->
<!--*******************************************************-->
<section xml:id="Hypervisors">
<title>Hypervisors</title>
<para>The Titanium extensions to the Hypervisor entity are:</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#Hypervisors">
</wadl:resource>
<wadl:resource
href="../wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl#hypervisor_id">
<wadl:method href="#ShowHypervisorDetail"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

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

@ -1,178 +0,0 @@
<?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>

110
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_fm-api-v1.xml
View File

@ -1,110 +0,0 @@
<?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="fmapi-v1"
role="api-reference">
<title>Fault Management API v1</title>
<para>The API supports alarm and event collection of the cloud platform itself. </para>
<para>The typical port used for the FM REST API is 18002.
However, proper technique would be to look up the FM service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-fm-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#versions">
<wadl:method href="#listVersions-fm-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#version">
<wadl:method href="#showVersionDetails-fm-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- ALARMS -->
<!--*******************************************************-->
<section xml:id="alarms-v1">
<title>Alarms</title>
<para>These APIs allow the display of the Active Alarms
in the system.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarms">
<wadl:method href="#listAlarms"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_uuid">
<wadl:method href="#getAlarm"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_uuid">
<wadl:method href="#deleteAlarm"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#alarm_summary">
<wadl:method href="#alarmSummary"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- EVENT LOG -->
<!--*******************************************************-->
<section xml:id="eventlog-v1">
<title>Event Log</title>
<para>These APIs allow the display of the Event Log
in the system. The Event log contains both historical alarms and customer logs.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_log">
<wadl:method href="#listEventLog"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_log_uuid">
<wadl:method href="#getEventLog"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- EVENT SUPPRESSION -->
<!--*******************************************************-->
<section xml:id="eventsuppression-v1">
<title>Event Suppression</title>
<para>These APIs allow the display of the Event Suppression state
in the system.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_suppression">
<wadl:method href="#listEventSuppression"/>
</wadl:resource>
<wadl:resource
href="../wadls/fm-api/v1/fm-api-v1.wadl#event_suppression_uuid">
<wadl:method href="#modifyEventSuppression"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

63
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_image-v2-cgcs-ext.xml
View File

@ -1,63 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE chapter[
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="image-v2-cgcs-ext"
role="api-reference">
<title>Image API v2 Titanium extensions</title>
<para>Titanium extensions to the OpenStack Image API to support
additional properties on images for customizing migration behaviour, supporting
raw cached images in ceph cluster, disabling VM auto-recovery and indicating
the backend where the image is stored.
</para>
<para>The typical port used for the Image REST API is 9292.
However, proper technique would be to look up the image/glance service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- IMAGES -->
<!--*******************************************************-->
<section xml:id="image-ext-action">
<title>Images</title>
<para>The Image entity is extended by Titanium Cloud to
have additional properties on images for customizing migration behaviour, supporting
raw cached images in ceph cluster, disabling VM auto-recovery and indicating
the backend where the image is stored. </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/image-api/v2/cgcs-ext/image-v2-cgcs-ext.wadl#images">
<wadl:method href="#addImage"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/v2/cgcs-ext/image-v2-cgcs-ext.wadl#images">
<wadl:method href="#listImages"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/v2/cgcs-ext/image-v2-cgcs-ext.wadl#image_id">
<wadl:method href="#getImage"/>
</wadl:resource>
<wadl:resource
href="../wadls/image-api/v2/cgcs-ext/image-v2-cgcs-ext.wadl#image_id">
<wadl:method href="#modifyImage"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

409
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_networking-v2-cgcs-ext.xml
View File

@ -1,409 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE chapter[
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="networking-v2-cgcs-ext"
role="api-reference">
<title>Networking API v2 Titanium extensions</title>
<para>This section describes changes made to the standard OpenStack Networking API for the Titanium Cloud. Some existing OpenStack API instances have been enhanced to add new attributes, or update the semantics of existing attributes. In other cases, entirely new API instances have been created to expose Titanium Cloud networking functionality via the standard RESTful API.</para>
<para>The typical port used for the Networking REST API is 9696.
However, proper technique would be to look up the neutron service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- EXTENSIONS -->
<!--*******************************************************-->
<section xml:id="networking-ext-list">
<title>Extensions</title>
<para>The Extensions entity lists all available extensions; both open-source extensions and Wind River (wrs-) extensions.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#extensions">
<wadl:method href="#listExtensions"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#extensionget">
<wadl:method href="#getExtension"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Providernets -->
<!--*******************************************************-->
<section xml:id="networking-providernet">
<title>Provider Network</title>
<para>The Provider Network entity is a new entity which was added to the OpenStack API. It enables management of provider networks via the RESTful API. The standard OpenStack API included no such entity; instead, the end user was required to edit static configuration files through the system to add, or update provider network information.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernets">
<wadl:method href="#listProvidernets"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernet_id">
<wadl:method href="#getProvidernet"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernets">
<wadl:method href="#createProvidernet"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernet_id">
<wadl:method href="#updateProvidernet"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernet_id">
<wadl:method href="#deleteProvidernet"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernet_bindings">
<wadl:method href="#listNetworksOnProviderNet"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Providernetranges -->
<!--*******************************************************-->
<section xml:id="networking-providernetrange">
<title>Provider Network Range</title>
<para>The Provider Network Range entity is a new entity which was added to the OpenStack API. It enables management of provider network segmentation ranges via the RESTful API. The standard OpenStack API included no such entity; instead, the end user was required to edit static configuration files through the system to add, or update provider network segmentation ranges.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetranges">
<wadl:method href="#listProvidernetranges"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetrange_id">
<wadl:method href="#getProvidernetrange"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetranges">
<wadl:method href="#createProvidernetrange"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetrange_id">
<wadl:method href="#updateProvidernetrange"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetrange_id">
<wadl:method href="#deleteProvidernetrange"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Providernettypes -->
<!--*******************************************************-->
<section xml:id="networking-providernettype">
<title>Provider Network Type</title>
<para>The Provider Network Type entity is a new entity which was added to the OpenStack API. It exists simply to allow the end user to query which provider network types are supported by the system.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernettypes">
<wadl:method href="#listProvidernettypes"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Providernetconnectivitytests -->
<!--*******************************************************-->
<section xml:id="networking-providernetconnectivitytest">
<title>Provider Network Connectivity Test</title>
<para>The Provider Network Connectivity Test entity is a new entity which was added to the OpenStack API. It enables the verification of provider network connectivity between compute nodes.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetconnectivitytests">
<wadl:method href="#listProvidernetconnectivitytests"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#providernetconnectivitytests">
<wadl:method href="#scheduleProvidernetconnectivitytest"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Hosts -->
<!-- ( Internal API ) -->
<!--*******************************************************-->
<!--
<section xml:id="networking-host">
<title>Neutron Host</title>
<para>The Host entity is a new entity which was added to the OpenStack API. It enables management of neutron services on a per compute host basis. As the availability status of compute hosts is updated the system reacts by migrating neutron services (i.e., DHCP servers, Layer3 Routers, etc.) to other available compute hosts.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#hosts">
<wadl:method href="#listHosts"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#host_id">
<wadl:method href="#getHost"/>
</wadl:resource>
</wadl:resources>
</section>
-->
<!--*******************************************************-->
<!-- Settings -->
<!--*******************************************************-->
<section xml:id="networking-setting">
<title>Tenant Settings</title>
<para>The Tenant Settings entity is a new entity which was added to the OpenStack API. It enables management of features or system behaviours on a per-tenant basis by the administrator.</para>
<para>This entity and all of its operations are only available to administrator level users.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#settings">
<wadl:method href="#listSettings"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#tenant_id">
<wadl:method href="#getSetting"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#tenant_id">
<wadl:method href="#updateSetting"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#tenant_id">
<wadl:method href="#deleteSetting"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- QOS policies -->
<!--*******************************************************-->
<section xml:id="networking-qos">
<title>QOS Policies</title>
<para>The QOS entity is a new entity which was added to the OpenStack API. It enables management of Quality of Service policies and profiles via the RESTful API. QOS policies can be created and maintained by the administrator.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#qoses">
<wadl:method href="#listQoses"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#qos_id">
<wadl:method href="#getQos"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#qoses">
<wadl:method href="#createQos"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#qos_id">
<wadl:method href="#updateQos"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#qos_id">
<wadl:method href="#deleteQos"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Networks -->
<!--*******************************************************-->
<section xml:id="networking-network">
<title>Network</title>
<para>The Network entity is an existing OpenStack API. It has been extended to add the following Titanium Cloud functionality.</para>
<itemizedlist>
<listitem>
<para>A QOS policy can optionally be associated to a tenant network</para>
</listitem>
<listitem>
<para>The maximum transmit unit (MTU) of each tenant network is inherited from its associated provider network</para>
</listitem>
<listitem>
<para>The status of each tenant network is derived from the state of the DHCP server which services its subnets</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#networks">
<wadl:method href="#listNetworks"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#network_id">
<wadl:method href="#showNetwork"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Subnets -->
<!--*******************************************************-->
<section xml:id="networking-subnet">
<title>Subnet</title>
<para>The Subnet entity is an existing OpenStack API. It has been extended to add the following Titanium Cloud functionality.</para>
<itemizedlist>
<listitem>
<para>A subnet can be configured to allow VLAN tagging by the VM instance.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#subnets">
<wadl:method href="#listSubnets"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#subnet_id">
<wadl:method href="#getSubnet"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#subnets">
<wadl:method href="#createSubnet"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Ports -->
<!--*******************************************************-->
<section xml:id="networking-port">
<title>Port</title>
<para>The Port entity is an existing OpenStack API. It has been extended to add the following Titanium Cloud functionality.</para>
<itemizedlist>
<listitem>
<para>The network interface type (vif_model) is recorded when attached to a VM instance.</para>
</listitem>
<listitem>
<para>Source MAC address filtering is enabled when created for a tenant which has this feature enabled by the administrator.</para>
</listitem>
<listitem>
<para>The MAC address automatically updates to reflect changes to PCI passthrough devices for VM instances.</para>
</listitem>
<listitem>
<para>The maximum transmit unit (MTU) attribute is a reflection of the MTU value of the attached tenant network.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#ports">
<wadl:method href="#listPorts"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#port_id">
<wadl:method href="#showPort"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Routers -->
<!--*******************************************************-->
<section xml:id="networking-router">
<title>Router</title>
<para>The Router entity is an existing OpenStack API. It has been extended to add the following Titanium Cloud functionality.</para>
<itemizedlist>
<listitem>
<para>The host attribute has been added to reflect which compute host implements the virtual router.</para>
</listitem>
</itemizedlist>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#routers">
<wadl:method href="#listRouters"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#router_id">
<wadl:method href="#showRouter"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Port Forwarding -->
<!--*******************************************************-->
<section xml:id="networking-portforwarding">
<title>Port Forwarding</title>
<para>The portfowarding entity is an upstream subproject that is not yet part of the existing OpenStack API. It provides virtual router port forwarding functionality. It has been included to add the functionality to the Titanium Cloud.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#portforwardings">
<wadl:method href="#listPortForwardings"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#portforwardings">
<wadl:method href="#createPortForwarding"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#portforwarding_id">
<wadl:method href="#showPortForwarding"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#portforwarding_id">
<wadl:method href="#updatePortForwarding"/>
</wadl:resource>
<wadl:resource
href="../wadls/networking-api/v2/cgcs-ext/networking-v2-cgcs-ext.wadl#portforwarding_id">
<wadl:method href="#deletePortForwarding"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

116
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_nfv-vim-api-v1.xml
View File

@ -1,116 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2016-2017 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="nfv-vim-v1"
role="api-reference">
<title>NFV VIM API v1</title>
<para>Manage patch orchestration with the Titanium Cloud NFV VIM API. This includes
creation, application and querying of patch strategies.</para>
<para>Manage upgrade orchestration with the Titanium Cloud NFV VIM API. This includes
creation, application and querying of upgrade strategies.</para>
<para>The typical port used for the NFV VIM REST API is 4545.
However, proper technique would be to look up the nfv vim service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-nfv-vim-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#nfv-vim">
<wadl:method href="#listLinks-nfv-vim"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#api">
<wadl:method href="#listVersions-nfv-vim-api"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#orchestration">
<wadl:method href="#listLinks-orchestration"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#sw-patch">
<wadl:method href="#listLinks-sw-patch"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#sw-upgrade">
<wadl:method href="#listLinks-sw-upgrade"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Patch Strategy -->
<!--*******************************************************-->
<section xml:id="patch-strategy-v1">
<title>Patch Strategy</title>
<para>Patch orchestration is done with a patch orchestration strategy,
or plan, for the automated patching procedure which contains a
number of parameters for customizing the particular behavior of the
patching orchestration.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#patch-strategy">
<wadl:method href="#getPatchStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#patch-strategy">
<wadl:method href="#createPatchStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#patch-strategy">
<wadl:method href="#deletePatchStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#patch-strategy-actions">
<wadl:method href="#patchStrategyActions"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Upgrade Strategy -->
<!--*******************************************************-->
<section xml:id="upgrade-strategy-v1">
<title>Upgrade Strategy</title>
<para>Upgrade orchestration is done with an upgrade orchestration strategy,
or plan, for the automated upgrade procedure which contains a
number of parameters for customizing the particular behavior of the
upgrade orchestration.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#upgrade-strategy">
<wadl:method href="#getUpgradeStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#upgrade-strategy">
<wadl:method href="#createUpgradeStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#upgrade-strategy">
<wadl:method href="#deleteUpgradeStrategy"/>
</wadl:resource>
<wadl:resource
href="../wadls/nfv-vim-api/v1/nfv-vim-api-v1.wadl#upgrade-strategy-actions">
<wadl:method href="#upgradeStrategyActions"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

97
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_patching-api-v1.xml
View File

@ -1,97 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 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="patching-v1"
role="api-reference">
<title>Patching API v1</title>
<para>Manage the patching of hosts with the Titanium Cloud Patching API.
This includes upload, application, installation, removal, deletion,
and querying.</para>
<para>The typical port used for the Patching REST API is 15491.
However, proper technique would be to look up the patching service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-patching-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#versions">
<wadl:method href="#listVersions-patching-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- Patches -->
<!--*******************************************************-->
<section xml:id="patches-v1">
<title>Patches</title>
<para>The patches used by the patching service to update individual
hosts in the cloud.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#patches">
<wadl:method href="#listPatches"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#showPatch">
<wadl:method href="#showPatch"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#upload">
<wadl:method href="#uploadPatch"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#doapply">
<wadl:method href="#applyPatch"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#doremove">
<wadl:method href="#removePatch"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#dodelete">
<wadl:method href="#deletePatch"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- HOSTS -->
<!--*******************************************************-->
<section xml:id="patchinghosts-v1">
<title>Hosts</title>
<para>Hosts are the physical hosts or servers for the system
as viewed by the patching service.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#hosts">
<wadl:method href="#queryHosts"/>
</wadl:resource>
<wadl:resource
href="../wadls/patching-api/v1/patching-api-v1.wadl#doinstallasync">
<wadl:method href="#hostInstallAsync"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

104
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_smapi-v1.xml
View File

@ -1,104 +0,0 @@
<?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="smapi-v1"
role="api-reference">
<title>SM API v1</title>
<para> Interact with Service Management </para>
<para>The typical port used for the SM REST API is 7777.
However, proper technique would be to look up the smapi service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-smapi-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#versions">
<wadl:method href="#listVersions-smapi-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#version">
<wadl:method href="#showVersionDetails-smapi-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICES -->
<!--*******************************************************-->
<section xml:id="smapi-services-v1">
<title>Services</title>
<para>These APIs allow the display of the services running
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#services">
<wadl:method href="#smlistServices"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#service_id">
<wadl:method href="#smgetService" />
</wadl:resource>
<!--<wadl:resource-->
<!--href="../wadls/sm-api/v1/sm-api-v1.wadl#service_name">-->
<!--<wadl:method href="#modifyService"/>-->
<!--</wadl:resource>-->
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICE NODES -->
<!--*******************************************************-->
<section xml:id="smapi-service-nodes-v1">
<title>Service Nodes</title>
<para>These APIs allow the display of the service nodes
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicenodes">
<wadl:method href="#smlistServiceNodes"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#node_id">
<wadl:method href="#smgetServiceNode" />
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICE GROUPS -->
<!--*******************************************************-->
<section xml:id="smapi-services-groups-v1">
<title>Service Groups</title>
<para>These APIs allow the display of the service groups
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup">
<wadl:method href="#smlistServiceGroups"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup_id">
<wadl:method href="#smgetServiceGroup" />
</wadl:resource>
</wadl:resources>
</section>
</chapter>

1383
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_sysinv-api-v1.xml
View File

File diff suppressed because it is too large Load Diff

53
restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -1,53 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE itemizedlist [
]>
<itemizedlist 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="service-list">
<listitem>
<para><link xlink:href="api-ref-compute-v2-cgcs-ext.html">Compute
API v2 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-networking-v2-cgcs-ext.html">Networking
API v2.0 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-blockstorage-v2-cgcs-ext.xml">Block Storage
API v2 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-image-v2-cgcs-ext.html">Image
API v2 Titanium extensions</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-sysinv-v1.html">Titanium System Inventory
API v1</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-patching-v1.html">Titanium Patching Service
API v1</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-nfv-vim-v1.html">Titanium NFV VIM Service
API v1</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-smapi-v1.html">Titanium SM API Service
API v1</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-fm-v1.html">Titanium Fault Management Service
API v1</link></para>
</listitem>
</itemizedlist>

26
restapi-doc/restapi-doc/api-ref/src/docbkx/preface.xml
View File

@ -1,26 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<preface 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="Overview">
<title>Titanium API Complete Reference</title>
<para>Use the Titanium APIs and extensions to launch server
instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your OpenStack cloud.</para>
<para>You must install the packages for each API separately. You
can use the APIs and extensions after you authenticate through
the Identity API.</para>
<para>To get started with the APIs, see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para>
</preface>

49
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/extension_get-response.json
View File

@ -1,49 +0,0 @@
{
"extension" : {
"namespace" : "http://docs.windriver.com/tis/ext/wrs-if/api/v1.0",
"name" : "wrs-server-if",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Interface Related Extensions",
"alias" : "wrs-if",
"links" : []
}
}
OR
{
"extension" : {
"namespace" : "http://docs.windriver.com/tis/ext/wrs-res/api/v1.0",
"name" : "wrs-server-resource",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Server Resource Extensions",
"alias" : "wrs-res",
"links" : []
}
}
OR
{
"extension" : {
"namespace" : "http://docs.windriver.com/tis/ext/wrs-sg/api/v1.0",
"name" : "wrs-server-group",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Server Group Extensions",
"alias" : "wrs-sg",
"links" : []
}
}
OR
{
"extension" : {
"namespace" : "http://docs.windriver.com/tis/ext/wrs/api/v1.0",
"name" : "wrs-flavor-extra-spec",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Extended Flavor Extra Spec Keys"
"alias" : "wrs",
"links" : []
}
}

39
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/extension_list-response.json
View File

@ -1,39 +0,0 @@
{
"extensions" : [
...
{
"namespace" : "http://docs.windriver.com/tis/ext/wrs-if/api/v1.0",
"name" : "wrs-server-if",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Interface Related Extensions",
"alias" : "wrs-if",
"links" : []
},
{
"namespace" : "http://docs.windriver.com/tis/ext/wrs-res/api/v1.0",
"name" : "wrs-server-resource",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Server Resource Extensions",
"alias" : "wrs-res",
"links" : []
},
{
"namespace" : "http://docs.windriver.com/tis/ext/wrs-sg/api/v1.0",
"name" : "wrs-server-group",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Server Grouip Extensions",
"alias" : "wrs-sg",
"links" : []
},
{
"namespace" : "http://docs.windriver.com/tis/ext/wrs/api/v1.0",
"name" : "wrs-flavor-extra-spec",
"updated" : "2014-08-16T00:00:00+00:00",
"description" : "WRS Extended Flavor Extra Spec Keys"
"alias" : "wrs",
"links" : []
},
...
]
}

5
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/flavor-extra-specs-create-request.json
View File

@ -1,5 +0,0 @@
{
"extra_specs": {
"sw:wrs:guest:heartbeat": "True",
}
}

5
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/flavor-extra-specs-create-response.json
View File

@ -1,5 +0,0 @@
{
"extra_specs": {
"sw:wrs:guest:heartbeat": "True",
}
}

3
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/flavor-extra-specs-get-response.json
View File

@ -1,3 +0,0 @@
{
"sw:wrs:guest:heartbeat": "True",
}

13
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/flavor-extra-specs-list-response.json
View File

@ -1,13 +0,0 @@
{
"extra_specs": {
"sw:wrs:guest:heartbeat": "True",
"sw:wrs:srv_grp_messaging": "True",
"sw:wrs:vtpm": "False",
"hw:numa_node.0": "1",
"hw:wrs:vcpu:scheduler": "fifo:50:0"
"hw:wrs:min_vcpus": "2"
"hw:wrs:shared_vcpu": "1"
"hw:cpu_model": "Nehalem"
"aggregate_instance_extra_specs:localstorage": "False"
}
}

110
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/hypervisor-get-resp.json
View File

@ -1,110 +0,0 @@
{
"hypervisor":{
"memory_mb_used_by_node":"{\"0\": {\"2M\": 5120, \"4K\": 0, \"1G\": 0}, \"1\": {\"2M\": 0, \"4K\": 0, \"1G\": 0}}",
"cpu_info":{
"arch":"x86_64",
"model":"IvyBridge",
"vendor":"Intel",
"features":[
"pge",
"avx",
"vmx",
"clflush",
"sep",
"syscall",
"vme",
"dtes64",
"tsc",
"sse",
"xsave",
"xsaveopt",
"erms",
"xtpr",
"cmov",
"smep",
"ssse3",
"est",
"pat",
"monitor",
"smx",
"pcid",
"lm",
"msr",
"nx",
"fxsr",
"tm",
"sse4.1",
"pae",
"sse4.2",
"pclmuldq",
"acpi",
"tsc-deadline",
"popcnt",
"mmx",
"osxsave",
"cx8",
"mce",
"de",
"tm2",
"ht",
"dca",
"pni",
"pdcm",
"mca",
"pdpe1gb",
"apic",
"fsgsbase",
"f16c",
"pse",
"ds",
"invtsc",
"lahf_lm",
"aes",
"sse2",
"ss",
"ds_cpl",
"arat",
"pbe",
"fpu",
"cx16",
"pse36",
"mtrr",
"rdrand",
"rdtscp",
"x2apic"
],
"topology":{
"cores":10,
"cells":2,
"threads":2,
"sockets":1
}
},
"free_disk_gb":208,
"memory_mb_used":5120,
"vcpus_by_node":"{\"0\": 14, \"1\": 20}",
"memory_mb_by_node":"{\"0\": {\"2M\": 21440, \"4K\": 0, \"1G\": 0}, \"1\": {\"2M\": 29088, \"4K\": 0, \"1G\": 0}}",
"service":{
"host":"compute-1",
"disabled_reason":null,
"id":8
},
"local_gb_used":9,
"id":2,
"current_workload":0,
"state":"up",
"vcpus_used_by_node":"{\"0\": {\"shared\": 0.125, \"dedicated\": 6}, \"1\": {\"shared\": 0.0, \"dedicated\": 0}}",
"status":"enabled",
"host_ip":"192.168.205.205",
"hypervisor_hostname":"compute-1",
"hypervisor_version":2006000,
"disk_available_least":208,
"local_gb":219,
"free_ram_mb":45408,
"vcpus_used":6.125,
"hypervisor_type":"QEMU",
"memory_mb":50528,
"vcpus":34,
"running_vms":7
}
}

15
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/os-server-groups/server-groups-get-resp.json
View File

@ -1,15 +0,0 @@
{
"server_group": {
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"wrs-sg:project_id": "28d41dbebab24bdf8854a6632271a3f6"
"name": "callservergroup",
"policies": [
"wrs-sg:affinity-hyperthread"
],
"members": [],
"metadata": {
"wrs-sg:best_effort": "1",
"wrs-sg:group_size": "2"
}
}
}

27
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/os-server-groups/server-groups-list-resp.json
View File

@ -1,27 +0,0 @@
{
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"wrs-sg:project_id": "28d41dbebab24bdf8854a6632271a3f6"
"name": "callservergroup",
"policies": [
"wrs-sg:affinity-hyperthread"
],
"members": [],
"metadata": {
"wrs-sg:best_effort": "1",
"wrs-sg:group_size": "2"
}
},
{
"id": "2fb919a2-4666-11e4-9255-080027367628",
"wrs-sg:project_id": "28d41dbebab24bdf8854a6632271a3f6"
"name": "antiaffinitygroup",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
]
}

13
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/os-server-groups/server-groups-post-req.json
View File

@ -1,13 +0,0 @@
{
"server_group": {
"name": "antiaffinitygroup",
"wrs-sg:project_id": "28d41dbebab24bdf8854a6632271a3f6"
"policies": [
"anti-affinity"
],
"metadata": {
"wrs-sg:best_effort": "1",
"wrs-sg:group_size": "2"
}
}
}

15
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/os-server-groups/server-groups-post-resp.json
View File

@ -1,15 +0,0 @@
{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"wrs-sg:project_id": "28d41dbebab24bdf8854a6632271a3f6"
"name": "antiaffinitygroup",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {
"wrs-sg:best_effort": "1",
"wrs-sg:group_size": "2"
}
}
}

48
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/pci-get-resp.json
View File

@ -1,48 +0,0 @@
{
"pci_device_usage": [
{
"pci_vfs_used": 0,
"host": "compute-3",
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_configured": 0,
"device_name": "Coleto Creek PCIe Co-processor",
"vendor_id": "8086",
"device_id": "0443",
"class_id": "0b4000"
},
{
"pci_vfs_used": 1,
"host": "compute-1",
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_configured": 32,
"device_name": "Coleto Creek PCIe Co-processor",
"vendor_id": "8086",
"device_id": "0443",
"class_id": "0b4000"
},
{
"pci_vfs_used": 0,
"host": "compute-2",
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_configured": 0,
"device_name": "Coleto Creek PCIe Co-processor",
"vendor_id": "8086",
"device_id": "0443",
"class_id": "0b4000"
},
{
"pci_vfs_used": 0,
"host": "compute-0",
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_configured": 32,
"device_name": "Coleto Creek PCIe Co-processor",
"vendor_id": "8086",
"device_id": "0443",
"class_id": "0b4000"
}
]
}

14
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/pci-list-resp.json
View File

@ -1,14 +0,0 @@
{
"pci_device_usage": [
{
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_used": 1,
"vendor_id": "8086",
"pci_vfs_configured": 64,
"device_name": "Coleto Creek PCIe Co-processor",
"device_id": "0443",
"class_id": "0b4000"
}
]
}

10
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/providernet-get-resp.json
View File

@ -1,10 +0,0 @@
{
"providernet": {
"pci_pfs_used": 0,
"pci_pfs_configured": 0,
"pci_vfs_used": 1,
"pci_vfs_configured": 16,
"id": "21c41131-07fb-43ac-a6f3-8a8020152530",
"name": "group0-data0"
}
}

86
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server-get-resp.json
View File

@ -1,86 +0,0 @@
{
"server" : {
"accessIPv4" : "",
"wrs-if:nics" : [
{
"nic1" : {
"network" : "tenant1-mgmt-net",
"port_id" : "dc627524-64a9-4fec-957a-b271f353fb22",
"vif_model" : "virtio",
"vif_pci_address": "0000:04:12.0",
"mtu" : 1500
}
}
],
"OS-EXT-SRV-ATTR:instance_name" : "instance-0000003d",
"OS-SRV-USG:terminated_at" : null,
"accessIPv6" : "",
"config_drive" : "",
"OS-DCF:diskConfig" : "MANUAL",
"wrs-sg:server_group" : "",
"updated" : "2015-04-01T20:32:57Z",
"metadata" : {},
"id" : "770a214c-5d22-42ce-9273-f6baab0ad7fd",
"flavor" : {
"id" : "00bbded9-318a-461a-aef8-3904356ca8d9",
"links" : [
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/flavors/00bbded9-318a-461a-aef8-3904356ca8d9"
}
]
},
"links" : [
{
"rel" : "self",
"href" : "http://128.224.151.243:8774/v2/101d1cffc5ec4accbdb075c89a4c5cd7/servers/770a214c-5d22-42ce-9273-f6baab0ad7fd"
},
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/servers/770a214c-5d22-42ce-9273-f6baab0ad7fd"
}
],
"OS-EXT-SRV-ATTR:host" : "compute-0",
"OS-EXT-AZ:availability_zone" : "nova",
"name" : "vm07-shared-vcpu-id",
"hostId" : "938254ae1b04aabc901dd4ad2cf2a561a4eab858efa0b0a48eb048ff",
"user_id" : "13dbcb9d22474c39a4a612cd44bf58ad",
"status" : "ACTIVE",
"wrs-res:topology" : "node:1, 1024MB, pgsize:4K, vcpus:3",
"wrs-res:pci_devices": "node:1, addr:0000:83:04.6, type:VF, vendor:8086, product:0443",
"OS-EXT-STS:power_state" : 1,
"OS-EXT-SRV-ATTR:hypervisor_hostname" : "compute-0",
"tenant_id" : "101d1cffc5ec4accbdb075c89a4c5cd7",
"OS-SRV-USG:launched_at" : "2015-04-01T20:32:57.000000",
"OS-EXT-STS:vm_state" : "active",
"OS-EXT-STS:task_state" : null,
"progress" : 0,
"key_name" : null,
"image" : {
"id" : "a99dfaa7-c850-4a63-ad99-d4a5f8da3069",
"links" : [
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/images/a99dfaa7-c850-4a63-ad99-d4a5f8da3069"
}
]
},
"wrs-res:vcpus (min/cur/max)" : [
3,
3,
3
],
"created" : "2015-04-01T20:32:49Z",
"addresses" : {
"tenant1-mgmt-net" : [
{
"OS-EXT-IPS:type" : "fixed",
"version" : 4,
"OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:fc:65:81",
"addr" : "192.168.102.6"
}
]
},
"os-extended-volumes:volumes_attached" : []
}
}

6
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server-interface-attach-request.json
View File

@ -1,6 +0,0 @@
{
"interfaceAttachment": {
"net_id": "e8b9af5e-1f47-429e-9ee0-fef202d4ea14",
"wrs-if:vif_model": "virtio"
}
}

88
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server-list-resp.json
View File

@ -1,88 +0,0 @@
{
"servers" : [
{
"accessIPv4" : "",
"wrs-if:nics" : [
{
"nic1" : {
"network" : "tenant1-mgmt-net",
"port_id" : "dc627524-64a9-4fec-957a-b271f353fb22",
"vif_model" : "virtio",
"vif_pci_address": "0000:04:12.0",
"mtu" : 1500
}
}
],
"OS-EXT-SRV-ATTR:instance_name" : "instance-0000003d",
"OS-SRV-USG:terminated_at" : null,
"accessIPv6" : "",
"config_drive" : "",
"OS-DCF:diskConfig" : "MANUAL",
"wrs-sg:server_group" : "",
"updated" : "2015-04-01T20:32:57Z",
"metadata" : {},
"id" : "770a214c-5d22-42ce-9273-f6baab0ad7fd",
"flavor" : {
"id" : "00bbded9-318a-461a-aef8-3904356ca8d9",
"links" : [
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/flavors/00bbded9-318a-461a-aef8-3904356ca8d9"
}
]
},
"links" : [
{
"rel" : "self",
"href" : "http://128.224.151.243:8774/v2/101d1cffc5ec4accbdb075c89a4c5cd7/servers/770a214c-5d22-42ce-9273-f6baab0ad7fd"
},
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/servers/770a214c-5d22-42ce-9273-f6baab0ad7fd"
}
],
"OS-EXT-SRV-ATTR:host" : "compute-0",
"OS-EXT-AZ:availability_zone" : "nova",
"name" : "vm07-shared-vcpu-id",
"hostId" : "938254ae1b04aabc901dd4ad2cf2a561a4eab858efa0b0a48eb048ff",
"user_id" : "13dbcb9d22474c39a4a612cd44bf58ad",
"status" : "ACTIVE",
"wrs-res:topology" : "node:1, 1024MB, pgsize:4K, vcpus:3",
"wrs-res:pci_devices": "node:1, addr:0000:83:04.6, type:VF, vendor:8086, product:0443",
"OS-EXT-STS:power_state" : 1,
"OS-EXT-SRV-ATTR:hypervisor_hostname" : "compute-0",
"tenant_id" : "101d1cffc5ec4accbdb075c89a4c5cd7",
"OS-SRV-USG:launched_at" : "2015-04-01T20:32:57.000000",
"OS-EXT-STS:vm_state" : "active",
"OS-EXT-STS:task_state" : null,
"progress" : 0,
"key_name" : null,
"image" : {
"id" : "a99dfaa7-c850-4a63-ad99-d4a5f8da3069",
"links" : [
{
"rel" : "bookmark",
"href" : "http://128.224.151.243:8774/101d1cffc5ec4accbdb075c89a4c5cd7/images/a99dfaa7-c850-4a63-ad99-d4a5f8da3069"
}
]
},
"wrs-res:vcpus (min/cur/max)" : [
3,
3,
3
],
"created" : "2015-04-01T20:32:49Z",
"addresses" : {
"tenant1-mgmt-net" : [
{
"OS-EXT-IPS:type" : "fixed",
"version" : 4,
"OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:fc:65:81",
"addr" : "192.168.102.6"
}
]
},
"os-extended-volumes:volumes_attached" : []
}
]
}

6
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server-scale-up-request.json
View File

@ -1,6 +0,0 @@
{
"wrs-res:scale": {
"direction": "up",
"resource": cpu
}
}

20
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server_add-request.json
View File

@ -1,20 +0,0 @@
{
"server": {
"name": "testvm",
"imageRef": "ec42f67b-1dcd-4f09-aa02-7a426737c20a",
"flavorRef": "2",
"networks": [
{
"wrs-if:vif_model": "e1000",
"uuid": "06937e9e-0acd-4ad5-a6bb-f82d8896d5e8"
},
{
"wrs-if:vif_pci_address": "0000:04:12.0",
"uuid": "cdc149b5-9122-4a16-975c-6acb973f49c3"
},
{
"uuid": "b7adf5a0-3c5a-47f3-b733-8d56d12d2f45"
}
]
}
}

16
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/api_samples/compute-v2-cgcs-ext/server_add-response.json
View File

@ -1,16 +0,0 @@
{
"server": {
"adminPass": "yjzytFHb7XHc",
"id": "f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"rel": "bookmark"
}
]
}
}

1039
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/cgcs-ext/compute-v2-cgcs-ext.wadl
View File

File diff suppressed because it is too large Load Diff

321
restapi-doc/restapi-doc/api-ref/src/wadls/compute-api/v2/common.ent
View File

@ -1,321 +0,0 @@
<!-- Extension List/Show Parameters -->
<!ENTITY extensionListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="namespace" 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>Indicates namespace of the extension.</para>
</wadl:doc>
</param>
<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>Indicates name of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="updated" 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>Indicates updated time of the extension.</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>Indicates description of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alias" 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>Indicates alias of the extension.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" 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>A list of links for the extension.</para>
</wadl:doc>
</param>
'>
<!--
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:computeFault"/>
<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>
<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="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<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>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:NetworkNotFound"/>
<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>
'>
<!--
Faults that can occur when we are building servers or images.
-->
<!ENTITY buildFaults
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Holds build in progress which occurs when an operation fails
because the server is in the process of being built.
-->
<!ENTITY inProgressFault
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
<representation mediaType="application/json"/>
</response>
'>
<!-- Server Group List/Show Parameters -->
<!ENTITY serverGroupsParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="wrs-sg:project_id" required="true"
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 tenant or project owning the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
<para>Titanium Cloud added <code>wrs-sg:affinity-hyperthread</code> policy to indicate that <code>only</code> the
members of this server group can share sibling threads with each other.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
<para>Titanium Cloud added a boolean valued <code>wrs-sg:best_effort</code> metadata key-and-value
pair to indicate whether the server groups policy should be strictly enforced
or not.</para>
<para>Titanium Cloud added an integer valued <code>wrs-sg:group_size</code> metadata key-and-value
pair to indicate the maximum number of members of the server group.</para>
</wadl:doc>
</param>
'>
<!-- Server List/Show Parameters -->
<!ENTITY serverParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="nics" style="plain" type="xsd:list" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>nics</code> object. Contains the list of NICs provisioned on the server
instance.</para>
<para>Optionally, in Titanium Cloud, each NIC can contain:</para>
<itemizedlist>
<listitem>
<para>A <code>wrs-if:vif_model</code> attribute specifying the NICs vif model;
where valid vif model values are: <code>e1000</code>,
<code>virtio</code>, <code>ne2k_pci</code>, <code>pcnet</code>,
<code>rtl8139</code>, <code>pci-passthrough</code>,
<code>pci-sriov</code>. If not specified,
a vif model of <code>virtio</code> is being used.</para>
</listitem>
<listitem>
<para>A <code>wrs-if:vif_pci_address</code> attibute specifying the NICs PCI
address. If not specified, the PCI address in the guest is chosen by the
hypervisor and this value is empty.
</para>
</listitem>
</itemizedlist>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="addresses" style="plain" type="xsd:list" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>An <code>addresses</code> object. Contains
the list of addresses associated with the server instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="wrs-if:nics" style="plain" type="xsd:list" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>An <code>wrs-if:nics</code> object. Contains
the list of NIC devices allocated for a VM instance. These
are a VM representation of the neutron port objects associated
to the VM. They are listed in the same order which the network
attachments were specified when the VM was launched.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="wrs-res:topology" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>This attribute specifies a number of resource details of the VM Server;
the number of numa nodes, the amount of memory and the memory page size,
and the current number of VCPUs.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="wrs-res:pci_devices" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>List of pci devices associated with the server instance;
indicates the numa node, pci address, type of device, vendor id,
product id.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="wrs-res:vcpus (min/cur/max)" style="plain" type="xsd:list" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>This attribute specifies the minimum number of vcpus, current number of
vcpus and maximum number of vcpus of a VM Server.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="wrs-sg:server_group" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>This attribute specifies the server group which the
VM Server is in; a null-string if the VM Server is not in a
server group.</para>
</wadl:doc>
</param>
'>
<!-- Flavor Extra Spec List/Show Parameters -->
<!ENTITY flavorextraspecListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sw:wrs:guest:heartbeat" style="plain" type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates whether or not the guest applications running in the virtual
machine make use of the Titanium Cloud Heartbeat client API.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sw:wrs:vtpm" style="plain" type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates whether or not to expose a TPM device to the Guest.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="hw:wrs:shared_vcpu" style="plain" type="xsd:integer" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates the vCPU of the guest virtual machine that will be scheduled
to run on a shared CPU of the host. Note, this can be specified even if
hw:cpu_policy is set to dedicated; allowing the guest application to use
dedicated cores exclusively for its high-load tasks, but use a shared core
for its low-load (e.g. management type) tasks.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="hw:wrs:min_vcpus" style="plain" type="xsd:integer" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Indicates the minimum number of vCPUs for the virtual machine. The value
must be between one and the number of VCPUs in the flavor of the virtual
machine. If this extra_spec is specified then the server is assumed to support
vCPU scaling.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name=" extra spec " style="plain" type="xsd:integer" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>See Wind River Titanium Cloud Administration Guide for complete list of
additional flavor extra specs.</para>
</wadl:doc>
</param>
'>
<!-- 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>'>

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

@ -1,13 +0,0 @@
{
"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
View File

@ -1,16 +0,0 @@
{
"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
View File

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

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

@ -1,10 +0,0 @@
{
"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
View File

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

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

@ -1,28 +0,0 @@
{
"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
View File

@ -1,12 +0,0 @@
{
"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
View File

@ -1,7 +0,0 @@
{
"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
View File

@ -1,12 +0,0 @@
{
"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
View File

@ -1,6 +0,0 @@
{
"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
View File

@ -1,10 +0,0 @@
{
"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
View File

@ -1,10 +0,0 @@
{
"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
View File

@ -1,34 +0,0 @@
{
"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
View File

@ -1,10 +0,0 @@
{
"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
View File

@ -1,10 +0,0 @@
{
"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
View File

@ -1,16 +0,0 @@
{
"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
View File

@ -1,15 +0,0 @@
{
"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
View File

@ -1,5 +0,0 @@
{
"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
View File

@ -1,83 +0,0 @@
{
"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
View File

@ -1,38 +0,0 @@
{
"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
View File

@ -1,5 +0,0 @@
{
"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
View File

@ -1,16 +0,0 @@
{
"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
View File

@ -1,390 +0,0 @@
<!--
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
View File

@ -1,841 +0,0 @@
<?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>

18
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm-response.json
View File

@ -1,18 +0,0 @@
{
"alarm_state": "set",
"service_affecting": "True",
"proposed_repair_action": "contact next level of support",
"alarm_type": "processing-error",
"severity": "minor",
"created_at": "2014-09-23T00:38:16.797155+00:00",
"entity_type_id": "host",
"probable_cause": "key-expired",
"updated_at": "2014-09-24T00:38:17.403135+00:00",
"alarm_id": "400.003",
"entity_instance_id": "system=big_lab.host=controller-0",
"suppression": "False",
"timestamp": "2014-09-24T00:38:17.400169+00:00",
"uuid": "2a88acd3-e9eb-432e-bc0a-4276e3537a40",
"reason_text": "evaluation license key will exprire on 31-dec-2014",
"mgmt_affecting": "critical"
}

1
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-request.json
View File

@ -1 +0,0 @@
http://192.168.204.2:18002/v1/alarms?q.field=severity&q.op=eq&q.type=&q.value=major&include_suppress=True

24
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_list-response.json
View File

@ -1,24 +0,0 @@
{
"ialarms":[
{
"severity":"major",
"timestamp":"2016-05-12T12:11:10.405609",
"uuid":"25d28c97-70e4-45c7-a896-ba8e71a81f26",
"alarm_id":"400.002",
"entity_instance_id":"service_domain=controller.service_group=oam-services",
"suppression_status":"suppressed",
"reason_text":"Service group oam-services loss of redundancy; expected 1 standby member but no standby members available",
"mgmt_affecting": "warning"
},
{
"severity":"major",
"timestamp":"2016-05-12T12:08:12.850730",
"uuid":"63c94239-2d16-4a30-a910-60198de1c0a8",
"alarm_id":"200.001",
"entity_instance_id":"host=controller-1",
"suppression_status":"unsuppressed",
"reason_text":"controller-1 was administratively locked to take it out-of-service.",
"mgmt_affecting": "warning"
}
]
}

8
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/alarm_summary-response.json
View File

@ -1,8 +0,0 @@
{
"status": "OK",
"major": 0,
"warnings": 0,
"system_uuid": "6a314f63-4969-46f8-9221-b69b6b50424c",
"critical": 0,
"minor": 0
}

Some files were not shown because too many files have changed in this diff Show More