1384 lines
59 KiB
XML
1384 lines
59 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
Copyright (c) 2014-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="sysinv-v1"
|
|
role="api-reference">
|
|
<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 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>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- API VERSIONS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="versions-sysinv-v1">
|
|
<title>API versions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#versions">
|
|
<wadl:method href="#listVersions-sysinv-v1"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#version">
|
|
<wadl:method href="#showVersionDetails-sysinv-v1"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SYSTEM -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="system-v1">
|
|
<title>System</title>
|
|
<para>The cloud server cluster is represented internally by a unique object referred to as 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#systems">
|
|
<wadl:method href="#getSystem"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#systems">
|
|
<wadl:method href="#modifySystem"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CLUSTER -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="cluster-v1">
|
|
<title>Clusters</title>
|
|
<para>A cluster within the cloud server is represented internally by a unique object referred to as the
|
|
cluster.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#clusters">
|
|
<wadl:method href="#listClusters"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#uuid">
|
|
<wadl:method href="#getCluster"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- HOSTS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="hosts-v1">
|
|
<title>Hosts</title>
|
|
<para>Hosts are the physical hosts or servers for 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#hosts">
|
|
<wadl:method href="#listHosts"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_id">
|
|
<wadl:method href="#getHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_id">
|
|
<wadl:method href="#modifyHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_id">
|
|
<wadl:method href="#actionHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_id">
|
|
<wadl:method href="#deleteHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#hosts">
|
|
<wadl:method href="#addHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#hosts_bulk_add">
|
|
<wadl:method href="#addHostBulk"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#hosts_bulk_export">
|
|
<wadl:method href="#exportHostBulk"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_upgrade">
|
|
<wadl:method href="#upgradeHost"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#host_downgrade">
|
|
<wadl:method href="#downgradeHost"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- PORTS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="ports-v1">
|
|
<title>Ports</title>
|
|
<para>These APIs allow the display of the physical ports of
|
|
a host and their attributes.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#ports">
|
|
<wadl:method href="#listPorts"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#port_id">
|
|
<wadl:method href="#getPort" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- INTERFACES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="interfaces-v1">
|
|
<title>Interfaces</title>
|
|
<para>These APIs allow the create, display, modify and delete
|
|
of the L2 interfaces of a host.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#interfaces">
|
|
<wadl:method href="#listInterfaces"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#interface_id">
|
|
<wadl:method href="#getInterface"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#interfaces">
|
|
<wadl:method href="#addInterface"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#interface_id">
|
|
<wadl:method href="#modifyInterface"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#interface_id">
|
|
<wadl:method href="#deleteInterface"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CPUS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="cpus-v1">
|
|
<title>CPUs</title>
|
|
<para>These APIs allow the display of the logical core(s) of the
|
|
processor(s) on a host, and the display and modification
|
|
of the cores assigned function.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#hostcpus">
|
|
<wadl:method href="#listCpus"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#cpu_id">
|
|
<wadl:method href="#getCpu"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#hostcpusmodify">
|
|
<wadl:method href="#modifyCpu"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- MEMORYS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="memorys-v1">
|
|
<title>Memory</title>
|
|
<para>These APIs allow the display of the size and usage
|
|
of various memory areas of the NUMA nodes of a host.
|
|
The modification of the size of these memory areas is
|
|
also supported through these APIs.
|
|
The different memory areas of a NUMA node of a host are:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Memory reserved for the Platform; where the Platform consists
|
|
of the kernel and the cloud services,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Memory reserved for the virtual switch (Note: only on 'compute' hosts),</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Memory reserved for the hosted VMs (Note: only on 'compute' hosts).</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#memorys">
|
|
<wadl:method href="#listMemorys"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#memory_id">
|
|
<wadl:method href="#getMemory"/>
|
|
<wadl:method href="#modifyMemory"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SENSORS GROUPS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="sensorgroups-v1">
|
|
<title>SensorGroup</title>
|
|
<para>These APIs allow the display of the operational state
|
|
and configuration attributes of the sensorgroups of a host.
|
|
The modification of certain sensorgroup attributes is
|
|
supported through these APIs; and propagates the
|
|
configuration change to the corresponding attributes of
|
|
<emphasis>all</emphasis> sensors defined in the group.
|
|
Examples of sensorgroup sensortype monitoring for
|
|
the host are:
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para> temperature,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> voltage,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> current,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> fan, </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> cpu,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> memory,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> disk,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> partition,</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> firmware baseline, </para>
|
|
</listitem>
|
|
<listitem>
|
|
<para> hardware baseline. </para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sensorgroups">
|
|
<wadl:method href="#listSensorGroups"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sensorgroup_id">
|
|
<wadl:method href="#getSensorGroup"/>
|
|
<wadl:method href="#modifySensorGroup"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SENSORS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="sensors-v1">
|
|
<title>Sensor</title>
|
|
<para>These APIs allow the display of the status and
|
|
operational state of various sensor areas of a host.
|
|
The modification of the certain sensor attributes is
|
|
also supported through these APIs.
|
|
Examples of different sensortypes are as defined for
|
|
the sensorgroup.
|
|
</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sensors">
|
|
<wadl:method href="#listSensors"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sensor_id">
|
|
<wadl:method href="#getSensor"/>
|
|
<wadl:method href="#modifySensor"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- DISKS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="disks-v1">
|
|
<title>Disks</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#disks">
|
|
<wadl:method href="#listDisks"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#disk_id">
|
|
<wadl:method href="#getDisk"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#disk_id">
|
|
<wadl:method href="#modifyDisk"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- PARTITIONS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="partitions-v1">
|
|
<title>Partitions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#partitions">
|
|
<wadl:method href="#listPartitions"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#partition_id">
|
|
<wadl:method href="#getPartition"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#partitions">
|
|
<wadl:method href="#addPartition"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#partition_id">
|
|
<wadl:method href="#editPartition"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#partition_id">
|
|
<wadl:method href="#deletePartition"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CEPH STORAGE -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="stors-v1">
|
|
<title>Ceph Storage Functions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#stors">
|
|
<wadl:method href="#listStors"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#stor_id">
|
|
<wadl:method href="#getStor"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#stors">
|
|
<wadl:method href="#addStor"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#stor_id">
|
|
<wadl:method href="#editStor"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#stor_id">
|
|
<wadl:method href="#deleteStor"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- VOLUME GROUPS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="volumegroups-v1">
|
|
<title>Volume Groups</title>
|
|
<para>These APIs allow the creation, deletion, and displaying
|
|
of LVM volume groups. </para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#volumegroupsbyhost">
|
|
<wadl:method href="#listVolumeGroups"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#volumegroup_id">
|
|
<wadl:method href="#getVolumeGroup"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#volumegroups">
|
|
<wadl:method href="#addVolumeGroup"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#volumegroup_id">
|
|
<wadl:method href="#modifyVolumeGroup"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#volumegroup_id">
|
|
<wadl:method href="#deleteVolumeGroup"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- PHYSICAL VOLUMES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="physicalvolumes-v1">
|
|
<title>Physical Volumes</title>
|
|
<para>These APIs allow the creation, deletion, and displaying
|
|
of LVM physical volumes. </para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#physicalvolumesbyhost">
|
|
<wadl:method href="#listPhysicalVolumes"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#physicalvolume_id">
|
|
<wadl:method href="#getPhysicalVolume"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#physicalvolumes">
|
|
<wadl:method href="#addPhysicalVolume"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#physicalvolume_id">
|
|
<wadl:method href="#deletePhysicalVolume"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- PROFILES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="profiles-v1">
|
|
<title>Profiles</title>
|
|
<para>These APIs allow the create, display and delete
|
|
of host profiles. This includes interface profiles,
|
|
cpu profiles, and volume profiles. NOTE that the
|
|
same record is used in the database for both hosts and
|
|
host profiles.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#profiles">
|
|
<wadl:method href="#listProfiles"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#profile_id">
|
|
<wadl:method href="#getProfile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#profiles">
|
|
<wadl:method href="#addProfile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#profile_id">
|
|
<wadl:method href="#deleteProfile"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--****************************************************-->
|
|
<!-- DNS -->
|
|
<!--****************************************************-->
|
|
|
|
<section xml:id="dns-v1">
|
|
<title>DNS</title>
|
|
<para>The DNS is the Domain Name Server entity for 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#dns">
|
|
<wadl:method href="#getDns"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#dns_id">
|
|
<wadl:method href="#modifyDns"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--****************************************************-->
|
|
<!-- NTP -->
|
|
<!--****************************************************-->
|
|
|
|
<section xml:id="ntp-v1">
|
|
<title>NTP</title>
|
|
<para>The NTP is the Network Time Protocol entity for 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#ntp">
|
|
<wadl:method href="#getNtp"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#ntp_id">
|
|
<wadl:method href="#modifyNtp"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--****************************************************-->
|
|
<!-- External OAM -->
|
|
<!--****************************************************-->
|
|
|
|
<section xml:id="extoam-v1">
|
|
<title>External OAM</title>
|
|
<para>The extoam is the External OAM entity for 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#extoam">
|
|
<wadl:method href="#getExtoam"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#extoam_id">
|
|
<wadl:method href="#modifyExtoam"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--****************************************************-->
|
|
<!-- Infrastructure Subnet -->
|
|
<!--****************************************************-->
|
|
|
|
<section xml:id="infra-v1">
|
|
<title>Infrastructure Subnet</title>
|
|
<para>The infra is the Infrastructure subnet entity for 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#infra">
|
|
<wadl:method href="#getInfra"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#infra">
|
|
<wadl:method href="#addInfra"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#infra_id">
|
|
<wadl:method href="#modifyInfra"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#infra_id">
|
|
<wadl:method href="#applyInfra"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--****************************************************-->
|
|
<!-- DRBD Configuration -->
|
|
<!--****************************************************-->
|
|
|
|
<section xml:id="drbdconfig-v1">
|
|
<title>DRBD Configuration</title>
|
|
<para>The drbdconfig is the Distributed Replicated Block Device (DRBD)
|
|
configuration entity for 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#drbdconfig">
|
|
<wadl:method href="#getDrbdconfig"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#drbdconfig_id">
|
|
<wadl:method href="#modifyDrbdconfig"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- COMMUNITIES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="communities-v1">
|
|
<title>SNMP Communities</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#community">
|
|
<wadl:method href="#listCommunities"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#community_id">
|
|
<wadl:method href="#getCommunity"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#community">
|
|
<wadl:method href="#addCommunity"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#community_id">
|
|
<wadl:method href="#modifyCommunity"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#community_id">
|
|
<wadl:method href="#deleteCommunity"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- TRAPDESTS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="trapdests-v1">
|
|
<title>SNMP Trap Destinations</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#trapdests">
|
|
<wadl:method href="#listTrapdests"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#trapdest_id">
|
|
<wadl:method href="#getTrapdest"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#trapdests">
|
|
<wadl:method href="#addTrapdest"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#trapdest_id">
|
|
<wadl:method href="#modifyTrapdest"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#trapdest_id">
|
|
<wadl:method href="#deleteTrapdest"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- DEVICES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="devices-v1">
|
|
<title>Devices</title>
|
|
<para>These APIs allow the display of the pci devices of
|
|
a host and their attributes.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#devices">
|
|
<wadl:method href="#listDevices"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#device_id">
|
|
<wadl:method href="#getDevice" />
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#device_id">
|
|
<wadl:method href="#modifyDevice"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICE PARAMETER -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="service-parameter-v1">
|
|
<title>Service Parameter</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#service_parameter">
|
|
<wadl:method href="#listServiceParameter"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#parameter_id">
|
|
<wadl:method href="#getServiceParameter"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#service_parameter">
|
|
<wadl:method href="#addServiceParameter"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#service_parameter_apply">
|
|
<wadl:method href="#applyServiceParameter"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#parameter_id">
|
|
<wadl:method href="#modifyServiceParameter"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#parameter_id">
|
|
<wadl:method href="#deleteServiceParameter"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- LLDP AGENTS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="lldp-agents-v1">
|
|
<title>LLDP Agents</title>
|
|
<para>These APIs allow the display of the lldp agents of
|
|
a host and their attributes.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#lldp_agents">
|
|
<wadl:method href="#listLldpAgents"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#lldp_agent_id">
|
|
<wadl:method href="#getLldpAgent" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- LLDP NEIGHBORS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="lldp-neighbors-v1">
|
|
<title>LLDP Neighbors</title>
|
|
<para>These APIs allow the display of the lldp neighbors of
|
|
a host and their attributes.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#lldp_neighbors">
|
|
<wadl:method href="#listLldpNeighbors"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#lldp_neighbor_id">
|
|
<wadl:method href="#getLldpNeighbor" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="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/sysinv-api/v1/sysinv-api-v1.wadl#services">
|
|
<wadl:method href="#listServices"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#service_id">
|
|
<wadl:method href="#getService" />
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#service_name">
|
|
<wadl:method href="#modifyService"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICE NODES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="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/sysinv-api/v1/sysinv-api-v1.wadl#servicenodes">
|
|
<wadl:method href="#listServiceNodes"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#node_id">
|
|
<wadl:method href="#getServiceNode" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SERVICE GROUPS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="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/sysinv-api/v1/sysinv-api-v1.wadl#servicegroup">
|
|
<wadl:method href="#listServiceGroups"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#servicegroup_id">
|
|
<wadl:method href="#getServiceGroup" />
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SDN CONTROLLERS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="sdn-controllers-v1">
|
|
<title>SDN Controllers</title>
|
|
<para>These APIs allow for the display and configuration of
|
|
the SDN controllers that each of the compute nodes will connect
|
|
to for the purpose of SDN manager interface (i.e. OVSDB connection).
|
|
The SDN controllers configured are for active connections to
|
|
the SDN controller for each of the virtual switch instances running
|
|
on the compute nodes, and is shared across all compute nodes.
|
|
</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sdn_controller">
|
|
<wadl:method href="#listSdnController"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_id">
|
|
<wadl:method href="#getSdnController"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#sdn_controller">
|
|
<wadl:method href="#addSdnController"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_id">
|
|
<wadl:method href="#modifySdnController"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_id">
|
|
<wadl:method href="#deleteSdnController"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- REMOTE LOGGING -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="remote-logging-v1">
|
|
<title>Remote Logging</title>
|
|
<para>These APIs allow the display and configuration of the
|
|
remote logging settings</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#remotelogging">
|
|
<wadl:method href="#showRemoteLogging"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#remotelogging_id">
|
|
<wadl:method href="#modifyRemoteLogging"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- NETWORKS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="networks-v1">
|
|
<title>Networks</title>
|
|
<para>These APIs allow the display of system managed networks. They are intended for internal system use only.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#networks">
|
|
<wadl:method href="#listNetworks"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#network_id">
|
|
<wadl:method href="#getNetwork"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- ADDRESS POOLS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="addrpools-v1">
|
|
<title>Address Pools</title>
|
|
<para>These APIs allow the display and configuration of IP address pools.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#addrpools">
|
|
<wadl:method href="#listAddrPools"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#addrpools">
|
|
<wadl:method href="#addAddrPool"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#pool_id">
|
|
<wadl:method href="#getAddrPool"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#pool_id">
|
|
<wadl:method href="#modifyAddrPool"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#pool_id">
|
|
<wadl:method href="#deleteAddrPool"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- ADDRESSES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="addresses-v1">
|
|
<title>Addresses</title>
|
|
<para>These APIs allow the display and configuration of IP addresses for a specific host resource.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#addresses">
|
|
<wadl:method href="#listAddresses"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#addresses">
|
|
<wadl:method href="#addAddress"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#address_id">
|
|
<wadl:method href="#getAddress"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#address_id">
|
|
<wadl:method href="#deleteAddress"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- ROUTES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="routes-v1">
|
|
<title>Routes</title>
|
|
<para>These APIs allow the display and configuration of IP route for a specific host resource.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#routes">
|
|
<wadl:method href="#listRoutes"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#routes">
|
|
<wadl:method href="#addRoute"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#route_id">
|
|
<wadl:method href="#getRoute"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#route_id">
|
|
<wadl:method href="#deleteRoute"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- STORAGE BACKENDS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="storage-backends-v1">
|
|
<title>Storage Backends</title>
|
|
<para>These APIs allow the display and configuration of different storage backends.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_backend">
|
|
<wadl:method href="#listStorageBackends"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#usage">
|
|
<wadl:method href="#listStorageUsage"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_lvm">
|
|
<wadl:method href="#listStorageLvms"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_lvm">
|
|
<wadl:method href="#addStorageLvm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_lvm_id">
|
|
<wadl:method href="#getStorageLvm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_lvm_id">
|
|
<wadl:method href="#modifyStorageLvm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_lvm_id">
|
|
<wadl:method href="#deleteStorageLvm"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph">
|
|
<wadl:method href="#listStorageCephs"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph">
|
|
<wadl:method href="#addStorageCeph"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_id">
|
|
<wadl:method href="#getStorageCeph"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_id">
|
|
<wadl:method href="#modifyStorageCeph"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_id">
|
|
<wadl:method href="#deleteStorageCeph"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_external">
|
|
<wadl:method href="#listStorageCephExternals"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_external">
|
|
<wadl:method href="#addStorageCephExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_external_id">
|
|
<wadl:method href="#getStorageCephExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_external_id">
|
|
<wadl:method href="#modifyStorageCephExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_ceph_external_id">
|
|
<wadl:method href="#deleteStorageCephExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_file">
|
|
<wadl:method href="#listStorageFiles"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_file">
|
|
<wadl:method href="#addStorageFile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_file_id">
|
|
<wadl:method href="#getStorageFile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_file_id">
|
|
<wadl:method href="#modifyStorageFile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_file_id">
|
|
<wadl:method href="#deleteStorageFile"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_external">
|
|
<wadl:method href="#listStorageExternals"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_external">
|
|
<wadl:method href="#addStorageExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_external_id">
|
|
<wadl:method href="#getStorageExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_external_id">
|
|
<wadl:method href="#modifyStorageExternal"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_external_id">
|
|
<wadl:method href="#deleteStorageExternal"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- STORAGE TIERS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="storage_tiers-v1">
|
|
<title>Storage Tiers</title>
|
|
<para>These APIs allow the create, display, modify and delete
|
|
of the storage tiers.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_tiers">
|
|
<wadl:method href="#listStorageTiers"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_tier_id">
|
|
<wadl:method href="#getStorageTier"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_tiers">
|
|
<wadl:method href="#addStorageTier"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_tier_id">
|
|
<wadl:method href="#modifyStorageTier"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#storage_tier_id">
|
|
<wadl:method href="#deleteStorageTier"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CONTROLLER FILESYSTEM -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="controller-fs-v1">
|
|
<title>Controller Filesystem</title>
|
|
<para>These APIs allow the display and configuration of the controller filesystem.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_fs">
|
|
<wadl:method href="#listControllerFs"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_fs_id">
|
|
<wadl:method href="#modifyControllerFs"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_fs_update_many">
|
|
<wadl:method href="#modifyMultiControllerFs"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#controller_fs_id">
|
|
<wadl:method href="#getControllerFs"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CEPH MONITORS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="ceph-mon-v1">
|
|
<title>Ceph Monitors</title>
|
|
<para>These APIs allow the display and configuration of the Ceph monitors.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#ceph_mon">
|
|
<wadl:method href="#listCephMons"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#ceph_mon_id">
|
|
<wadl:method href="#getCephMon"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#ceph_mon_id">
|
|
<wadl:method href="#modifyCephMon"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SYSTEM HEALTH -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="system-health-v1">
|
|
<title>System Health</title>
|
|
<para>These APIs allow the display of the system health.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#system_health">
|
|
<wadl:method href="#getSystemHealth"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#system_health_upgrade">
|
|
<wadl:method href="#getSystemHealthUpgrade"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- LOADS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="loads-v1">
|
|
<title>Software Loads</title>
|
|
<para>These APIs allow the display and configuration of the software loads.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#loads">
|
|
<wadl:method href="#listLoads"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#load_id">
|
|
<wadl:method href="#getLoadDetails"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#load_id">
|
|
<wadl:method href="#deleteLoad"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#import_load">
|
|
<wadl:method href="#importLoad"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- SOFTWARE UPGRADE -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="upgrade-v1">
|
|
<title>Software Upgrade</title>
|
|
<para>These APIs allow the display and configuration of the software upgrade.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#upgrade">
|
|
<wadl:method href="#showUpgrade"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#upgrade">
|
|
<wadl:method href="#startUpgrade"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#upgrade">
|
|
<wadl:method href="#patchUpgrade"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#upgrade">
|
|
<wadl:method href="#deleteUpgrade"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CERTIFICATE CONFIGURATION -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="certconfig-v1">
|
|
<title>System Certificate Configuration</title>
|
|
<para>These APIs allow for the display and configuration of
|
|
Host certificates which include SSL, Murano and Trusted Platform Module(TPM) certificates.
|
|
</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#certconfig">
|
|
<wadl:method href="#installCert"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#certs">
|
|
<wadl:method href="#listCert"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#certconfig_uuid">
|
|
<wadl:method href="#showCert"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- CUSTOM FIREWALL RULES -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="firewallrules-v1">
|
|
<title>Custom Firewall Rules</title>
|
|
<para>These APIs allow for the installation of custom firewall rules.
|
|
</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#firewallrules">
|
|
<wadl:method href="#importFirewallRules"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#firewallrules">
|
|
<wadl:method href="#showFirewallRules"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- LICENSE -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="license-v1">
|
|
<title>License</title>
|
|
<para>These APIs allow for the installation of license file and display of
|
|
the license information.
|
|
</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#install_license">
|
|
<wadl:method href="#installLicense"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#license">
|
|
<wadl:method href="#listLicenseInfo"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
<!--*******************************************************-->
|
|
<!-- LABELS -->
|
|
<!--*******************************************************-->
|
|
|
|
<section xml:id="labels-v1">
|
|
<title>Labels</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#labels">
|
|
<wadl:method href="#listLabel"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#assign_label">
|
|
<wadl:method href="#assignLabel"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/sysinv-api/v1/sysinv-api-v1.wadl#label_id">
|
|
<wadl:method href="#removeLabel"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
|
|
</chapter>
|