ironic.api.controllers.v1.conductor.
Conductor
(**kwargs)[source]¶Bases: ironic.api.controllers.base.APIBase
API representation of a bare metal conductor.
alive
¶Indicates whether this conductor is considered alive
conductor_group
¶The conductor group this conductor belongs to
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)
drivers
¶The drivers enabled on this conductor
hostname
¶The hostname for this conductor
links
¶A list containing a self link and associated conductor links
sanitize
(fields)[source]¶Removes sensitive and unrequested data.
Will only keep the fields specified in the fields
parameter.
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)
ironic.api.controllers.v1.conductor.
ConductorCollection
(**kwargs)[source]¶Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of conductors.
conductors
¶A list containing conductor 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.conductor.
ConductorsController
(*args, **kwargs)[source]¶Bases: pecan.rest.RestController
REST controller for conductors.
get_all
(marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[source]¶Retrieve a list of conductors.
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.
detail – Optional, boolean to indicate whether retrieve a list of conductors with detail.
get_one
(hostname, fields=None)[source]¶Retrieve information about the given conductor.
hostname – hostname of a conductor.
fields – Optional, a list with a specified set of fields of the resource to be returned.
invalid_sort_key_list
= ['alive', 'drivers']¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.