GET /api/smart_class_parameters
List all smart class parameters

GET /api/hosts/:host_id/smart_class_parameters
List of smart class parameters for a specific host

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
List of smart class parameters for a specific host group

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
List of smart class parameters for a specific Puppet class

GET /api/environments/:environment_id/smart_class_parameters
List of smart class parameters for a specific environment

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
List of smart class parameters for a specific environment/Puppet class combination

Parâmentros

Nome parâmetro Descrição
host_id
opcional

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
opcional

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
opcional

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
opcional

Validations:

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

search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

ordenar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be String


GET /api/smart_class_parameters/:id
Show a smart class parameter

Parâmentros

Nome parâmetro Descrição
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.


PUT /api/smart_class_parameters/:id
Update a smart class parameter

Parâmentros

Nome parâmetro Descrição
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.

smart_class_parameter
requerido

Validations:

  • Must be a Hash

smart_class_parameter[override]
opcional

Whether the smart class parameter value is managed by Foreman

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[description]
opcional

Description of smart class

Validations:

  • Must be String

smart_class_parameter[default_value]
opcional

Valor a usar quando não houver combinação

Validations:

  • Must be String

smart_class_parameter[hidden_value]
opcional

When enabled the parameter is hidden in the UI

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[use_puppet_default]
opcional

Do not send this parameter via the ENC. Puppet will use the value defined in the Puppet manifest for this parameter

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[path]
opcional

A ordem na qual os valores são resolvidos

Validations:

  • Must be String

smart_class_parameter[validator_type]
opcional

Tipos de valores de validação

Validations:

  • Must be one of: regexp, list.

smart_class_parameter[validator_rule]
opcional

Used to enforce certain values for the parameter values

Validations:

  • Must be String

smart_class_parameter[override_value_order]
opcional

A ordem na qual os valores são resolvidos

Validations:

  • Must be String

smart_class_parameter[parameter_type]
opcional

Tipos de valores de validação

Validations:

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

smart_class_parameter[required]
opcional

If true, will raise an error if there is no default value and no matcher provide a value

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[merge_overrides]
opcional

Merge all matching values (only array/hash type)

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[merge_default]
opcional

Include default value when merging all matching values

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_class_parameter[avoid_duplicates]
opcional

Remove duplicate values (only array type)

Validations:

  • Must be 'true' or 'false' or '1' or '0'