The ironic.api.controllers.v1.chassis Module¶

class ironic.api.controllers.v1.chassis.Chassis(**kwargs)[source]¶

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 convert_with_links(rpc_chassis, fields=None)[source]¶

classmethod sample(expand=True)[source]¶

class ironic.api.controllers.v1.chassis.ChassisCollection(**kwargs)[source]¶

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

API representation of a collection of chassis.

static convert_with_links(chassis, limit, url=None, fields=None, **kwargs)[source]¶

classmethod sample()[source]¶

class ironic.api.controllers.v1.chassis.ChassisController[source]¶

Bases: pecan.rest.RestController

REST controller for Chassis.

delete(*args, **kwargs)[source]¶

Delete a chassis.

Parameters:	chassis_uuid – UUID of a chassis.

detail(*args, **kwargs)[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(*args, **kwargs)[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(*args, **kwargs)[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.

patch(*args, **kwargs)[source]¶

Update an existing chassis.

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

post(*args, **kwargs)[source]¶

Create a new chassis.

Parameters:	chassis – a chassis within the request body.

class ironic.api.controllers.v1.chassis.ChassisPatchType(**kw)[source]¶

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