Smart class parameters

>>>

GET /api/smart_class_parameters
Список всех переопределяемых классов параметров

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

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

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

GET /api/environments/:environment_id/smart_class_parameters
Список смарт-параметров для определенного окружения

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
Список смарт-параметров для определенной комбинации окружение/класс Puppet

Параметры

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

Set the current location context for the request

Validations:

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

Set the current organization context for the request

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

Номер страницы, начиная с 1

Validations:

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

Число элементов на странице

Validations:

  • Must be a number.

Search fields

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

GET /api/smart_class_parameters/:id
Создать смарт-параметр

Параметры

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

Set the current location context for the request

Validations:

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

Set the current organization context for the request

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.
>>>

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

Параметры

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

Set the current location context for the request

Validations:

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

Set the current organization context for the request

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

Validations:

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

Разрешает Foreman контролировать значение смарт-параметра

Validations:

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

Описание переопределяемого класса

Validations:

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

Значение, которое будет использоваться по умолчанию

Validations:

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

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

Validations:

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

Foreman will not send this parameter in classification output. Puppet will use the value defined in the Puppet manifest for this parameter

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

Если установлено, вызовет ошибку, если не установлено значение по умолчанию и не найдет поставщик значения

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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