GET /api/smart_class_parameters
Lista wszystkich parametrów klasy inteligentnych

GET /api/hosts/:host_id/smart_class_parameters
Lista parametrów inteligentnych klasy dla konkretnego hosta

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
Lista parametrów inteligentnej klasy dla określonej grupy hostów

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
Lista parametrów inteligentnych klasy dla konkretnej klasy Puppet

GET /api/environments/:environment_id/smart_class_parameters
Lista parametrów inteligentnych klasy dla konkretnego środowiska

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
Lista parametrów inteligentnych klasy dla określonego środowiska / Połączenie klasy Puppet

Przykłady

GET /api/puppetclasses/980190962/smart_class_parameters
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "override": true,
      "parameter_type": "string",
      "hidden_value?": false,
      "omit": null,
      "required": false,
      "validator_type": null,
      "validator_rule": null,
      "merge_overrides": false,
      "merge_default": false,
      "avoid_duplicates": false,
      "override_value_order": "fqdn\norganization,location\nhostgroup\nos",
      "created_at": "2019-11-07 08:52:01 UTC",
      "updated_at": "2019-11-07 08:52:01 UTC",
      "use_puppet_default": null,
      "parameter": "cluster",
      "id": 328495940,
      "puppetclass_id": 980190962,
      "override_values_count": 2,
      "default_value": "secret",
      "puppetclass_name": "base"
    }
  ]
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
opcjonalny

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
opcjonalny

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
opcjonalny

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
opcjonalny

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
opcjonalny

Display hidden values

Validations:

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

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ 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
Pokaż parametry inteligentnej klasy

Przykłady

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": "2019-11-07 08:36:36 UTC",
  "updated_at": "2019-11-07 08:36:36 UTC",
  "use_puppet_default": null,
  "parameter": "param38",
  "id": 1018350796,
  "puppetclass_id": 980190962,
  "override_values_count": 1,
  "default_value": "hidden",
  "puppetclass_name": "base",
  "environments": [],
  "override_values": [
    {
      "created_at": "2019-11-07 08:36:36 UTC",
      "updated_at": "2019-11-07 08:36:36 UTC",
      "id": 1018350796,
      "match": "os=fake",
      "value": "abc",
      "omit": false,
      "use_puppet_default": false
    }
  ]
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

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
opcjonalny

Display hidden values

Validations:

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


PUT /api/smart_class_parameters/:id
Aktualizacja parametru inteligentnej klasy

Przykłady

PUT /api/smart_class_parameters/1018350796
{
  "smart_class_parameter": {
    "parameter_type": "boolean",
    "default_value": "bTreQsKkLv"
  }
}
500
{
  "error": {
    "message": "Validation failed: Default value is invalid, Lookup values is invalid"
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

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
wymagany

Validations:

  • Must be a Hash

smart_class_parameter[override]
opcjonalny

Czy inteligentna wartość parametru klasy jest zarządzana przez Foreman

Validations:

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

smart_class_parameter[description]
opcjonalny

Opis inteligentnej klasy

Validations:

  • Must be a String

smart_class_parameter[default_value]
opcjonalny

Warto używać, gdy nie ma dopasowania

Validations:

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

smart_class_parameter[hidden_value]
opcjonalny

Gdy upoważniony parametr jest ukryty e UI

Validations:

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

smart_class_parameter[use_puppet_default]
opcjonalny

Deprecated, please use omit

Validations:

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

smart_class_parameter[omit]
opcjonalny

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

Kolejność, w jakiej wartości są rozwiązane

Validations:

  • Must be a String

smart_class_parameter[validator_type]
opcjonalny

Rodzaje walidacji wartości

Validations:

  • Must be one of: regexp, list.

smart_class_parameter[validator_rule]
opcjonalny

Służy do wymuszenia pewnych wartości dla wartości parametrów

Validations:

  • Must be a String

smart_class_parameter[override_value_order]
opcjonalny

Kolejność, w jakiej wartości są rozwiązane

Validations:

  • Must be a String

smart_class_parameter[parameter_type]
opcjonalny

Rodzaje wartości zmiennych

Validations:

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

smart_class_parameter[required]
opcjonalny

Jeśli to prawda, zgłosi błąd, jeśli nie ma wartości domyślnej ani podanej dopasowanej wartości

Validations:

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

smart_class_parameter[merge_overrides]
opcjonalny

Scalanie wszystkie pasujących wartości (tylko tablica / typ hash)

Validations:

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

smart_class_parameter[merge_default]
opcjonalny

Dołącz wartość domyślną podczas łączenia wszystkich pasujących wartości

Validations:

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

smart_class_parameter[avoid_duplicates]
opcjonalny

Usuń zduplikowane wartości (tylko typ tablicowy)

Validations:

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