Smart variables

>>>

GET /api/smart_variables
Список всех смарт-переменных

GET /api/hosts/:host_id/smart_variables
Список смарт-переменных для определенного узла

GET /api/hostgroups/:hostgroup_id/smart_variables
Список смарт-переменных для определенной группы узлов

GET /api/puppetclasses/:puppetclass_id/smart_variables
Список смарт-переменных для определенного класса Puppet

Параметры

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

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

Validations:

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

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

Validations:

  • Must be a Integer
host_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.
hostgroup_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.
puppetclass_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.
show_hidden
необязательно

Display hidden values

Validations:

  • Must be one of: true, false, 1, 0.
search
необязательно

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

Validations:

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

Sort field and order, eg. ‘id DESC’

Validations:

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

постраничный вывод

Validations:

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

количество записей на запрос

Validations:

  • Must be a String

Search fields

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

GET /api/smart_variables/:id
Показать смарт-переменную

Параметры

Имя параметра Описание
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.
show_hidden
необязательно

Display hidden values

Validations:

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

POST /api/smart_variables
Создать смарт-переменную

Параметры

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

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

Validations:

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

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

Validations:

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

Validations:

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

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

Validations:

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

Код класса Puppet

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

PUT /api/smart_variables/:id
Изменить смарт-переменную

Параметры

Имя параметра Описание
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.
smart_variable
обязательно

Validations:

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

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

Validations:

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

Код класса Puppet

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

DELETE /api/smart_variables/:id
Удалить смарт-переменную

Параметры

Имя параметра Описание
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.