GET /api/provisioning_templates
Bereitstellungsvorlagen auflisten

GET /api/operatingsystems/:operatingsystem_id/provisioning_templates
Bereitstellungsvorlagen pro Betriebssystem auflisten

GET /api/locations/:location_id/provisioning_templates
Bereitstellungsvorlagen pro Standort auflisten

GET /api/organizations/:organization_id/provisioning_templates
Bereitstellungsvorlagen pro Organisation auflisten

Parameter

Parametername Beschreibung
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String

location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String

Search fields

Feld Name Typ Mögliche Werte
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
Details der Bereitstellungsvorlage anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/provisioning_templates
Bereitstellungsvorlage erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

provisioning_template
verpflichtend

Validations:

  • Must be a Hash

provisioning_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String

provisioning_template[template]
verpflichtend

Validations:

  • Must be a String

provisioning_template[snippet]
optional , nil erlaubt

Validations:

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

provisioning_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

provisioning_template[template_kind_id]
optional , nil erlaubt

nicht relevant für Snippet

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
optional , nil erlaubt

Abfolge von Vorlagenkombinationen (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
optional , nil erlaubt

Abfolge von Betriebssystem-Kennungen, die der Vorlage zugeordnet werden sollen

Validations:

  • Must be an array of any type

provisioning_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

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

provisioning_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


POST /api/provisioning_templates/import
Import einer Bereitstellungsvorlage

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

provisioning_template
verpflichtend

Validations:

  • Must be a Hash

provisioning_template[name]
optional

Vorlagenname

Validations:

  • Must be a String

provisioning_template[template]
optional

template contents including metadata

Validations:

  • Must be a String

provisioning_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

options
optional

Validations:

  • Must be a Hash

options[force]
optional , nil erlaubt

use if you want update locked templates

Validations:

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

options[associate]
optional , nil erlaubt

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 erlaubt

Importierte Templates sperren (Standardwert: false)

Validations:

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

options[default]
optional , nil erlaubt

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
Bereitstellungsvorlage aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

provisioning_template
verpflichtend

Validations:

  • Must be a Hash

provisioning_template[name]
optional

Vorlagenname

Validations:

  • Must be a String

provisioning_template[template]
optional

Validations:

  • Must be a String

provisioning_template[snippet]
optional , nil erlaubt

Validations:

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

provisioning_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

provisioning_template[template_kind_id]
optional , nil erlaubt

nicht relevant für Snippet

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
optional , nil erlaubt

Abfolge von Vorlagenkombinationen (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
optional , nil erlaubt

Abfolge von Betriebssystem-Kennungen, die der Vorlage zugeordnet werden sollen

Validations:

  • Must be an array of any type

provisioning_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

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

provisioning_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


GET /api/provisioning_templates/revision

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

version
optional

Vorlagenversion

Validations:

  • Must be a String


DELETE /api/provisioning_templates/:id
Bereitstellungsvorlage löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/provisioning_templates/build_pxe_default
Standard-PXE-Menü auf allen konfigurierten TFTP-Servern aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer


POST /api/provisioning_templates/:id/clone
Bereitstellungsvorlage klonen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

provisioning_template
verpflichtend

Validations:

  • Must be a Hash

provisioning_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String


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

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.