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

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/provisioning_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

provisioning_template
必填

Validations:

  • Must be a Hash

provisioning_template[name]
必填

模板名称

Validations:

  • Must be a String

provisioning_template[description]
选填 , 允许空值

Validations:

  • Must be a String

provisioning_template[template]
必填

Validations:

  • Must be a String

provisioning_template[snippet]
选填 , 允许空值

Validations:

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

provisioning_template[audit_comment]
选填 , 允许空值

Validations:

  • Must be a String

provisioning_template[template_kind_id]
选填 , 允许空值

与片段无关

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
选填 , 允许空值

模板组合阵列(hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
选填 , 允许空值

与该模板关联的操作系统 ID 阵列

Validations:

  • Must be an array of any type

provisioning_template[locked]
选填 , 允许空值

是否已锁定该模板进行编辑

Validations:

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

provisioning_template[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


POST /api/provisioning_templates/import
导入预配模板

参数

参数名字 描述
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

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]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type

options
选填

Validations:

  • Must be a Hash

options[force]
选填 , 允许空值

在您希望更新锁定的模板时使用

Validations:

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

options[associate]
选填 , 允许空值

确定模板何时应基于元数据关联对象,new 表示只在创建新模板时,always 表示同时适用于新模板和的只进行更新的现有模板,never 表示忽略元数据

Validations:

  • Must be one of: new, always, never.

options[lock]
选填 , 允许空值

锁定导入的模板(默认为 false)

Validations:

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

options[default]
选填 , 允许空值

把模块设为默认意味着它将自动与新创建的组织和位置相关联(默认为 false)

Validations:

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


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

provisioning_template
必填

Validations:

  • Must be a Hash

provisioning_template[name]
选填

模板名称

Validations:

  • Must be a String

provisioning_template[description]
选填 , 允许空值

Validations:

  • Must be a String

provisioning_template[template]
选填

Validations:

  • Must be a String

provisioning_template[snippet]
选填 , 允许空值

Validations:

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

provisioning_template[audit_comment]
选填 , 允许空值

Validations:

  • Must be a String

provisioning_template[template_kind_id]
选填 , 允许空值

与片段无关

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
选填 , 允许空值

模板组合阵列(hostgroup_id, environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
选填 , 允许空值

与该模板关联的操作系统 ID 阵列

Validations:

  • Must be an array of any type

provisioning_template[locked]
选填 , 允许空值

是否已锁定该模板进行编辑

Validations:

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

provisioning_template[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


GET /api/provisioning_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/provisioning_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/provisioning_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/provisioning_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.

provisioning_template
必填

Validations:

  • Must be a Hash

provisioning_template[name]
必填

模板名称

Validations:

  • Must be a String


GET /api/provisioning_templates/:id/export
导出置备模板到 ERB

参数

参数名字 描述
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.