Provisioning templates

>>>

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

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

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

GET /api/organizations/:organization_id/provisioning_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
任意

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

Validations:

  • Must be a String
page
任意

1 から始まるページ番号

Validations:

  • Must be a number.
per_page
任意

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

Validations:

  • Must be a number.

検索フィールド

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

GET /api/provisioning_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/provisioning_templates
プロビジョニングテンプレートの作成

パラメーター

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

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer
organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer
provisioning_template
必須

Validations:

  • Must be a Hash
provisioning_template[name]
必須

テンプレート名

Validations:

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

Validations:

  • Must be a String
provisioning_template[template]
必須

Validations:

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

Validations:

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

  • Must be an array of any type
>>>

POST /api/provisioning_templates/import
プロビジョニングテンプレートのインポート

パラメーター

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

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer
organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer
provisioning_template
必須

Validations:

  • Must be a Hash
provisioning_template[name]
任意

テンプレート名

Validations:

  • Must be a String
provisioning_template[template]
任意

メタデータを含むテンプレートコンテンツ

Validations:

  • Must be a String
provisioning_template[location_ids]
任意 , nil可

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

Validations:

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

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

Validations:

  • Must be an array of any type
options
任意

Validations:

  • Must be a Hash
options[force]
任意 , nil可

ロックしたテンプレートを更新したい場合に使用

Validations:

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

テンプレートがオブジェクトをメタデータに基づいて関連付ける場合を決定します。new は新規テンプレートが作成中であることを意味します。always は、新規および更新中の既存のテンプレートを意味します。never はメタデータを無視します

Validations:

  • Must be one of: new, always, never.
options[lock]
任意 , nil可

インポートされたテンプレートをロックします (デフォルトは false)

Validations:

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

テンプレートにデフォルトで意味付けし、新たに作成された組織と場所に自動的に関連付けます (デフォルトは false)

Validations:

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

PUT /api/provisioning_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.
provisioning_template
必須

Validations:

  • Must be a Hash
provisioning_template[name]
任意

テンプレート名

Validations:

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

Validations:

  • Must be a String
provisioning_template[template]
任意

Validations:

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

Validations:

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

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

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

Validations:

  • Must be an array of any type
>>>

GET /api/provisioning_templates/revision

パラメーター

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

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer
organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer
version
任意

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

Validations:

  • Must be a String
>>>

DELETE /api/provisioning_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/provisioning_templates/build_pxe_default
すべての設定済み TFTP サーバーでのデフォルト PXE メニューの更新

パラメーター

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

要求に現在のロケーションコンテキストを設定します

Validations:

  • Must be a Integer
organization_id
任意

要求に現在の組織コンテキストを設定します

Validations:

  • Must be a Integer
>>>

POST /api/provisioning_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.
provisioning_template
必須

Validations:

  • Must be a Hash
provisioning_template[name]
必須

テンプレート名

Validations:

  • Must be a String
>>>

GET /api/provisioning_templates/:id/export
プロビジョニングテンプレート ERB にエクスポート

パラメーター

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