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.

show_hidden
Optional

Display hidden values

Validations:

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

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.

show_hidden
Optional

Display hidden values

Validations:

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


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>

有効な場合はパラメーターが 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>

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

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>

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

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>

有効な場合はパラメーターが 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>

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

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>

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

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.