选择区域语言: EN CN HK

13-网络管理和监控命令参考

07-NETCONF命令

本章节下载  (154.67 KB)

docurl=/cn/Service/Document_Software/Document_Center/Routers/Catalog/SR_Router/SR6600-X/Command/Command_Manual/H3C_SR6600_SR6600-X_CR-R7612-6W100/13/201809/1112091_30005_0.htm

07-NETCONF命令


1 NETCONF

1.1  NETCONF配置命令

说明

设备运行于FIPS模式时,本特性部分配置相对于非FIPS模式有所变化,具体差异请见本文相关描述。有关FIPS模式的详细介绍请参见“安全配置指导”中的“FIPS”。

 

1.1.1  netconf idle-timeout

netconf idle-timeout命令用来配置NETCONF会话超时时间。

undo netconf idle-timeout命令用来恢复缺省情况。

【命令】

netconf { soap | agent } idle-timeout minute

undo netconf { soap | agent } idle-timeout

【缺省情况】

基于NETCONF over SOAP over HTTP的会话超时时间为10分钟。

基于NETCONF over SSH/Telnet/Console的会话超时时间为0,即不超时。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

soap:用来配置基于NETCONF over SOAP over HTTP的会话超时时间。

agent:用来配置基于NETCONF over SSH/Telnet/Console的会话超时时间。

minute:表示超时时间,单位为分钟,取值范围为:

·     对于基于NETCONF over SOAP over HTTP的会话,取值范围为1~999。

·     对于基于NETCONF over SSH/Telnet/Console的会话,取值范围为0~999,0表示不超时。

【使用指导】

用户通过Telnet、SSH、Console、或配置工具与设备建立NETCONF连接,如果在超时时间内,用户与设备无任何NETCONF报文交互,达到超时时间后,设备将断开与用户配置端的NETCONF连接。

【举例】

# 配置基于NETCONF over SOAP over HTTP的会话超时时间为20分钟。

<Sysname> system-view

[Sysname] netconf soap idle-timeout 20

1.1.2  netconf log

netconf log命令用来配置NETCONF日志功能。

undo netconf log命令用来取消指定类型的NETCONF日志配置。

【命令】

netconf log source { all | { agent | soap | web } * } { { protocol-operation { all | { action | config | get | set | session | syntax | others } * } } | verbose }

undo netconf log source { all | { agent | soap | web } * } { { protocol-operation { all | { action | config | get | set | session | syntax | others } * } } | verbose }

【缺省情况】

未配置NETCONF日志功能。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

source:表示需要输出日志的NETCONF操作来源:

·     agent表示输出源自Telnet/SSH/NETCONF over SSH/Console类型的NETCONF日志。

·     all表示输出所有来源的NETCONF日志。

·     soap表示输出源自SOAP over HTTP的NETCONF日志。

·     web表示输出源自本设备Web类型的NETCONF日志。

protocol-operation表示需要输出日志的NETCONF操作:

·     action表示action操作。

·     all表示所有NETCONF操作。

·     config表示配置类的NETCONF操作,包括CLI、save、load、rollback、save-point、lock、unlock。

·     get表示获取数据的NETCONF操作,包括get、get-bulk、get-config、get-bulk-config、get-sessions。

·     others表示除action、config、get、set、session、set、syntax外,其他类型的NETCONF操作。

·     session表示与会话相关的NETCONF操作,包括kill-session、close-session、hello。

·     set表示所有edit-config操作。

·     syntax表示包含xml和schema的格式错误的请求。

verbose表示输出NETCONF日志的详细信息。

【使用指导】

NETCONF日志命令可以按照NETCONF操作来源(source)和NETCONF操作类型(protocol-operation)配置设备输出不同类型的NETCONF操作日志。系统先将NETCONF日志发送到信息中心,根据信息中心的输出规则将日志信息输出到不同方向。信息中心的相关配置请参见“网络管理和监控配置指导”中的“信息中心”。

配置verbose参数后,设备输出NETCONF日志的详细信息:

·     对于请求类型的日志:当请求报文格式正确时,设备在简要日志后输出源报文的内容。

·     对于处理结果类型的日志:仅支持输出set的详细日志信息。即,当edit-config操作的单个行执行错误时输出详细错误信息。

【举例】

# 配置设备输出源自agent的edit-config类型的操作日志。

<Sysname> system-view

[sysname] netconf log source agent protocol-operation set

1.1.3  netconf soap domain

netconf soap domain命令用来配置NETCONF用户的强制认证域。

undo netconf soap domain命令用来恢复缺省情况。

【命令】

netconf soap domain domain-name

undo netconf soap domain domain-name

【缺省情况】

未配置NETCONF用户的强制认证域。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

domain-name:ISP域名,为1~255个字符的字符串,不区分大小写。关于ISP域的详细介绍请参见“安全配置指导”中的“AAA”。

【使用指导】

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

NETCONF支持使用如下方式指定认证域:

·     通过netconf soap domain命令配置强制认证域。配置该命令后,所有用户都会使用强制认证域进行认证。

·     在SOAP请求的<UserName>中携带认证域信息。SOAP请求中携带的认证域仅对当前请求生效。通过netconf soap domain命令配置强制认证域后,SOAP请求中携带的认证域不生效。

【举例】

# 配置NETCONF用户的强制认证域为my-domain。

<Sysname> system-view

[Sysname] netconf soap domain my-domain

1.1.4  netconf soap http acl

netconf soap http acl命令用来配置基于HTTP的NETCONF over SOAP功能关联的ACL。

undo netconf soap http acl命令用来恢复缺省情况。

【命令】

netconf soap http acl { acl-number | name acl-name }

undo netconf soap http acl

【缺省情况】

未配置基于HTTP的NETCONF over SOAP功能关联的ACL。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

acl-number:ACL的编号,取值范围为2000~2999。

name acl-name:指定ACL的名称。acl-name表示ACL的名称,为1~63个字符的字符串,不区分大小写,必须以英文字母a~z或A~Z开头。为避免混淆,ACL的名称不允许使用英文单词all。仅当指定名称的ACL存在且为基本IPv4 ACL时生效。

【使用指导】

FIPS模式下,不支持本命令。

配置SOAP服务与ACL关联后,只有ACL允许通过的NETCONF客户端能够通过SOAP方式登录设备。不匹配ACL或ACL拒绝通过的NETCONF客户端将不能通过SOAP方式登录设备。

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

【举例】

# 配置基于HTTP的NETCONF over SOAP功能与ACL 2001关联,只允许10.10.0.0/16网段的客户端访问设备。

<Sysname> system-view

[Sysname] acl basic 2001

[Sysname-acl-ipv4-basic-2001] rule permit source 10.10.0.0 0.0.255.255

[Sysname-acl-ipv4-basic-2001] quit

[Sysname] netconf soap http acl 2001

1.1.5  netconf soap http enable

netconf soap http enable命令用来开启基于HTTP的SOAP功能。

undo netconf soap http enable命令用来关闭基于HTTP的SOAP功能。

【命令】

netconf soap http enable

undo netconf soap http enable

【缺省情况】

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

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

FIPS模式下,不支持本命令。

配置该命令后,表示设备能够解析这样的HTTP报文,报文中的数据为SOAP封装过的NETCONF指令。

【举例】

# 开启基于HTTP的SOAP功能。

<Sysname> system-view

[Sysname] netconf soap http enable

1.1.6  netconf ssh server enable

netconf ssh server enable命令用来开启NETCONF Over SSH的接入方式。

undo netconf ssh server enable命令用来关闭NETCONF Over SSH的接入方式。

【命令】

netconf ssh server enable

undo netconf ssh server enable

【缺省情况】

NETCONF Over SSH的接入方式处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

用户配置该命令后,可以利用SSH客户端通过SSH子系统的方式接入设备的NETCONF系统,然后直接进入NETCONF配置模式,而不用手工输入XML命令。

配置该命令前必须在设备上把SSH连接终端的认证方式设置为scheme,支持NETCONF over SSH的客户端才能连接到NETCONF系统,目前只支持用urn:ietf:params:netconf:base:1.0(设备与终端共同支持的能力集)连接系统。

【举例】

# 开启NETCONF Over SSH的接入方式。

<Sysname> system-view

[Sysname] netconf ssh server enable

1.1.7  netconf ssh server port

netconf ssh server port命令用来设置NETCONF Over SSH接入方式的监听端口号。

undo netconf ssh server port命令用来恢复缺省情况。

【命令】

netconf ssh server port port-number

undo netconf ssh server port

【缺省情况】

NETCONF Over SSH接入方式的监听端口为830。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

port-number:基于NETCONF Over SSH的接入方式的监听端口,取值范围为1~65535,缺省值为830。

【使用指导】

用户可以在必要时使用此命令来重新配置一个端口作为NETCONF子系统的监听端口,但由于SSH服务使用共享端口的方式来分配监听端口,为了正常使用,必须保证分配的端口不和其他使用的端口冲突。

【举例】

# 配置NETCONF Over SSH接入方式的监听端口为800。

<sysname> system-view

[sysname] netconf ssh server port 800

1.1.8  xml

xml命令用来进入XML视图。

【命令】

xml

【视图】

用户视图

【缺省用户角色】

network-admin

network-operator

【使用指导】

进入XML视图后可以输入NETCONF指令来配置或者获取系统数据。用户登录时使用的角色不同,可执行的NETCONF操作也不同:

·     network-admin可执行全部操作。

·     network-operator可执行get、get-bulk、get-config、get-bulk-config、get-sessions、close-session操作。

进入XML视图后,用户需要严格按照NETCONF报文格式将报文拷贝、粘贴到XML视图中。在NETCONF配置过程中,请勿进行其他任何操作(例如手工输入NETCONF报文),否则可能导致NETCONF配置失败。

在XML视图下进行NETCONF配置时,XML报文最后需要添加“]]>]]>”,否则设备无法识别。

进入XML视图后,设备将自动向客户端发送自身支持的NETCONF能力集,此时,客户端需要向设备发送自身支持的NETCONF能力集,完成能力交换后,用户即可使用客户端对设备进行配置。

用户输入的NETCONF指令必须符合XML语言格式要求和《NETCONF XML API手册》中的语法、语义要求。建议使用第三方软件来协助生成NETCONF指令,命令行手工输入方式通常用于研发和测试环境。

退出XML视图时需要使用相关的NETCONF指令,不能使用quit

在XML模式下终止当前任务的快捷键有重置缓存的功能,快捷键之前的内容都会被清除掉。如果在用户线/用户线类视图下使用escape-key命令配置了终止当前任务的快捷键(缺省为Ctrl+C),可能会影响XML视图下相关配置。例如:在用户线视图下配置了escape-key a,当NETCONF指令中含有字符‘a’时,其实只有NETCONF指令最后一个‘a’之后的内容能够得到处理;当NETCONF指令中不含有字符‘a’时,则对XML视图下的配置没有影响。

【举例】

# 进入XML视图。

<Sysname> xml

<?xml version="1.0" encoding="UTF-8"?><hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"><capabilities><capability>urn:ietf:params:netconf:base:1.1</capability><capability>urn:ietf:params:netconf:writable-running</capability><capability>urn:ietf:params:netconf:capability:notification:1.0</capability><capability>urn:ietf:params:netconf:capability:validate:1.1</capability><capability>urn:ietf:params:netconf:capability:interleave:1.0</capability><capability>urn:h3c:params:netconf:capability:h3c-netconf-ext:1.0</capability></capabilities><session-id>1</session-id></hello>]]>]]>

# 进行能力交换。

<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">

  <capabilities>

    <capability>

            urn:ietf:params:netconf:base:1.0

    </capability>

  </capabilities>

</hello>]]>]]>

# 退出XML视图。

<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">

  <close-session>

  </close-session>

</rpc>]]>]]>

<Sysname>

 

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