DCIM API 文档 / IPMI / 服务器重装
服务器重装
重装系统API，参数提交方式 post 公共参数与其他API一致
1.获取操作系统和附加配置
▍URL
/index.php?m=api&a=getMirrorOsConfig
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 服务器id | 是 | int | 需要重装的服务器id，用于获取支持的操作系统 |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
os | array id 操作系统id name 操作系统名称 group_id 操作系统分组id group_name 操作系统分组名称 | 可用于重装的系统 |
config | array id 附加配置id name 附加配置名称 osname 关联的操作系统id | 可用的附加配置 |
2.重装系统
▍URL
/index.php?m=api&a=reinstallSystem
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 服务器id | 是 | int | 需要重装的服务器id，用于获取支持的操作系统 |
| rootpass | 密码 | 是 | string | 重装需要设置的操作系统密码 |
| mos | 操作系统id | 是 | int | 需要安装的操作系统 |
| mcon | 附加配置id | 否 | int | 需要使用的附加配置 |
| action | 分区方式 | 否 | int | 0 默认 1附加配置 2自定义 |
| port | 端口 | 否 | int | 端口 (DCIM3.5及以上) |
| part_type | 分区类型 | 否 | int | 0 完全分区, 1 第一分区格式化 (DCIM3.5及以上) |
| xml | 自定义分区配置 | 否 | string | 自定义分区配置 (DCIM3.5及以上) |
| custom_tag | 自定义标签 | 否 | string | 自定义标签 (DCIM4.7及以上) |
| mscripts | 开机脚本 | 否 | int|string | 传入int类型，则当作开机脚本ID处理；传入string类型，则当作开机脚本内容处理 |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| status | string | success 成功 error 失败 |
| msg | string | 报错信息或提示信息 |
| password | string | 操作系统密码 |
3.获取正在重装的服务器
▍URL
/index.php?m=api&a=getReinstallStatus
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 服务器id | 否 | int | 需要查看服务器id，为空时获取所有正在重装的服务器 |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| status | string | success 成功 error 失败 |
| data | array id 重装任务id wltag 服务器标签 time 重装发起时间 progress 重装进度百分比 step 重装当前步骤 name 操作系统名称 crackPwd 需要选择破解的用户数组 | 重装任务信息 |
| msg | string | 报错信息 |
4.取消重装系统
▍URL
URL:/index.php?m=api&a=cancellReinstall
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 重装任务id | 是 | int | 需要取消重装任务的id |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| status | string | success 成功 error 失败 |
| msg | string | 报错信息或提示信息 |
5.破解密码
▍URL
/index.php?m=api&a=ipmiCrackPwd
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 服务器id | 是 | int | 需要破解密码的服务器id |
| action | 密码 | 否 | string | action为chooseUser时为选择要破解的用户，用于获取重装服务器时，如果返回来需要选择破解的用户列表时选择用户 |
| user | 用户 | 否 | string | 需要破解的用户，other_user为1或action为chooseUser时需要传入 |
| other_user | 是否破解非默认用户 | 是 | int | 0：破解默认用户（administrator，root），1：破解传入的用户 |
| crack_password | 密码 | 是 | string | 破解后自定义的密码，六位以上且由大小写字母数字组成 |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| status | string | success 成功 error 失败 |
| msg | string | 报错信息或提示信息 |
6.救援系统
▍URL
/index.php?m=api&a=ipmiRescueSystem
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| id | 服务器id | 是 | int | 需要救援系统的服务器id |
| system | 救援系统类型 | 是 | int | 1：Linux，2：Windows |
▍返回参数
| 变量名 | 类型 | 描述 |
|---|---|---|
| status | string | success 成功 error 失败 |
| msg | string | 报错信息或提示信息 |