starlingx
/
integ
Code Issues Proposed changes
integ/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/sysinv-api-v1.wadl

7363 lines
343 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-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/sysinv/" xml:id="sysinv-v1">
<!-- / -->
<resource id="versions" path="//">
<method href="#listVersions-sysinv-v1"/>
</resource>
<!-- /v1 -->
<resource id="version" type="#VersionDetails" path="//v1">
<!-- /v1/isystems -->
<resource id="systems" path="isystems">
<method href="#getSystem"/>
<method href="#modifySystem"/>
<!-- /v1/isystems/{system_uuid} -->
<resource id="system_uuid" path="{system_uuid}" >
<param name="system_uuid" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the system.</para>
</wadl:doc>
</param>
<!-- /v1/isystems/{system_uuid}/controller_fs/update_many -->
<resource id="controller_fs_update_many" path="controller_fs/update_many" >
<method href="#modifyMultiControllerFs"/>
</resource>
</resource>
</resource>
<!-- /v1/ihosts -->
<resource id="hosts" path="ihosts">
<method href="#listHosts"/>
<method href="#addHost"/>
<!-- /v1/ihosts/bulk_add -->
<resource id="hosts_bulk_add" path="bulk_add">
<method href="#addHostBulk"/>
</resource>
<!-- /v1/ihosts/bulk_export -->
<resource id="hosts_bulk_export" path="bulk_export">
<method href="#exportHostBulk"/>
</resource>
<!-- /v1/ihosts/{host_id} -->
<resource id="host_id" path="{host_id}" >
<param name="host_id" 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 host.</para>
</wadl:doc>
</param>
<method href="#getHost"/>
<method href="#modifyHost"/>
<method href="#actionHost"/>
<method href="#deleteHost"/>
<!-- /v1/ihosts/{host_id}/ports -->
<resource id="ports" path="ports">
<method href="#listPorts"/>
</resource>
<!-- /v1/ihosts/{host_id}/iinterfaces -->
<resource id="interfaces" path="iinterfaces">
<method href="#listInterfaces"/>
<method href="#addInterface"/>
</resource>
<!-- /v1/ihosts/{host_id}/icpus -->
<resource id="hostcpus" path="icpus">
<method href="#listCpus"/>
</resource>
<!-- /v1/ihosts/{host_id}/state/host_cpus_modify -->
<resource id="hostcpusmodify" path="state/host_cpus_modify">
<method href="#modifyCpu"/>
</resource>
<!-- /v1/ihosts/{host_id}/imemorys -->
<resource id="memorys" path="imemorys">
<method href="#listMemorys"/>
</resource>
<!-- /v1/ihosts/{host_id}/idisks -->
<resource id="disks" path="idisks">
<method href="#listDisks"/>
</resource>
<!-- /v1/ihosts/{host_id}/partitions -->
<resource id="partitions" path="partitions">
<method href="#listPartitions"/>
<method href="#addPartition"/>
</resource>
<!-- /v1/ihosts/{host_id}/istors -->
<resource id="stors" path="istors">
<method href="#listStors"/>
<method href="#addStor"/>
</resource>
<!-- /v1/ihosts/{host_id}/ilvgs -->
<resource id="volumegroupsbyhost" path="ilvgs">
<method href="#listVolumeGroups"/>
</resource>
<!-- /v1/ihosts/{host_id}/ipvs -->
<resource id="physicalvolumesbyhost" path="ipvs">
<method href="#listPhysicalVolumes"/>
</resource>
<!-- /v1/ihosts/{host_id}/isensorgroups -->
<resource id="sensorgroups" path="isensorgroups">
<method href="#listSensorGroups"/>
</resource>
<!-- /v1/ihosts/{host_id}/isensors -->
<resource id="sensors" path="isensors">
<method href="#listSensors"/>
</resource>
<!-- /v1/ihosts/{host_id}/pci_devices -->
<resource id="devices" path="pci_devices">
<method href="#listDevices"/>
</resource>
<!-- /v1/ihosts/{host_id}/lldp_agents -->
<resource id="agents" path="lldp_agents">
<method href="#listLldpAgents"/>
</resource>
<!-- /v1/ihosts/{host_id}/lldp_neighbors -->
<resource id="neighbors" path="lldp_neighbors">
<method href="#listLldpNeighbors"/>
</resource>
<!-- /v1/ihosts/{host_id}/addresses -->
<resource id="addresses" path="addresses">
<method href="#listAddresses"/>
<method href="#addAddress"/>
<!-- /v1/ihosts/{host_id}/addresses/{address_id} -->
<resource id="address_id" path="{address_id}" >
<param name="host_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an address resource.</para>
</wadl:doc>
</param>
<method href="#getAddress"/>
<method href="#deleteAddress"/>
</resource>
</resource>
<!-- /v1/ihosts/{host_id}/routes -->
<resource id="routes" path="routes">
<method href="#listRoutes"/>
<method href="#addRoute"/>
<!-- /v1/ihosts/{host_id}/routes/{route_id} -->
<resource id="route_id" path="{route_id}">
<param name="host_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a route resource.</para>
</wadl:doc>
</param>
<method href="#getRoute"/>
<method href="#deleteRoute"/>
</resource>
</resource>
<!-- /v1/ihosts/{host_id}/upgrade -->
<resource id="host_upgrade" path="upgrade">
<method href="#upgradeHost"/>
</resource>
<!-- /v1/ihosts/{host_id}/downgrade -->
<resource id="host_downgrade" path="downgrade">
<method href="#downgradeHost"/>
</resource>
<!-- /v1/ihosts/{host_id}/labels -->
<resource id="labels" path="labels">
<method href="#listLabel"/>
</resource>
</resource>
</resource>
<!-- /v1/ports -->
<resource id="port" path="ports">
<!-- /v1/ports/{port_id} -->
<resource id="port_id" path="{port_id}" >
<param name="port_id" 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 port.</para>
</wadl:doc>
</param>
<method href="#getPort"/>
<!-- /v1/ports/{port_id}/lldp_agents -->
<resource id="agents" path="lldp_agents">
<method href="#listLldpAgents"/>
</resource>
<!-- /v1/ports/{port_id}/lldp_neighbors -->
<resource id="neighbors" path="lldp_neighbors">
<method href="#listLldpNeighbors"/>
</resource>
</resource>
</resource>
<!-- /v1/iinterfaces -->
<resource id="interface" path="iinterfaces">
<!-- /v1/iinterfaces/{interface_id} -->
<resource id="interface_id" path="{interface_id}" >
<param name="interface_id" 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 interface.</para>
</wadl:doc>
</param>
<method href="#getInterface"/>
<method href="#modifyInterface"/>
<method href="#deleteInterface"/>
</resource>
</resource>
<!-- /v1/icpus -->
<resource id="cpus" path="icpus">
<!-- /v1/icpus/{cpu_id} -->
<resource id="cpu_id" path="{cpu_id}" >
<param name="cpu_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a cpu (logical processor core).</para>
</wadl:doc>
</param>
<method href="#getCpu"/>
</resource>
</resource>
<!-- /v1/imemorys -->
<resource id="memorys" path="imemorys">
<!-- /v1/imemorys/{memory_id} -->
<resource id="memory_id" path="{memory_id}" >
<param name="memory_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a memory area.</para>
</wadl:doc>
</param>
<method href="#getMemory"/>
<method href="#modifyMemory"/>
</resource>
</resource>
<!-- /v1/idisks -->
<resource id="disks" path="idisks">
<!-- /v1/idisks/{disk_id} -->
<resource id="disk_id" path="{disk_id}" >
<param name="disk_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a physical disk.</para>
</wadl:doc>
</param>
<method href="#getDisk"/>
<method href="#modifyDisk"/>
</resource>
</resource>
<!-- /v1/partitions -->
<resource id="partitions" path="partitions">
<!-- /v1/partitions/{partition_id} -->
<resource id="partition_id" path="{partition_id}" >
<param name="partition_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a physical partition.</para>
</wadl:doc>
</param>
<method href="#getPartition"/>
<method href="#editPartition"/>
<method href="#deletePartition"/>
</resource>
</resource>
<!-- /v1/istors -->
<resource id="stors" path="istors">
<!-- /v1/istors/{stor_id} -->
<resource id="stor_id" path="{stor_id}" >
<param name="stor_id" 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 Ceph storage function.</para>
</wadl:doc>
</param>
<method href="#getStor"/>
<method href="#editStor"/>
<method href="#deleteStor"/>
</resource>
</resource>
<!-- /v1/istorconfig -->
<resource id="storconfig" path="istorconfig">
<method href="#summary"/>
</resource>
<!-- /v1/ilvgs -->
<resource id="volumegroups" path="ilvgs">
<method href="#addVolumeGroup"/>
<!-- /v1/ilvgs/{volumegroup_id} -->
<resource id="volumegroup_id" path="{volumegroup_id}" >
<param name="volumegroup_id" 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 LVM volume group.</para>
</wadl:doc>
</param>
<method href="#getVolumeGroup"/>
<method href="#modifyVolumeGroup"/>
<method href="#deleteVolumeGroup"/>
</resource>
</resource>
<!-- /v1/ipvs -->
<resource id="physicalvolumes" path="ipvs">
<method href="#addPhysicalVolume"/>
<!-- /v1/ipvs/{physicalvolume_id} -->
<resource id="physicalvolume_id" path="{physicalvolume_id}" >
<param name="physicalvolume_id" 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 LVM physical volume.</para>
</wadl:doc>
</param>
<method href="#getPhysicalVolume"/>
<method href="#deletePhysicalVolume"/>
</resource>
</resource>
<!-- /v1/isensorgroups -->
<resource id="sensorgroups" path="isensorgroups">
<!-- /v1/isensorgroups/{sensorgroup_id} -->
<resource id="sensorgroup_id" path="{sensorgroup_id}" >
<param name="sensorgroup_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a sensorgroup.</para>
</wadl:doc>
</param>
<method href="#getSensorGroup"/>
<method href="#modifySensorGroup"/>
</resource>
</resource>
<!-- /v1/isensors -->
<resource id="sensors" path="isensors">
<!-- /v1/isensors/{sensor_id} -->
<resource id="sensor_id" path="{sensor_id}" >
<param name="sensor_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a sensor.</para>
</wadl:doc>
</param>
<method href="#getSensor"/>
<method href="#modifySensor"/>
</resource>
</resource>
<!-- /v1/iprofiles -->
<resource id="profiles" path="iprofiles">
<method href="#listProfiles"/>
<method href="#addProfile"/>
<!-- /v1/iprofiles/{profile_id} -->
<resource id="profile_id" path="{profile_id}" >
<param name="profile_id" 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 profile.</para>
</wadl:doc>
</param>
<method href="#getProfile"/>
<method href="#deleteProfile"/>
<!-- /v1/iprofiles/{profile_id}/ports -->
<resource id="profileports" path="ports">
<method href="#listPorts"/>
</resource>
<!-- /v1/iprofiles/{profile_id}/iinterfaces -->
<resource id="profileinterfaces" path="iinterfaces">
<method href="#listInterfaces"/>
</resource>
<!-- /v1/iprofiles/{profile_id}/icpus -->
<resource id="profilecpus" path="icpus">
<method href="#listCpus"/>
</resource>
<!-- /v1/iprofiles/{profile_id}/istors -->
<resource id="profilevolumes" path="istors">
<method href="#listVolumes"/>
</resource>
</resource>
</resource>
<!-- /v1/idns -->
<resource id="dns" path="idns">
<method href="#getDns"/>
<!-- /v1/dns/{dns_id} -->
<resource id="dns_id" path="{dns_id}" >
<param name="dns_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the DNS for this system.</para>
</wadl:doc>
</param>
<method href="#modifyDns"/>
</resource>
</resource>
<!-- /v1/intp -->
<resource id="ntp" path="intp">
<method href="#getNtp"/>
<!-- /v1/ntp/{ntp_id} -->
<resource id="ntp_id" path="{ntp_id}" >
<param name="ntp_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the NTP for this system.</para>
</wadl:doc>
</param>
<method href="#modifyNtp"/>
</resource>
</resource>
<!-- /v1/iextoam -->
<resource id="extoam" path="iextoam">
<method href="#getExtoam"/>
<!-- /v1/extoam/{extoam_id} -->
<resource id="extoam_id" path="{extoam_id}" >
<param name="extoam_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the External OAM for this system.</para>
</wadl:doc>
</param>
<method href="#modifyExtoam"/>
</resource>
</resource>
<!-- /v1/iinfra -->
<resource id="infra" path="iinfra">
<method href="#getInfra"/>
<method href="#addInfra"/>
<!-- /v1/iinfra/{infra_id} -->
<resource id="infra_id" path="{infra_id}" >
<param name="infra_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the infrastructure network subnet configuration for this system.</para>
</wadl:doc>
</param>
<method href="#modifyInfra"/>
<method href="#applyInfra"/>
</resource>
</resource>
<!-- /v1/drbdconfig -->
<resource id="drbdconfig" path="drbdconfig">
<method href="#getDrbdconfig"/>
<!-- /v1/drbdconfig/{drbdconfig_id} -->
<resource id="drbdconfig_id" path="{drbdconfig_id}" >
<param name="drbdconfig_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the DRBD config for this system.</para>
</wadl:doc>
</param>
<method href="#modifyDrbdconfig"/>
</resource>
</resource>
<!-- /v1/icommunity -->
<resource id="community" path="icommunity">
<method href="#listCommunities"/>
<method href="#addCommunity"/>
<!-- /v1/icommunity/{community_id} -->
<resource id="community_id" path="{community_id}" >
<param name="community_id" style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique community string of an existing SNMP Community.</para>
</wadl:doc>
</param>
<method href="#getCommunity"/>
<method href="#modifyCommunity"/>
<method href="#deleteCommunity"/>
</resource>
</resource>
<!-- /v1/itrapdest -->
<resource id="trapdests" path="itrapdest">
<method href="#listTrapdests"/>
<method href="#addTrapdest"/>
<!-- /v1/itrapdest/{trapdest_id} -->
<resource id="trapdest_id" path="{trapdest_id}" >
<param name="trapdest_id" 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 SNMP Trap Destination.</para>
</wadl:doc>
</param>
<method href="#getTrapdest"/>
<method href="#modifyTrapdest"/>
<method href="#deleteTrapdest"/>
</resource>
</resource>
<!-- /v1/pci_devices -->
<resource id="device" path="devices">
<!-- /v1/pci_devices/{device_id} -->
<resource id="device_id" path="{device_id}" >
<param name="device_id" 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 pci device. PCI address or name.</para>
</wadl:doc>
</param>
<method href="#getDevice"/>
<method href="#modifyDevice"/>
</resource>
</resource>
<!-- /v1/service_parameter -->
<resource id="service_parameter" path="service_parameter">
<method href="#listServiceParameter"/>
<method href="#addServiceParameter"/>
<!-- /v1/service_parameter/apply -->
<resource id="service_parameter_apply" path="apply">
<method href="#applyServiceParameter"/>
</resource>
<!-- /v1/service_parameter/{parameter_id} -->
<resource id="parameter_id" path="{parameter_id}" >
<param name="parameter_id" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a service parameter.</para>
</wadl:doc>
</param>
<method href="#getServiceParameter"/>
<method href="#modifyServiceParameter"/>
<method href="#deleteServiceParameter"/>
</resource>
</resource>
<!-- /v1/clusters -->
<resource id="clusters" path="clusters">
<method href="#listClusters"/>
<!-- /v1/clusters/{uuid} -->
<resource id="uuid" path="{uuid}" >
<param name="uuid" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The system generated unique identifier of a cluster.</para>
</wadl:doc>
</param>
<method href="#getCluster"/>
</resource>
</resource>
<!-- /v1/lldp_agents -->
<resource id="lldp_agents" path="lldp_agents">
<method href="#listLldpAgents"/>
<!-- /v1/lldp_agents/{lldp_agent_id} -->
<resource id="lldp_agent_id" path="{lldp_agent_id}" >
<param name="lldp_agent_id" 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 lldp agent. </para>
</wadl:doc>
</param>
<method href="#getLldpAgent"/>
</resource>
</resource>
<!-- /v1/lldp_neighbors -->
<resource id="lldp_neighbors" path="lldp_neighbors">
<method href="#listLldpNeighbors"/>
<!-- /v1/lldp_neighbors/{lldp_neighbor_id} -->
<resource id="lldp_neighbor_id" path="{lldp_neighbor_id}" >
<param name="lldp_neighbor_id" 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 lldp neighbor. </para>
</wadl:doc>
</param>
<method href="#getLldpNeighbor"/>
</resource>
</resource>
<!-- /v1/services -->
<resource id="services" path="services">
<method href="#listServices"/>
<!-- /v1/services/{service_id} -->
<resource id="service_id" path="{service_id}" >
<param name="service_id" 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 service. </para>
</wadl:doc>
</param>
<method href="#getService"/>
</resource>
<!-- /v1/services/{service_name} -->
<resource id="service_name" path="{service_name}" >
<param name="service_name" style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The name of an existing service. </para>
</wadl:doc>
</param>
<method href="#modifyService"/>
</resource>
</resource>
<!-- /v1/servicenodes -->
<resource id="servicenodes" path="servicenodes">
<method href="#listServiceNodes"/>
<!-- /v1/servicenodes/{node_id} -->
<resource id="node_id" path="{node_id}" >
<param name="node_id" 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 service node. </para>
</wadl:doc>
</param>
<method href="#getServiceNode"/>
</resource>
</resource>
<!-- /v1/servicegroup -->
<resource id="servicegroup" path="servicegroup">
<method href="#listServiceGroups"/>
<!-- /v1/servicegroup/{servicegroup_id} -->
<resource id="servicegroup_id" path="{servicegroup_id}" >
<param name="servicegroup_id" 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 service group. </para>
</wadl:doc>
</param>
<method href="#getServiceGroup"/>
</resource>
</resource>
<!-- /v1/sdn_controller -->
<resource id="sdn_controller" path="sdn_controller">
<method href="#listSdnController"/>
<method href="#addSdnController"/>
<!-- /v1/sdn_controller/{controller_id} -->
<resource id="controller_id" path="{controller_id}" >
<param name="controller_id" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the SDN controller.</para>
</wadl:doc>
</param>
<method href="#getSdnController"/>
<method href="#modifySdnController"/>
<method href="#deleteSdnController"/>
</resource>
</resource>
<!-- /v1/remotelogging -->
<resource id="remotelogging" path="remotelogging">
<method href="#showRemoteLogging"/>
<!-- /v1/remotelogging/{remotelogging_id} -->
<resource id="remotelogging_id" path="{remotelogging_id}" >
<param name="remotelogging_id" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of a remotelogging settings entry.</para>
</wadl:doc>
</param>
<method href="#modifyRemoteLogging"/>
</resource>
</resource>
<!-- /v1/addrpools -->
<resource id="addrpools" path="addrpools">
<method href="#listAddrPools"/>
<method href="#addAddrPool"/>
<!-- /v1/addrpools/{pool_id} -->
<resource id="pool_id" path="{pool_id}">
<param name="pool_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the address pool resource.</para>
</wadl:doc>
</param>
<method href="#getAddrPool"/>
<method href="#modifyAddrPool"/>
<method href="#deleteAddrPool"/>
</resource>
</resource>
<!-- /v1/networks -->
<resource id="networks" path="networks">
<method href="#listNetworks"/>
<!-- /v1/networks/{network_id} -->
<resource id="network_id" path="{network_id}">
<param name="network_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the network resource.</para>
</wadl:doc>
</param>
<method href="#getNetwork"/>
</resource>
</resource>
<!-- /v1/storage_backend -->
<resource id="storage_backend" path="storage_backend">
<method href="#listStorageBackends"/>
</resource>
<!-- /v1/storage_backend/usage -->
<resource id="usage" path="storage_backend/usage">
<method href="#listStorageUsage"/>
</resource>
<!-- /v1/storage_lvm -->
<resource id="storage_lvm" path="storage_lvm" >
<method href="#listStorageLvms"/>
<method href="#addStorageLvm"/>
<!-- /v1/storage_lvm/{storage_lvm_id} -->
<resource id="storage_lvm_id" path="{storage_lvm_id}" >
<param name="storage_lvm_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage backend.</para>
</wadl:doc>
</param>
<method href="#getStorageLvm"/>
<method href="#modifyStorageLvm"/>
<method href="#deleteStorageLvm"/>
</resource>
</resource>
<!-- /v1/storage_ceph -->
<resource id="storage_ceph" path="storage_ceph" >
<method href="#listStorageCephs"/>
<method href="#addStorageCeph"/>
<!-- /v1/storage_ceph/{storage_ceph_id} -->
<resource id="storage_ceph_id" path="{storage_ceph_id}" >
<param name="storage_ceph_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage backend.</para>
</wadl:doc>
</param>
<method href="#getStorageCeph"/>
<method href="#modifyStorageCeph"/>
<method href="#deleteStorageCeph"/>
</resource>
</resource>
<!-- /v1/storage_ceph_external -->
<resource id="storage_ceph_external" path="storage_ceph_external" >
<method href="#listStorageCephExternals"/>
<method href="#addStorageCephExternal"/>
<!-- /v1/storage_ceph_external/{storage_ceph_external_id} -->
<resource id="storage_ceph_external_id" path="{storage_ceph_external_id}" >
<param name="storage_ceph_external_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage backend.</para>
</wadl:doc>
</param>
<method href="#getStorageCephExternal"/>
<method href="#modifyStorageCephExternal"/>
<method href="#deleteStorageCephExternal"/>
</resource>
</resource>
<!-- /v1/storage_file -->
<resource id="storage_file" path="storage_file" >
<method href="#listStorageFiles"/>
<method href="#addStorageFile"/>
<!-- /v1/storage_file/{storage_file_id} -->
<resource id="storage_file_id" path="{storage_file_id}" >
<param name="storage_file_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage backend.</para>
</wadl:doc>
</param>
<method href="#getStorageFile"/>
<method href="#modifyStorageFile"/>
<method href="#deleteStorageFile"/>
</resource>
</resource>
<!-- /v1/storage_external -->
<resource id="storage_external" path="storage_external" >
<method href="#listStorageExternals"/>
<method href="#addStorageExternal"/>
<!-- /v1/storage_external/{storage_external_id} -->
<resource id="storage_external_id" path="{storage_external_id}" >
<param name="storage_external_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage backend.</para>
</wadl:doc>
</param>
<method href="#getStorageExternal"/>
<method href="#modifyStorageExternal"/>
<method href="#deleteStorageExternal"/>
</resource>
</resource>
<!-- /v1/storage_tiers -->
<resource id="storage_tiers" path="storage_tiers">
<method href="#listStorageTiers"/>
<method href="#addStorageTier"/>
<!-- /v1/storage_tiers/{storage_tier_id} -->
<resource id="storage_tier_id" path="{storage_tier_id}">
<param name="storage_tier_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the storage tier resource.</para>
</wadl:doc>
</param>
<method href="#getStorageTier"/>
<method href="#modifyStorageTier"/>
<method href="#deleteStorageTier"/>
</resource>
</resource>
<!-- /v1/controller_fs -->
<resource id="controller_fs" path="controller_fs" >
<method href="#listControllerFs"/>
<!-- /v1/controller_fs/{controller_fs_id} -->
<resource id="controller_fs_id" path="{controller_fs_id}" >
<param name="controller_fs_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the controller filesystem.</para>
</wadl:doc>
</param>
<method href="#getControllerFs"/>
<method href="#modifyControllerFs"/>
</resource>
</resource>
<!-- /v1/ceph_mon -->
<resource id="ceph_mon" path="ceph_mon">
<method href="#listCephMons"/>
<!-- /v1/ceph_mon/{ceph_mon_id} -->
<resource id="ceph_mon_id" path="{ceph_mon_id}" >
<param name="ceph_mon_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of Ceph monitor.</para>
</wadl:doc>
</param>
<method href="#getCephMon"/>
<method href="#modifyCephMon"/>
</resource>
</resource>
<!-- /v1/health -->
<resource id="system_health" path="health">
<method href="#getSystemHealth"/>
</resource>
<!-- /v1/health/upgrade -->
<resource id="system_health_upgrade" path="health/upgrade">
<method href="#getSystemHealthUpgrade"/>
</resource>
<!-- /v1/loads -->
<resource id="loads" path="loads">
<method href="#listLoads"/>
<!-- /v1/loads/{load_id} -->
<resource id="load_id" path="{load_id}">
<param name="load_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the load.</para>
</wadl:doc>
</param>
<method href="#getLoadDetails"/>
<method href="#deleteLoad"/>
</resource>
</resource>
<!-- /v1/loads/import_load -->
<resource id="import_load" path="loads/import_load">
<method href="#importLoad"/>
</resource>
<!-- /v1/upgrade -->
<resource id="upgrade" path="upgrade">
<method href="#showUpgrade"/>
<method href="#startUpgrade"/>
<method href="#patchUpgrade"/>
<method href="#deleteUpgrade"/>
</resource>
<!-- /v1/certificate/certificate_install -->
<resource id="certconfig" path="certificate/certificate_install">
<method href="#installCert"/>
</resource>
<!-- /v1/certificate -->
<resource id="certs" path="certificate">
<method href="#listCert"/>
</resource>
<!-- /v1/certificate/{uuid} -->
<resource id="certconfig_uuid" path="certificate/{uuid}" >
<param name="uuid" style="template" required="true"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the Certificate configuration.</para>
</wadl:doc>
</param>
<method href="#showCert"/>
</resource>
<!-- /v1/firewallrules/import_firewall_rules -->
<resource id="firewallrules" path="firewallrules/import_firewall_rules">
<method href="#importFirewallRules"/>
</resource>
<!-- /v1/firewallrules -->
<resource id="firewallrules" path="firewallrules">
<method href="#showFirewallRules"/>
</resource>
<!-- /v1/license/install_license -->
<resource id="install_license" path="license/install_license">
<method href="#installLicense"/>
</resource>
<!-- /v1/license -->
<resource id="license" path="license">
<method href="#listLicenseInfo"/>
</resource>
<!-- /v1/labels/{host_id} -->
<resource id="assign_label" path="labels/{host_id}">
<param name="host_id" 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 host.</para>
</wadl:doc>
</param>
<method href="#assignLabel"/>
</resource>
<!-- /v1/labels/{label_id} -->
<resource id="label_id" path="labels/{label_id}" >
<param name="label_id" 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 host label. </para>
</wadl:doc>
</param>
<method href="#removeLabel"/>
</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-sysinv-v1"/>
</resource_type>
<!--*******************************************************-->
<!-- METHODS -->
<!--*******************************************************-->
<!-- ..................................................... -->
<!-- .. Versions .. -->
<!-- ..................................................... -->
<method name="GET" id="listVersions-sysinv-v1">
<wadl:doc xml:lang="EN" title="List API versions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all Titanium Cloud System Inventory 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/sysinv-versions-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="showVersionDetails-sysinv-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show API v1 details">
<para role="shortdesc">Shows details for System Inventory 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>
<!-- ..................................................... -->
<!-- .. Hosts .. -->
<!-- ..................................................... -->
<method name="GET" id="listHosts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List hosts">
<para role="shortdesc">Lists all host entities.</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="ihosts" 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 host entities.</para>
</wadl:doc>
</param>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show host">
<para role="shortdesc">Shows detailed information about a specific host.</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="invProvisioned" 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 host has the minimum level of provisioning or not.
Only a <code>provisioned</code> host can be unlocked.</para>
</wadl:doc>
</param>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create host">
<para role="shortdesc">Creates a host.</para>
<para>Note that a host should only be added through the REST API if the system is
not already configured to be automatically added by the system.
This is determined by configuration option during config_controller at
system installation.</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="hostname" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The hostname for the host. Must be a unique name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="personality" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The role of of this host:
i.e. <code>controller</code>, <code>storage</code>, <code>compute</code>
.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="mgmt_mac" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The MAC address of the host's management interface. Must be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="mgmt_ip" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The IP address of the host's management interface. Must be unique.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_type" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para> This attribute specifies whether board management controller type is
<code>bmc</code>.
</para>
<para><code>bmc</code> enables Board Management Controller.
Default is None to indicate no board management controller.
If bm_type is specified, then bm_ip, bm_username,
and bm_password are also required.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_ip" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Only applicable if <code>bm_type</code> is not None.
This attribute specifies the host's board management controller interface IP
address. <code>bm_ip</code> is not allowed to be added if the system is configured
with board management (e.g. board management subnet and vlan) at installation
(config_controller).
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_username" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Only applicable if <code>bm_type</code> is not None.
This attribute specifies the host's board management controller username.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_password" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Only applicable if <code>bm_type</code> is not None.
This attribute specifies the host's board management controller password.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="boot_device" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Device used for boot partition, relative to /dev. Default: sda</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rootfs_device" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Device used for rootfs and platform partitions, relative to /dev. Default: sda</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="install_output" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Installation output format. Values are 'text' or 'graphical'. Default: text</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="console" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Serial console configuration, specifying port and baud rate. Default: 'ttyS0,115200'.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ttys_dcd" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This attribute specifies whether serial port data carrier detect is enabled.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="plain" type="xsd:dict" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The location of the host.
Must be a dictinoary with a single parameter 'locn'.</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/host_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&hostListShowParameters;
&hostAddParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_add-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="POST" id="addHostBulk">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Bulk Create hosts">
<para role="shortdesc">Creates multiple hosts from a template.</para>
<para>Accepts an XML file containing the specifications of hosts
to be added to the system and performs a host-add for each.
Refer to the Administration Guide for XML specifications.
</para>
</wadl:doc>
<request>
<representation mediaType="application/octet-stream">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_bulk_add-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="GET" id="exportHostBulk">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Bulk Export hosts">
<para role="shortdesc">Export hosts definition file from an existing system.</para>
<para>Output XML string is well formatted (with line breaks and indent)</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_bulk_export-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="PATCH" id="modifyHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify host">
<para role="shortdesc">Modifies a specific host.</para>
<para>The atrributes of a Host which are modifiable:</para>
<itemizedlist>
<listitem><para>personality,</para></listitem>
<listitem><para>hostname,</para></listitem>
<listitem><para>bm_type,</para></listitem>
<listitem><para>bm_ip,</para></listitem>
<listitem><para>bm_username,</para></listitem>
<listitem><para>bm_password,</para></listitem>
<listitem><para>serialid,</para></listitem>
<listitem><para>location,</para></listitem>
<listitem><para>boot_device,</para></listitem>
<listitem><para>rootfs_device,</para></listitem>
<listitem><para>install_output,</para></listitem>
<listitem><para>console,</para></listitem>
<listitem><para>ttys_dcd.</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="hostname" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name provisioned for the host.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="personality" 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 role of the host: <code>controller</code>, <code>compute</code> or <code>storage</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_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 board management type of the host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_username" 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 board management username of the host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bm_ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The board management IP Address of the host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="serialid" 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 serial id configured for the host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="location" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The location information of the host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="boot_device" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Device used for boot partition, relative to /dev. Default: sda</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rootfs_device" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Device used for rootfs and platform partitions, relative to /dev. Default: sda</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="install_output" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Installation output format. Values are 'text' or 'graphical'. Default: text</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="console" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Serial console configuration, specifying port and baud rate. Default: 'ttyS0,115200'.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ttys_dcd" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This attribute specifies whether serial port data carrier detect is enabled.</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/host_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>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="actionHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Action host">
<para role="shortdesc">Executes an action on a specific host.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="action" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Perform one of the following actions to the host:
Valid values are: <code>unlock</code>,
<code>lock</code>,
<code>swact</code>,
<code>apply-profile</code>,
<code>reboot</code>,
<code>reset</code>,
<code>power-on</code>,
<code>power-off</code>,
or <code>reinstall</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/host_action-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>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_action-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete host">
<para role="shortdesc">Deletes a specific host.</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>
<!-- ..................................................... -->
<!-- .. Ports .. -->
<!-- ..................................................... -->
<method name="GET" id="listPorts">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List ports">
<para role="shortdesc">List the physical ports of a host.</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="ports" 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 physical ports of a host.</para>
</wadl:doc>
</param>
&portListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/port_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getPort">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show port">
<para role="shortdesc">Shows the attributes of a specific physical port.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&portListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/port_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Interfaces .. -->
<!-- ..................................................... -->
<method name="GET" id="listInterfaces">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List interfaces">
<para role="shortdesc">List the L2 interfaces of a specific host.</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="iinterfaces" 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 L2 interfaces for a specific host.</para>
</wadl:doc>
</param>
&interfaceListShowParameters;
&commonListShowParameters;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Interfaces which the current interface uses.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>Interfaces which use the current interface.
</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/interface_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getInterface">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show interface">
<para role="shortdesc">Shows information about a specific L2 interface.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&interfaceListShowParameters;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ifcapabilities" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="providernetworksdict" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ports" 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 physical ports of this interface.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Interfaces which the current interface uses.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>Interfaces which use the current interface.
</para>
</wadl:doc>
</param>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/interface_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addInterface">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create interface">
<para role="shortdesc">Creates an L2 interface on a specific host.</para>
<para>Note that <code>mgmt</code> and <code>oam</code>
can only be added through the REST API if their networktype is unassigned to none.
<code>mgmt</code> and <code>oam</code> are automatically added by the
system by default.</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="ifname" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="networktype" 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 network that this interface will be attached to;
i.e. <code>mgmt</code>, <code>infra</code>, <code>oam</code>,
<code>data</code>, <code>pci-passthrough</code>, <code>pci-sriov</code>,
<code>infra</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="iftype" 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 interface; i.e. <code>ae</code> or
<code>vlan</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="aemode" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Only applicable if <code>iftype : ae</code>,
this attribute specifies whether the AE/LAG should operate as <code>balanced</code>
or <code>active_standby</code> or <code>802.3ad</code> across its links.
The <code>balanced</code> and <code>active_standby</code> are the only modes
supported by <code>data</code> type interface. For <code>mgmt</code>
type interface the <code>802.3ad</code> option must be selected.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="txhashpolicy" 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>Only applicable if <code>iftype : ae</code> and <code>aemode : balanced</code>,
this attribute specifies what packet headers the AE/LAG should use to distribute
packets across the different links/ports of the AE/LAG group;
<code>layer2</code>, <code>layer2+3</code> or <code>layer3+4</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vlan_id" 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>Only applicable if <code>iftype : vlan</code>,
this attribute specifies a virtual lan id for a vlan interface type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="providernetworks" 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>Only applicable if <code>networktype : data</code>,
this attribute specifies a comma-separated list of
provider networks that this <code>data</code> interface
is attached to.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ports" 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>This attribute specifies a comma-separated list of
ports that this interface contains. If <code>iftype : ethernet</code>
then only one port is allowed.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Only applicable if <code>iftype : ae</code> or <code>iftype: vlan</code>,
this attribute specifies a comma-separated list of
interfaces that this interface uses.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>This attribute specifies a comma-separated list of
interfaces that use this interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imtu" 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>This attribute specifies the interface's Maximum Transmit Unit.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sriov_numvfs" 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>The number of VFs to configure on the interface's port; only applicable
if <code>networktype = pci-sriov</code> where only a
single port is associated with the interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ihost_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 UUID of the host to create the interface on.</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/interface_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&interfaceListShowParameters;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ifcapabilities" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="providernetworksdict" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ports" 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 physical ports of this interface.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Interfaces which the current interface uses.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>Interfaces which use the current interface.
</para>
</wadl:doc>
</param>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/interface_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyInterface">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify interface">
<para role="shortdesc">Modifies a specific L2 interface.</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="ifname" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="networktype" 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 network that this interface will be attached to;
i.e. <code>mgmt</code>, <code>infra</code>, <code>oam</code>,
<code>data</code>, <code>pci-passthrough</code>, <code>pci-sriov</code>,
<code>infra</code> or <code>none</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="iftype" 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 interface; i.e. <code>ethernet</code> or <code>ae</code> or
<code>vlan</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="aemode" style="plain" type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Only applicable if <code>iftype : ae</code>,
this attribute specifies whether the AE/LAG should operate as <code>balanced</code>
or <code>active_standby</code> across its links. These are
the only modes supported by <code>data</code> type interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="txhashpolicy" 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>Only applicable if <code>iftype : ae</code> and <code>aemode : balanced</code>,
this attribute specifies what packet headers the AE/LAG should use to distribute
packets across the different links/ports of the AE/LAG group;
<code>layer2</code>, <code>layer2+3</code> or <code>layer3+4</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vlan_id" 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>Only applicable if <code>iftype : vlan</code>,
this attribute specifies a virtual lan id for a vlan interface type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="providernetworks" 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>Only applicable if <code>networktype : data</code>,
this attribute specifies a comma-separated list of
provider networks that this <code>data</code> interface
is attached to.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ports" 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>This attribute specifies a comma-separated list of
ports that this interface contains. If <code>iftype : ethernet</code>
then only one port is allowed.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Only applicable if <code>iftype : ae</code> or <code>iftype: vlan</code>,
this attribute specifies a comma-separated list of
interfaces that this interface uses.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>This attribute specifies a comma-separated list of
interfaces that use this interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imtu" 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>This attribute specifies the interface's Maximum Transmit Unit.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sriov_numvfs" 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>The number of VFs to configure on the interface's port; only applicable
if <code>networktype = pci-sriov</code> where only a single
port is associated with the interface.</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/interface_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>
&interfaceListShowParameters;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ifcapabilities" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="providernetworksdict" 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>Currently not supported.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ports" 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 physical ports of this interface.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uses" 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>Interfaces which the current interface uses.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="used_by" 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>Interfaces which use the current interface.
</para>
</wadl:doc>
</param>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/interface_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteInterface">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete interface">
<para role="shortdesc">Deletes a specific L2 interface.</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>
<!-- ..................................................... -->
<!-- .. System .. -->
<!-- ..................................................... -->
<method name="GET" id="getSystem">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show system">
<para role="shortdesc">Shows attributes of the System object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&systemListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/system_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifySystem">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify system">
<para role="shortdesc">Modifies attributes of the System object.</para>
<para>The attributes of the System object that are modifiable are: </para>
<itemizedlist>
<listitem><para>name,</para></listitem>
<listitem><para>system_mode,</para></listitem>
<listitem><para>timezone,</para></listitem>
<listitem><para>description,</para></listitem>
<listitem><para>location,</para></listitem>
<listitem><para>sdn_enabled,</para></listitem>
<listitem><para>contact.</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/system_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="ihosts" 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>Links for retreiving the list of hosts for this system.
</para>
</wadl:doc>
</param>
&systemListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/system_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Clusters .. -->
<!-- ..................................................... -->
<method name="GET" id="listClusters">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List clusters">
<para role="shortdesc">Lists all cluster entities.</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="clusters" 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 cluster entities.</para>
</wadl:doc>
</param>
&clusterListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cluster_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getCluster">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show cluster">
<para role="shortdesc">Shows detailed information about a specific cluster.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&clusterListShowParameters;
&clusterShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cluster_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Cpus .. -->
<!-- ..................................................... -->
<method name="GET" id="listCpus">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List cpus">
<para role="shortdesc">Lists all cpus (logical processor cores) of a host.</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="icpus" 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 cpus (logical processor cores) of a host.</para>
</wadl:doc>
</param>
&cpuListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cpu_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getCpu">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show cpu">
<para role="shortdesc">Shows information about a specific cpu (logical processor core).</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&cpuListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cpu_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PUT" id="modifyCpu">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify cpu">
<para role="shortdesc">Modifies the number of cores assigned to different functions
on a host.</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="function" 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>This parameter specifies the function that is being assigned
a different number of cores. The only functions currently allowed to be
assigned a different number of cores <code>platform</code>, <code>vswitch</code> and
<code>shared</code>.</para>
<para><code>platform</code> function is for managing the cores
dedicated to the platform.</para>
<para><code>vswitch</code> function is for managing the cores
dedicated to the vswitch.</para>
<para><code>shared</code> function is for managing the cores
reserved for sharing by VMs using the hw:wrs:shared_vcpu flavor extra spec.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="sockets" 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 number of cores on a socket assigned to this function.</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/cpu_modify-request.json"/>
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cpu_modify-request-platform.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>
&cpuListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/cpu_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Memorys .. -->
<!-- ..................................................... -->
<method name="GET" id="listMemorys">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List memorys">
<para role="shortdesc">Lists the memory information of all NUMA nodes of a host.</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="imemorys" 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 NUMA nodes (and their associated memory information) for this host.</para>
</wadl:doc>
</param>
&memoryListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/memory_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getMemory">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show memory">
<para role="shortdesc">Shows the memory information about a specific NUMA node of a specific host.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&memoryListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/memory_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyMemory">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify memory">
<para role="shortdesc">Modifies the memory information about a specific NUMA node of a specific host..</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="platform_reserved_mib" 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>If not null, the amount of reserved memory for platform in MiB
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vm_hugepages_nr_1G_pending" 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>If not null, the pending configured number of Virtual Machine
1G huge pages.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vm_hugepages_nr_2M_pending" 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>If not null, the pending configured number of Virtual Machine
2M huge pages.</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/memory_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>
&memoryListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/memory_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Sensor Groups and Sensors .. -->
<!-- ..................................................... -->
<method name="GET" id="listSensorGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List sensorgroups">
<para role="shortdesc">Lists the sensorgroup information of a host.</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="isensorgroups" 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 associated sensorgroup information for this host.</para>
</wadl:doc>
</param>
&sensorgroupListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensorgroup_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getSensorGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show sensorgroup">
<para role="shortdesc">Shows the sensorgroup information of a specific sensorgroup.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sensorgroupListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensorgroup_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifySensorGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify sensorgroup">
<para role="shortdesc">Modifies the sensorgroup information of a specific sensorgroup.</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="suppress" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>If <code>True</code>, suppresses any actions configured for the sensorgroup.
The sensorgroup remains monitored, but the actions configured will be suppressed.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="actions_critical_group" 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>Specifies the actions to take upon critical threshold event. Action selectable from actions_critical_choices. e.g. <code>alarm, ignore, log, reset, powercycle</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="actions_major_group" 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>Specifies the actions to take upon major threshold event. Action selectable from actions_major_choices. e.g. <code>alarm, ignore, log</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="actions_minor_group" 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>Specifies the actions to take upon minor threshold event. Action selectable from actions_minor_choices. e.g. <code>ignore, log, alarm</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="audit_interval_group" 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>Specifies the audit interval, in time-units of seconds, for the sensors in the sensorgroup.
</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/sensorgroup_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>
&sensorgroupListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensorgroup_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="GET" id="listSensors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List sensors">
<para role="shortdesc">Lists the sensor information of a host.</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="isensors" 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 their associated sensor information for this host.</para>
</wadl:doc>
</param>
&sensorListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensor_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getSensor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show sensor">
<para role="shortdesc">Shows the sensor information of a specific sensor.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sensorListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensor_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifySensor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify sensor">
<para role="shortdesc">Modifies the sensor information of a specific sensor.</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="suppress" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>If <code>True</code>, suppresses any actions configured for the sensor.
When suppressed, the sensor remains monitored, but the actions configured will be suppressed.
</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/sensor_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>
&sensorListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sensor_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Disks .. -->
<!-- ..................................................... -->
<method name="GET" id="listDisks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List disks">
<para role="shortdesc">Lists all physical disks of a host.</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="idisks" 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 physical disk entities.</para>
</wadl:doc>
</param>
&diskListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/disk_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getDisk">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show disk">
<para role="shortdesc">Shows detailed information about a specific physical disk.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&diskListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/disk_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyDisk">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify disk">
<para role="shortdesc">Modifies the disk.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&diskModifyParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/disk_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>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Partitions .. -->
<!-- ..................................................... -->
<method name="GET" id="listPartitions">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List partitions">
<para role="shortdesc">Lists all disk partitions of a host.</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="partitions" 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 disk partition entities.</para>
</wadl:doc>
</param>
&partitionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/partition_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getPartition">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Disk Partition">
<para role="shortdesc">Shows detailed information about a specific disk partition.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&partitionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/partition_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="editPartition">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Edit Partition">
<para role="shortdesc">Modifies a specific disk partition.</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="size_mib" 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>This parameter specifies a new size for the disk
partition.
</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/partition_edit-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>
&partitionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/partition_edit-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="addPartition">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a disk partition">
<para role="shortdesc">Creates a partition on a specific disk of a host.</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="ihost_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>This parameter specifies the partition host uuid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type_guid" 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>This parameter specifies the partition type guid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="idisk_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>This parameter specifies the partition disk uuid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size_mib" 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>This parameter specifies the size of the partition.
</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/partition_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&partitionListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/partition_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deletePartition">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Partition">
<para role="shortdesc">Deletes a specific disk partition.</para>
<para>This is supported just for user created, LVM Physical Volume, partition.
In order to delete a partition, it must be the last partition on the disk.
</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>
<!-- ..................................................... -->
<!-- .. Ceph Storage Volumes .. -->
<!-- ..................................................... -->
<method name="GET" id="listStors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List stor functions">
<para role="shortdesc">Lists all Ceph storage functions of a host.</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="stors" 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 Ceph storage function entities.</para>
</wadl:doc>
</param>
&volumeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Ceph Storage Function">
<para role="shortdesc">Shows detailed information about a specific Ceph storage function.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&volumeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="editStor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Edit a Ceph Storage Function">
<para role="shortdesc">Modifies a specific Ceph storage function.</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="journal_location" 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>This parameter specifies a new location for the stor's journal.
Needed only for "osd" functions.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="journal_size_mib" 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>This parameter specifies a new size for the stor's journal.
Needed only for "osd" functions.
</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/volume_edit-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>
&volumeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_edit-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="addStor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a Ceph storage function">
<para role="shortdesc">Creates a Ceph storage function on a specific host.</para>
<para>
PREREQUISITES: A 'ceph' storage backend must be configured in the
system. If multiple storage tiers are defined then a tier_uuid must be
specified.
</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="function" 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>This parameter specifies the Ceph storage function.
Valid values are (is): <code>osd</code> or <code>journal</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ihost_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>This parameter specifies the storage host uuid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="idisk_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>This parameter specifies the storage disk uuid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="journal_location" 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>This parameter specifies the uuid of the journal stor
on which the stor's journal will reside. Needed only
for "osd" functions.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="journal_size_mib" 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>This parameter specifies the size of the journal. Needed
only for "osd" functions.
</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/volume_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&volumeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volume_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete the Ceph Storage Function">
<para role="shortdesc">Deletes a specific Ceph storage function.</para>
<para>This is supported just for journal type stors. The host must be locked.
In order to delete an osd stor, the host must be locked and deleted.
</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>
<!-- ..................................................... -->
<!-- .. storconfig .. -->
<!-- ..................................................... -->
<method name="GET" id="summary">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="summary">
<para role="shortdesc">get storage backend summary.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&profileShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/istorconfig_summary-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Volume Groups .. -->
<!-- ..................................................... -->
<method name="GET" id="listVolumeGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volume groups">
<para role="shortdesc">Lists all LVM volume groups of a host.</para>
<para>
This will list all the LVM volume groups for a given host.
</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="ilvgs" 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 volume group entities.</para>
</wadl:doc>
</param>
&volumegroupListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volumegroup_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getVolumeGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show volume group">
<para role="shortdesc">Shows detailed information about a specific LVM volume group.</para>
<para>
This will show detailed information about a specific LVM volume group.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&volumegroupListShowParameters;
&volumegroupListShowParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volumegroup_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyVolumeGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify volume group">
<para role="shortdesc">Modifies a specific volume group capability.</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="capabilites" 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>A dictionary of key-value pairs prepresenting volume group parameters and values.
Valid nova-local parameters are: <code>instances_lv_size_mib</code>,
<code>instance_backing</code>, and <code>concurrent_disk_operations</code>. Valid
cinder-volumes parameters are: <code>lvm_type</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/volumegroup_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>
&volumegroupListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volumegroup_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="addVolumeGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create a volume Group">
<para role="shortdesc">Creates an LVM volume group on a specific host.</para>
<para>
This will create an LVM volume group on the specified host. This
functionality is not available on storage hosts. In addition, the
volume group name is limited to "nova-local" or "cinder-volumes".
</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="lvm_vg_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the volume group name.
Valid values are (is): <code>nova-local</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ihost_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>This parameter specifies the compute host uuid.
</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/volumegroup_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&volumegroupListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/volumegroup_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteVolumeGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete a volume group">
<para role="shortdesc">Deletes a specific LVM volume group.</para>
<para>
In order to delete an LVM volume group, the host must be locked. All
physical volumes assigned to the volume group will also be deleted.
</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>
<!-- ..................................................... -->
<!-- .. Physical Volumes .. -->
<!-- ..................................................... -->
<method name="GET" id="listPhysicalVolumes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List volumes">
<para role="shortdesc">Lists all LVM physical volumes of a host.</para>
<para>
This will list all the LVM physical volumes defined on the given host.
A physical volume can be a pre-defined disk partition or an entire
extra disk as supported by the Volume Group.
</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="ivolumes" 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 physical volume entities.</para>
</wadl:doc>
</param>
&physicalvolumeListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/physvolume_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getPhysicalVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show physical volume">
<para role="shortdesc">Shows detailed information about a specific LVM physical volume.</para>
<para>
This will show detailed information about a specific LVM physical volume.
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&physicalvolumeListShowParameters;
&physicalvolumeListShowParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/physvolume_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addPhysicalVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create an LVM physical volume">
<para role="shortdesc">Creates an LVM physical volume on a specific host.</para>
<para>
This will create an LVM physical volume on the specified host. This
functionality is disabled on storage nodes. A physical volume can
be a pre-defined disk partition or an entire extra disk as supported by
the Volume Group. In addition, the volume group name is limited to
"nova-local" or "cinder-volumes".
</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="ilvg_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>This parameter specifies the volume group uuid.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ihost_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>This parameter specifies the compute host uuid.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="idisk_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>This parameter specifies the storage disk uuid.
</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/physvolume_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&physicalvolumeListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/physvolume_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deletePhysicalVolume">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete an LVM physical volume">
<para role="shortdesc">Deletes a specific LVM physical volume.</para>
<para>
In order to delete an LVM physical volume, the host must be locked.
</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>
<!-- ..................................................... -->
<!-- .. Profiles .. -->
<!-- ..................................................... -->
<method name="GET" id="listProfiles">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List profiles">
<para role="shortdesc">Lists all profiles.</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="iprofiles" 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 profile entities.</para>
</wadl:doc>
</param>
&profileListParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/profile_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getProfile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show profile">
<para role="shortdesc">Shows information about a specific profile.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&profileShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/profile_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addProfile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create profile">
<para role="shortdesc">Creates a profile.</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="profilename" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the new profile.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="profiletype" 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 profile to be created.
Valid values are: <code>if</code>, <code>cpu</code> or
<code>stor</code>.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ihost_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 UUID of the Host to create the profile based on.</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/profile_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&profileShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/profile_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteProfile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete profile">
<para role="shortdesc">Deletes a specific profile.</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>
<!-- ..................................................... -->
<!-- .. Communities .. -->
<!-- ..................................................... -->
<method name="GET" id="listCommunities">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List communities">
<para role="shortdesc">Lists all SNMP Communities.</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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="icommunity" 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 SNMP Communities.</para>
</wadl:doc>
</param>
&communityListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/community_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getCommunity">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show community">
<para role="shortdesc">Shows information about a specific SNMP Community.</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>
&communityListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/community_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyCommunity">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify community">
<para role="shortdesc">Modifies a specific SNMP Community.</para>
<para></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="community" 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>This parameter specifies the new community string.</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/community_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>
&communityListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/community_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="addCommunity">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create community">
<para role="shortdesc">Creates a SNMP Community.</para>
<para></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="community" 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>This parameter specifies the community string to create.</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/community_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&communityListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/community_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteCommunity">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete community">
<para role="shortdesc">Deletes a specific SNMP Community.</para>
<para></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>
<!-- ..................................................... -->
<!-- .. Trap Destinations .. -->
<!-- ..................................................... -->
<method name="GET" id="listTrapdests">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List trap destinations">
<para role="shortdesc">Lists all SNMP Trap Destinations.</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>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="itrapdests" 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 SNMP Trap Destinations.</para>
</wadl:doc>
</param>
&trapdestListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/trapdest_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getTrapdest">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show trap destination">
<para role="shortdesc">Shows information about a specific SNMP Trap Destination.</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>
&trapdestListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/trapdest_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyTrapdest">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify trap destination">
<para role="shortdesc">Modifies a specific SNMP Trap Destination.</para>
<para></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="ip_address" 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>This parameter specifies the IP address of a specific trap destination.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="community" 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>This parameter specifies the community of which the trap destination is a member.</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/trapdest_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>
&trapdestListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/trapdest_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="addTrapdest">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create trap destination">
<para role="shortdesc">Creates a SNMP Trap Destination.</para>
<para></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="ip_address" 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>This parameter specifies the IP address of a new trap destination.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="community" 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>This parameter specifies the community of which the trap destination is a member.</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/trapdest_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&trapdestListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/trapdest_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteTrapdest">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete trap destination">
<para role="shortdesc">Deletes a specific SNMP Trap Destination.</para>
<para></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>
<!-- ..................................................... -->
<!-- .. Dns .. -->
<!-- ..................................................... -->
<method name="GET" id="getDns">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show dns">
<para role="shortdesc">Shows attributes of the DNS object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&dnsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/dns_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyDns">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify dns">
<para role="shortdesc">Modifies attributes of the DNS object.</para>
<para>The attributes of the DNS object that are configurable are: </para>
<itemizedlist>
<listitem><para>nameservers</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="nameservers" 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>This parameter specifies the list of Domain Name Servers (DNS). Comma separated list.</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/dns_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>
&dnsListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/dns_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Ntp .. -->
<!-- ..................................................... -->
<method name="GET" id="getNtp">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show ntp">
<para role="shortdesc">Shows attributes of the NTP object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&ntpListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ntp_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyNtp">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify ntp">
<para role="shortdesc">Modifies attributes of the NTP object.</para>
<para>The attributes of the NTP object that are configurable are: </para>
<itemizedlist>
<listitem><para>ntpservers</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ntpservers" 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>This parameter specifies the list of Network Time Protocol (NTP) Servers. Comma separated list.</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/ntp_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>
&ntpListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ntp_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. External OAM .. -->
<!-- ..................................................... -->
<method name="GET" id="getExtoam">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show External OAM">
<para role="shortdesc">Shows attributes of the External OAM object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&extoamListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/extoam_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyExtoam">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify External OAM">
<para role="shortdesc">Modifies attributes of the External OAM object.</para>
<para>The attributes of the External OAM objects that are configurable are: </para>
<itemizedlist>
<listitem><para>oam_subnet</para></listitem>
<listitem><para>oam_gateway_ip</para></listitem>
<listitem><para>oam_floating_ip</para></listitem>
<listitem><para>oam_c0_ip</para></listitem>
<listitem><para>oam_c1_ip</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam_subnet" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies External
OAM IP Subnet.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam_gateway_ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies External
OAM Gateway IP Address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam_floating_ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies External
OAM Floating IP.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam_c0_ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies External
OAM Controller-0 IP Address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="oam_c1_ip" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies External
OAM Controller-1 IP Address.</para>
</wadl:doc>
</param>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/extoam_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>
&extoamListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/extoam_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Infrastructure Subnet .. -->
<!-- ..................................................... -->
<method name="GET" id="getInfra">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show infrastructure network IP subnet configuration">
<para role="shortdesc">Shows attributes of the infrastructure network IP subnet object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&infraListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/infra_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addInfra">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add infrastructure network IP subnet">
<para role="shortdesc">Add attributes of the infrastructure network IP subnet object.</para>
<para>The attributes of the infrastructure network IP subnet object that are configurable are: </para>
<itemizedlist>
<listitem><para>infra_subnet</para></listitem>
<listitem><para>infra_start</para></listitem>
<listitem><para>infra_end</para></listitem>
<listitem><para>infra_mtu</para></listitem>
<listitem><para>infra_vlan_id</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_subnet" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the infrastructure network IP subnet.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_start" 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>This parameter specifies the infrastructure network start IP address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_end" 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>This parameter specifies the infrastructure network end IP address.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_mtu" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the MTU of the infrastructure interface.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_vlan_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>This parameter specifies the VLAN ID of the infrastructure interface.</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/infra_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&infraListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/infra_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyInfra">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify infrastructure network IP subnet">
<para role="shortdesc">Modifies attributes of the infrastructure network IP subnet object.</para>
<para>The attributes of the infrastructure network IP subnet object that are configurable are: </para>
<itemizedlist>
<listitem><para>infra_start</para></listitem>
<listitem><para>infra_end</para></listitem>
<listitem><para>infra_mtu</para></listitem>
<listitem><para>infra_vlan_id</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="infra_subnet" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the infrastructure network IP subnet.</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/infra_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>
&infraListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/infra_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="applyInfra">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Apply infrastructure network attributes">
<para role="shortdesc">Applies attributes of the infrastructure network IP subnet object.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/infra_apply-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/infra_apply-response.json"/>
</wadl:doc>
</representation>
</response>
</method>
<!-- ..................................................... -->
<!-- .. DRBD Configuration .. -->
<!-- ..................................................... -->
<method name="GET" id="getDrbdconfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show DRBD configuration">
<para role="shortdesc">Shows attributes of the DRBD configuration object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&drbdsyncListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/drbdsync_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyDrbdconfig">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify DRBD configuration">
<para role="shortdesc">Modifies attributes of the DRBD configuration object.</para>
<para>The attributes of the DRBD configuration object that are configurable are: </para>
<itemizedlist>
<listitem><para>link_util</para></listitem>
<listitem><para>num_parallel</para></listitem>
<listitem><para>rtt_ms</para></listitem>
</itemizedlist>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="link_util" 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>This parameter specifies the DRBD engineered link utilization percent during resync.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="num_parallel" 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>This parameter specifies the DRBD number of parallel devices to resync.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rtt_ms" style="plain" type="xsd:float" >
<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 DRBD replication nodes round-trip-time milliseconds.</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/drbdsync_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>
&drbdsyncListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/drbdsync_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Devices .. -->
<!-- ..................................................... -->
<method name="GET" id="listDevices">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List devices">
<para role="shortdesc">List the PCI devices of a host.</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="devices" 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 PCI devices of a host.</para>
</wadl:doc>
</param>
&deviceListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/device_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getDevice">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show device">
<para role="shortdesc">Shows the attributes of a specific PCI device.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&deviceListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/device_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyDevice">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify device">
<para role="shortdesc">Modifies a specific PCI device.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the device.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enabled" 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 status of this device;
i.e. <code>True</code>, <code>False</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/device_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="devices" 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 PCI devices of this host.
</para>
</wadl:doc>
</param>
&deviceListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/device_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Service Parameter .. -->
<!-- ..................................................... -->
<method name="GET" id="listServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List service parameters">
<para role="shortdesc">List the service parameters.</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="parameters" 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 service parameters.</para>
</wadl:doc>
</param>
&serviceParameterListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_parameter_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service parameter">
<para role="shortdesc">Shows attributes of the Service parameter
object.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceParameterListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_parameter_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create service parameter">
<para role="shortdesc">Creates parameters for a service.</para>
<para></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="service" 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>This parameter specifies the name of the service.
Valid values are (is): <code>identity</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="section" 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>This parameter specifies the section of the
configuration file for the service.
</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/service_parameter_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceParameterListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_parameter_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="applyServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Apply service parameters">
<para role="shortdesc">Applies the service parameters.</para>
<para></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="service" 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>This parameter specifies the name of the service.
Valid values are (is): <code>identity</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/service_parameter_apply-request.json"/>
</wadl:doc>
</representation>
</request>
<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="PATCH" id="modifyServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify service parameter">
<para role="shortdesc">Modifies the value of the Service
parameter object.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name for the service parameter.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="value" 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 value of the service parameter.</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/service_parameter_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="parameters" 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 service parameters. </para>
</wadl:doc>
</param>
&serviceParameterListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_parameter_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteServiceParameter">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete service parameter">
<para role="shortdesc">Deletes a service parameter.</para>
<para></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>
<!-- ..................................................... -->
<!-- .. LLDP Agents .. -->
<!-- ..................................................... -->
<method name="GET" id="listLldpAgents">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List LLDP agents">
<para role="shortdesc">List the LLDP agents of a host.</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="lldp_agents" 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 LLDP agents of a host.</para>
</wadl:doc>
</param>
&lldpAgentListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/lldp_agent_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getLldpAgent">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show LLDP agent">
<para role="shortdesc">Shows the attributes of a specific LLDP agent.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&lldpAgentListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/lldp_agent_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. LLDP Neighbors .. -->
<!-- ..................................................... -->
<method name="GET" id="listLldpNeighbors">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List LLDP neighbors">
<para role="shortdesc">List the LLDP neighbors of a host.</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="lldp_agents" 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 LLDP neighbors of a host.</para>
</wadl:doc>
</param>
&lldpNeighborListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/lldp_neighbor_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getLldpNeighbor">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show LLDP neighbor">
<para role="shortdesc">Shows the attributes of a specific LLDP neighbor.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&lldpNeighborListShowParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/lldp_neighbor_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Services .. -->
<!-- ..................................................... -->
<method name="GET" id="listServices">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List services">
<para role="shortdesc">List all services running.</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="services" 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 services.</para>
</wadl:doc>
</param>
&serviceListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service">
<para role="shortdesc">Shows the attributes of a specific service.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify service">
<para role="shortdesc">Modifies the configuration of a service.</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="enabled" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Service enabled.</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/service_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="enabled" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Service enabled.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Service name.</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/service_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Service Nodes .. -->
<!-- ..................................................... -->
<method name="GET" id="listServiceNodes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List service nodes">
<para role="shortdesc">List all service nodes in the system.</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="nodes" 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 service nodes.</para>
</wadl:doc>
</param>
&serviceNodeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_node_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getServiceNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service node">
<para role="shortdesc">Shows the attributes of a specific service node.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceNodeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_node_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Service Group .. -->
<!-- ..................................................... -->
<method name="GET" id="listServiceGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List service groups">
<para role="shortdesc">List all service groups in the system.</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="service_groups" 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 service groups.</para>
</wadl:doc>
</param>
&serviceGroupListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_group_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getServiceGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service group">
<para role="shortdesc">Shows the attributes of a specific service group.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceGroupListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_group_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. SDN Controllers .. -->
<!-- ..................................................... -->
<method name="GET" id="listSdnController">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List SDN controllers">
<para role="shortdesc">List the SDN controllers.</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="sdn_controllers" 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 SDN controllers.</para>
</wadl:doc>
</param>
&sdnControllerCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getSdnController">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show SDN controller">
<para role="shortdesc">Shows attributes of the SDN controller.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sdnControllerCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addSdnController">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Create SDN controller">
<para role="shortdesc">Adds an SDN controller.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sdnControllerCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sdnControllerCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifySdnController">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify SDN controller">
<para role="shortdesc">Modifies the attributes of the SDN controller.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&sdnControllerCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_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>
&sdnControllerCommonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/sdn_controller_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteSdnController">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete SDN controller">
<para role="shortdesc">Deletes an SDN controller.</para>
<para></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>
<!-- ..................................................... -->
<!-- .. Remote Logging .. -->
<!-- ..................................................... -->
<method name="GET" id="showRemoteLogging">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show remote logging">
<para role="shortdesc">Show configuration for remote logging.</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="remoteloggings" 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 remotelogging configuration.</para>
</wadl:doc>
</param>
&remoteLoggingParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/remotelogging_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyRemoteLogging">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify remotelogging">
<para role="shortdesc">Modifies the configuration of the remote logging of this system.</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="ip_address" 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>IP Address of remote log server.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="enabled" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Remote log server enabled.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="transport" 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>Remote log server transport protocol.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="port" 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>Remote log server port.</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/remotelogging_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>
&remoteLoggingParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/remotelogging_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="GET" id="getAddrPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Address Pool">
<para role="shortdesc">Shows detailed information about a specific address pool.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addrPoolCommonParameters;
&addrPoolListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/addrpool_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listAddrPools">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Address Pools">
<para role="shortdesc">Shows detailed information about all address pools.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addrPoolCommonParameters;
&addrPoolListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/addrpool_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteAddrPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Address Pool">
<para role="shortdesc">Deletes an address pool.</para>
<para></para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="addAddrPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Address Pool">
<para role="shortdesc">Adds an address pool.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addrPoolCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/addrpool_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addrPoolCommonParameters; &addrPoolListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/addrpool_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyAddrPool">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Address Pool">
<para role="shortdesc">Modifies an address pool.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name (or network type) of the address pool resource.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="order" 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>A string representing the IP address allocation scheme; <code>random</code> to allocate in random order, or <code>sequential</code> to allocate in sequential order.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ranges" 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>A python list, formatted as a JSON string, representing a series of start-end pairs which define the allocatable ranges of IP addresses in the pool.</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/addrpool_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>
&addrPoolCommonParameters;
&addrPoolListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/addrpool_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="GET" id="getAddress">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Address">
<para role="shortdesc">Shows detailed information about a specific address.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addressCommonParameters;
&addressListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_addr_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listAddresses">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Addresses">
<para role="shortdesc">Shows detailed information about all addresses.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addressCommonParameters;
&addressListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_addr_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteAddress">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Address">
<para role="shortdesc">Deletes an address.</para>
<para></para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="addAddress">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Address">
<para role="shortdesc">Adds an address.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addressCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_addr_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&addressCommonParameters; &addressListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_addr_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="GET" id="getRoute">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Route">
<para role="shortdesc">Shows detailed information about a specific route.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&routeCommonParameters;
&routeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_route_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listRoutes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Routes">
<para role="shortdesc">Shows detailed information about all routes.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&routeCommonParameters;
&routeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_route_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteRoute">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Route">
<para role="shortdesc">Deletes a route.</para>
<para></para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="addRoute">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add Route">
<para role="shortdesc">Adds a route.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&routeCommonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_route_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&routeCommonParameters; &routeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_route_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="GET" id="getNetwork">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Network">
<para role="shortdesc">Shows detailed information about a specific network.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&networkListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/network_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listNetworks">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Networks">
<para role="shortdesc">Shows detailed information about all networks.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&networkListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/network_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Storage Backends - Base Class .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageBackends">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List storage backends">
<para role="shortdesc">List the storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_backend_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listStorageUsage">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List storage backends usage">
<para role="shortdesc">List the storage backends usage.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendUsageParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_usage_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Storage Backends - LVM .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageLvms">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List LVM storage backends">
<para role="shortdesc">List LVM storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageLvmParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageLvm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Lvm storage backend">
<para role="shortdesc">Shows attributes of the Lvm storage backend.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageLvmParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageLvm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add a Lvm storage backend">
<para role="shortdesc">Add a Lvm storage backend.</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="backend" 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>This parameter specifies the type of the backend.
Valid values are (is): <code>lvm</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the name of the backend.
</para>
</wadl:doc>
</param>
&storageBackendModifyParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageLvmParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageLvm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Lvm storage backend">
<para role="shortdesc">Modifies the Lvm storage backend.</para>
<para>
LVM backend only supports cinder service and is mandatory. Also, there is
currently no modifiable parameter in the capabilities field. Any custom
defined parameter will remain unused.
</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendModifyParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_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="confirmed" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Returns back parameter in request.</para>
</wadl:doc>
</param>
&storageBackendListParameters;
&storageLvmParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_lvm_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageLvm">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete LVM storage backend">
<para role="shortdesc">Deletes an LVM storage backend.</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>
<!-- ..................................................... -->
<!-- .. Storage Backends - Ceph .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageCephs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Ceph storage backends">
<para role="shortdesc">List Ceph storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageCeph">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Ceph storage backend">
<para role="shortdesc">Shows attributes of the Ceph storage backend.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageCeph">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add a Ceph storage backend">
<para role="shortdesc">Add a Ceph storage backend.</para>
<para></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="backend" 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>This parameter specifies the type of the backend.
Valid values are (is): <code>ceph</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the name of the backend.
</para>
</wadl:doc>
</param>
&storageBackendModifyParameters;
&storageCephParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageCeph">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Ceph storage backend">
<para role="shortdesc">Modifies the Ceph storage backend.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendModifyParameters;
&storageCephParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_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>
&storageBackendListParameters;
&storageCephParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageCeph">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete ceph storage backend">
<para role="shortdesc">Deletes a ceph storage backend.</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>
<!-- ..................................................... -->
<!-- .. Storage Backends - Ceph External .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageCephExternals">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Ceph External storage backends">
<para role="shortdesc">List Ceph External storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageCephExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Ceph External storage backend">
<para role="shortdesc">Shows attributes of the Ceph External storage backend.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageCephExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add a Ceph External storage backend">
<para role="shortdesc">Add a Ceph External storage backend.</para>
<para></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="backend" 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>This parameter specifies the type of the backend.
Valid values are (is): <code>ceph-external</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the name of the backend.
</para>
</wadl:doc>
</param>
&storageBackendModifyParameters;
&storageCephExternalParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageCephExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageCephExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Ceph External storage backend">
<para role="shortdesc">Modifies the Ceph External storage backend.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendModifyParameters;
&storageCephExternalParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_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>
&storageBackendListParameters;
&storageCephExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_ceph_external_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageCephExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete ceph External storage backend">
<para role="shortdesc">Deletes a ceph External storage backend.</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>
<!-- ..................................................... -->
<!-- .. Storage Backends - File .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageFiles">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List File storage backends">
<para role="shortdesc">List file storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageFileParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageFile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show File storage backend">
<para role="shortdesc">Shows attributes of the file storage backend.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageFileParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageFile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add a File storage backend">
<para role="shortdesc">Add a File storage backend.</para>
<para></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="backend" 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>This parameter specifies the type of the backend.
Valid values are (is): <code>file</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the name of the backend.
</para>
</wadl:doc>
</param>
&storageBackendModifyParameters;
&storageFileParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageFileParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageFile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify File storage backend">
<para role="shortdesc">Modifies the File storage backend.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendModifyParameters;
&storageFileParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_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>
&storageBackendListParameters;
&storageFileParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_file_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageFile">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete file storage backend">
<para role="shortdesc">Deletes a file storage backend.</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>
<!-- ..................................................... -->
<!-- .. Storage Backends - External .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageExternals">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List External storage backends">
<para role="shortdesc">List external storage backends.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show External storage backend">
<para role="shortdesc">Shows attributes of the external storage backend.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add an External storage backend">
<para role="shortdesc">Add an External storage backend.</para>
<para></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="backend" 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>This parameter specifies the type of the backend.
Valid values are (is): <code>external</code>
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>This parameter specifies the name of the backend.
</para>
</wadl:doc>
</param>
&storageBackendModifyParameters;
&storageExternalParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendListParameters;
&storageExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify External storage backend">
<para role="shortdesc">Modifies the External storage backend.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageBackendModifyParameters;
&storageExternalParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_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>
&storageBackendListParameters;
&storageExternalParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_external_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageExternal">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete external storage backend">
<para role="shortdesc">Deletes an external storage backend.</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>
<!-- ..................................................... -->
<!-- .. Storage Tiers .. -->
<!-- ..................................................... -->
<method name="GET" id="listStorageTiers">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List storage tiers">
<para role="shortdesc">List the storage tiers.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageTierListParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getStorageTier">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show storage tiers">
<para role="shortdesc">Shows attributes of a storage tier.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageTierListParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="addStorageTier">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Add a storage tier">
<para role="shortdesc">Add a storage tier.</para>
<para></para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<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 unique name of the storage tier.</para>
</wadl:doc>
</param>
&storageTierModifyParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_add-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageTierListParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_add-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PATCH" id="modifyStorageTier">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify storage tier">
<para role="shortdesc">Modifies the storage tier.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&storageTierModifyParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_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>
&storageTierListParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/storage_tier_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="DELETE" id="deleteStorageTier">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete storage tier">
<para role="shortdesc">Deletes a storage tier.</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>
<!-- ..................................................... -->
<!-- .. Controller filesystem .. -->
<!-- ..................................................... -->
<method name="GET" id="getControllerFs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Controller filesystem information">
<para role="shortdesc">Shows attributes of a Controller filesystem.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&controllerFsParametersFilesystems;
&controllerFsParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/controller_fs_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listControllerFs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Controller filesystems">
<para role="shortdesc">List the Controller filesystems.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&controllerFsParametersFilesystems;
&controllerFsParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/controller_fs_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyControllerFs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Controller filesystem">
<para role="shortdesc">Modifies a Controller filesystem.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&controllerFsModifyParametersFilesystems;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/controller_fs_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>
&controllerFsParametersFilesystems;
&controllerFsParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/controller_fs_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="PUT" id="modifyMultiControllerFs">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify Multiple Controller Filesystem(s)">
<para role="shortdesc">Modifies Controller Filesystem(s).</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&controllerFsModifyParametersFilesystems;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/controller_fs_modify_multi-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Ceph Monitors .. -->
<!-- ..................................................... -->
<method name="GET" id="listCephMons">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Ceph monitors">
<para role="shortdesc">List Ceph monitors.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&cephMonParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ceph_mon_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getCephMon">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Ceph monitor attributes">
<para role="shortdesc">Shows attributes of a Ceph monitor.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&cephMonParameters;
&cephMonParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ceph_mon_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="PATCH" id="modifyCephMon">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Modify a Ceph monitor">
<para role="shortdesc">Modifies a Ceph monitor.</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&cephMonParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ceph_mon_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>
&cephMonParameters;
&cephMonParametersExtra;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/ceph_mon_modify-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. System Health .. -->
<!-- ..................................................... -->
<method name="GET" id="getSystemHealth">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show system health information">
<para role="shortdesc">Shows the health status of the system.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/system_health-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getSystemHealthUpgrade">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show system health information for an upgrade">
<para role="shortdesc">Shows the health status of the system with requirements for an upgrade.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/system_health_upgrade-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Loads .. -->
<!-- ..................................................... -->
<method name="GET" id="listLoads">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List system loads">
<para role="shortdesc">List of loads installed on the system.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&loadParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loads_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="getLoadDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show load details">
<para role="shortdesc">Shows the attributes of a load.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&loadParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/loads_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteLoad">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Delete Load">
<para role="shortdesc">Deletes a load.</para>
<para></para>
</wadl:doc>
<response status="204">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
</method>
<method name="POST" id="importLoad">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Import load">
<para role="shortdesc">Import a load.</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="path_to_iso" 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 full system path of the iso.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="path_to_signature" 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 full system path of the detached signature for the iso.</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/load_import-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>
&loadParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/load_import-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Upgrade .. -->
<!-- ..................................................... -->
<method name="GET" id="showUpgrade">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show upgrade details">
<para role="shortdesc">Shows the status of the upgrade</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&upgradeListParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/upgrade_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="deleteUpgrade">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Complete Upgrade">
<para role="shortdesc">Completes the upgrade. This can be done after the upgrade is activated or aborted.</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>
&upgradeParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/upgrade_delete-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults;
</method>
<method name="PATCH" id="patchUpgrade">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Abort/Activate Upgrade">
<para role="shortdesc">Activate or abort the upgrade.</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="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>Change the state of the upgrade:
Valid values are: <code>aborting</code>,
or <code>activation-requested</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/upgrade_patch-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>
&upgradeParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/upgrade_patch-response.json"/>
</wadl:doc>
</representation>
</response>
&postPutFaults;
</method>
<method name="POST" id="startUpgrade">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Start Upgrade">
<para role="shortdesc">Starts the upgrade.</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="force" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Set to true to ignore minor and warning alarms.</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/upgrade_start-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>
&upgradeParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/upgrade_start-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<method name="POST" id="upgradeHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Upgrade Host">
<para role="shortdesc">Upgrades a host.</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="force" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Set to true to perform the action even if the host is offline.</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/host_upgrade-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>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_upgrade-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<method name="POST" id="downgradeHost">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Downgrade Host">
<para role="shortdesc">Downgrades a host.</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="force" style="plain" type="xsd:boolean" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Set to true to perform the action even if the host is offline.</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/host_downgrade-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>
&hostListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_downgrade-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. Certificate Configuration .. -->
<!-- ..................................................... -->
<method name="POST" id="installCert">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Install Certificate">
<para role="shortdesc">Install System Certificate.</para>
<para>Accepts a PEM file containing the X509 certificate.
</para>
<warning>
<para>
For security reasons, the original certificate,
containing the private key, will be removed,
once the private key is processed.
</para>
</warning>
</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="Content-Type multipart/form-data" style="plain" type="xsd:string" required="true" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The content of a file.
e.g. if using curl, this would be specified as:
curl -F name=@full_path_of_filename
</para>
<xsdxt:code href="api_samples/certificate_install-request.json"/>
</wadl:doc>
</param>
&certconfigCommonParameters;
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<method name="GET" id="showCert">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Certificate configuration">
<para role="shortdesc">Shows attributes of the Certificate configuration, including
additional details if available for that certificate mode
</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/certconfig_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="listCert">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List Certificates">
<para role="shortdesc">List installed System Certificates.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Custom Firewall Rules .. -->
<!-- ..................................................... -->
<method name="GET" id="showFirewallRules">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show Custom Firewall Rules">
<para role="shortdesc">Shows custom firewall rules.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&customFirewallRulesParameters;
&commonListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/firewall_rules_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="POST" id="importFirewallRules">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Install firewall rules">
<para role="shortdesc">Install custom firewall rules.</para>
<para>Accepts a file containing the custom OAM firewall rules
compatible with the Linux Netfilter framework.
</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="Content-Type multipart/form-data" style="plain" type="xsd:string" required="true" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The content of a file.
e.g. if using curl, this would be specified as:
curl -F name=@full_path_of_filename
</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>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<!-- ..................................................... -->
<!-- .. License .. -->
<!-- ..................................................... -->
<method name="POST" id="installLicense">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Install license file">
<para role="shortdesc">Install license file.</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="Content-Type multipart/form-data" style="plain" type="xsd:string" required="true" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The content of a file.
e.g. if using curl, this would be specified as:
curl -F name=@full_path_of_filename
</para>
<xsdxt:code href="api_samples/license_install-request.json"/>
</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>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<method name="GET" id="listLicenseInfo">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List license files">
<para role="shortdesc">List license information.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&licenseListParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/license_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Label .. -->
<!-- ..................................................... -->
<method name="POST" id="assignLabel">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Assign label to a host">
<para role="shortdesc">Assign label to a host.</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="label" 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>This parameter specifies the label key value pairs.
</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/host_label_assign-request.json"/>
</wadl:doc>
</representation>
</request>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
</representation>
</response>
&commonFaults; &postPutFaults;
</method>
<method name="GET" id="listLabel">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List label for a host">
<para role="shortdesc">List host label.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&labelListParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/host_label_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="DELETE" id="removeLabel">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Remove label from a host">
<para role="shortdesc">Remove label from a host.</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>
</application>
View Git Blame Copy Permalink