mogan/api-ref/source/v1/manageable_servers.inc
wanghao d577c88d4a Manage existing BMs: Part-1
This patch introduce a new API:
'GET: /manageable_servers' to list the adoptable nodes
from drivers to operators.

As a reference, now we implement api in the Ironic driver.

APIImpact

Implements: bp manage-existing-bms

Change-Id: I56340ce534c3b8d4e855a4c753ecf90a07147d29
2017-08-25 19:42:58 +08:00

41 lines
960 B
ReStructuredText

.. -*- rst -*-
===================
Manageable Servers
===================
Lists manageable servers.
List manageable servers information
===================================
.. rest_method:: GET /manageable_servers
Lists manageable servers information.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- manageable_servers: manageable_servers
- uuid: manageable_servers_uuid
- name: manageable_servers_name
- resource_class: manageable_servers_resource_class
- power_state: manageable_servers_power_state
- provision_state: manageable_servers_provision_state
- ports: manageable_servers_ports
- portgroups: manageable_servers_portgroups
- image_source: manageable_servers_image_source
|
**Example List manageable servers information**
.. literalinclude:: samples/manageable_servers/manageable-servers-list-resp.json
:language: javascript