ironic.api.controllers.v1.chassis module¶

service None

Bases: ironic.api.controllers.base.APIBase

API representation of a chassis.

This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a chassis.

classmethod Chassis.convert_with_links(rpc_chassis, fields=None)¶

classmethod Chassis.sample(expand=True)¶

service None

Bases: ironic.api.controllers.v1.collection.Collection

API representation of a collection of chassis.

static ChassisCollection.convert_with_links(chassis, limit, url=None, fields=None, **kwargs)¶

classmethod ChassisCollection.sample()¶

service None

Bases: pecan.rest.RestController

REST controller for Chassis.

ChassisController.delete(chassis_uuid)¶

Delete a chassis.

Parameters:	chassis_uuid – UUID of a chassis.

ChassisController.detail(marker=None, limit=None, sort_key='id', sort_dir='asc')¶

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.

ChassisController.get_all(marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)¶

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.

ChassisController.get_one(chassis_uuid, fields=None)¶

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.

ChassisController.patch(chassis_uuid, patch)¶

Update an existing chassis.

Parameters:	chassis_uuid – UUID of a chassis. patch – a json PATCH document to apply to this chassis.

ChassisController.post(chassis)¶

Create a new chassis.

Parameters:	chassis – a chassis within the request body.

service None

Bases: ironic.api.controllers.v1.types.JsonPatchType