Bases: ironicclient.common.base.CreateManager
Delete the Allocation.
allocation_id – The UUID or name of an allocation.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
Get an allocation with the specified identifier.
allocation_id – The UUID or name of an allocation.
fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
an Allocation
object.
Retrieve a list of allocations.
resource_class – Optional, get allocations with this resource class.
state – Optional, get allocations in this state. One of
allocating
, active
or error
.
node – UUID or name of the node of the allocation.
marker – Optional, the UUID of an allocation, eg the last allocation from a previous result set. Return the next result set.
limit –
request, if:
limit > 0, the maximum number of allocations to return.
limit == 0, return the entire list of allocations.
limit == None, the number of items returned respect the maximum imposed by the Ironic API (see Ironic’s api.max_limit option).
sort_key – Optional, field used for sorting.
sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’.
fields – Optional, a list with a specified set of fields of the resource to be returned.
owner – Optional, project that owns the allocation.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
A list of allocations.
InvalidAttribute if a subset of fields is requested with detail option set.
Updates the Allocation. Only ‘name’ and ‘extra’ field are allowed.
allocation_id – The UUID or name of an allocation.
patch – a json PATCH document to apply to this allocation.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
Wait for the Allocation to become active.
timeout – timeout in seconds, no timeout if 0.
poll_interval – interval in seconds between polls.
poll_delay_function – function to use to wait between polls (defaults to time.sleep). Should take one argument - delay time in seconds. Any exceptions raised inside it will abort the wait.
os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.
global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.
updated Allocation
object.
StateTransitionFailed if allocation reaches the error state.
StateTransitionTimeout on timeout.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.