ironic.api.controllers.v1.chassis module

class ironic.api.controllers.v1.chassis.Chassis(**kwargs)

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, sanitize=True)

created_at

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

description

The description of the chassis

extra

The metadata of the chassis

links

A list containing a self link and associated chassis links

nodes

Links to the collection of nodes contained in this chassis

classmethod sample(expand=True)

sanitize(fields=None)

Removes sensitive and unrequested data.

Will only keep the fields specified in the fields parameter.

Parameters

fields (list of str) – list of fields to preserve, or None to preserve them all

updated_at

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

uuid

The UUID of the chassis

class ironic.api.controllers.v1.chassis.ChassisCollection(**kwargs)

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

API representation of a collection of chassis.

chassis

A list containing chassis objects

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

next

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

classmethod sample()

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

Bases: pecan.rest.RestController

REST controller for Chassis.

delete(chassis_uuid)

Delete a chassis.

Parameters

chassis_uuid – UUID of a chassis.

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.

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.

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.

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)

Update an existing chassis.

Parameters

• chassis_uuid – UUID of a chassis.

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

post(chassis)

Create a new chassis.

Parameters

chassis – a chassis within the request body.

class ironic.api.controllers.v1.chassis.ChassisPatchType(**kw)

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

op

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

path

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)

value

Complex type attribute definition.

Example:

class MyComplexType(ctypes.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(ctypes.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)