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.
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
sanitize
(fields=None)[source]¶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
ironic.api.controllers.v1.chassis.
ChassisCollection
(**kwargs)[source]¶Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of chassis.
chassis
¶A list containing chassis objects
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)
ironic.api.controllers.v1.chassis.
ChassisController
[source]¶Bases: pecan.rest.RestController
REST controller for Chassis.
detail
(marker=None, limit=None, sort_key='id', sort_dir='asc')[source]¶Retrieve a list of chassis with detail.
Parameters: |
|
---|
get_all
(marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[source]¶Retrieve a list of chassis.
Parameters: |
|
---|
get_one
(chassis_uuid, fields=None)[source]¶Retrieve information about the given chassis.
Parameters: |
|
---|
invalid_sort_key_list
= ['extra']¶nodes
= <ironic.api.controllers.v1.node.NodesController object>¶Expose nodes as a sub-element of chassis
ironic.api.controllers.v1.chassis.
ChassisPatchType
(**kw)[source]¶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)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.