ironicclient.v1.chassis module¶

class ironicclient.v1.chassis.Chassis(manager, info, loaded=False)[source]¶

Bases: ironicclient.common.base.Resource

class ironicclient.v1.chassis.ChassisManager(api)[source]¶

Bases: ironicclient.common.base.CreateManager

delete(chassis_id)[source]¶

get(chassis_id, fields=None)[source]¶

list(marker=None, limit=None, sort_key=None, sort_dir=None, detail=False, fields=None)[source]¶

Retrieve a list of chassis.

Parameters:

marker – Optional, the UUID of a chassis, eg the last chassis from a previous result set. Return the next result set. limit – The maximum number of results to return per request, if: limit > 0, the maximum number of chassis to return. limit == 0, return the entire list of chassis. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic’s api.max_limit option). sort_key – Optional, field used for sorting. sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’. detail – Optional, boolean whether to return detailed information about chassis. fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set.

Returns:

A list of chassis.

list_nodes(chassis_id, marker=None, limit=None, sort_key=None, sort_dir=None, detail=False, fields=None, associated=None, maintenance=None, provision_state=None)[source]¶

List all the nodes for a given chassis.

Parameters:

chassis_id – The UUID of the chassis. marker – Optional, the UUID of a node, eg the last node from a previous result set. Return the next result set. limit – The maximum number of results to return per request, if: limit > 0, the maximum number of nodes to return. limit == 0, return the entire list of nodes. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic’s api.max_limit option). sort_key – Optional, field used for sorting. sort_dir – Optional, direction of sorting, either ‘asc’ (the default) or ‘desc’. detail – Optional, boolean whether to return detailed information about nodes. fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set. associated – Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return a list of associated (True or “True”) or unassociated (False or “False”) nodes. maintenance – Optional. Either a Boolean or a string representation of a Boolean that indicates whether to return nodes in maintenance mode (True or “True”), or not in maintenance mode (False or “False”). provision_state – Optional. String value to get only nodes in that provision state.

Returns:

A list of nodes.

resource_class¶

alias of Chassis

update(chassis_id, patch)[source]¶