# ironicclient.v1.deploy_template module

class ironicclient.v1.deploy_template.DeployTemplate(manager: BaseManager, info: dict[str, Any], loaded: bool = False)

  Bases: `Resource`

class ironicclient.v1.deploy_template.DeployTemplateManager(api)

  Bases: `CreateManager`

  delete(template_id, os_ironic_api_version=None, global_request_id=None)
  get(template_id, fields=None, os_ironic_api_version=None, global_request_id=None)
  list(limit=None, marker=None, sort_key=None, sort_dir=None, detail=False, fields=None, os_ironic_api_version=None, global_request_id=None)

    Retrieve a list of deploy templates.

    Parameters:

      - marker – Optional, the UUID of a deploy template, eg the last template from a previous result set. Return the next result set.

      - limit –

        The maximum number of results to return per

          request, if:

        1. limit > 0, the maximum number of deploy templates to return.

        2. limit == 0, return the entire list of deploy templates.

        3. 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 deploy templates.

      - fields – Optional, a list with a specified set of fields of the resource to be returned. Can not be used when ‘detail’ is set.

      - os_ironic_api_version – String version (e.g. “1.35”) to use for the request. If not specified, the client’s default is used.

      - global_request_id – String containing global request ID header value (in form “req-<UUID>”) to use for the request.

    Returns:

      A list of deploy templates.

  resource_class

    alias of `DeployTemplate`

  update(template_id, patch, os_ironic_api_version=None, global_request_id=None)

this page last updated: 2026-02-27 11:39:19

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

found an error? report a bug