Config templates

>>>

GET /api/config_templates
プロビジョニングテンプレートを一覧表示

GET /api/operatingsystems/:operatingsystem_id/config_templates
オペレーティングシステムごとのプロビジョニングテンプレートを一覧表示

GET /api/locations/:location_id/config_templates
ロケーションごとのプロビジョニングテンプレートを一覧表示

GET /api/organizations/:organization_id/config_templates
組織ごとのプロビジョニングテンプレートを一覧表示

パラメーター

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

オペレーティングシステムの ID

Validations:

  • Must be a String
location_id
任意

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
search
任意

結果のフィルター

Validations:

  • Must be a String
order
任意

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
任意

結果のページネーション

Validations:

  • Must be a String
per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String

検索フィールド

フィールド名 タイプ 設定可能な値
default true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked true, false
name string
operatingsystem string
organization string
organization_id integer
snippet true, false
template text
vendor string
>>>

GET /api/config_templates/:id
プロビジョニングテンプレートの詳細を表示

パラメーター

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

POST /api/config_templates
プロビジョニングテンプレートの作成

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
config_template
必須

Validations:

  • Must be a Hash
config_template[name]
必須

テンプレート名

Validations:

  • Must be a String
config_template[template]
必須

Validations:

  • Must be a String
config_template[snippet]
任意 , nil可

Validations:

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

Validations:

  • Must be a String
config_template[template_kind_id]
任意 , nil可

スニペットに関連がありません

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
任意 , nil可

テンプレートの組み合わせ (hostgroup_id、environment_id) の配列

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
任意 , nil可

テンプレートに関連付けるオペレーティングシステム ID の配列

Validations:

  • Must be an array of any type
config_template[locked]
任意 , nil可

テンプレートを編集用にロックするかどうか

Validations:

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

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type
config_template[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type
>>>

PUT /api/config_templates/:id
プロビジョニングテンプレートの更新

パラメーター

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

Validations:

  • Must be a Hash
config_template[name]
任意

テンプレート名

Validations:

  • Must be a String
config_template[template]
任意

Validations:

  • Must be a String
config_template[snippet]
任意 , nil可

Validations:

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

Validations:

  • Must be a String
config_template[template_kind_id]
任意 , nil可

スニペットに関連がありません

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
任意 , nil可

テンプレートの組み合わせ (hostgroup_id、environment_id) の配列

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
任意 , nil可

テンプレートに関連付けるオペレーティングシステム ID の配列

Validations:

  • Must be an array of any type
config_template[locked]
任意 , nil可

テンプレートを編集用にロックするかどうか

Validations:

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

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type
config_template[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type
>>>

GET /api/config_templates/revision

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
version
任意

テンプレートのバージョン

Validations:

  • Must be a String
>>>

DELETE /api/config_templates/:id
プロビジョニングテンプレートの削除

パラメーター

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

POST /api/config_templates/build_pxe_default
すべての設定済み TFTP サーバーでのデフォルト PXE メニューの更新

パラメーター

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

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

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
>>>

POST /api/config_templates/:id/clone
プロビジョンテンプレートのクローン

パラメーター

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

Validations:

  • Must be a Hash
config_template[name]
必須

テンプレート名

Validations:

  • Must be a String