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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

ansible_variable
requerido

Validations:

  • Must be a Hash

ansible_variable[variable]
requerido

Nombre de la variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
requerido

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
opcional , nil permitido

Valor predeterminado de la variable

Validations:

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

ansible_variable[hidden_value]
opcional , nil permitido

Al habilitarse, el parámetro está oculto en la UI.

Validations:

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

ansible_variable[override_value_order]
opcional , nil permitido

El orden en el cual se resuelven los valores

Validations:

  • Must be a String

ansible_variable[description]
opcional , nil permitido

Descripción de la variable

Validations:

  • Must be a String

ansible_variable[validator_type]
opcional , nil permitido

Tipos de valores de validación

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
opcional , nil permitido

Utilizado para imponer ciertos valores para los valores del parámetro

Validations:

  • Must be a String

ansible_variable[variable_type]
opcional , nil permitido

Tipos de valores de variable

Validations:

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

ansible_variable[merge_overrides]
opcional , nil permitido

Combinar todos los valores que coinciden (solo tipo array/hash)

Validations:

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

ansible_variable[merge_default]
opcional , nil permitido

Incluir el valor predeterminado al combinar todos los valores que coinciden

Validations:

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

ansible_variable[avoid_duplicates]
opcional , nil permitido

Eliminar valores duplicados (solo tipo array)

Validations:

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


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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

ansible_variable[variable]
opcional

Nombre de la variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
opcional

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
opcional , nil permitido

Valor predeterminado de la variable

Validations:

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

ansible_variable[hidden_value]
opcional , nil permitido

Al habilitarse, el parámetro está oculto en la UI.

Validations:

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

ansible_variable[override_value_order]
opcional , nil permitido

El orden en el cual se resuelven los valores

Validations:

  • Must be a String

ansible_variable[description]
opcional , nil permitido

Descripción de la variable

Validations:

  • Must be a String

ansible_variable[validator_type]
opcional , nil permitido

Tipos de valores de validación

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
opcional , nil permitido

Utilizado para imponer ciertos valores para los valores del parámetro

Validations:

  • Must be a String

ansible_variable[variable_type]
opcional , nil permitido

Tipos de valores de variable

Validations:

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

ansible_variable[merge_overrides]
opcional , nil permitido

Combinar todos los valores que coinciden (solo tipo array/hash)

Validations:

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

ansible_variable[merge_default]
opcional , nil permitido

Incluir el valor predeterminado al combinar todos los valores que coinciden

Validations:

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

ansible_variable[avoid_duplicates]
opcional , nil permitido

Eliminar valores duplicados (solo tipo array)

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

proxy_id
requerido

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

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

proxy_id
requerido

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.