For details on how to use baremetal, see Using OpenStack Baremetal
The baremetal high-level interface is available through the baremetal
member of a Connection
object.
The baremetal
member will only be added if the service is detected.
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)¶create_node
(**attrs)¶Create a new node from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a
Node , it comprised
of the properties on the Node class. |
---|---|
Returns: | The results of node creation. |
Return type: | Node . |
update_node
(node, **attrs)¶Update a node.
Parameters: |
|
---|---|
Returns: | The updated node. |
Return type: |
delete_node
(node, ignore_missing=True)¶Delete a node.
Parameters: |
|
---|---|
Returns: | The instance of the node which was deleted. |
Return type: |
|
get_node
(node)¶Get a specific node.
Parameters: | node – The value can be the name or ID of a chassis or a
Node instance. |
---|---|
Returns: | One Node |
Raises: | ResourceNotFound when no
node matching the name or ID could be found. |
find_node
(name_or_id, ignore_missing=True)¶Find a single node.
Parameters: |
|
---|---|
Returns: | One |
nodes
(details=False, **query)¶Retrieve a generator of nodes.
Parameters: |
|
---|---|
Returns: | A generator of node instances. |
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_port
(**attrs)¶Create a new port from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a
Port , it comprises of the
properties on the Port class. |
---|---|
Returns: | The results of port creation. |
Return type: | Port . |
update_port
(port, **attrs)¶Update a port.
Parameters: |
|
---|---|
Returns: | The updated port. |
Return type: |
delete_port
(port, ignore_missing=True)¶Delete a port.
Parameters: |
|
---|---|
Returns: | The instance of the port which was deleted. |
Return type: |
|
get_port
(port, **query)¶Get a specific port.
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
find_port
(name_or_id, ignore_missing=True)¶Find a single port.
Parameters: |
|
---|---|
Returns: | One |
ports
(details=False, **query)¶Retrieve a generator of ports.
Parameters: |
|
---|---|
Returns: | A generator of port instances. |
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_port_group
(**attrs)¶Create a new portgroup from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a
PortGroup , it
comprises of the properties on the PortGroup class. |
---|---|
Returns: | The results of portgroup creation. |
Return type: | PortGroup . |
update_port_group
(port_group, **attrs)¶Update a port group.
Parameters: |
|
---|---|
Returns: | The updated port group. |
Return type: |
delete_port_group
(port_group, ignore_missing=True)¶Delete a port group.
Parameters: |
|
---|---|
Returns: | The instance of the port group which was deleted. |
Return type: |
get_port_group
(port_group, **query)¶Get a specific port group.
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
find_port_group
(name_or_id, ignore_missing=True)¶Find a single port group.
Parameters: |
|
---|---|
Returns: | One |
port_groups
(details=False, **query)¶Retrieve a generator of port groups.
Parameters: |
|
---|---|
Returns: | A generator of port group instances. |
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)drivers
()¶Retrieve a generator of drivers.
Returns: | A generator of driver instances. |
---|
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_chassis
(**attrs)¶Create a new chassis from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a
Chassis , it comprised
of the properties on the Chassis class. |
---|---|
Returns: | The results of chassis creation. |
Return type: | Chassis . |
update_chassis
(chassis, **attrs)¶Update a chassis.
Parameters: |
|
---|---|
Returns: | The updated chassis. |
Return type: |
delete_chassis
(chassis, ignore_missing=True)¶Delete a chassis.
Parameters: |
|
---|---|
Returns: | The instance of the chassis which was deleted. |
Return type: |
get_chassis
(chassis)¶Get a specific chassis.
Parameters: | chassis – The value can be the name or ID of a chassis or a
Chassis instance. |
---|---|
Returns: | One Chassis |
Raises: | ResourceNotFound when no
chassis matching the name or ID could be found. |
find_chassis
(name_or_id, ignore_missing=True)¶Find a single chassis.
Parameters: |
|
---|---|
Returns: | One |
chassis
(details=False, **query)¶Retrieve a generator of chassis.
Parameters: |
|
---|---|
Returns: | A generator of chassis instances. |
openstack.baremetal.v1._proxy.
Proxy
(session=None, task_manager=None, *args, **kwargs)create_portgroup
(*args, **kwargs)¶Create a new port group from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a
PortGroup , it
comprises of the properties on the PortGroup class. |
---|---|
Returns: | The results of portgroup creation. |
Return type: | PortGroup . |
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use create_port_group instead
update_portgroup
(*args, **kwargs)¶Update a port group.
Parameters: |
|
---|---|
Returns: | The updated port group. |
Return type: |
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use update_port_group instead
delete_portgroup
(*args, **kwargs)¶Delete a port group.
Parameters: |
|
---|---|
Returns: | The instance of the port group which was deleted. |
Return type: |
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use delete_port_group instead
get_portgroup
(*args, **kwargs)¶Get a specific port group.
Parameters: |
|
---|---|
Returns: | One |
Raises: |
|
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use get_port_group instead
find_portgroup
(*args, **kwargs)¶Find a single port group.
Parameters: |
|
---|---|
Returns: | One |
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use find_port_group instead
portgroups
(*args, **kwargs)¶Retrieve a generator of port groups.
Parameters: |
|
---|---|
Returns: | A generator of portgroup instances. |
Deprecated since version 0.9.14: This will be removed in 2.0.0. Use port_groups instead
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.