Ansible variables

>>>

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
id
обязательно

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
search
необязательно

отфильтровать результаты

Validations:

  • Must be a String
order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
необязательно

Page number, starting at 1

Validations:

  • Must be a number.
per_page
необязательно

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
ansible_role string
avoid_duplicates true, false
imported true, false
key string
merge_default true, false
merge_overrides true, false
name string
override true, false
parameter string
>>>

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
id
обязательно

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
ansible_variable
обязательно

Validations:

  • Must be a Hash
ansible_variable[variable]
обязательно

Имя переменной

Validations:

  • Must be a String
ansible_variable[ansible_role_id]
обязательно

Role ID

Validations:

  • Must be a number.
ansible_variable[default_value]
необязательно , nil разрешен

Значение по умолчанию для переменной

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
ansible_variable[hidden_value]
необязательно , nil разрешен

Если включено, параметр будет скрыт

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[override_value_order]
необязательно , nil разрешен

Порядок обработки значений

Validations:

  • Must be a String
ansible_variable[description]
необязательно , nil разрешен

Описание переменной

Validations:

  • Must be a String
ansible_variable[validator_type]
необязательно , nil разрешен

Типы значений проверок

Validations:

  • Must be one of: regexp, list.
ansible_variable[validator_rule]
необязательно , nil разрешен

Используется для обеспечения определенных значений для значений параметров

Validations:

  • Must be a String
ansible_variable[variable_type]
необязательно , nil разрешен

Типы значений переменных

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
ansible_variable[merge_overrides]
необязательно , nil разрешен

Слить все совпадающие значения (только для типов массив/хэш)

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[merge_default]
необязательно , nil разрешен

При объединении совпадающих значений также включить значение, используемое по умолчанию

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[avoid_duplicates]
необязательно , nil разрешен

Удалить повторяющиеся значения (только для массива)

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[override]
необязательно , nil разрешен

Whether to override variable or not

Validations:

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

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
id
обязательно

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
обязательно

Validations:

  • Must be a Hash
ansible_variable[variable]
необязательно

Имя переменной

Validations:

  • Must be a String
ansible_variable[ansible_role_id]
необязательно

Role ID

Validations:

  • Must be a number.
ansible_variable[default_value]
необязательно , nil разрешен

Значение по умолчанию для переменной

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
ansible_variable[hidden_value]
необязательно , nil разрешен

Если включено, параметр будет скрыт

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[override_value_order]
необязательно , nil разрешен

Порядок обработки значений

Validations:

  • Must be a String
ansible_variable[description]
необязательно , nil разрешен

Описание переменной

Validations:

  • Must be a String
ansible_variable[validator_type]
необязательно , nil разрешен

Типы значений проверок

Validations:

  • Must be one of: regexp, list.
ansible_variable[validator_rule]
необязательно , nil разрешен

Используется для обеспечения определенных значений для значений параметров

Validations:

  • Must be a String
ansible_variable[variable_type]
необязательно , nil разрешен

Типы значений переменных

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
ansible_variable[merge_overrides]
необязательно , nil разрешен

Слить все совпадающие значения (только для типов массив/хэш)

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[merge_default]
необязательно , nil разрешен

При объединении совпадающих значений также включить значение, используемое по умолчанию

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[avoid_duplicates]
необязательно , nil разрешен

Удалить повторяющиеся значения (только для массива)

Validations:

  • Must be one of: true, false, 1, 0.
ansible_variable[override]
необязательно , nil разрешен

Whether to override variable or not

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
proxy_id
обязательно

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

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer
organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer
proxy_id
обязательно

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.