Provisioning templates

>>>

GET /api/provisioning_templates
List provisioning templates

GET /api/operatingsystems/:operatingsystem_id/provisioning_templates
List provisioning templates per operating system

GET /api/locations/:location_id/provisioning_templates
List provisioning templates per location

GET /api/organizations/:organization_id/provisioning_templates
List provisioning templates per organization

Params

Param name Description
operatingsystem_id
optional

ID of operating system

Validations:

  • String
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
default_template true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked true, false
name string
operatingsystem string
organization string
organization_id integer
snippet true, false
template text
vendor string
>>>

GET /api/provisioning_templates/:id
Show provisioning template details

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
>>>

POST /api/provisioning_templates
Create a provisioning template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
provisioning_template
required

Validations:

  • Hash
provisioning_template[name]
required

template name

Validations:

  • String
provisioning_template[description]
optional , nil allowed

Validations:

  • String
provisioning_template[template]
required

Validations:

  • String
provisioning_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
provisioning_template[audit_comment]
optional , nil allowed

Validations:

  • String
provisioning_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.
provisioning_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type
provisioning_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type
provisioning_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.
provisioning_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
provisioning_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

POST /api/provisioning_templates/import
Import a provisioning template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
provisioning_template
required

Validations:

  • Hash
provisioning_template[name]
optional

template name

Validations:

  • String
provisioning_template[template]
optional

template contents including metadata

Validations:

  • String
provisioning_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
provisioning_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
options
optional

Validations:

  • Hash
options[force]
optional , nil allowed

use if you want update locked templates

Validations:

  • Must be one of: true, false, 1, 0.
options[associate]
optional , nil allowed

determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

Validations:

  • Must be one of: new, always, never.
options[lock]
optional , nil allowed

lock imported templates (false by default)

Validations:

  • Must be one of: true, false, 1, 0.
options[default]
optional , nil allowed

makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

Validations:

  • Must be one of: true, false, 1, 0.
>>>

PUT /api/provisioning_templates/:id
Update a provisioning template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
provisioning_template
required

Validations:

  • Hash
provisioning_template[name]
optional

template name

Validations:

  • String
provisioning_template[description]
optional , nil allowed

Validations:

  • String
provisioning_template[template]
optional

Validations:

  • String
provisioning_template[snippet]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
provisioning_template[audit_comment]
optional , nil allowed

Validations:

  • String
provisioning_template[template_kind_id]
optional , nil allowed

not relevant for snippet

Validations:

  • Must be a number.
provisioning_template[template_combinations_attributes]
optional , nil allowed

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type
provisioning_template[operatingsystem_ids]
optional , nil allowed

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type
provisioning_template[locked]
optional , nil allowed

Whether or not the template is locked for editing

Validations:

  • Must be one of: true, false, 1, 0.
provisioning_template[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
provisioning_template[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

GET /api/provisioning_templates/revision

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
version
optional

template version

Validations:

  • String
>>>

DELETE /api/provisioning_templates/:id
Delete a provisioning template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
>>>

POST /api/provisioning_templates/build_pxe_default
Update the default PXE menu on all configured TFTP servers

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
>>>

POST /api/provisioning_templates/:id/clone
Clone a provision template

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
provisioning_template
required

Validations:

  • Hash
provisioning_template[name]
required

template name

Validations:

  • String
>>>

GET /api/provisioning_templates/:id/export
Export a provisioning template to ERB

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..