Override values

>>>

GET /api/smart_variables/:smart_variable_id/override_values
List of override values for a specific smart variable

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values
List of override values for a specific smart class parameter

Examples

GET /api/smart_class_parameters/328495940-cluster/override_values
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-09-11 14:40:10 UTC",
      "updated_at": "2019-09-11 14:40:10 UTC",
      "id": 674471636,
      "match": "fqdn=temp.yourdomain.net",
      "value": "8080",
      "omit": false,
      "use_puppet_default": false
    },
    {
      "created_at": "2019-09-11 14:40:10 UTC",
      "updated_at": "2019-09-11 14:40:10 UTC",
      "id": 874520030,
      "match": "hostgroup=Common",
      "value": "8080",
      "omit": false,
      "use_puppet_default": false
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
smart_variable_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.
smart_class_parameter_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.
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
>>>

GET /api/smart_variables/:smart_variable_id/override_values/:id
Show an override value for a specific smart variable

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Show an override value for a specific smart class parameter

Examples

GET /api/smart_class_parameters/1018350796-param22/override_values/os=fake
200
{
  "created_at": "2019-09-11 14:34:53 UTC",
  "updated_at": "2019-09-11 14:34:53 UTC",
  "id": 1018350796,
  "match": "os=fake",
  "value": "*****",
  "omit": false,
  "use_puppet_default": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
smart_variable_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.
smart_class_parameter_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.
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.
>>>

POST /api/smart_variables/:smart_variable_id/override_values
Create an override value for a specific smart variable

POST /api/smart_class_parameters/:smart_class_parameter_id/override_values
Create an override value for a specific smart class parameter

Examples

POST /api/smart_class_parameters/328495940-cluster/override_values
{
  "override_value": {
    "match": "os=abc",
    "value": "liftoff"
  }
}
201
{
  "created_at": "2019-09-11 14:40:10 UTC",
  "updated_at": "2019-09-11 14:40:10 UTC",
  "id": 1018350796,
  "match": "os=abc",
  "value": "liftoff",
  "omit": false,
  "use_puppet_default": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
smart_variable_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.
smart_class_parameter_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.
override_value
required

Validations:

  • Must be a Hash
override_value[match]
required

Override match

Validations:

  • Must be a String
override_value[value]
optional , nil allowed

Override value, required if omit is false

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
override_value[use_puppet_default]
optional , nil allowed

Deprecated, please use omit

Validations:

  • Must be one of: true, false, 1, 0.
override_value[omit]
optional , nil allowed

Foreman will not send this parameter in classification output, replaces use_puppet_default

Validations:

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

PUT /api/smart_variables/:smart_variable_id/override_values/:id
Update an override value for a specific smart variable

PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Update an override value for a specific smart class parameter

Examples

PUT /api/smart_class_parameters/328495940-cluster/override_values/hostgroup=Common
{
  "override_value": {
    "match": "os=abc"
  }
}
200
{
  "created_at": "2019-09-11 14:40:10 UTC",
  "updated_at": "2019-09-11 14:40:11 UTC",
  "id": 874520030,
  "match": "os=abc",
  "value": "8080",
  "omit": false,
  "use_puppet_default": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
smart_variable_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.
smart_class_parameter_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.
override_value
required

Validations:

  • Must be a Hash
override_value[match]
optional

Override match

Validations:

  • Must be a String
override_value[value]
optional , nil allowed

Override value, required if omit is false

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
override_value[use_puppet_default]
optional , nil allowed

Deprecated, please use omit

Validations:

  • Must be one of: true, false, 1, 0.
override_value[omit]
optional , nil allowed

Foreman will not send this parameter in classification output, replaces use_puppet_default

Validations:

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

DELETE /api/smart_variables/:smart_variable_id/override_values/:id
Delete an override value for a specific smart variable

DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
Delete an override value for a specific smart class parameter

Examples

DELETE /api/smart_variables/1018350801/override_values/1018350801
{
  "override_value": {}
}
200
{
  "created_at": "2019-09-11 14:40:11 UTC",
  "updated_at": "2019-09-11 14:40:11 UTC",
  "id": 1018350801,
  "match": "is_virtual=true",
  "value": "some_value",
  "omit": false,
  "use_puppet_default": false
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
smart_variable_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.
smart_class_parameter_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.
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.