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
選填

頁數，從 1 開始

Validations:

  • Must be a number.
per_page
選填

每頁要傳回的結果數量

Validations:

  • Must be a number.

Search fields

Field name 類型 Possible values
default_template 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
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

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
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer
config_template
必填

Validations:

  • Must be a Hash
config_template[name]
必填

範本名稱

Validations:

  • Must be a String
config_template[description]
選填 , 允許空值

Validations:

  • Must be a String
config_template[template]
必填

Validations:

  • Must be a String
config_template[snippet]
選填 , 允許空值

Validations:

  • Must be one of: true, false, 1, 0.
config_template[audit_comment]
選填 , 允許空值

Validations:

  • Must be a String
config_template[template_kind_id]
選填 , 允許空值

與程式碼片段不相關

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
選填 , 允許空值

範本組合陣列（hostgroup_id、environment_id）

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
選填 , 允許空值

與範本相關連的作業系統 ID 之陣列

Validations:

  • Must be an array of any type
config_template[locked]
選填 , 允許空值

範本是否鎖定並禁止進行編輯

Validations:

  • Must be one of: true, false, 1, 0.
config_template[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type
config_template[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type
>>>

PUT /api/config_templates/:id
更新佈建範本

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

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[description]
選填 , 允許空值

Validations:

  • Must be a String
config_template[template]
選填

Validations:

  • Must be a String
config_template[snippet]
選填 , 允許空值

Validations:

  • Must be one of: true, false, 1, 0.
config_template[audit_comment]
選填 , 允許空值

Validations:

  • Must be a String
config_template[template_kind_id]
選填 , 允許空值

與程式碼片段不相關

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
選填 , 允許空值

範本組合陣列（hostgroup_id、environment_id）

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
選填 , 允許空值

與範本相關連的作業系統 ID 之陣列

Validations:

  • Must be an array of any type
config_template[locked]
選填 , 允許空值

範本是否鎖定並禁止進行編輯

Validations:

  • Must be one of: true, false, 1, 0.
config_template[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type
config_template[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type
>>>

GET /api/config_templates/revision

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer
version
選填

範本版本

Validations:

  • Must be a String
>>>

DELETE /api/config_templates/:id
刪除佈建範本

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

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
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

Validations:

  • Must be a Integer
>>>

POST /api/config_templates/:id/clone
複製佈建範本

參數

參數名字 描述
location_id
選填

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
選填

Set the current organization context for the request

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