01-RESTful配置
本章节下载: 01-RESTful配置 (141.98 KB)
为了方便用户对网络设备进行配置和维护,设备提供了RESTful API(Representational State Transfer Application Programming Interface)。用户遵循API参数和返回值约定,使用Python、Ruby或Java等语言进行编程,发送HTTP或HTTPS报文到设备进行认证,认证成功后,可以通过在HTTP或HTTPS报文中指定RESTful API操作来配置和维护设备,这些操作包括Get、Put、Post和Delete等。
设备支持HTTP和HTTPS两种方式在Internet上传递RESTful请求信息。
(1) 进入系统视图。
system-view
(2) (可选)配置基于HTTP的RESTful功能的端口号。
restful http port port-number
缺省情况下,基于HTTP的RESTful功能的端口号为80。
(3) 开启基于HTTP的RESTful功能。
restful http enable
缺省情况下,基于HTTP的RESTful功能处于关闭状态。
(4) 创建本地用户用于RESTful登录,并进入本地用户视图。
local-user user-name [ class manage ]
(5) 设置本地用户的密码。
password [ { hash | simple } password ]
(6) (可选)配置RESTful用户的角色。
authorization-attribute user-role user-role
缺省情况下,RESTful用户的角色为network-operator。
(7) 配置RESTful用户的服务类型为HTTP。
service-type http
缺省情况下,未配置用户的服务类型。
基于HTTPS的RESTful功能支持以下认证模式:
· 用户名+密码认证模式:基于HTTPS的RESTful客户端需要在登录页面上输入合法的用户名和密码才能登录到设备。
· 数字证书认证模式:基于HTTPS的RESTful客户端使用其数字证书,经设备认证后自动登录到设备。该认证模式下,设备从RESTful客户端的数字证书中提取CN(Common Name,公用名称)字段作为用户名,如果该用户名在设备上存在(已通过local-user命令添加),则允许该用户登录。
设备采用数字证书认证模式时,需要满足如下条件:
· 配置PKI域,并通过pki import命令将RESTful客户端的数字证书导入该PKI域。关于PKI的配置,请参见“安全配置指导”中的“PKI”。
· 配置SSL服务器端策略:
¡ 通过pki-domain命令指定该策略使用的PKI域
¡ 通过client-verify enable命令对SSL客户端进行基于数字证书的身份验证
· 通过restful https ssl-server-policy命令将RESTful功能与SSL服务器端策略关联
(1) 进入系统视图。
system-view
(2) (可选)配置基于HTTPS的RESTful功能与SSL服务器端策略关联。
restful https ssl-server-policy policy-name
缺省情况下,基于HTTPS的RESTful功能未与SSL服务器端策略关联。
配置该功能后,设备将使用SSL服务器端策略指定的加密套件等SSL参数建立连接,以加强基于HTTPS的RESTful功能的安全性。有关SSL服务器端策略的配置,请参见“安全配置指导”中的“SSL”。
(3) (可选)配置基于HTTPS的RESTful功能的端口号。
restful https port port-number
缺省情况下,基于HTTPS的RESTful功能的端口号为443。
(4) 开启基于HTTPS的RESTful功能。
restful https enable
缺省情况下, 基于HTTPS的RESTful功能处于关闭状态。
(5) (可选)配置基于HTTPS的RESTful功能的认证模式为数字证书。
restful https authentication-mode certificate
缺省情况下,基于HTTPS的RESTful功能的认证模式为用户名+密码。
(6) 创建本地用户用于RESTful登录,并进入本地用户视图。
local-user user-name [ class manage ]
(7) 设置本地用户的密码。
password [ { hash | simple } password ]
基于HTTPS的RESTful功能的认证模式为数字证书时,不需要配置本步骤。
(8) (可选)配置RESTful用户的角色。
authorization-attribute user-role user-role
缺省情况下,RESTful用户的角色为network-operator。
(9) 配置RESTful用户的服务类型为HTTPS。
service-type https
缺省情况下,未配置用户的服务类型。
不同款型规格的资料略有差异, 详细信息请向具体销售和400咨询。H3C保留在没有任何通知或提示的情况下对资料内容进行修改的权利!