Config templates

>>>

GET /api/config_templates
Llista de les plantilles d'aprovisionament

GET /api/operatingsystems/:operatingsystem_id/config_templates
Llista de les plantilles d'aprovisionament per sistema operatiu

GET /api/locations/:location_id/config_templates
Llista de les plantilles d'aprovisionament per ubicació

GET /api/organizations/:organization_id/config_templates
Llista de les plantilles d'aprovisionament per organització

Params

Param Name Description
operatingsystem_id
Optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
Optional

filtra els resultats

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

pagina els resultats

Validations:

  • Must be a String
per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be a String

Search fields

Field name Tipus Possible values
default 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/config_templates/:id
Mostra els detalls de la plantilla d'aprovisionament

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

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/config_templates
Crea una plantilla d'aprovisionament

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
config_template
Required

Validations:

  • Must be a Hash
config_template[name]
Required

nom de la plantilla

Validations:

  • Must be a String
config_template[template]
Required

Validations:

  • Must be a String
config_template[snippet]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

no és rellevant per al fragment

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Determina si una plantilla està bloquejada o no per a l'edició

Validations:

  • Must be one of: true, false, 1, 0
config_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
config_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/config_templates/:id
Actualitza una plantilla d'aprovisionament

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

Validations:

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

Validations:

  • Must be a Hash
config_template[name]
Optional

nom de la plantilla

Validations:

  • Must be a String
config_template[template]
Optional

Validations:

  • Must be a String
config_template[snippet]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

no és rellevant per al fragment

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Array of template combinations (hostgroup_id, environment_id)

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Array of operating system IDs to associate with the template

Validations:

  • Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Determina si una plantilla està bloquejada o no per a l'edició

Validations:

  • Must be one of: true, false, 1, 0
config_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
config_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

GET /api/config_templates/revision

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
version
Optional

versió de la plantilla

Validations:

  • Must be a String
>>>

DELETE /api/config_templates/:id
Suprimeix una plantilla d'aprovisionament

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

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/config_templates/build_pxe_default
Actualitza el menú PXE per defecte en tots els servidors TFTP configurats

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
>>>

POST /api/config_templates/:id/clone
Clona una plantilla d'aprovisionament

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
Optional

Abast per organitzacions

Validations:

  • Must be a Integer
id
Required

Validations:

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

Validations:

  • Must be a Hash
config_template[name]
Required

nom de la plantilla

Validations:

  • Must be a String