ironic.api.controllers.v1.allocation module

class ironic.api.controllers.v1.allocation.AllocationsController(*args, **kwargs)

Bases: RestController

REST controller for allocations.

delete(allocation_ident)

Delete an allocation.

Parameters:

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)

Retrieve a list of allocations.

Parameters:

• 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)

Retrieve information about the given allocation.

Parameters:

• 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']

patch(allocation_ident, patch)

Update an existing allocation.

Parameters:

• allocation_ident – UUID or logical name of an allocation.

• patch – a json PATCH document to apply to this allocation.

post(allocation)

Create a new allocation.

Parameters:

allocation – an allocation within the request body.

class ironic.api.controllers.v1.allocation.NodeAllocationController(*args, **kwargs)

Bases: RestController

REST controller for allocations.

delete()

get_all(fields=None)

invalid_sort_key_list = ['extra', 'candidate_nodes', 'traits']

ironic.api.controllers.v1.allocation.allocation_sanitize(allocation, fields)

ironic.api.controllers.v1.allocation.convert_with_links(rpc_allocation, fields=None, sanitize=True)

ironic.api.controllers.v1.allocation.hide_fields_in_newer_versions(allocation)

ironic.api.controllers.v1.allocation.list_convert_with_links(rpc_allocations, limit, url=None, fields=None, **kwargs)