• 返回
  • 最后更新
  • 2020-12-10 15:34:49 +0800 CST

ToughRADIUS 商业版 API — 接入设备

通过 API 来管理接入设备, 这里设备指的是用来实现网络接入的BRAS,AC 等, 其具备 PPPOE, L2TP, PPTP, SSTP, OpenVPN, 无线控制器等一项或多项功能, 接入设备必须具备的是支持作为 RADIUS 客户端发起认证。

数据结构

identifier: 设备标识
vendor_code: 厂商标识代码
name: 名称
ipaddr: IP 地址
secret: 共享密钥
coa_port: 授权端口
ac_port: AC 控制器端口
ldap_id: LDAP 服务器节点ID
status: 状态
remark: 备注
tags:  标签
create_time: 创建时间
update_time: 更新时间

ldap_id 只有在启用 ldap 认证时才有意义, 通常设置0不使用, coa_port 必须 设备本身支持 COA 功能才有效, ac_port 是针对无线控制器的配置参数

- 查询接入设备

GET /bss/vpe/list?tags=&keyword=

参数通过 url 传递, 通过tags 和 keyword 模糊匹配

请求Header

authorization: Bearer <Api Token>

响应结果

{ 
    "code": 0, 
    "msg": "Success"  
    "data": [{
          "id": "1",
          "tags": "N/A",
          "name": "default",
          "domain": "N/A",
          "addr_pool": "N/A",
          "active_num": 1,
          "up_rate": 0,
          "down_rate": 0,
          "limit_policy": "N/A",
          "up_limit_policy": "N/A",
          "down_limit_policy": "N/A",
          "bill_times": 1,
          "bill_timeunit": "day",
          "status": "enabled",
          "remark": "default",
          "create_time": "2020-09-01 00:00:00",
          "update_time": "2020-09-09 15:32:55"
        },...
     ]
 }

- 根据ID查询单个接入设备

GET /bss/vpe/get?id=1

请求Header

authorization: Bearer <Api Token>

响应结果

{
  "code": 0,
  "msgtype": "info",
  "msg": "Operation Success",
  "data": {
      "id": "1",
      "identifier": "default",
      "tags": "N/A",
      "name": "default",
      "ipaddr": "127.0.0.1",
      "secret": "secret",
      "vendor_code": "0",
      "coa_port": 3799,
      "ac_port": 2000,
      "status": "enabled",
      "ldap_id": "0",
      "remark": "default test nas",
      "create_time": "2020-10-10 00:00:00",
      "update_time": "2020-12-10 15:05:50"
  }
}

- 创建接入设备

POST /bss/vpe/add

请求Header

authorization: Bearer <Api Token>
content-type: application/x-www-form-urlencoded

请求参数

create_time: 2020-10-10 00:00:00
update_time: 2020-12-10 15:05:50
identifier: default
vendor_code: 14988
name: default
ipaddr: 127.0.0.1
secret: secret
coa_port: 3799
ac_port: 2000
ldap_id: 0
status: enabled
remark: default test nas
tags: N/A

响应结果

{ "code":0, "msg": "Success", data: { "id": "..." } }

返回记录唯一ID

- 修改接入设备

POST /bss/vpe/update

请求Header

authorization: Bearer <Api Token>
content-type: application/x-www-form-urlencoded

请求参数

id: 1
create_time: 2020-10-10 00:00:00
update_time: 2020-10-10 00:00:00
identifier: default
vendor_code: 0
name: default
ipaddr: 127.0.0.1
secret: secret
coa_port: 3799
ac_port: 2000
ldap_id: 0
status: enabled
remark: default test nas
tags: N/A

响应结果

{ "code": 0, "msg": "Success" }

- 删除接入设备

GET /bss/vpe/delete?ids=1

参数直接通过url参数ids传递,支持多个id,英文逗号分割

请求Header

authorization: Bearer <Api Token>

响应结果

{ "code": 0, "msg": "Success" }