Smart variables

>>>

GET /api/smart_variables
すべてのスマート変数を一覧表示

GET /api/hosts/:host_id/smart_variables
特定ホストのスマート変数の一覧

GET /api/hostgroups/:hostgroup_id/smart_variables
特定ホストグループのスマート変数の一覧

GET /api/puppetclasses/:puppetclass_id/smart_variables
特定 Puppet クラスのスマート変数の一覧

例

GET /api/puppetclasses/298486374/smart_variables
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "description": null,
      "parameter_type": "string",
      "variable_type": "string",
      "hidden_value?": false,
      "validator_type": null,
      "validator_rule": null,
      "override_value_order": "organization,location\nxyz\nhostgroup",
      "merge_overrides": false,
      "merge_default": false,
      "avoid_duplicates": false,
      "puppetclass_id": 298486374,
      "puppetclass_name": "apache",
      "created_at": "2019-09-11 14:58:01 UTC",
      "updated_at": "2019-09-11 14:58:01 UTC",
      "variable": "special_info",
      "id": 281110143,
      "default_value": "secret",
      "override_values_count": 2
    }
  ]
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
host_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.
hostgroup_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.
puppetclass_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.
search
任意

結果のフィルター

Validations:

  • Must be a String
order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String
page
任意

1 から始まるページ番号

Validations:

  • Must be a number.
per_page
任意

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

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
avoid_duplicates true, false
key string
merge_default true, false
merge_overrides true, false
override true, false
parameter string
puppetclass string
>>>

GET /api/smart_variables/:id
スマート変数の表示

例

GET /api/puppetclasses/980190962/smart_variables/1018350796
200
{
  "description": null,
  "parameter_type": null,
  "variable_type": null,
  "hidden_value?": true,
  "validator_type": null,
  "validator_rule": null,
  "override_value_order": "fqdn\nhostgroup\nos\ndomain",
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "puppetclass_id": 980190962,
  "puppetclass_name": "base",
  "created_at": "2019-09-11 14:34:10 UTC",
  "updated_at": "2019-09-11 14:34:10 UTC",
  "variable": "param8",
  "id": 1018350796,
  "default_value": "hidden",
  "override_values_count": 0,
  "override_values": []
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
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
スマート変数の作成

例

POST /api/smart_variables
{
  "smart_variable": {
    "variable": "QSFxqjVjdV",
    "puppetclass_id": 298486374,
    "hidden_value": true
  }
}
201
{
  "description": null,
  "parameter_type": null,
  "variable_type": null,
  "hidden_value?": true,
  "validator_type": null,
  "validator_rule": null,
  "override_value_order": "fqdn\nhostgroup\nos\ndomain",
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "puppetclass_id": 298486374,
  "puppetclass_name": "apache",
  "created_at": "2019-09-11 14:34:11 UTC",
  "updated_at": "2019-09-11 14:34:11 UTC",
  "variable": "QSFxqjVjdV",
  "id": 1018350798,
  "default_value": "*****",
  "override_values_count": 0,
  "override_values": []
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
smart_variable
必須

Validations:

  • Must be a Hash
smart_variable[variable]
必須

変数の名前

Validations:

  • Must be a String
smart_variable[puppetclass_id]
任意 , nil可

Puppet クラス ID

Validations:

  • Must be a number.
smart_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
smart_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String
smart_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String
smart_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.
smart_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String
smart_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

Validations:

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

PUT /api/smart_variables/:id
スマート変数の更新

例

PUT /api/smart_variables/1018350799-IJcocqAlPP
{
  "smart_variable": {
    "hidden_value": false
  }
}
200
{
  "description": null,
  "parameter_type": null,
  "variable_type": null,
  "hidden_value?": false,
  "validator_type": null,
  "validator_rule": null,
  "override_value_order": "fqdn\nhostgroup\nos\ndomain",
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "puppetclass_id": 980190962,
  "puppetclass_name": "base",
  "created_at": "2019-09-11 14:34:11 UTC",
  "updated_at": "2019-09-11 14:34:11 UTC",
  "variable": "IJcocqAlPP",
  "id": 1018350799,
  "default_value": null,
  "override_values_count": 0,
  "override_values": []
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
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_variable
必須

Validations:

  • Must be a Hash
smart_variable[variable]
任意

変数の名前

Validations:

  • Must be a String
smart_variable[puppetclass_id]
任意 , nil可

Puppet クラス ID

Validations:

  • Must be a number.
smart_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json
smart_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String
smart_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String
smart_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.
smart_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String
smart_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
smart_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

  • Must be one of: true, false, 1, 0.
smart_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

Validations:

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

DELETE /api/smart_variables/:id
スマート変数の削除

例

DELETE /api/smart_variables/281110143-special_info
{
  "smart_variable": {}
}
200
{
  "description": null,
  "parameter_type": "string",
  "variable_type": "string",
  "hidden_value?": false,
  "validator_type": null,
  "validator_rule": null,
  "override_value_order": "organization,location\nxyz\nhostgroup",
  "merge_overrides": false,
  "merge_default": false,
  "avoid_duplicates": false,
  "puppetclass_id": 298486374,
  "puppetclass_name": "apache",
  "created_at": "2019-09-11 14:58:01 UTC",
  "updated_at": "2019-09-11 14:58:01 UTC",
  "variable": "special_info",
  "id": 281110143,
  "default_value": "secret",
  "override_values_count": 0,
  "override_values": []
}

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

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