summaryrefslogtreecommitdiff
path: root/doc/source/webapi/v1.rst
blob: c07dfc7e0c292bf493b1c78335b5da7e0657eede (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
=====================
 RESTful Web API (v1)
=====================

Chassis
=======

.. rest-controller:: ironic.api.controllers.v1.chassis:ChassisController
   :webprefix: /v1/chassis

.. autotype:: ironic.api.controllers.v1.chassis.ChassisCollection
   :members:

.. autotype:: ironic.api.controllers.v1.chassis.Chassis
   :members:


Drivers
=======

.. rest-controller:: ironic.api.controllers.v1.driver:DriversController
   :webprefix: /v1/drivers

.. rest-controller:: ironic.api.controllers.v1.driver:DriverPassthruController
   :webprefix: /v1/drivers/(driver_name)/vendor_passthru

.. autotype:: ironic.api.controllers.v1.driver.DriverList
   :members:

.. autotype:: ironic.api.controllers.v1.driver.Driver
   :members:


Links
=====

.. autotype:: ironic.api.controllers.link.Link
   :members:


Nodes
=====

.. rest-controller:: ironic.api.controllers.v1.node:NodesController
   :webprefix: /v1/nodes

.. rest-controller:: ironic.api.controllers.v1.node:NodeMaintenanceController
   :webprefix: /v1/nodes/(node_ident)/maintenance

.. rest-controller:: ironic.api.controllers.v1.node:BootDeviceController
   :webprefix: /v1/nodes/(node_ident)/management/boot_device

.. rest-controller:: ironic.api.controllers.v1.node:NodeStatesController
   :webprefix: /v1/nodes/(node_ident)/states

.. rest-controller:: ironic.api.controllers.v1.node:NodeConsoleController
   :webprefix: /v1/nodes/(node_ident)/states/console

.. rest-controller:: ironic.api.controllers.v1.node:NodeVendorPassthruController
   :webprefix: /v1/nodes/(node_ident)/vendor_passthru

.. autotype:: ironic.api.controllers.v1.node.ConsoleInfo
   :members:

.. autotype:: ironic.api.controllers.v1.node.Node
   :members:

.. autotype:: ironic.api.controllers.v1.node.NodeCollection
   :members:

.. autotype:: ironic.api.controllers.v1.node.NodeStates
   :members:


Ports
=====

.. rest-controller:: ironic.api.controllers.v1.port:PortsController
   :webprefix: /v1/ports

.. autotype:: ironic.api.controllers.v1.port.PortCollection
   :members:

.. autotype:: ironic.api.controllers.v1.port.Port
   :members: