ironic.api.controllers.v1.conductor module

class 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.

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.

  • 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.

Parameters
  • 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']