Smart class parameters

>>>

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

Examples

GET /api/puppetclasses/100000/smart_class_parameters
404
{
  "error": {
    "message": "Puppetclass with id '100000' was not found"
  }
}

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

Display hidden values

Validations:

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

filter results

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

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
avoid_duplicates true, false
environment string
key string
merge_default true, false
merge_overrides true, false
override true, false
parameter string
puppetclass string
puppetclass_name string
>>>

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

Examples

GET /api/puppetclasses/980190962/smart_class_parameters/1018350796
200
{
  "description": null,
  "override": false,
  "parameter_type": null,
  "hidden_value?": true,
  "omit": null,
  "required": false,
  "validator_type": null,
  "validator_rule": null,
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "override_value_order": "fqdn\nhostgroup\nos\ndomain",
  "created_at": "2020-05-20 13:21:16 UTC",
  "updated_at": "2020-05-20 13:21:16 UTC",
  "parameter": "param37",
  "id": 1018350796,
  "puppetclass_id": 980190962,
  "override_values_count": 0,
  "default_value": "hidden",
  "puppetclass_name": "base",
  "environments": [],
  "override_values": []
}

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

Display hidden values

Validations:

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

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

Examples

PUT /api/smart_class_parameters/1018350795
{
  "smart_class_parameter": {
    "override": true,
    "parameter_type": "string",
    "default_value": "pWQqmdWLlB",
    "merge_default": true
  }
}
500
{
  "error": {
    "message": "Validation failed: Merge default can only be set when merge overrides is set"
  }
}

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

Description of smart class

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

The order in which values are resolved

Validations:

  • Must be a String
smart_class_parameter[validator_type]
optional

Types of validation values

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

The order in which values are resolved

Validations:

  • Must be a String
smart_class_parameter[parameter_type]
optional

Types of variable values

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_class_parameter[required]
optional

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

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.