GET /ansible/api/ansible_variables/:id
Show variable

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.


GET /ansible/api/ansible_variables
List Ansible variables

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

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


DELETE /ansible/api/ansible_variables/:id
Deletes Ansible variable

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 /ansible/api/ansible_variables
Create Ansible variable

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

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Required

Nom de la variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Required

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Valor per defecte de la variable

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

ansible_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

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

ansible_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

L'ordre en què es resolen els valors

Validations:

  • Must be a String

ansible_variable[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció de la variable

Validations:

  • Must be a String

ansible_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de valors de validació

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be a String

ansible_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de valors de la variable

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

ansible_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)

Validations:

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

ansible_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

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

ansible_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Remove duplicate values (only array type)

Validations:

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


PUT /ansible/api/ansible_variables/:id
Updates Ansible variable

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.

ansible_variable
Required

Validations:

  • Must be a Hash

ansible_variable[variable]
Optional

Nom de la variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
Optional

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Valor per defecte de la variable

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

ansible_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

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

ansible_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

L'ordre en què es resolen els valors

Validations:

  • Must be a String

ansible_variable[description]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció de la variable

Validations:

  • Must be a String

ansible_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de valors de validació

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be a String

ansible_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Tipus de valors de la variable

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

ansible_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Merge all matching values (only array/hash type)

Validations:

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

ansible_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

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

ansible_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Remove duplicate values (only array type)

Validations:

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


PUT /ansible/api/ansible_variables/import
Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles

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

proxy_id
Required

Smart Proxy to import from

Validations:

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


PUT /ansible/api/ansible_variables/obsolete
Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles

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

proxy_id
Required

Smart Proxy to import from

Validations:

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