魔方云对接WHMCS
本文整理智简魔方云平台中“魔方云对接 WHMCS”相关的配置、操作或问题处理内容，供管理员和运维人员按原文步骤查阅与执行。
前言
WHMCS 插件用于「魔方云系统对接 WHMCS」，实现自动化管理，实现 whmcs 开通，删除云主机开机、关机、重装等管理。
支持 whmcs 版本为「whmcs7.x」
一、WHMCS 插件下载和安装方法
- 1 功能支持
- 2 插件下载和安装
①下载：前往【魔方云系统后台】-【系统设置】-【whmcs 设置】-【右上角点击下载 whmcs 插件】
②安装：将下载后的插件【上传至 whmcs 中】，需将【zjmfcloud 文件】上传至【whmcs 根目录/module/server/中】
二、WHMCS 中的设置
-
1 服务器对接原理和参数 系统通过 whmcs 预留的 server module 原生方式对接至 whmcs，使用 whmcs 原生产品设置和配置选项进行产品的价格定义，您可根据教程一步一步完成配置。
-
1.1 添加服务器【前往 WHMCS】-【系统设置】-【服务器设置】-【添加新的服务器】
*必填字段：
- NAME（名称）：魔方云配置
- Hostname （主机名）：填写访问魔方云系统的域名
- Ip（IP 地址）：填写访问魔方云系统的 ip
- Type（类型）：选择魔方云
- Username（用户名）：登录魔方云系统的账号
- Password（密码）：登录魔方云系统的密码
- 勾选 SSL：端口默认为 8443，如有变更魔方云访问端口，请填写魔方云端口
- **Hash:**必填参数：
admin -- admin #是指魔方云系统设置，安全设置中的后台管理员路径，如果是代理商端对接，填代理商路径 user
可选参数：
2. 1.2 添加服务器分组
【前往 WHMCS】-【系统设置】-【服务器设置】-【创建新的分组】
- 1.3 分配服务器至分组
- 1.4 添加产品
前往【系统设置】-【产品/服务】-【产品/服务】-【新增产品】
- 产品类型：独服/VPS
- 产品名称：服务器产品型号 1
- 模块设置：模块名称-魔方云
- 服务器组：魔方云服务组
- 接口参数设置：请根据以下说明配置参数
参数说明
注:如果接口设置和可配置项中都配有此参数，优先读取可配置中的
表格一
| 配置项名称 | 配置项参数 | 参数说明 | 必选 | 未传递****默认值 |
|---|---|---|---|---|
| area|数据中心 | 1|CN^香港 CN2 | 1指魔方云系统-区域管理-区域 ID 注：数据中心和节点 id 必传一个 | ✔ | |
| node|节点 id | 1| CN^香港 CN2^一区 | 1指魔方云系统-节点管理-节点 ID 注：数据中心和节点 id 必传一个 | 不传递系统将自动分配 | |
| os|操作系统 | 1|windows^windows2008 | 1指魔方云系统-镜像管理-操作系统 ID | ✔ | |
| cpu|CPU | 2|2 核心 | 2指需要为该云主机分配的 cpu 核心数 | ✔ | |
| memory|内存 | 1024|1G | 1024指需要为该云主机分配的内存大小,单位 M | ✔ | |
| system_disk_size|系统盘 | 20|20G | 20指需要为该云主机分配的系统盘大小 | 不传递默认 50G，Windows 系统盘最小 30G | |
| store|系统盘存储 | 1|本地存储 | 1指区域节点-存储管理中的存储 ID,选择系统盘开在那个存储下，也可不传递，默认随机 | ||
| network_type|网络类型 | normal|经典网络 vpc|VPC 网络 | normal是指分配的 ip 地址可直接配置在机器里 vpc 是指支持浮动 ip，机器内不再配置公网 ip | ✔ | |
| bw|带宽 | 10|10Mbps | 10指需要为该云主机分配的上下行带宽 | 不传递默认为 0Mbps | |
| in_bw|流入带宽 | 100|100Mbps | 100指需要为该云主机分配的进带宽如果配置 in_bw 优先使用该参数 | 不传递默认为 0Mbps | |
| ip_num|IP 数量 | 2|2 个 | 2指需要为该云主机分配的 ip 数量 | ✔ | |
| flow_way|流量方向 | in|进方向 out|出方向 all|进出汇总方向 | in 指进方向的流量，out 指出方向的流量，all 指进出方向汇总的流量 | 不传递默认为 all | |
| flow_limit|流量 | 1024|1T | 1024指需要为该云主机分配的流量大小，单位 G | 不传递默认为不限量 | |
| snap_num|快照数量 | -1|不开通，0|不限量，5|5 个 | -1指该云主机不能创建快照,0指可以不限量创建快照,5指只能创建 5 个快照 | 不传递默认 2 个 | |
| backup_num|备份数量 | -1|不开通，0|不限量，5|5 个 | -1指该云主机不能创建备份,0指可以不限量创建备份,5指只能创建 5 个备份 | 不传递默认 2 个 | |
| nat_acl_limit|NAT 转发 | -1|不支持, 0|不限制, 5|5 个 | -1指该云主机不能设置 nat 转发,0指可以不限量 nat 转发,5指只能创建 5 个 nat 转发 | 不传递默认不支持 | |
| nat_web_limit|共享建站 | -1|不支持, 0|不限制, 5|5 个 | -1指该云主机不能 nat 建站,0指可以不限量 nat 建站,5指只能创建 5 个 nat 建站 | 不传递默认不支持 | |
| system_disk_io_limit|系统盘性能 | 0,0,0,0|不限制性能，500,500,2000,2000|500 持续 2000IOPS | 0,0,0,0指不限制系统盘性能，500,500,2000,2000 读取限制 500MB/s，写入限制 500MB/s，读取限制 2000ops/s，写入限制 2000ops/s | 不传递默认不限制 | |
| data_disk_io_limit|数据盘性能 | 0,0,0,0|不限制性能，500,500,2000,2000|500 持续 2000IOPS | 0,0,0,0指不限制数据盘性能，500,500,2000,2000读取限制 500MB/s，写入限制 500MB/s，读取限制 2000ops/s，写入限制 2000ops/s | 不传递默认不限制 | |
| ip_group|IP 分组 | 1|电信,2|联通 | 1指魔方云系统-ip 管理-ip 分组中的 ID | ||
| node_group|节点分组 | 1|台湾,2|香港 | 1指魔方云系统-区域管理-节点管理-节点分组的 ID | ||
| node_priority|节点选择优先级(1 数量平均,2 负载最低,3 内存最低，4 填满一个) | 1|数量平均,2|负载最低,3|内存最低，4|填满一个 | 1指在创建实例时，会优先分在节点实例最少的。2指会优化分给节点 cpu 负载最低的。3指会优先分给节点内存最低的。4指根据节点 id 从小到大填满一个的方式创建实例，当节点资源达到限制后，就在其他节点开通实例。 | 不传递默认数量平均 | |
| IP_MACBond|嵌套虚拟化 | 0|关闭绑定,1|开启绑定 | 0 指关闭 IP-MAC 绑定，1 指开启 IP-MAC 绑定 | 不传递默认开启绑定 | |
| cpu_limit|CPU 限制 | 50|50% | 50指开通实例设置 CPU 限制为 50% | 不传递默认以魔方云系统设置为准 | |
| traffic_bill_type|流量计费周期 | month|自然月， last_30days|订购日至下月 | month是指每月 1 日流量进行清零，last_30days|是指产品开通日至下月进行清零 | 不传递默认每月 1 日清零 | |
| type|云节点类型 | host|KVM 加强版，lightHost|KVM 轻量版，hyperv|Hyper-V ，adsl|拨号云 | host 是指 KVM 加强版节点类型，lightHost 是指 KVM 轻量版节点类型，hyperv 是指 Hyper-V 节点类型，adsl 是指拨号云节点类型 | 不传递默认 KVM 加强版 | |
| advanced_bw|智能带宽 | 1|降至 30% | 1 指在魔方云系统-监控-智能规则-智能带宽的 ID | ||
| advanced_cpu|智能 CPU | 1|降至 50% | 1 指在魔方云系统-监控-智能规则-智能 CPU 的 ID | ||
| port|端口 | auto|随机端口 | auto 指随机端口 | 不传递默认不支持 | |
| data_disk_size|数据盘 | 20,1|20G | 20 指需要为该云主机分配的数据盘大小，单位 G;1 指区域节点-存储管理中的存储 ID,选择数据盘开在那个存储下，也可不传递，默认随机。 | 不传递默认无数据盘 | |
| data1_disk_size|数据盘 | 20,1|20G | 多块数据盘分配的时候增加使用该参数 | ||
| data2_disk_size|数据盘 | 20,1|20G | |||
| data3_disk_size|数据盘 | 20,1|20G | |||
| data4_disk_size|数据盘 | 20,1|20G | |||
| ipv6_num|ipv6 数量 | 2|2 个 | 2 指 ipv6 地址数量为 2 个 | ||
| gpu_num|GPU 数量 | 1|1 个 GPU | 1 指 GPU 显卡的个数 | 不传递默认不支持 | |
| simulate_physical_machine|模拟物理机运行 | 1|开启 0|关闭 | 1 指创建云主机时开启模拟物理机运行 0 指创建云主机时关闭模拟物理机运行 | 不传递默认关闭模拟物理机运行 | |
| ip_num_[1-6] | 2|2 个 | 2 指 ip 数量，1 指 ip 管理-ip 分组中的 IDIP 数量都必须对应一个分组才行，可配置相同分组：例如 ip_num_1 对应 ip_group_1,以此类推，如果没有对应上，则 ip_num 不生效；例如：配置了 ip_num_6，没有配置 ip_group_6,则 ip_num_6 下的选项均不生效 | 魔方云 3.8.6+支持 | |
| ip_group_[1-6] | 1|ip 分组 1 |
- 1.5 重装系统时能够选择格式化数据盘功能**【仅对接的魔方云是专业版可用】**
在服务器-访问哈希中加上这一段
- 2 可配置选项原理和参数
我们使用 whmcs 可配置选项功能进行配置选项传递，包含以下产品，格式为： 参数 | 显示名称
前往【系统设置】-【产品/服务】-【可配置选项】-【Create a New Group】
- **Group Name：**配置组名称
- **Description：**描述自定义
- **Assigned Products：**指定产品
- **Add New Configurable Option：**点击添加新的可配置选项
注：添加配置参数可参考上面表格一，方法都是一致，本教程就添加一个为范例。
四、WHMCS 前后台管理
- 1 产品对接魔方云实现开机关机重装后台管理
完成以上配置后，我们即可实现对接管理，为客户添加产品后进行测试即可。
- 1.1 产品开通（自动和手动）
（1）随机分配开通：正常流程下单，管理员手动通过模块命令执行“开通”，或者设置下单自动开通
该开通方式，在魔方云里按照要求，随机分配配置信息，新开通云主机
（2）指定主机开通：在 whmcs 端正常下单服务器，然后在管理员后台，产品/服务中，找到对应的订单，通过输入 hostid（对应云主控实例列表中的 id）来对应开通魔方云中已存在的机器
该开通方式主要用于已经在使用的主机，指定分配给用户，这种方式的开通不会对服务器进行重装操作
五、问题说明
- 1 用户名密码错误
- 检查 WHMCS 的服务器设置的用户名和密码是否是魔方云登录的用户名及密码
- 2 连接端口错误
- 检查 SSL 端口是否填写正确
- 3 魔方云无法连接
- 检查 WHMCS 服务器设置中的主机名及 IP 是否是魔方云的访问 ip