ironic.api.controllers.v1.deploy_template module¶
-
class
ironic.api.controllers.v1.deploy_template.
DeployStepType
(**kwargs)[source]¶ Bases:
ironic.api.types.Base
,ironic.api.controllers.base.AsDictMixin
A type describing a deployment step.
-
args
¶ 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)
-
interface
¶ 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)
-
priority
¶ 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)
-
step
¶ 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)
-
-
class
ironic.api.controllers.v1.deploy_template.
DeployTemplate
(**kwargs)[source]¶ Bases:
ironic.api.controllers.base.APIBase
API representation of a deploy template.
-
classmethod
convert_with_links
(rpc_template, fields=None, sanitize=True)[source]¶ Add links to the deploy template.
-
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)
-
extra
¶ This deploy template’s meta data
-
links
¶ A list containing a self link and associated deploy template links.
-
name
¶ The logical name for this deploy template.
-
sanitize
(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
-
steps
¶ The deploy steps of this deploy template.
-
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
¶ Unique UUID for this deploy template.
-
classmethod
-
class
ironic.api.controllers.v1.deploy_template.
DeployTemplateCollection
(**kw)[source]¶ Bases:
ironic.api.controllers.v1.collection.Collection
API representation of a collection of deploy templates.
-
deploy_templates
¶ A list containing deploy template 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)
-
-
class
ironic.api.controllers.v1.deploy_template.
DeployTemplatePatchType
(**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)
-
-
class
ironic.api.controllers.v1.deploy_template.
DeployTemplatesController
(*args, **kwargs)[source]¶ Bases:
pecan.rest.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']¶
-