GET /api/smart_class_parameters
すべてのスマートクラスパラメーターを一覧表示

GET /api/hosts/:host_id/smart_class_parameters
特定ホストのスマートクラスパラメーターの一覧

GET /api/hostgroups/:hostgroup_id/smart_class_parameters
特定ホストグループのスマートクラスパラメーターの一覧

GET /api/puppetclasses/:puppetclass_id/smart_class_parameters
特定 Puppet クラスのスマートクラスパラメーターの一覧

GET /api/environments/:environment_id/smart_class_parameters
特定の環境のスマートクラスパラメーターの一覧

GET /api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters
特定の環境/Puppet クラスの組み合わせ用のスマートクラスパラメーターの一覧

パラメーター

パラメーター名 記述
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.

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

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/smart_class_parameters/:id
スマートクラスパラメーターの表示

パラメーター

パラメーター名 記述
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


PUT /api/smart_class_parameters/:id
スマートクラスパラメーターの更新

パラメーター

パラメーター名 記述
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
必須

Validations:

  • Must be a Hash

smart_class_parameter[override]
任意

スマートクラスパラメーター値が Foreman によって管理されているかどうか

Validations:

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

smart_class_parameter[description]
任意

スマートクラスの説明

Validations:

  • Must be a String

smart_class_parameter[default_value]
任意

一致がない場合に使用する値

Validations:

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

smart_class_parameter[hidden_value]
任意

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

Validations:

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

smart_class_parameter[use_puppet_default]
任意

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

Validations:

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

smart_class_parameter[omit]
任意

Foreman はこのパラメーターを分類出力で送信しません。Puppet はこのパラメーターについて Puppet マニフェストで定義された値を使用します

Validations:

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

smart_class_parameter[path]
任意

値が解決される順序

Validations:

  • Must be a String

smart_class_parameter[validator_type]
任意

検証値のタイプ

Validations:

  • Must be one of: regexp, list.

smart_class_parameter[validator_rule]
任意

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

Validations:

  • Must be a String

smart_class_parameter[override_value_order]
任意

値が解決される順序

Validations:

  • Must be a String

smart_class_parameter[parameter_type]
任意

変数値のタイプ

Validations:

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

smart_class_parameter[required]
任意

true の場合は、デフォルト値がなく、Matcher が値を提供しないときにエラーが発生します

Validations:

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

smart_class_parameter[merge_overrides]
任意

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

Validations:

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

smart_class_parameter[merge_default]
任意

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

Validations:

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

smart_class_parameter[avoid_duplicates]
任意

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

Validations:

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