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

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

根据位置界定的范围

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

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

根据位置界定的范围

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