Login
[x]
Log in using an account from:
Fedora Account System
Red Hat Associate
Red Hat Customer
Or login using a Red Hat Bugzilla account
Forgot Password
Login:
Hide Forgot
Create an Account
Red Hat Bugzilla – Attachment 836376 Details for
Bug 1042930
replica_count field not present in rsdl definitions for migrate
[?]
New
Simple Search
Advanced Search
My Links
Browse
Requests
Reports
Current State
Search
Tabular reports
Graphical reports
Duplicates
Other Reports
User Changes
Plotly Reports
Bug Status
Bug Severity
Non-Defaults
|
Product Dashboard
Help
Page Help!
Bug Writing Guidelines
What's new
Browser Support Policy
5.0.4.rh83 Release notes
FAQ
Guides index
User guide
Web Services
Contact
Legal
This site requires JavaScript to be enabled to function correctly, please enable it.
rsdl from rhsc-cb11
file_1042930.txt (text/plain), 159.50 KB, created by
Dustin Tsang
on 2013-12-13 16:20:43 UTC
(
hide
)
Description:
rsdl from rhsc-cb11
Filename:
MIME Type:
Creator:
Dustin Tsang
Created:
2013-12-13 16:20:43 UTC
Size:
159.50 KB
patch
obsolete
><?xml version="1.0"?> ><rsdl href="/api?rsdl" rel="rsdl"> > <description>The oVirt RESTful API description language.</description> > <version major="2" minor="1" build="2" revision="0"/> > <schema href="/api?schema" rel="schema"> > <name>ovirt-engine-api-schema.xsd</name> > <description>oVirt API entities schema.</description> > </schema> > <general href="/*" rel="*"> > <description>These options are valid for entire application.</description> > <request> > <headers> > <header required="false"> > <name>Session-TTL</name> > <description> >Idle session TTL. An interval value of zero or less indicates that the session should never timeout ></description> > <value>minutes</value> > </header> > </headers> > </request> > <name>The oVirt RESTful API generic descriptor.</name> > </general> > <links> > <link href="/api/capabilities" rel="get"> > <description> >get the capabilities of the system listing the features that are supported for all versions of cluster/data center ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Capabilities</type> > </response> > </link> > <link href="/api/capabilities/{capabilitie:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>VersionCaps</type> > </response> > </link> > <link href="/api/clusters" rel="add"> > <description>add a new cluster to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Cluster</type> > <parameters_set> > <description>add a new cluster to the system</description> > <parameter required="true" type="xs:string"> > <name>cluster.data_center.id|name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>cluster.name</name> > </parameter> > <parameter required="true" type="xs:int"> > <name>cluster.version.major</name> > </parameter> > <parameter required="true" type="xs:int"> > <name>cluster.version.minor</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>cluster.cpu.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.comment</name> > </parameter> > <parameter required="false" type="xs:double"> > <name>cluster.memory_policy.overcommit.percent</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name> >cluster.memory_policy.transparent_hugepages.enabled ></name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.scheduling_policy.policy</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.low</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.high</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.duration</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.error_handling.on_error</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.virt_service</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.gluster_service</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.threads_as_cores</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.tunnel_migration</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.trusted_service</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.ballooning_enabled</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Cluster</type> > </response> > </link> > <link href="/api/clusters" rel="get"> > <description>get the list of clusters in the system</description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>Filter</name> > <value>true|false</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Clusters</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}" rel="delete"> > <description> >get the details of the specified cluster in the system ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}" rel="get"> > <description> >get the details of the specified cluster in the system ></description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>Filter</name> > <value>true|false</value> > </header> > </headers> > <body/> > </request> > <response> > <type>Cluster</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}" rel="update"> > <description>update the specified cluster in the system</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Cluster</type> > <parameters_set> > <description> >update the specified cluster in the system. The capabilities like virt servicem luster service, tarnsparent huge pages etc can be changed. ></description> > <parameter required="false" type="xs:string"> > <name>cluster.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.comment</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.data_center.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.cpu.id</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.version.major</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.version.minor</name> > </parameter> > <parameter required="false" type="xs:double"> > <name>cluster.memory_policy.overcommit.percent</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name> >cluster.memory_policy.transparent_hugepages.enabled ></name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.scheduling_policy.policy</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.low</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.high</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>cluster.scheduling_policy.thresholds.duration</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>cluster.error_handling.on_error</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.virt_service</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.gluster_service</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.threads_as_cores</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.tunnel_migration</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>cluster.ballooning_enabled</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Cluster</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>GlusterHooks</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks/{glusterhook:id}" rel="delete"> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks/{glusterhook:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>GlusterHook</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks/{glusterhook:id}/disable" rel="disable"> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set/> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks/{glusterhook:id}/enable" rel="enable"> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set/> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glusterhooks/{glusterhook:id}/resolve" rel="resolve"> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>action.resolution_type</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.host.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes" rel="add"> > <description>add a new gluster volume to the cluster</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>force</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body> > <type>GlusterVolume</type> > <parameters_set> > <description> >add a new gluster volume to the cluster with bricks ></description> > <parameter required="true" type="xs:string"> > <name>gluster_volume.name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>gluster_volume.volume_type</name> > </parameter> > <parameter required="true" type="collection"> > <name>gluster_volume.bricks.brick</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>brick.server_id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>brick.brick_dir</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>gluster_volume.transport_types</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>transport_type</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:unsignedShort"> > <name>gluster_volume.replica_count</name> > </parameter> > <parameter required="false" type="xs:unsignedShort"> > <name>gluster_volume.stripe_count</name> > </parameter> > <parameter required="false" type="collection"> > <name>gluster_volume.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>GlusterVolume</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes" rel="get"> > <description> >get the list of gluster volumes attached to the cluster ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>GlusterVolumes</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}" rel="delete"> > <request> > <http_method>DELETE</http_method> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>GlusterVolume</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks" rel="add"> > <description> >add a new brick to the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>force</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body> > <type>GlusterBricks</type> > <parameters_set> > <description> >add a new brick to the gluster volume attached to the cluster ></description> > <parameter required="true" type="collection"> > <name>brick</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>brick.server_id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>brick.brick_dir</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:unsignedShort"> > <name>replica_count</name> > </parameter> > <parameter required="false" type="xs:unsignedShort"> > <name>stripe_count</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>GlusterBricks</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks" rel="get"> > <description> >get the list of all bricks in the gluster volume attached to the cluster ></description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>All-Content</name> > <value>true|false</value> > </header> > </headers> > <body/> > </request> > <response> > <type>GlusterBricks</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/activate" rel="activate"> > <description> >activates the bricks post migration of data for reuse ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >activates the bricks post migration of data for reuse ></description> > <parameter required="true" type="collection"> > <name>bricks</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>brick.name</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/migrate" rel="migrate"> > <description> >migrate the data from the brick to others and mark for deletion ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >migrate the data from the brick to others and mark for deletion ></description> > <parameter required="true" type="collection"> > <name>bricks</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>brick.name</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/stopmigrate" rel="stopmigrate"> > <description> >stops the bricks migration task started on on volume ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >stops the bricks migration task started on on volume ></description> > <parameter required="true" type="collection"> > <name>bricks</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>brick.name</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/{brick:id}" rel="delete"> > <request> > <http_method>DELETE</http_method> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/{brick:id}" rel="get"> > <description> >get the details of the specified brick in the gluster volume attached to the cluster ></description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>All-Content</name> > <value>true|false</value> > </header> > </headers> > <body/> > </request> > <response> > <type>GlusterBrick</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/{brick:id}/replace" rel="replace"> > <description>This is deprecated.Use migrate and delete instead.</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <deprecated>true</deprecated> > <description> >replace the specified brick with a new brick directory in the gluster volume attached to the cluster ></description> > <parameter required="true" type="xs:string"> > <name>action.brick.server_id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>action.brick.brick_dir</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/{brick:id}/statistics" rel="get"> > <description> >get the statistics for the specified brick in the gluster volume attached to the cluster ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Statistics</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/bricks/{brick:id}/statistics/{statistic:id}" rel="get"> > <description> >get the details of the specified statistics for the brick in the gluster volume attached to the cluster ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Statistic</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/rebalance" rel="rebalance"> > <description> >invoke the rebalance command on the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >invoke the rebalance command on the gluster volume attached to the cluster with optional arguments to fix the lay and force the operation ></description> > <parameter required="false" type="xs:boolean"> > <name>action.fix_layout</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/resetalloptions" rel="resetalloptions"> > <description> >resets all options for the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >resets all options for the gluster volume attached to the cluster ></description> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/resetoption" rel="resetoption"> > <description> >reset an option for the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >reset an option for the gluster volume attached to the cluster with mandatory option to force the operation ></description> > <parameter required="true" type="xs:string"> > <name>action.option.name</name> > </parameter> > <parameter required="true" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/setoption" rel="setoption"> > <description> >set an option for the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>action.option.name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>action.option.value</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/start" rel="start"> > <description>start the gluster volume attached to the cluster</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >start the gluster volume attached to the cluster with an optional argument to force the operation ></description> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/stop" rel="stop"> > <description>stop the gluster volume attached to the cluster</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >stop the gluster volume attached to the cluster with an optional argument to force the operation ></description> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/glustervolumes/{glustervolume:id}/stoprebalance" rel="stoprebalance"> > <description> >invoke the stop rebalance command on the gluster volume attached to the cluster ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >invoke the stop rebalance command on the gluster volume attached to the cluster ></description> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/networks" rel="add"> > <description>add a new network to the cluster</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Network</type> > <parameters_set> > <description>add a new network to the cluster</description> > <parameter required="true" type="xs:string"> > <name>network.id|name</name> > </parameter> > <parameter required="false" type="collection"> > <name>network.usages.usage</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>usage</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/networks" rel="get"> > <description>get the list of networks in the cluster</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Networks</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/networks/{network:id}" rel="delete"> > <description>delete the specified network in the cluster</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}/networks/{network:id}" rel="get"> > <description> >get the detials of the specified network in the cluster ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/networks/{network:id}" rel="update"> > <description>update the specified network in the cluster</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Network</type> > <parameters_set> > <description> >update the specified network in the cluster with network usage. Display is provided here for backwards compatibility. ></description> > <parameter required="false" type="xs:boolean"> > <name>network.display</name> > </parameter> > <parameter required="false" type="collection"> > <name>network.usages.usage</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>usage</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/permissions" rel="add"> > <description>add a new permission on the cluster</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permission</type> > <parameters_set> > <description>add a new user level permission on the cluster</description> > <parameter required="true" type="xs:string"> > <name>permission.user.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description>add a new group level permission on the cluster</description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.group.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/permissions" rel="get"> > <description>get the list of permissions on the cluster</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/clusters/{cluster:id}/permissions/{permission:id}" rel="delete"> > <description>delete the permission on the cluster</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/clusters/{cluster:id}/permissions/{permission:id}" rel="get"> > <description>get the details of the permission on the cluster</description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/domains" rel="get"> > <description>get a list of domains in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Domains</type> > </response> > </link> > <link href="/api/domains/{domain:id}" rel="get"> > <description> >get the details of the specified domain in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Domain</type> > </response> > </link> > <link href="/api/domains/{domain:id}/groups" rel="get"> > <description>get the list of groups in the specified domain</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Groups</type> > </response> > </link> > <link href="/api/domains/{domain:id}/groups/{group:id}" rel="get"> > <description> >get the details of the specified group in the domain ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Group</type> > </response> > </link> > <link href="/api/domains/{domain:id}/users" rel="get"> > <description>get the list of users in the domain</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Users</type> > </response> > </link> > <link href="/api/domains/{domain:id}/users/{user:id}" rel="get"> > <description> >get the details of the specified user in the domain ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>User</type> > </response> > </link> > <link href="/api/events" rel="add"> > <description>add a new event to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Event</type> > <parameters_set> > <description>add a new event to the system</description> > <parameter required="true" type="xs:string"> > <name>event.description</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>event.severity</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>event.origin</name> > </parameter> > <parameter required="true" type="xs:int"> > <name>event.custom_id</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>event.flood_rate</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.host.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.user.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.vm.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.storage_domain.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.template.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.cluster.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>event.data_center.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Event</type> > </response> > </link> > <link href="/api/events" rel="get"> > <description>get the list of events in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:string" context="matrix"> > <name>from</name> > <value>event_id</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Events</type> > </response> > </link> > <link href="/api/events/{event:id}" rel="delete"> > <description>delete the specified event from the system</description> > <request> > <http_method>DELETE</http_method> > <body/> > </request> > </link> > <link href="/api/events/{event:id}" rel="get"> > <description> >get the details of the specified event in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Event</type> > </response> > </link> > <link href="/api/groups" rel="add"> > <description>add a new group to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Group</type> > <parameters_set> > <description>add a new group to the system</description> > <parameter required="true" type="xs:string"> > <name>group.name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Group</type> > </response> > </link> > <link href="/api/groups" rel="get"> > <description>get the list of groups in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Groups</type> > </response> > </link> > <link href="/api/groups/{group:id}" rel="delete"> > <description>delete the specified group in the system</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/groups/{group:id}" rel="get"> > <description> >get the details of the specified group in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Group</type> > </response> > </link> > <link href="/api/groups/{group:id}/permissions" rel="add"> > <description>add a new permission to the group in the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permission</type> > <parameters_set> > <description> >add a new permission on the data center to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.data_center.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the cluster to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.cluster.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the host to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.host.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the storage domain to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.storage_domain.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the vm to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.vm.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the vm pool to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.vmpool.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new permission on the template to the group in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.template.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/groups/{group:id}/permissions" rel="get"> > <description> >get list of permissions for the group in the system ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/groups/{group:id}/permissions/{permission:id}" rel="delete"> > <description> >delete the specified permission from the group in the system ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/groups/{group:id}/permissions/{permission:id}" rel="get"> > <description> >get the details of the specified permission for the group in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/groups/{group:id}/roles" rel="add"> > <description>add a new role to the specified group</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Role</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>role.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Role</type> > </response> > </link> > <link href="/api/groups/{group:id}/roles" rel="get"> > <description> >get the list of roles assigned to the specified group ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Roles</type> > </response> > </link> > <link href="/api/groups/{group:id}/roles/{role:id}" rel="delete"> > <description>delete the specified role assigned to a group</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/groups/{group:id}/roles/{role:id}/permits" rel="add"> > <description>add a new permit for a role in a group</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permit</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>permit.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/groups/{group:id}/roles/{role:id}/permits" rel="get"> > <description>get the permits for the specified role in a group</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permits</type> > </response> > </link> > <link href="/api/groups/{group:id}/roles/{role:id}/permits/{permit:id}" rel="delete"> > <description>delete the specified permit for a role in a group</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/groups/{group:id}/roles/{role:id}/permits/{permit:id}" rel="get"> > <description> >get details of the specified permit for a role in a group ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/groups/{group:id}/tags" rel="add"> > <description>add a new tag to a given group</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Tag</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>tag.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/groups/{group:id}/tags" rel="get"> > <description>get the list of tags attached to a given group</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Tags</type> > </response> > </link> > <link href="/api/groups/{group:id}/tags/{tag:id}" rel="delete"> > <description>delete the specified tag attached to a given group</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/groups/{group:id}/tags/{tag:id}" rel="get"> > <description> >get details of the specified tag attached to a given group ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/hosts" rel="add"> > <description>add a new host to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Host</type> > <parameters_set> > <description> >add a new host to the system providing the host root password. This has been deprecated and provided for backwards compatibility ></description> > <parameter required="true" type="xs:string"> > <name>host.name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>host.address</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>host.root_password</name> > <deprecated>true</deprecated> > </parameter> > <parameter required="true" type="xs:string"> > <name>host.cluster.id|name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.comment</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.port</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.display.address</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.storage_manager.priority</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.type</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.power_management.enabled</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.password</name> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.pm_proxy</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>propietary</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.agents.agent</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>password</name> > </parameter> > <parameter required="false" type="collection"> > <name>options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.reboot_after_installation</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.override_iptables</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new host to the system providing the ssh password or fingerprint ></description> > <parameter required="true" type="xs:string"> > <name>host.name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>host.address</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>host.cluster.id|name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.comment</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.ssh.port</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.fingerprint</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.authentication_method</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.user.user_name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.user.password</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.port</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.display.address</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.storage_manager.priority</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.type</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.power_management.enabled</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.password</name> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.pm_proxy</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>propietary</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.agents.agent</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>password</name> > </parameter> > <parameter required="false" type="collection"> > <name>options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.reboot_after_installation</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.override_iptables</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Host</type> > </response> > </link> > <link href="/api/hosts" rel="get"> > <description>get the list of hosts in the system</description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>Filter</name> > <value>true|false</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Hosts</type> > </response> > </link> > <link href="/api/hosts/{host:id}" rel="delete"> > <description>delete the specified host in the system</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body required="false"> > <type>Action</type> > <parameters_set> > <description>delete the specified host in the system</description> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > </link> > <link href="/api/hosts/{host:id}" rel="get"> > <description> >get the details of the specified host in the system ></description> > <request> > <http_method>GET</http_method> > <headers> > <header required="false"> > <name>Filter</name> > <value>true|false</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>force</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Host</type> > </response> > </link> > <link href="/api/hosts/{host:id}" rel="update"> > <description>update the specified host in the system</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body> > <type>Host</type> > <parameters_set> > <description> >update the specified host in the system. This is deprecated and is provided only for backwards compatibility ></description> > <parameter required="false" type="xs:string"> > <name>host.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.comment</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.root_password</name> > <deprecated>true</deprecated> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.display.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.cluster.id|name</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.port</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.storage_manager.priority</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.type</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.power_management.enabled</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.password</name> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.pm_proxy</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>propietary</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.agents.agent</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>password</name> > </parameter> > <parameter required="false" type="collection"> > <name>options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > <parameters_set> > <description>update the specified host in the system</description> > <parameter required="false" type="xs:string"> > <name>host.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.comment</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.address</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.ssh.port</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.user.user_name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.ssh.fingerprint</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.display.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.cluster.id|name</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.port</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>host.storage_manager.priority</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.type</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host.power_management.enabled</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host.power_management.password</name> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.pm_proxy</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>propietary</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>host.power_management.agents.agent</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>username</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>password</name> > </parameter> > <parameter required="false" type="collection"> > <name>options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Host</type> > </response> > </link> > <link href="/api/hosts/{host:id}/activate" rel="activate"> > <description>activate the specified host in the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/approve" rel="approve"> > <description>approve specified host to be added to the engine</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >approve specified host to be added to the engine. this occurs when the host registers itself with the engine ></description> > <parameter required="false" type="xs:string"> > <name>action.cluster.id|name</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.async</name> > </parameter> > <parameter required="false" type="xs:long"> > <name>action.grace_period.expiry</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/commitnetconfig" rel="commitnetconfig"> > <description> >commit the changes made to network configuration of the host ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/deactivate" rel="deactivate"> > <description>deactivate the specified host</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/fence" rel="fence"> > <description> >initiate the fence operation on the host which has become non-responsive after multiple retries to connect to it ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >initiate the fence operation on the host which has become non-responsive after multiple retries to connect to it ></description> > <parameter required="true" type="xs:string"> > <name>action.fence_type</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/forceselectspm" rel="forceselectspm"> > <description> >force the specified to be selected as storage pool manager ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/hooks" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Hooks</type> > </response> > </link> > <link href="/api/hosts/{host:id}/hooks/{hook:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Hook</type> > </response> > </link> > <link href="/api/hosts/{host:id}/install" rel="install"> > <description> >install vdsm and other packages required to get the host ready to be used in the engine ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <deprecated>true</deprecated> > <description> >install vdsm and other packages required to get the host ready to be used in the engine providing the root password. This has been deprecated ></description> > <parameter required="false" type="xs:string"> > <name>action.root_password</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.image</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >install vdsm and other packages required to get the host ready to be used in the engine providing thre ssh password ></description> > <parameter required="false" type="xs:int"> > <name>action.ssh.port</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.ssh.fingerprint</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.ssh.authentication_method</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.ssh.user.user_name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.ssh.user.password</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>action.image</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/iscsidiscover" rel="iscsidiscover"> > <description> >initiate the command to discover the iscsi targets and map the targets to the storage server connections ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >initiate the command to discover the iscsi targets and map the targets to the storage server connections ></description> > <parameter required="true" type="xs:string"> > <name>action.iscsi.address</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/iscsilogin" rel="iscsilogin"> > <description> >login to the specified iscsi target at the specified address ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >login to the specified iscsi target at the specified address ></description> > <parameter required="true" type="xs:string"> > <name>action.iscsi.address</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>action.iscsi.target</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics" rel="add"> > <description>add a new network interface for the host</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>HostNIC</type> > <parameters_set> > <description>add a new network interface for the host</description> > <parameter required="true" type="xs:string"> > <name>hostnic.network.id|name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>hostnic.name</name> > </parameter> > <parameter required="true" type="collection"> > <name>hostnic.bonding.slaves.host_nic</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>host_nic.id|name</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>hostnic.bonding.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>HostNIC</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics" rel="get"> > <description>get the list of network interfaces for the host</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>HostNics</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/setupnetworks" rel="setupnetworks"> > <description> >initiate the command to setup networks for the network interface card of the specified host ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >initiate the command to setup networks for the network interface card of the specified host ></description> > <parameter required="false" type="collection"> > <name>action.host_nics.host_nic</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>host_nic.network.id|name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.ip.gateway</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.boot_protocol</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.mac</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.ip.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>host_nic.ip.netmask</name> > </parameter> > <parameter required="false" type="collection"> > <name>host_nic.bonding.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.type</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="collection"> > <name>bonding.slaves.host_nic</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>host_nic.name|id</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>host_nic.override_configuration</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.checkConnectivity</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>action.connectivityTimeout</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.force</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}" rel="delete"> > <description> >delete the specified network interface for the host ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}" rel="get"> > <description> >get the details of the specified network interface for the host ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>HostNIC</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}" rel="update"> > <description> >update the specified network interface for the host ></description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body> > <type>HostNIC</type> > <parameters_set> > <description> >update the specified network interface for the host ></description> > <parameter required="false" type="collection"> > <name>hostnic.bonding.slaves.host_nic</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>host_nic.id|name</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.network.id|name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.name</name> > </parameter> > <parameter required="false" type="collection"> > <name>hostnic.bonding.options.option</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>option.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>option.value</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>type</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.ip.gateway</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.boot_protocol</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.mac</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.ip.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>hostnic.ip.netmask</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>hostnic.ip.mtu</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>HostNIC</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}/attach" rel="attach"> > <description> >attach the network interface card to the specified host ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >attach the network interface card to the specified host ></description> > <parameter required="true" type="xs:string"> > <name>action.network.id|name</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>action.async</name> > </parameter> > <parameter required="false" type="xs:long"> > <name>action.grace_period.expiry</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}/detach" rel="detach"> > <description> >detach the network interface card from the specified host ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Action</type> > <parameters_set> > <description> >detach the network interface card from the specified host ></description> > <parameter required="false" type="xs:boolean"> > <name>action.async</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Action</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}/statistics" rel="get"> > <description> >get the statistics for the network interface card attached to the specified host ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Statistics</type> > </response> > </link> > <link href="/api/hosts/{host:id}/nics/{nic:id}/statistics/{statistic:id}" rel="get"> > <description> >get the details of the specified statistics for the network interface card attached to the specified host ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Statistic</type> > </response> > </link> > <link href="/api/hosts/{host:id}/permissions" rel="add"> > <description>add a new permission for the host</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permission</type> > <parameters_set> > <description>add a new user level permission for the host</description> > <parameter required="true" type="xs:string"> > <name>permission.user.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description>add a new group level permission for the host</description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.group.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/hosts/{host:id}/permissions" rel="get"> > <description>get the list of permissions for the host</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/hosts/{host:id}/permissions/{permission:id}" rel="delete"> > <description>delete the specified permission for the host</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/hosts/{host:id}/permissions/{permission:id}" rel="get"> > <description> >get the details of the specified permission for the host ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/hosts/{host:id}/statistics" rel="get"> > <description>get the statistics for the host</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Statistics</type> > </response> > </link> > <link href="/api/hosts/{host:id}/statistics/{statistic:id}" rel="get"> > <description> >get the details of the specified statistics for the host ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Statistic</type> > </response> > </link> > <link href="/api/hosts/{host:id}/storage" rel="get"> > <description> >get the list of all logical units and volume groups for the host ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>HostStorage</type> > </response> > </link> > <link href="/api/hosts/{host:id}/storage/{storage:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Storage</type> > </response> > </link> > <link href="/api/hosts/{host:id}/tags" rel="add"> > <description>add a new tag to the host</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Tag</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>tag.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/hosts/{host:id}/tags" rel="get"> > <description>get the list of all tags added to the host</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Tags</type> > </response> > </link> > <link href="/api/hosts/{host:id}/tags/{tag:id}" rel="delete"> > <description>delete the specified tag added to the host</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/hosts/{host:id}/tags/{tag:id}" rel="get"> > <description> >get the details of the specified tag added to the host ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/networks" rel="add"> > <description>add a new network to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Network</type> > <parameters_set> > <description>add a new network to the system</description> > <parameter required="true" type="xs:string"> > <name>network.data_center.id|name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>network.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.comment</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.vlan.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.gateway</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.netmask</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>network.display</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>network.stp</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>network.mtu</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>network.profile_required</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/networks" rel="get"> > <description>get the list of all networks in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Networks</type> > </response> > </link> > <link href="/api/networks/{network:id}" rel="delete"> > <description>delete the specified network in the system</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/networks/{network:id}" rel="get"> > <description> >get the details of the specified network in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/networks/{network:id}" rel="update"> > <description>update the specified network in the system</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Network</type> > <parameters_set> > <description>update the specified network in the system</description> > <parameter required="false" type="xs:string"> > <name>network.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.comment</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.vlan.id</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.address</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.gateway</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>network.ip.netmask</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>network.display</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>network.stp</name> > </parameter> > <parameter required="false" type="xs:int"> > <name>network.mtu</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Network</type> > </response> > </link> > <link href="/api/networks/{network:id}/permissions" rel="add"> > <description>add a new permission on a network in the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permission</type> > <parameters_set> > <description> >add a new user level permission on a network in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.user.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new group level permission on a network in the system ></description> > <parameter required="true" type="xs:string"> > <name>permission.group.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/networks/{network:id}/permissions" rel="get"> > <description> >get the list of all permissions on a network in the system ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/networks/{network:id}/permissions/{permission:id}" rel="delete"> > <description> >delete the specified permission on a network in the system ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/networks/{network:id}/permissions/{permission:id}" rel="get"> > <description> >get the details of the specified permission on a network in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles" rel="add"> > <description> >add a new virtual network interface card profile for the network ></description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>VnicProfile</type> > <parameters_set> > <description> >add a new virtual network interface card profile for the network ></description> > <parameter required="true" type="xs:string"> > <name>vnicprofile.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>vnicprofile.description</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>vnicprofile.port_mirroring</name> > </parameter> > <parameter required="false" type="collection"> > <name>vnicprofile.custom_properties.custom_property</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>custom_property.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>custom_property.value</name> > </parameter> > </parameters_set> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>VnicProfile</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles" rel="get"> > <description> >get the list of all virtual network interface card profiles for the network ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>VnicProfiles</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}" rel="delete"> > <description> >delete the specified virtual network interface card profile for the network ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}" rel="get"> > <description> >get the details of the specified virtual network interface card profile for the network ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>VnicProfile</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}/permissions" rel="add"> > <request> > <http_method>POST</http_method> > <body> > <type>Permission</type> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}/permissions" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}/permissions/{permission:id}" rel="delete"> > <request> > <http_method>DELETE</http_method> > <body/> > </request> > </link> > <link href="/api/networks/{network:id}/vnicprofiles/{vnicprofile:id}/permissions/{permission:id}" rel="get"> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/roles" rel="add"> > <description>add a new role to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Role</type> > <parameters_set> > <description>add a new role to the system</description> > <parameter required="true" type="xs:string"> > <name>role.name</name> > </parameter> > <parameter required="true" type="collection"> > <name>role.permits.permit</name> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>permit.id</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:string"> > <name>role.description</name> > </parameter> > <parameter required="false" type="xs:boolean"> > <name>role.administrative</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Role</type> > </response> > </link> > <link href="/api/roles" rel="get"> > <description>get the list of all roles in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Roles</type> > </response> > </link> > <link href="/api/roles/{role:id}" rel="delete"> > <description> >get the details of the specified role in the system ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/roles/{role:id}" rel="get"> > <description> >get the details of the specified role in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Role</type> > </response> > </link> > <link href="/api/roles/{role:id}" rel="update"> > <description>update the specified role in the system</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Role</type> > <parameters_set> > <description>update the specified role in the system</description> > <parameter required="false" type="collection"> > <name>role.permits.permit</name> > <parameters_set> > <parameter required="false" type="xs:string"> > <name>permit.id</name> > </parameter> > </parameters_set> > </parameter> > <parameter required="false" type="xs:string"> > <name>role.description</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Role</type> > </response> > </link> > <link href="/api/roles/{role:id}/permits" rel="add"> > <description>add a new permit for the role in the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permit</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>permit.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/roles/{role:id}/permits" rel="get"> > <description> >get the list of all permits for the specified role in the system ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permits</type> > </response> > </link> > <link href="/api/roles/{role:id}/permits/{permit:id}" rel="delete"> > <description> >delete the specified permit for the role in the system ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/roles/{role:id}/permits/{permit:id}" rel="get"> > <description> >get the details of the specified permit for the role in the system ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/tags" rel="add"> > <description>add a new tag to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Tag</type> > <parameters_set> > <parameter required="true" type="xs:string"> > <name>tag.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>tag.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>tag.parent.tag.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/tags" rel="get"> > <description>get the list of tags in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Tags</type> > </response> > </link> > <link href="/api/tags/{tag:id}" rel="delete"> > <description>delete the specified tag in the system</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/tags/{tag:id}" rel="get"> > <description>get the details of the specified tag in the system</description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/tags/{tag:id}" rel="update"> > <description>update the specified tag in the system</description> > <request> > <http_method>PUT</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Tag</type> > <parameters_set> > <description> >update the name, description or parent tag of the specified tag in the system ></description> > <parameter required="false" type="xs:string"> > <name>tag.name</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>tag.description</name> > </parameter> > <parameter required="false" type="xs:string"> > <name>tag.parent.tag.name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/users" rel="add"> > <description>add a new user to the system</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>User</type> > <parameters_set> > <description> >add a new user to the specified domain with the specified user name ></description> > <parameter required="true" type="xs:string"> > <name>user.user_name</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>user.domain.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>User</type> > </response> > </link> > <link href="/api/users" rel="get"> > <description>get the list of all users registered in the system</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Users</type> > </response> > </link> > <link href="/api/users/{user:id}" rel="delete"> > <description>delete the from the domain</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/users/{user:id}" rel="get"> > <description> >get the details of the specified user registered in the system ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:string" context="query"> > <name>search</name> > <value>search query</value> > </parameter> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>case_sensitive</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>User</type> > </response> > </link> > <link href="/api/users/{user:id}/permissions" rel="add"> > <description>add a new permission for the user</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permission</type> > <parameters_set> > <description> >add a new tole permission for the user on the data center ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.data_center.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new tole permission for the user on the cluster ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.cluster.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description>add a new tole permission for the user on the host</description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.host.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new tole permission for the user on the storage domain ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.storage_domain.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description>add a new tole permission for the user on the vm</description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.vm.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new tole permission for the user on the vm pool ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.vmpool.id</name> > </parameter> > </parameters_set> > <parameters_set> > <description> >add a new tole permission for the user on the template ></description> > <parameter required="true" type="xs:string"> > <name>permission.role.id</name> > </parameter> > <parameter required="true" type="xs:string"> > <name>permission.template.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/users/{user:id}/permissions" rel="get"> > <description>get the list of all permissions for the user</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permissions</type> > </response> > </link> > <link href="/api/users/{user:id}/permissions/{permission:id}" rel="delete"> > <description>delete the specified permission for the user</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/users/{user:id}/permissions/{permission:id}" rel="get"> > <description> >get the details of the specified permission for the user ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permission</type> > </response> > </link> > <link href="/api/users/{user:id}/roles" rel="add"> > <description>add a new role to the user</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Role</type> > <parameters_set> > <description>add a new role to the user</description> > <parameter required="true" type="xs:string"> > <name>role.id</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Role</type> > </response> > </link> > <link href="/api/users/{user:id}/roles" rel="get"> > <description>get the list of roles assigned to the user</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Roles</type> > </response> > </link> > <link href="/api/users/{user:id}/roles/{role:id}" rel="delete"> > <description>delete the specified role assigned to the user</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/users/{user:id}/roles/{role:id}/permits" rel="add"> > <description>add a new permit for the role assigned to the user</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Permit</type> > <parameters_set> > <description>add a new permit for the role assigned to the user</description> > <parameter required="true" type="xs:string"> > <name>permit.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/users/{user:id}/roles/{role:id}/permits" rel="get"> > <description> >get the list of permits for the role assigned to the user ></description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Permits</type> > </response> > </link> > <link href="/api/users/{user:id}/roles/{role:id}/permits/{permit:id}" rel="delete"> > <description> >delete the specified permit for the role assigned to the user ></description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/users/{user:id}/roles/{role:id}/permits/{permit:id}" rel="get"> > <description> >get the details of the specified permit for the role assigned to the user ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Permit</type> > </response> > </link> > <link href="/api/users/{user:id}/tags" rel="add"> > <description>add a new tag to the user</description> > <request> > <http_method>POST</http_method> > <headers> > <header required="true"> > <name>Content-Type</name> > <value>application/xml|json</value> > </header> > <header required="false"> > <name>Expect</name> > <value>201-created</value> > </header> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <body> > <type>Tag</type> > <parameters_set> > <description>add a new tag to the user</description> > <parameter required="true" type="xs:string"> > <name>tag.id|name</name> > </parameter> > </parameters_set> > </body> > </request> > <response> > <type>Tag</type> > </response> > </link> > <link href="/api/users/{user:id}/tags" rel="get"> > <description>get the list of tags attached to the user</description> > <request> > <http_method>GET</http_method> > <url> > <parameters_set> > <parameter required="false" type="xs:int" context="matrix"> > <name>max</name> > <value>max results</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > <response> > <type>Tags</type> > </response> > </link> > <link href="/api/users/{user:id}/tags/{tag:id}" rel="delete"> > <description>delete the specified tag attached to the user</description> > <request> > <http_method>DELETE</http_method> > <headers> > <header required="false"> > <name>Correlation-Id</name> > <value>any string</value> > </header> > </headers> > <url> > <parameters_set> > <parameter required="false" type="xs:boolean" context="matrix"> > <name>async</name> > <value>true|false</value> > </parameter> > </parameters_set> > </url> > <body/> > </request> > </link> > <link href="/api/users/{user:id}/tags/{tag:id}" rel="get"> > <description> >get the details of the specified tag attached to the user ></description> > <request> > <http_method>GET</http_method> > <body/> > </request> > <response> > <type>Tag</type> > </response> > </link> > </links> ></rsdl>
<b>You cannot view the attachment while viewing its details because your browser does not support IFRAMEs. <a href="attachment.cgi?id=836376">View the attachment on a separate page</a>.</b>
View Attachment As Raw
Actions:
View
Attachments on
bug 1042930
: 836376