ironic.api.controllers.v1.chassis module

class ironic.api.controllers.v1.chassis.ChassisController(*args, **kwargs)[source]

Bases: RestController

REST controller for Chassis.

delete(chassis_uuid)[source]

Delete a chassis.

Parameters:

chassis_uuid – UUID of a chassis.

detail(marker=None, limit=None, sort_key='id', sort_dir='asc')[source]

Retrieve a list of chassis with detail.

Parameters:

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

get_all(marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[source]

Retrieve a list of chassis.

Parameters:

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

get_one(chassis_uuid, fields=None)[source]

Retrieve information about the given chassis.

Parameters:

  • chassis_uuid – UUID of a chassis.

  • fields – Optional, a list with a specified set of fields of the resource to be returned.

invalid_sort_key_list = ['extra']
nodes = <ironic.api.controllers.v1.node.NodesController object>

Expose nodes as a sub-element of chassis

patch(chassis_uuid, patch)[source]

Update an existing chassis.

Parameters:

  • chassis_uuid – UUID of a chassis.

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

post(chassis)[source]

Create a new chassis.

Parameters:

chassis – a chassis within the request body.