1Baremetal API
2=============
3
4For details on how to use baremetal, see :doc:`/user/guides/baremetal`
5
6.. automodule:: openstack.baremetal.v1._proxy
7
8The Baremetal Class
9-------------------
10
11The baremetal high-level interface is available through the ``baremetal``
12member of a :class:`~openstack.connection.Connection` object.
13The ``baremetal`` member will only be added if the service is detected.
14
15Node Operations
16^^^^^^^^^^^^^^^
17.. autoclass:: openstack.baremetal.v1._proxy.Proxy
18  :noindex:
19  :members: nodes, find_node, get_node, create_node, update_node, patch_node, delete_node,
20            validate_node, set_node_power_state, set_node_provision_state,
21            wait_for_nodes_provision_state, wait_for_node_power_state,
22            wait_for_node_reservation, set_node_maintenance, unset_node_maintenance
23
24Port Operations
25^^^^^^^^^^^^^^^
26.. autoclass:: openstack.baremetal.v1._proxy.Proxy
27  :noindex:
28  :members: ports, find_port, get_port, create_port, update_port, delete_port, patch_port
29
30Port Group Operations
31^^^^^^^^^^^^^^^^^^^^^
32.. autoclass:: openstack.baremetal.v1._proxy.Proxy
33  :noindex:
34  :members: port_groups, find_port_group, get_port_group,
35            create_port_group, update_port_group, delete_port_group, patch_port_group
36
37Driver Operations
38^^^^^^^^^^^^^^^^^
39.. autoclass:: openstack.baremetal.v1._proxy.Proxy
40  :noindex:
41  :members: drivers, get_driver
42
43Chassis Operations
44^^^^^^^^^^^^^^^^^^
45.. autoclass:: openstack.baremetal.v1._proxy.Proxy
46  :noindex:
47  :members: chassis, find_chassis, get_chassis,
48            create_chassis, update_chassis, patch_chassis, delete_chassis
49
50VIF Operations
51^^^^^^^^^^^^^^
52.. autoclass:: openstack.baremetal.v1._proxy.Proxy
53  :noindex:
54  :members: list_node_vifs, attach_vif_to_node, detach_vif_from_node
55
56Allocation Operations
57^^^^^^^^^^^^^^^^^^^^^
58.. autoclass:: openstack.baremetal.v1._proxy.Proxy
59  :noindex:
60  :members: allocations, get_allocation, create_allocation,
61            update_allocation, patch_allocation, delete_allocation,
62            wait_for_allocation
63
64Volume Connector Operations
65^^^^^^^^^^^^^^^^^^^^^^^^^^^
66.. autoclass:: openstack.baremetal.v1._proxy.Proxy
67  :noindex:
68  :members: volume_connectors, find_volume_connector, get_volume_connector,
69            create_volume_connector, update_volume_connector,
70            patch_volume_connector, delete_volume_connector
71
72Volume Target Operations
73^^^^^^^^^^^^^^^^^^^^^^^^^^^
74.. autoclass:: openstack.baremetal.v1._proxy.Proxy
75  :noindex:
76  :members: volume_targets, find_volume_target, get_volume_target,
77            create_volume_target, update_volume_target,
78            patch_volume_target, delete_volume_target
79
80Deploy Template Operations
81^^^^^^^^^^^^^^^^^^^^^^^^^^^
82.. autoclass:: openstack.baremetal.v1._proxy.Proxy
83  :noindex:
84  :members: deploy_templates, get_deploy_template,
85            create_deploy_template, update_deploy_template,
86            patch_deploy_template, delete_deploy_template
87
88Utilities
89---------
90
91Building config drives
92^^^^^^^^^^^^^^^^^^^^^^
93
94.. automodule:: openstack.baremetal.configdrive
95  :noindex:
96   :members:
97