ironic.api.controllers.v1.deploy_template module

ironic.api.controllers.v1.deploy_template module

class ironic.api.controllers.v1.deploy_template.DeployTemplatesController(*args, **kwargs)[source]

Bases: RestController

REST controller for deploy templates.

delete(template_ident)[source]

Delete a deploy template.

Parameters

template_ident – UUID or logical name of a deploy template.

get_all(marker=None, limit=None, sort_key='id', sort_dir='asc', fields=None, detail=None)[source]

Retrieve a list of deploy templates.

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 deploy templates with detail.

get_one(template_ident, fields=None)[source]

Retrieve information about the given deploy template.

Parameters
  • template_ident – UUID or logical name of a deploy template.

  • fields – Optional, a list with a specified set of fields of the resource to be returned.

invalid_sort_key_list = ['extra', 'steps']
patch(template_ident, patch=None)[source]

Update an existing deploy template.

Parameters
  • template_ident – UUID or logical name of a deploy template.

  • patch – a json PATCH document to apply to this deploy template.

post(template)[source]

Create a new deploy template.

Parameters

template – a deploy template within the request body.

ironic.api.controllers.v1.deploy_template.convert_steps(rpc_steps)[source]

Add links to the deploy template.

ironic.api.controllers.v1.deploy_template.duplicate_steps(name, value)[source]

Argument validator to check template for duplicate steps

ironic.api.controllers.v1.deploy_template.step_sanitize(step)[source]
ironic.api.controllers.v1.deploy_template.template_sanitize(template, fields)[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

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.