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 クラスのスマート変数の一覧

Params

Param Name Description
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.

search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

リクエストあたりのエントリ数

Validations:

  • Must be String


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

Params

Param Name Description
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.


POST /api/smart_variables
スマート変数を作成

Params

Param Name Description
smart_variable
Required

Validations:

  • Must be a Hash

smart_variable[variable]
Required

変数名

Validations:

  • Must be String

smart_variable[puppetclass_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Puppet クラス ID

Validations:

  • Must be a number.

smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数のデフォルト値

Validations:

  • Must be String

smart_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

値が解決される順序

Validations:

  • Must be String

smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数の説明

Validations:

  • Must be String

smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

検証値の種類

Validations:

  • Must be one of: regexp, list.

smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be String

smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数値の種類

Validations:

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

smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

すべての一致する値をマージする ( 配列型とハッシュ型のみ )

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

重複した値を削除する ( 配列型のみ )

Validations:

  • Must be 'true' or 'false' or '1' or '0'


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

Params

Param Name Description
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.

smart_variable
Required

Validations:

  • Must be a Hash

smart_variable[variable]
Optional

変数名

Validations:

  • Must be String

smart_variable[puppetclass_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Puppet クラス ID

Validations:

  • Must be a number.

smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数のデフォルト値

Validations:

  • Must be String

smart_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

When enabled the parameter is hidden in the UI

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

値が解決される順序

Validations:

  • Must be String

smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数の説明

Validations:

  • Must be String

smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

検証値の種類

Validations:

  • Must be one of: regexp, list.

smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Used to enforce certain values for the parameter values

Validations:

  • Must be String

smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

変数値の種類

Validations:

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

smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

すべての一致する値をマージする ( 配列型とハッシュ型のみ )

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Include default value when merging all matching values

Validations:

  • Must be 'true' or 'false' or '1' or '0'

smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

重複した値を削除する ( 配列型のみ )

Validations:

  • Must be 'true' or 'false' or '1' or '0'


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

Params

Param Name Description
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.