• 产品与解决方案
  • 行业解决方案
  • 服务
  • 支持
  • 合作伙伴
  • 关于我们

23-可编程网络管理命令参考

目录

01-RESTful命令

本章节下载 01-RESTful命令  (153.86 KB)

01-RESTful命令


1 RESTful

1.1  RESTful命令

1.1.1  restful http enable

restful http enable命令用来开启基于HTTP的RESTful功能。

undo restful http enable命令用来关闭基于HTTP的RESTful功能。

【命令】

restful http enable

undo restful http enable

【缺省情况】

基于HTTP的RESTful功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

开启该功能后,用户才可以通过RESTful HTTP方式登录设备并采用RESTful API对设备进行配置和维护。

【举例】

# 开启基于HTTP的RESTful功能。

<Sysname> system-view

[Sysname] restful http enable

1.1.2  restful http port

restful http port命令用来配置基于HTTP的RESTful功能的端口号。

undo restful http port命令用来恢复缺省情况。

【命令】

restful http port port-number

undo restful http port

【缺省情况】

基于HTTP的RESTful功能的端口号为80。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

port-number:基于HTTP的RESTful功能的端口号,取值范围为1~65535。

【使用指导】

配置该命令后,基于HTTP的原RESTful会话将失效,RESTful用户需要使用新端口号重新登录设备。

【举例】

# 配置基于HTTP的RESTful功能的端口号为1000。

<Sysname> system-view

[Sysname] restful http port 1000

1.1.3  restful https authentication-mode

restful https authentication-mode命令用来配置基于HTTPS的RESTful功能的认证模式。

undo restful https authentication-mode命令用来恢复缺省情况。

【命令】

restful https authentication-mode certificate

undo restful https authentication-mode

【缺省情况】

基于HTTPS的RESTful功能的认证模式为用户名+密码。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

certificate:数字证书认证模式。

【使用指导】

工作机制

基于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服务器端策略关联

【举例】

# 完成如下配置后,配置基于HTTPS的RESTful功能的认证模式为数字证书,并配置用于RESTful登录的用户名user1(用户服务类型为HTTPS)。

·     配置SSL服务器端策略test_ssl:

¡     通过pki-domain命令指定该策略使用PKI域test_pki

¡     (可选)指定SSL服务器端策略支持如下加密套件:密钥交换算法采用RSA、数据加密算法采用256位AES_CBC、MAC算法采用SHA

¡     执行client-verify enable来对SSL客户端进行基于数字证书的身份验证

·     配置基于HTTPS的RESTful功能与之前创建的SSL服务器端策略关联

·     开启基于HTTPS的RESTful功能

<Sysname> system-view

[Sysname] ssl server-policy test_ssl

[Sysname-ssl-server-policy-test_ssl] pki-domain test_pki

[Sysname-ssl-server-policy-test_ssl] ciphersuite rsa_aes_256_cbc_sha

[Sysname-ssl-server-policy-test_ssl] client-verify enable

[Sysname-ssl-server-policy-test_ssl] quit

[Sysname] restful https ssl-server-policy test_ssl

[Sysname] restful https enable

[Sysname] restful https authentication-mode certificate

[Sysname] local-user user1 class manage

[Sysname-luser-manage-user1] service-type https

【相关命令】

·     client-verify(安全命令参考/SSL)

·     pki import(安全命令参考/PKI)

·     pki-domain(安全命令参考/SSL)

·     ssl server-policy(安全命令参考/SSL)

1.1.4  restful https enable

restful https enable命令用来开启基于HTTPS的RESTful功能。

undo restful https enable命令用来关闭基于HTTPS的RESTful功能。

【命令】

restful https enable

undo restful https enable

【缺省情况】

基于HTTPS的RESTful功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

开启该功能后,用户才可以通过RESTful HTTPS方式登录设备并采用RESTful API对设备进行配置和维护。

【举例】

# 开启基于HTTPS的RESTful功能。

<Sysname> system-view

[Sysname] restful https enable

1.1.5  restful https port

restful https port命令用来配置基于HTTPS的RESTful功能的端口号。

undo restful https port命令用来恢复缺省情况。

【命令】

restful https port port-number

undo restful https port

【缺省情况】

基于HTTPS的RESTful功能的端口号为443。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

port-number:基于HTTPS的RESTful功能的端口号,取值范围为1~65535。

【使用指导】

配置该命令后,基于HTTPS的原RESTful会话将失效,RESTful用户需要使用新端口号重新登录设备。

【举例】

# 配置基于HTTPS的RESTful功能的端口号为1000。

<Sysname> system-view

[Sysname] restful https port 1000

1.1.6  restful https ssl-server-policy

restful https ssl-server-policy命令用来配置基于HTTPS的RESTful功能与SSL服务器端策略关联。

undo restful https ssl-server-policy命令用来恢复缺省情况。

【命令】

restful https ssl-server-policy policy-name

undo restful https ssl-server-policy

【缺省情况】

基于HTTPS的RESTful功能未与SSL服务器端策略关联。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

policy-name:SSL服务器端策略名,为1~31个字符的字符串。

【使用指导】

配置本命令后,设备将使用SSL服务器端策略指定的加密套件等SSL参数建立连接,以加强基于HTTPS的RESTful功能的安全性。有关SSL服务器端策略的配置,请参见“安全配置指导”中的“SSL”。

多次执行本命令,最后一次执行的命令生效。

基于HTTPS的RESTful功能处于开启状态时,必须先执行undo restful https enable命令,才能配置本命令。

配置本命令后,需要执行restful https enable命令,配置才会生效。

如果修改了关联的SSL服务器端策略,RESTful客户端和设备新建立的HTTPS连接将会引用新的策略,已建立的HTTPS连接不会受到影响,依然引用旧的策略。

【举例】

# 配置基于HTTPS的RESTful功能关联的SSL服务器端策略为myssl。

<Sysname> system-view

[Sysname] restful https ssl-server-policy myssl

【相关命令】

·     restful https enable

·     ssl server-policy(安全命令参考/SSL)

 

不同款型规格的资料略有差异, 详细信息请向具体销售和400咨询。H3C保留在没有任何通知或提示的情况下对资料内容进行修改的权利!

新华三官网
联系我们