GET /api/smart_class_parameters
Alle Smart-Klassenparameter auflisten

GET /api/hosts/:host_id/smart_class_parameters
Liste der Smart-Klassenparameter für einen bestimmten Host

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
Liste der Smart-Klassenparameter für eine bestimmte Hostgruppe

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
Liste der Smart-Klassenparameter für eine bestimmte Puppetklasse

GET /api/environments/:environment_id/smart_class_parameters
Liste der Smart-Klassenparameter für eine bestimmte Umgebung

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
Liste der Smart-Klassenparameter für eine bestimmte Umgebung/Puppet-Klasse-Kombination

Beispiele

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"
    }
  ]
}

Parameter

Parametername Beschreibung
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

Versteckte Werte anzeigen

Validations:

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

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Feld und Reihenfolge sortieren, z.B. ‘id DESC’

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
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
Smart-Klassenparameter anzeigen

Beispiele

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

Parameter

Parametername Beschreibung
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
verpflichtend

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

Versteckte Werte anzeigen

Validations:

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


PUT /api/smart_class_parameters/:id
Smart-Klassenparameter aktualisieren

Beispiele

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"
  }
}

Parameter

Parametername Beschreibung
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
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

smart_class_parameter[override]
optional

Ob der Smart-Klassenparameter von Foreman gemanagt wird

Validations:

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

smart_class_parameter[description]
optional

Beschreibung der Smart-Klasse

Validations:

  • Must be a String

smart_class_parameter[default_value]
optional

Zu verwendender Wert, falls es keine Übereinstimmung gibt

Validations:

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

smart_class_parameter[hidden_value]
optional

Wenn aktiviert, so ist der Parameter im UI verborgen

Validations:

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

smart_class_parameter[use_puppet_default]
optional

Veraltet, bitte “Übergehen” verwenden

Validations:

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

smart_class_parameter[omit]
optional

Foreman wird diesen Parameter nicht in der Klassifizierungsausgabe verwenden. Es wird der Wert verwendet, welcher in den Puppet Manifesten definiert wurde.

Validations:

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

smart_class_parameter[path]
optional

Reihenfolge, in der Werte aufgelöst werden

Validations:

  • Must be a String

smart_class_parameter[validator_type]
optional

Typen von Validierungswerten

Validations:

  • Must be one of: regexp, list.

smart_class_parameter[validator_rule]
optional

Verwendet, um bestimmte Werte für die Parameterwerte umzusetzen

Validations:

  • Must be a String

smart_class_parameter[override_value_order]
optional

Reihenfolge, in der Werte aufgelöst werden

Validations:

  • Must be a String

smart_class_parameter[parameter_type]
optional

Typen von Variablenwerten

Validations:

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

smart_class_parameter[required]
optional

Falls “True”, wird dies einen Fehler erzeugen, wenn es keinen Standardwert gibt und kein Treffer einen Wert liefert

Validations:

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

smart_class_parameter[merge_overrides]
optional

Alle übereinstimmenden Werte (nur vom Typ Array/Hash) zusammenführen

Validations:

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

smart_class_parameter[merge_default]
optional

Standardwert einschließen, wenn alle übereinstimmenden Werte zusammengeführt werden

Validations:

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

smart_class_parameter[avoid_duplicates]
optional

Duplikate (nur vom Typ Array) entfernen

Validations:

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