GET /api/smart_variables/:smart_variable_id/override_values
特定スマート変数の上書き値の一覧

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values
特定スマートクラスパラメーターの上書き値の一覧

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

smart_variable_id
任意

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
任意

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
任意

非表示の値の表示

Validations:

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

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.


GET /api/smart_variables/:smart_variable_id/override_values/:id
特定スマート変数の上書き値を表示

GET /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
特定スマートクラスパラメーターの上書き値を表示

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
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

smart_variable_id
任意

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
任意

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
必須

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
任意

非表示の値の表示

Validations:

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


POST /api/smart_variables/:smart_variable_id/override_values
特定スマート変数の上書き値を作成

POST /api/smart_class_parameters/:smart_class_parameter_id/override_values
特定スマートクラスパラメーターの上書き値を作成

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
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

smart_variable_id
任意

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
任意

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
必須

Validations:

  • Must be a Hash

override_value[match]
必須

一致候補の上書き

Validations:

  • Must be a String

override_value[value]
任意 , nil可

オーバーライド値 (omit が false の場合に必要)

Validations:

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

override_value[use_puppet_default]
任意 , nil可

非推奨です。omit を使用してください。

Validations:

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

override_value[omit]
任意 , nil可

Foreman では、このパラメーターが分類出力で送信されず、use_puppet_default が置き換えられます

Validations:

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


PUT /api/smart_variables/:smart_variable_id/override_values/:id
特定スマート変数の上書き値を更新

PUT /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
特定スマートクラスパラメーターの上書き値を更新

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
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

smart_variable_id
任意

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
任意

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
必須

Validations:

  • Must be a Hash

override_value[match]
任意

一致候補の上書き

Validations:

  • Must be a String

override_value[value]
任意 , nil可

オーバーライド値 (omit が false の場合に必要)

Validations:

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

override_value[use_puppet_default]
任意 , nil可

非推奨です。omit を使用してください。

Validations:

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

override_value[omit]
任意 , nil可

Foreman では、このパラメーターが分類出力で送信されず、use_puppet_default が置き換えられます

Validations:

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


DELETE /api/smart_variables/:smart_variable_id/override_values/:id
特定スマート変数の上書き値を削除

DELETE /api/smart_class_parameters/:smart_class_parameter_id/override_values/:id
特定スマートクラスパラメーターの上書き値を削除

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
}

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

smart_variable_id
任意

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
任意

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
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.