DCIM API 文档 / IPMI / 开机脚本
开机脚本API,参数提交方式 post 公共参数与其他API一致
1.获取开机脚本
▍URL
/index.php?m=api&a=scriptsListing
▍请求参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
搜索内容 | search | 否 | string | 对开机脚本名称备注内容的搜索 |
分页数量 | listpages | 否 | int | 每一页显示的数据的数量 |
排序类型 | orderby | 否 | string | 用来排序的字段 |
排序规则 | sorting | 否 | string | 升序 asc 降序 desc |
▍返回参数
字段名 | 变量名 | 类型 | 描述 |
开机脚本列表 | listing | array id 开机脚本id vlan vlan限制 house 支持的机房 house[].id 机房ID house[].name 机房名称 house[].auto_install 是否支持自动安装0否1是 osname 支持的操作系统名称组成的数组 | 根据查询条件查询到的所有开机脚本数据 |
开机脚本总数 | sum | int | 系统内开机脚本数据的总数 |
分页数量 | listpages | int | 每一页显示的数据的数量 |
搜索类型 | search | string | 搜索类型 |
搜索内容 | key | string | 自定义的搜索内容 |
排序类型 | orderby | string | 用来排序的字段 |
排序规则 | sorting | string | 升序 asc 降序 desc |
数据偏移量 | offset | int | 返回数据的偏移指针,与分页数量结合使用 |
状态 | status | string | success 成功 error 失败 |
2.添加开机脚本
▍URL
/index.php?m=api&a=addScripts
▍请求参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
操作系统ID | osid | 是 | array | 支持的操作系统 |
名称 | name | 是 | string | 开机脚本名称 |
脚本内容 | data | 是 | string | 开机脚本内容 |
备注 | remarks | 是 | string | 开机脚本备注 |
vlan限制 | vlan | 是 | string | VLAN限制,安装了开机脚本插件后必填,格式为1,2,4-10 |
机房ID | house | 是 | array | 支持的机房ID数组,安装了开机脚本插件后必填 |
支持自动安装的机房ID | auto_install | 是 | array | 支持自动安装的机房ID数组,安装了开机脚本插件后必填 |
▍返回参数
变量名 | 类型 | 描述 |
status | string | success 成功 error 失败 |
msg | string | 报错信息或提示信息 |
id | int | 开机脚本ID |
3.修改开机脚本
▍URL
/index.php?m=api&a=editScripts
▍请求参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
开机脚本ID | id | 是 | int | 开机脚本ID |
操作系统ID | osid | 是 | array | 支持的操作系统 |
名称 | name | 是 | string | 开机脚本名称 |
脚本内容 | data | 是 | string | 开机脚本内容 |
备注 | remarks | 是 | string | 开机脚本备注 |
vlan限制 | vlan | 是 | string | VLAN限制,安装了开机脚本插件后必填,格式为1,2,4-10 |
机房ID | house | 是 | array | 支持的机房ID数组,安装了开机脚本插件后必填 |
支持自动安装的机房ID | auto_install | 是 | array | 支持自动安装的机房ID数组,安装了开机脚本插件后必填 |
▍返回参数
变量名 | 类型 | 描述 |
status | string | success 成功 error 失败 |
msg | string | 报错信息或提示信息 |
4.删除开机脚本
▍URL
URL:/index.php?m=api&a=delScripts
▍请求参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
开机脚本id | id | 是 | int | 开机脚本ID |
▍返回参数
变量名 | 类型 | 描述 |
status | string | success 成功 error 失败 |
msg | string | 报错信息或提示信息 |
5.操作系统获取附加开机脚本
▍URL
/index.php?m=api&a=getMirrorScripts
▍请求参数
字段名 | 变量名 | 必填 | 类型 | 描述 |
服务器ID | id | 是 | int | 当前服务器ID |
操作系统ID | mos | 是 | int | 当前选择的操作系统ID |
▍返回参数
字段名 | 变量名 | 类型 | 类型 |
开机脚本列表 | listing | array id 开机脚本id name 名称 auto_install 是否支持自动安装0否1是 | 根据当前服务器ID和操作系统ID查询到的所有开机脚本数据 |
状态 | status | string | success 成功 error 失败 |