GET /api/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent

GET /api/hosts/:host_id/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent per a un amfitrió específic

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent per a un grup d'amfitrions específic

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent per a una classe de Puppet específica

GET /api/environments/:environment_id/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent per a un entorn específic

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
Llista tots els paràmetres de la classe intel·ligent per a una combinació especifica d'entorn i classe de Puppet

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
optional

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
optional

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
optional

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
optional

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
optional

Mostra els valors ocults

Validations:

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

search
optional

filtra els resultats

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus 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
Mostra un paràmetre de classe intel·ligent

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

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
optional

Mostra els valors ocults

Validations:

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


PUT /api/smart_class_parameters/:id
Actualitza un paràmetre de classe intel·ligent

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
required

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
required

Validations:

  • Must be a Hash

smart_class_parameter[override]
optional

Whether the smart class parameter value is managed by Foreman

Validations:

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

smart_class_parameter[description]
optional

Descripció de la classe intel·ligent

Validations:

  • Must be a String

smart_class_parameter[default_value]
optional

Value to use when there is no match

Validations:

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

smart_class_parameter[hidden_value]
optional

When enabled the parameter is hidden in the UI

Validations:

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

smart_class_parameter[omit]
optional

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]
optional

L'ordre en què es resolen els valors

Validations:

  • Must be a String

smart_class_parameter[validator_type]
optional

Tipus de valors de validació

Validations:

  • Must be one of: regexp, list.

smart_class_parameter[validator_rule]
optional

Used to enforce certain values for the parameter values

Validations:

  • Must be a String

smart_class_parameter[override_value_order]
optional

L'ordre en què es resolen els valors

Validations:

  • Must be a String

smart_class_parameter[parameter_type]
optional

Tipus de valors de la variable

Validations:

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

smart_class_parameter[required]
optional

En cas que sigui cert, es produirà un error si no hi ha cap valor per defecte i no hi ha cap classificador que proporcioni un valor

Validations:

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

smart_class_parameter[merge_overrides]
optional

Merge all matching values (only array/hash type)

Validations:

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

smart_class_parameter[merge_default]
optional

Include default value when merging all matching values

Validations:

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

smart_class_parameter[avoid_duplicates]
optional

Remove duplicate values (only array type)

Validations:

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