starlingx
/
integ
Code Issues Proposed changes

Decouple Fault Management from stx-config 

Add FM rest API document
Remove the alarm and log APIs from sysinv rest API document
Update the collect script with the FM config file new location

Story: 2002828
Task: 22747

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

Change-Id: Ica507af0b6b0dc137bf1e469cdaed678917f24e8
Signed-off-by: Tao Liu <tao.liu@windriver.com>
This commit is contained in:
Tao Liu 2018-08-16 12:05:42 -04:00
parent fe36f11192
commit 40447bfa0d
33 changed files with 1235 additions and 799 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -154,6 +154,17 @@ SPDX-License-Identifier: Apache-2.0
<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>

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

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

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

@ -49,4 +49,5 @@ SPDX-License-Identifier: Apache-2.0
<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>

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

@ -87,6 +87,17 @@ SPDX-License-Identifier: Apache-2.0
<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>

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

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

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

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

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

@ -16,8 +16,8 @@ SPDX-License-Identifier: Apache-2.0
<title>SysInv API v1</title>
<para>Manage physical servers with the Titanium System Inventory API. This includes
inventory collection and configuration of nodes, ports, interfaces, CPUs, disks,
partitions, memory, and sensors. The API also supports alarm collection for fault
events of the cloud itself as well as configuration of the cloud's SNMP interface. </para>
partitions, memory, and sensors. The API also supports configuration of the
cloud's SNMP interface. </para>
<para>The typical port used for the SysInv REST API is 6385.
However, proper technique would be to look up the sysinv service endpoint in Keystone.</para>
@ -633,77 +633,6 @@ configuration entity for the system.
</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/sysinv-api/v1/sysinv-api-v1.wadl#alarms">
<wadl:method href="#listAlarms"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#alarm_uuid">
<wadl:method href="#getAlarm"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#alarm_uuid">
<wadl:method href="#deleteAlarm"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-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/sysinv-api/v1/sysinv-api-v1.wadl#event_log">
<wadl:method href="#listEventLog"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-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/sysinv-api/v1/sysinv-api-v1.wadl#event_suppression">
<wadl:method href="#listEventSuppression"/>
</wadl:resource>
<wadl:resource
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#event_suppression_uuid">
<wadl:method href="#modifyEventSuppression"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- COMMUNITIES -->
<!--*******************************************************-->

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

@ -46,4 +46,8 @@ SPDX-License-Identifier: Apache-2.0
<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>

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

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

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

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

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

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

@ -0,0 +1 @@
http://192.168.204.2:18002/v1/event_log?q.field=start&q.field=end&q.op=eq&q.op=eq&q.type=&q.type=&q.value=2014-11-28T16%3A56%3A44&q.value=2014-11-28T16%3A56%3A45&limit=2

0
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_list-response.json → restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_list-response.json
View File

0
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_log_show-response.json → restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_log_show-response.json
View File

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

@ -0,0 +1 @@
http://192.168.204.2:18002/v1/event_suppression

0
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_list-response.json → restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_list-response.json
View File

0
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-request.json → restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-request.json
View File

0
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/event_suppression_modify-response.json → restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/event_suppression_modify-response.json
View File

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

@ -0,0 +1,24 @@
{
"default_version": {
"id": "v1",
"links": [
{
"href": "http://192.168.204.2:18002/v1/",
"rel": "self"
}
]
},
"versions": [
{
"id": "v1",
"links": [
{
"href": "http://192.168.204.2:18002/v1/",
"rel": "self"
}
]
}
],
"name": "Fault Management API",
"description": "Fault Management is an OpenStack project which provides REST API services for alarms and logs."
}

24
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/version-get-response.json Normal file
View File

@ -0,0 +1,24 @@
{
"default_version": {
"id": "v1",
"links": [
{
"href": "http://192.168.204.2:18002/v1/",
"rel": "self"
}
]
},
"versions": [
{
"id": "v1",
"links": [
{
"href": "http://192.168.204.2:18002/v1/",
"rel": "self"
}
]
}
],
"name": "Fault Management API",
"description": "Fault Management is an OpenStack project which provides REST API services for alarms and logs."
}

50
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/api_samples/versionv1-get-response.json Normal file
View File

@ -0,0 +1,50 @@
{
"media_types": [
{
"base": "application/json",
"type": "application/vnd.openstack.fm.v1+json"
}
],
"links": [
{
"href": "http://192.168.204.2:18002/v1/",
"rel": "self"
},
{
"href": "http://www.windriver.com/developer/fm/dev/api-spec-v1.html",
"type": "text/html",
"rel": "describedby"
}
],
"event_log": [
{
"href": "http://192.168.204.2:18002/v1/event_log/",
"rel": "self"
},
{
"href": "http://192.168.204.2:18002/event_log/",
"rel": "bookmark"
}
],
"alarms": [
{
"href": "http://192.168.204.2:18002/v1/alarms/",
"rel": "self"
},
{
"href": "http://192.168.204.2:18002/alarms/",
"rel": "bookmark"
}
],
"event_suppression": [
{
"href": "http://192.168.204.2:18002/v1/event_suppression/",
"rel": "self"
},
{
"href": "http://192.168.204.2:18002/event_suppression/",
"rel": "bookmark"
}
],
"id": "v1"
}

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

@ -0,0 +1,436 @@
<!--
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>'>
<!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>
'>
<!-- COMMON List/Show Parameters -->
<!ENTITY commonListShowParameters '
<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 universally unique identifier for this object.</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>For convenience, resources contain links to themselves.
This allows a client to easily obtain rather than construct
resource URIs. The following types of link relations are
associated with resources: a self link containing a versioned
link to the resource, and a bookmark link containing a permanent
link to a resource that is appropriate for long term storage.</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>
'>
<!-- Alarm List/Show Parameters -->
<!ENTITY alarmListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_id" 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 alarm ID; each type of alarm has a unique ID. Note
the alarm_id and the entity_instance_id uniquely identify
an alarm instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_instance_id" 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 instance of the object raising alarm. A . separated list
of sub-entity-type=instance-value pairs, representing the containment
structure of the overall entity instance. Note
the alarm_id and the entity_instance_id uniquely identify
an alarm instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="reason_text" 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 text description of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="severity" 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 severity of the alarm; <code>critical</code>,
<code>major</code>, <code>minor</code>, or <code>warning</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="timestamp" 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 in UTC at which the alarm has last been updated.</para>
</wadl:doc>
</param>
<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 of the alarm.</para>
</wadl:doc>
</param>
'>
<!ENTITY alarmDetailShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_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 the alarm; <code>set</code> or <code>clear</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_affecting" 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 whether the alarm affects the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="proposed_repair_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>The proposed action to clear the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_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>The type of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_type_id" 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 type of the object raising the alarm. A . separated list
of sub-entity-type, representing the containment structure of the
overall entity type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="probable_cause" 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 probable cause of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression" 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 whether suppression of the specific alarm is allowed.</para>
</wadl:doc>
</param>
'>
<!ENTITY alarmSummaryShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="system_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>UUID of the system.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="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>Overall system status based on alarms present; <code>critical</code>,
<code>degraded</code>, or <code>OK</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="critical" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of critical alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="major" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of major alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minor" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of minor alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="warnings" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of warnings on the system</para>
</wadl:doc>
</param>
'>
<!-- Event Log List/Show Parameters -->
<!ENTITY eventLogListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log_id" 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 event log ID; each type of event log has a unique ID. Note
the event_log_id and the entity_instance_id uniquely identify
an event log instance.</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 the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_instance_id" 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 instance of the object generating the event log. A . separated list
of sub-entity-type=instance-value pairs, representing the containment
structure of the overall entity instance. Note
the event_log_id and the entity_instance_id uniquely identify
an event log instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="reason_text" 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 text description of the event log.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="severity" 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 severity of the event log; <code>critical</code>,
<code>major</code>, <code>minor</code> or <code>warning</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="timestamp" 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 in UTC at which the event log has last been updated.</para>
</wadl:doc>
</param>
<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 of the event log.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="next" 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 next attribute is the request to use to get the next n
items. It is used to paginate the event log list.</para>
</wadl:doc>
</param>
'>
<!ENTITY eventLogDetailShowParameters '
<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 the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_affecting" 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 whether the event affects the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="proposed_repair_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>The proposed action to clear the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log_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>The type of the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_type_id" 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 type of the object raising the alarm. A . separated list
of sub-entity-type, representing the containment structure of the
overall entity type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="probable_cause" 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 probable cause of the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression" 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 whether suppression of the specific event is allowed.</para>
</wadl:doc>
</param>
'>
<!-- Event Suppression List/Show Parameters -->
<!ENTITY EventSuppressionListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_id" 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 alarm ID type (event ID type) that can be suppressed or unsuppressed.
</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 text description of the event type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression_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 suppression status for the event ID type; <code>suppressed</code> or <code>unsuppressed</code></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>'>

469
restapi-doc/restapi-doc/api-ref/src/wadls/fm-api/v1/fm-api-v1.wadl Normal file
View File

@ -0,0 +1,469 @@
<?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/fm/" xml:id="fm-v1">
<!-- / -->
<resource id="versions" path="//">
<method href="#listVersions-fm-v1"/>
</resource>
<!-- /v1 -->
<resource id="version" type="#VersionDetails" path="//v1">
<!-- /v1/alarms -->
<resource id="alarms" path="alarms">
<method href="#listAlarms"/>
<!-- /v1/alarms/{alarm_uuid} -->
<resource id="alarm_uuid" path="{alarm_uuid}" >
<param name="alarm_uuid" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing active alarm.</para>
</wadl:doc>
</param>
<method href="#getAlarm"/>
<method href="#deleteAlarm"/>
</resource>
<!-- /v1/ialarms/summary -->
<resource id="alarm_summary" path="summary" >
<method href="#alarmSummary"/>
</resource>
</resource>
<!-- /v1/event_log -->
<resource id="event_log" path="event_log">
<method href="#listEventLog"/>
<!-- /v1/event_log/{log_uuid} -->
<resource id="event_log_uuid" path="{log_uuid}" >
<param name="log_uuid" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an event log.</para>
</wadl:doc>
</param>
<method href="#getEventLog"/>
</resource>
</resource>
<!-- /v1/event_suppression -->
<resource id="event_suppression" path="event_suppression">
<method href="#listEventSuppression"/>
</resource>
<!-- /v1/event_suppression/{event_suppression_uuid} -->
<resource id="event_suppression_uuid" path="event_suppression/{event_suppression_uuid}" >
<param name="event_suppression_uuid" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an event suppression.</para>
</wadl:doc>
</param>
<method href="#modifyEventSuppression"/>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- RESOURCE TYPES -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Version details">
<para>API version details.</para>
</wadl:doc>
<method href="#showVersionDetails-fm-v1"/>
</resource_type>
<!--*******************************************************-->
<!-- METHODS -->
<!--*******************************************************-->
<!-- ..................................................... -->
<!-- .. Versions .. -->
<!-- ..................................................... -->
<method name="GET" id="listVersions-fm-v1">
<wadl:doc xml:lang="EN" title="List API versions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all Fault Management 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/fm-versions-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="showVersionDetails-fm-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show API v1 details">
<para role="shortdesc">Shows details for Fault Management API v1.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/versionv1-get-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Alarms .. -->
<!-- ..................................................... -->
<method href="#listAlarms"/>
<method href="#getAlarm"/>
<method href="#deleteAlarm"/>
<method href="#alarmSummary"/>
<method name="GET" id="listAlarms">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List alarms">
<para role="shortdesc">Lists all active alarms based on specified query.</para>
<para>The supported query options are alarm_id, entity_type_id, entity_instance_id,
severity and alarm_type.</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="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in output.</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/alarm_list-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ialarms" 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 active alarms based on the specified query.</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_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getAlarm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show alarm">
<para role="shortdesc">Shows information about a specific alarm.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&alarmListShowParameters;
&alarmDetailShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/alarm-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteAlarm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete alarm">
<para role="shortdesc">Deletes a specific alarm.</para>
<para>NOTE Typically this command should NOT be used. I.e typically
alarms will be and should be cleared by the system
when the alarm condition clears. This command is only provided
in the event that the alarm has cleared but for some reason the
system has not removed the alarm.</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="SUMMARY" id="alarmSummary">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Alarm Summary">
<para role="shortdesc">Summarize all active alarms by severity.</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="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in the summations (default false).</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&alarmSummaryShowParameters;
</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>
&commonFaults;
</method>
<!-- ..................................................... -->
<!-- .. Event Logs .. -->
<!-- ..................................................... -->
<method href="#listEventLog"/>
<method href="#getEventLog"/>
<method name="GET" id="listEventLog">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List event logs">
<para role="shortdesc">Lists all event logs (historical alarms and customer logs) based on specified query. The logs
are returned in reverse chronological order.</para>
<para>The supported query options are event_log_id, entity_type_id, entity_instance_id,
severity, event_log_type, start and end.</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="q" style="query" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies filter rules for the logs to
be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the maximum number of event logs to
be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarms" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (alarms=true) specifies
that only alarm event log records should be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="logs" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (logs=true) specifies
that only customer log records should be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in output.</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/event_log_list-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log" 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 events log based on the specified query.</para>
</wadl:doc>
</param>
&eventLogListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_log_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getEventLog">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show event log">
<para role="shortdesc">Shows information about a specific event log.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&eventLogListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_log_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Event Suppression .. -->
<!-- ..................................................... -->
<method href="#listEventSuppression"/>
<method href="#getEventSuppression"/>
<method name="GET" id="listEventSuppression">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List event suppression">
<para role="shortdesc">Lists suppressed event id's.
</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="event_suppression" 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 suppressed event types.</para>
</wadl:doc>
</param>
&EventSuppressionListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_suppression_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyEventSuppression">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify event suppression">
<para role="shortdesc">Modifies the value of an event suppression.</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="suppression_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 suppression status of an event suppression; <code>suppressed</code> or <code>unsuppressed</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/event_suppression_modify-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_suppression" 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>URIs to the modified event suppression.
</para>
</wadl:doc>
</param>
&EventSuppressionListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_suppression_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
</application>

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

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

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

@ -1 +0,0 @@
http://192.168.204.2:6385/v1/event_log?q.field=start&q.field=end&q.op=eq&q.op=eq&q.type=&q.type=&q.value=2014-11-28T16%3A56%3A44&q.value=2014-11-28T16%3A56%3A45&limit=2

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

@ -1 +0,0 @@
http://192.168.204.2:6385/v1/event_suppression

2
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/sysinv-versions-response.json
View File

@ -19,6 +19,6 @@
]
}
],
"description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports alarms and fault collection for the cloud itself as well as the configuration of the cloud's SNMP interface. ",
"description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports the configuration of the cloud's SNMP interface. ",
"name":"Titanium SysInv API"
}

2
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/version-get-response.json
View File

@ -19,6 +19,6 @@
]
}
],
"description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports alarms and fault collection for the cloud itself as well as the configuration of the cloud's SNMP interface. ",
"description":"Titanium Cloud System API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports the configuration of the cloud's SNMP interface. ",
"name":"Titanium SysInv API"
}

30
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/api_samples/versionv1-get-response.json
View File

@ -136,36 +136,6 @@
"rel":"bookmark"
}
],
"ialarms":[
{
"href":"http://128.224.150.54:6385/v1/ialarms/",
"rel":"self"
},
{
"href":"http://128.224.150.54:6385/ialarms/",
"rel":"bookmark"
}
],
"event_log":[
{
"href":"http://128.224.150.54:6385/v1/event_log/",
"rel":"self"
},
{
"href":"http://128.224.150.54:6385/event_log/",
"rel":"bookmark"
}
],
"event_suppression":[
{
"href":"http://128.224.150.54:6385/v1/event_suppression/",
"rel":"self"
},
{
"href":"http://128.224.150.54:6385/event_suppression/",
"rel":"bookmark"
}
],
"icommunity":[
{
"href":"http://128.224.150.54:6385/v1/icommunity/",

308
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent
View File

@ -1538,163 +1538,6 @@
'>
<!-- Alarm List/Show Parameters -->
<!ENTITY alarmListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_id" 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 alarm ID; each type of alarm has a unique ID. Note
the alarm_id and the entity_instance_id uniquely identify
an alarm instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_instance_id" 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 instance of the object raising alarm. A . separated list
of sub-entity-type=instance-value pairs, representing the containment
structure of the overall entity instance. Note
the alarm_id and the entity_instance_id uniquely identify
an alarm instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="reason_text" 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 text description of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="severity" 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 severity of the alarm; <code>critical</code>,
<code>major</code>, <code>minor</code>, or <code>warning</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="timestamp" 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 in UTC at which the alarm has last been updated.</para>
</wadl:doc>
</param>
<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 of the alarm.</para>
</wadl:doc>
</param>
'>
<!ENTITY alarmDetailShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_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 the alarm; <code>set</code> or <code>clear</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_affecting" 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 whether the alarm affects the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="proposed_repair_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>The proposed action to clear the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_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>The type of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_type_id" 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 type of the object raising the alarm. A . separated list
of sub-entity-type, representing the containment structure of the
overall entity type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="probable_cause" 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 probable cause of the alarm.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression" 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 whether suppression of the specific alarm is allowed.</para>
</wadl:doc>
</param>
'>
<!ENTITY alarmSummaryShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="system_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>UUID of the system.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="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>Overall system status based on alarms present; <code>critical</code>,
<code>degraded</code>, or <code>OK</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="critical" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of critical alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="major" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of major alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minor" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of minor alarms on the system</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="warnings" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Count of warnings on the system</para>
</wadl:doc>
</param>
'>
<!-- Community List/Show Parameters -->
<!ENTITY communityListShowParameters '
@ -2589,157 +2432,6 @@
'>
<!-- Event Log List/Show Parameters -->
<!ENTITY eventLogListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log_id" 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 event log ID; each type of event log has a unique ID. Note
the event_log_id and the entity_instance_id uniquely identify
an event log instance.</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 the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_instance_id" 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 instance of the object generating the event log. A . separated list
of sub-entity-type=instance-value pairs, representing the containment
structure of the overall entity instance. Note
the event_log_id and the entity_instance_id uniquely identify
an event log instance.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="reason_text" 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 text description of the event log.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="severity" 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 severity of the event log; <code>critical</code>,
<code>major</code>, <code>minor</code> or <code>warning</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="timestamp" 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 in UTC at which the event log has last been updated.</para>
</wadl:doc>
</param>
<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 of the event log.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="next" 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 next attribute is the request to use to get the next n
items. It is used to paginate the event log list.</para>
</wadl:doc>
</param>
'>
<!ENTITY eventLogDetailShowParameters '
<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 the event; <code>set</code>, <code>clear</code> or <code>log</code></para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_affecting" 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 whether the event affects the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="proposed_repair_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>The proposed action to clear the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log_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>The type of the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="entity_type_id" 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 type of the object raising the alarm. A . separated list
of sub-entity-type, representing the containment structure of the
overall entity type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="probable_cause" 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 probable cause of the event.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression" 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 whether suppression of the specific event is allowed.</para>
</wadl:doc>
</param>
'>
<!-- Event Suppression List/Show Parameters -->
<!ENTITY EventSuppressionListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarm_id" 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 alarm ID type (event ID type) that can be suppressed or unsuppressed.
</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 text description of the event type.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="suppression_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 suppression status for the event ID type; <code>suppressed</code> or <code>unsuppressed</code></para>
</wadl:doc>
</param>
'>
<!-- Device List/Show Parameters -->
<!ENTITY deviceListShowParameters '

382
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/sysinv-api-v1.wadl
View File

@ -520,29 +520,6 @@ SPDX-License-Identifier: Apache-2.0
</resource>
<!-- /v1/ialarms -->
<resource id="alarms" path="ialarms">
<method href="#listAlarms"/>
<!-- /v1/ialarms/{alarm_uuid} -->
<resource id="alarm_uuid" path="{alarm_uuid}" >
<param name="alarm_uuid" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing active alarm.</para>
</wadl:doc>
</param>
<method href="#getAlarm"/>
<method href="#deleteAlarm"/>
</resource>
<!-- /v1/ialarms/summary -->
<resource id="alarm_summary" path="summary" >
<method href="#alarmSummary"/>
</resource>
</resource>
<!-- /v1/icommunity -->
<resource id="community" path="icommunity">
<method href="#listCommunities"/>
@ -581,40 +558,6 @@ SPDX-License-Identifier: Apache-2.0
</resource>
</resource>
<!-- /v1/event_log -->
<resource id="event_log" path="event_log">
<method href="#listEventLog"/>
<!-- /v1/event_log/{log_uuid} -->
<resource id="event_log_uuid" path="{log_uuid}" >
<param name="log_uuid" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an event log.</para>
</wadl:doc>
</param>
<method href="#getEventLog"/>
</resource>
</resource>
<!-- /v1/event_suppression -->
<resource id="event_suppression" path="event_suppression">
<method href="#listEventSuppression"/>
</resource>
<!-- /v1/event_suppression/{event_suppression_uuid} -->
<resource id="event_suppression_uuid" path="event_suppression/{event_suppression_uuid}" >
<param name="event_suppression_uuid" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an event suppression.</para>
</wadl:doc>
</param>
<method href="#modifyEventSuppression"/>
</resource>
<!-- /v1/pci_devices -->
<resource id="device" path="devices">
@ -3616,140 +3559,6 @@ SPDX-License-Identifier: Apache-2.0
<!-- ..................................................... -->
<!-- .. Alarms .. -->
<!-- ..................................................... -->
<method href="#listAlarms"/>
<method href="#getAlarm"/>
<method href="#deleteAlarm"/>
<method href="#alarmSummary"/>
<method name="GET" id="listAlarms">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List alarms">
<para role="shortdesc">Lists all active alarms based on specified query.</para>
<para>The supported query options are alarm_id, entity_type_id, entity_instance_id,
severity and alarm_type.</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="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in output.</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/alarm_list-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ialarms" 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 active alarms based on the specified query.</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_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getAlarm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show alarm">
<para role="shortdesc">Shows information about a specific alarm.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&alarmListShowParameters;
&alarmDetailShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/alarm-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteAlarm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete alarm">
<para role="shortdesc">Deletes a specific alarm.</para>
<para>NOTE Typically this command should NOT be used. I.e typically
alarms will be and should be cleared by the system
when the alarm condition clears. This command is only provided
in the event that the alarm has cleared but for some reason the
system has not removed the alarm.</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="SUMMARY" id="alarmSummary">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Alarm Summary">
<para role="shortdesc">Summarize all active alarms by severity.</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="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in the summations (default false).</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&alarmSummaryShowParameters;
</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>
&commonFaults;
</method>
<!-- ..................................................... -->
<!-- .. Communities .. -->
<!-- ..................................................... -->
@ -4570,197 +4379,6 @@ OAM Controller-1 IP Address.</para>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Event Logs .. -->
<!-- ..................................................... -->
<method href="#listEventLog"/>
<method href="#getEventLog"/>
<method name="GET" id="listEventLog">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List event logs">
<para role="shortdesc">Lists all event logs (historical alarms and customer logs) based on specified query. The logs
are returned in reverse chronological order.</para>
<para>The supported query options are event_log_id, entity_type_id, entity_instance_id,
severity, event_log_type, start and end.</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="q" style="query" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies filter rules for the logs to
be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="limit" style="query" type="xsd:int" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the maximum number of event logs to
be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="alarms" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (alarms=true) specifies
that only alarm event log records should be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="logs" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (logs=true) specifies
that only customer log records should be returned.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="include_suppress" style="query" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This optional parameter when set to true (include_suppress=true) specifies
to include suppressed alarms in output.</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/event_log_list-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_log" 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 events log based on the specified query.</para>
</wadl:doc>
</param>
&eventLogListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_log_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getEventLog">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show event log">
<para role="shortdesc">Shows information about a specific event log.</para>
<para></para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&eventLogListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_log_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Event Suppression .. -->
<!-- ..................................................... -->
<method href="#listEventSuppression"/>
<method href="#getEventSuppression"/>
<method name="GET" id="listEventSuppression">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List event suppression">
<para role="shortdesc">Lists suppressed event id's.
</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="event_suppression" 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 suppressed event types.</para>
</wadl:doc>
</param>
&EventSuppressionListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_suppression_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyEventSuppression">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify event suppression">
<para role="shortdesc">Modifies the value of an event suppression.</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="suppression_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 suppression status of an event suppression; <code>suppressed</code> or <code>unsuppressed</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/event_suppression_modify-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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="event_suppression" 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>URIs to the modified event suppression.
</para>
</wadl:doc>
</param>
&EventSuppressionListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/event_suppression_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Devices .. -->
<!-- ..................................................... -->

2
tools/collector/scripts/collect_mask_passwords
View File

@ -13,7 +13,7 @@ for conffile in \
${COLLECT_NAME_DIR}/etc/aodh/aodh.conf \
${COLLECT_NAME_DIR}/etc/ceilometer/ceilometer.conf \
${COLLECT_NAME_DIR}/etc/cinder/cinder.conf \
${COLLECT_NAME_DIR}/etc/fm.conf \
${COLLECT_NAME_DIR}/etc/fm/fm.conf \
${COLLECT_NAME_DIR}/etc/glance/glance-api.conf \
${COLLECT_NAME_DIR}/etc/glance/glance-registry.conf \
${COLLECT_NAME_DIR}/etc/heat/heat.conf \