ironic.api.controllers.v1.allocation.
AllocationsController
(*args, **kwargs)[source]¶Bases: pecan.rest.RestController
REST controller for allocations.
delete
(allocation_ident)[source]¶Delete an allocation.
allocation_ident – UUID or logical name of an allocation.
get_all
(node=None, resource_class=None, state=None, marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, owner=None)[source]¶Retrieve a list of allocations.
node – UUID or name of a node, to get only allocations for that node.
resource_class – Filter by requested resource class.
state – Filter by allocation state.
marker – pagination marker for large data sets.
limit – maximum number of resources to return in a single result. This value cannot be larger than the value of max_limit in the [api] section of the ironic configuration, or only max_limit resources will be returned.
sort_key – column to sort results by. Default: id.
sort_dir – direction to sort. “asc” or “desc”. Default: asc.
fields – Optional, a list with a specified set of fields of the resource to be returned.
owner – Filter by owner.
get_one
(allocation_ident, fields=None)[source]¶Retrieve information about the given allocation.
allocation_ident – UUID or logical name of an allocation.
fields – Optional, a list with a specified set of fields of the resource to be returned.
invalid_sort_key_list
= ['extra', 'candidate_nodes', 'traits']¶ironic.api.controllers.v1.allocation.
NodeAllocationController
(*args, **kwargs)[source]¶Bases: pecan.rest.RestController
REST controller for allocations.
invalid_sort_key_list
= ['extra', 'candidate_nodes', 'traits']¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.