NETCONF（Network Configuration Protocol，网络配置协议）是一种基于XML的网络管理协议，它提供了一种可编程的、对网络设备进行配置和管理的方法。用户可以通过该协议设置属性、获取属性值、获取统计信息等。这使得它在第三方软件的开发上非常便利，很容易开发出在混合不同厂商、不同设备的环境下的特殊定制的网管软件。

1.1.1 NETCONF协议结构

NETCONF协议采用分层结构，分为内容层（Content）、操作层（Operations）、RPC（Remote Procedure Call，远程调用）层和通信协议层（Transport Protocol）等。

表1-1 XML分层与NETCONF分层模型对应关系

NETCONF分层	XML分层	说明
内容层	配置数据、状态数据、统计信息等	被管理对象的集合，可以是配置数据、状态数据、统计信息等 NETCONF协议具体可读写的数据请参见《NETCONF XML API 手册》
操作层	<get>,<get-config>,<edit-config>…	在RPC中应用的基本的原语操作集，这些操作组成NETCONF的基本能力 NETCONF全面地定义了对被管理设备的各种基础操作，设备支持的操作请参见“2 Comware V7支持的NETCONF操作”
RPC层	<rpc>,<rpc-reply>	为RPC模块的编码提供了简单的、传输协议无关的机制。通过使用<rpc>和<rpc-reply>元素分别对NETCONF请求和响应数据（即操作层和内容层的内容）进行封装
通信协议层	Console/Telnet/SSH/HTTP/HTTPS/TLS	为NETCONF提供面向连接的、可靠的、顺序的数据链路。 · NETCONF支持Telnet、SSH和Console等CLI登录方式/协议，即NETCONF over SSH、NETCONF over Telnet和NETCONF over Console · NETCONF支持HTTP和HTTPS协议，即NETCONF over HTTP和NETCONF over HTTPS · NETCONF支持封装成SOAP（Simple Object Access Protocol，简单对象访问协议）报文后通过HTTP或HTTPS协议传输，即NETCONF over SOAP over HTTP和NETCONF over SOAP over HTTPS

1.1.2 NETCONF报文格式

1. NETCONF

NETCONF命令必须符合XML语言的基本格式，格式遵循RFC 4741。

NETCONF操作以及可操作的数据项，请参见《NETCONF XML API手册》。NETCONF报文的数据合法性都将经过校验才会下发，如果校验失败则会向客户端报错。其中，数据合法性校验通过XML Schema的方式完成。

如下为一个NETCONF报文示例，用于获取设备上所有接口的所有参数：

<?xml version="1.0" encoding="utf-8"?>

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

2. NETCONF over SOAP

NETCONF over SOAP之后，NETCONF报文会放在SOAP报文的BODY元素里，这些报文除了需要遵循纯NETCONF报文的规则外，还需要遵循以下规则：

· SOAP消息必须用XML来编码。

· SOAP消息必须使用SOAP Envelope命名空间。

· SOAP消息必须使用SOAP Encoding命名空间。

· SOAP消息不能包含DTD（Document Type Definition，文件类型定义）引用。

· SOAP消息不能包含XML处理指令。

如下为一个NETCONF over SOAP报文示例，用于获取设备上所有接口的所有参数：

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

<env:Header>

<auth:Authentication env:mustUnderstand="1" xmlns:auth="http://www.h3c.com/netconf/base:1.0">

<auth:AuthInfo>800207F0120020C</auth:AuthInfo>

</auth:Authentication>

</env:Header>

<env:Body>

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

</env:Body>

</env:Envelope>

1.1.3 如何使用NETCONF

用户可通过以下方式来使用NETCONF配置和管理设备：

· 通过Telnet、SSH和Console登录到设备并进入XML视图，将合法的NETCONF报文直接拷贝、粘贴到命令行提示符处执行，即可实现对设备的配置和管理。

· 通过HTTP或HTTPS登录到设备的Web页面，系统会自动将Web页面的配置转换成NETCONF指令下发给设备来实现对设备的配置和管理。该方式通过简洁易用的图像化Web页面上完成配置，配置结果也会以简洁清晰的方式呈现给用户，整个NETCONF的交互过程对用户透明。

· 使用配置工具给设备下发NETCONF指令来实现对设备的配置和管理。该方式需要将NETCONF指令用SOAP封装成通用的格式，以便设备能够正常转换。因此，使用该方式前必须开启NETCONF over SOAP功能。

1.1.4 协议规范

与NETCONF、SOAP协议相关的协议规范有：

· RFC 3339：Date and Time on the Internet: Timestamps

· RFC 4741：NETCONF Configuration Protocol

· RFC 4742：Using the NETCONF Configuration Protocol over Secure SHell (SSH)

· RFC 4743：Using NETCONF over the Simple Object Access Protocol (SOAP)

· RFC 5277：NETCONF Event Notifications

· RFC 5381：Experience of Implementing NETCONF over SOAP

· RFC 5539：NETCONF over Transport Layer Security (TLS)

· RFC 6241：Network Configuration Protocol

1.2 NETCONF配置任务简介

NETCONF配置任务如下：

(1) 配置NETCONF使用专用命名空间

(2) 建立NETCONF会话

a. （可选）配置NETCONF会话公共属性

b. 建立NETCONF over SOAP会话

c. 建立NETCONF over SSH会话

d. 建立NETCONF over Telnet或NETCONF over Console会话

(3) （可选）获取设备配置信息

(4) （可选）过滤表和列的信息

(5) （可选）配置加锁和解锁

(6) （可选）下发配置

(7) （可选）配置文件管理

¡ 保存配置

¡ 加载配置文件

¡ 回滚配置

(8) （可选）下发命令行

(9) （可选）关闭NETCONF会话

(10) （可选）退出XML视图

1.3 配置NETCONF使用专用命名空间

1. 功能简介

NETCONF支持共用命名空间和专用命名空间：

· 共用命名空间：各模块共用一个命名空间。使用共用命名空间的报文中，命名空间位于<top>元素中，模块位于<top>元素下，报文示例如下：

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

· 专用命名空间：每个模块单独使用一个命名空间。使用专用命名空间的报文中无<top>元素，命名空间位于模块名后，报文示例如下：

<get-bulk>

</Interfaces>

</Ifmgr>

</filter>

</get-bulk>

</rpc>

两种类型的命名空间互不兼容。客户端与设备必须使用相同的命名空间才能建立会话。缺省情况下，NETCONF使用共用命名空间。如果客户端不支持共用命名空间，则需要配置本命令，让设备和客户端建立会话时使用专用命名空间。

2. 配置限制和指导

配置本功能后，用户需要重新建立NETCONF会话，以使客户端和设备使用相同的命名空间。

3. 配置步骤

(1) 进入系统视图。

system-view

(2) 配置NETCONF使用专用命名空间。

netconf capability specific-namespace

缺省情况下，NETCONF使用共用命名空间。

1.4 建立NETCONF会话

1.4.1 配置限制和指导

建立NETCONF会话后，客户端先与设备进行能力集交互，完成能力集的交互后，设备才会处理客户端发送的其他请求。

多个用户同时配置设备时，可能会导致用户配置与配置结果不一致，因此，请避免多个用户同时配置设备。

设备同一时间内允许建立的最大会话数可以通过aaa session-limit命令配置，关于该命令的详细描述，请参见“用户接入与认证配置指导”中的“AAA”。用户数超过上限后，新登录的用户将登录失败。

1.4.2 配置NETCONF会话公共属性

1. 功能简介

NETCONF支持共用命名空间和专用命名空间，两种类型的命名空间互不兼容。客户端与设备必须使用相同的命名空间才能建立会话。如果客户端不支持共用命名空间，则需要配置本功能，使设备和客户端建立会话时使用专用命名空间。

· 共用命名空间：各模块共用一个命名空间。缺省情况下，设备使用共用命名空间。使用共用命名空间的报文中，命名空间位于<top>元素中，模块位于<top>元素下，报文示例如下：

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

· 专用命名空间：每个模块单独使用一个命名空间。使用专用命名空间的报文中无<top>元素，命名空间位于模块名后，报文示例如下：

<get-bulk>

</Interfaces>

</Ifmgr>

</filter>

</get-bulk>

</rpc>

2. 配置步骤

(1) 进入系统视图。

system-view

(2) 配置NETCONF会话超时时间。

netconf { agent | soap } idle-timeout minute

属性	说明
agent	agent表示如下NETCONF会话类型： · NETCONF over SSH · NETCONF over Telnet · NETCONF over Console 缺省超时时间为0（不超时）
soap	soap表示如下NETCONF会话类型： · NETCONF over SOAP over HTTP · NETCONF over SOAP over HTTPS 缺省超时时间为10分钟

属性

说明

agent

agent表示如下NETCONF会话类型：

· NETCONF over SSH

· NETCONF over Telnet

· NETCONF over Console

缺省超时时间为0（不超时）

soap

soap表示如下NETCONF会话类型：

· NETCONF over SOAP over HTTP

· NETCONF over SOAP over HTTPS

缺省超时时间为10分钟

(3) 开启NETCONF日志功能。

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

缺省情况下，NETCONF日志功能处于关闭状态。

(4) 配置设备使用专用命名空间。

netconf capability specific-namespace

缺省情况下，设备使用共用命名空间。

配置NETCONF使用专用命名空间后，需要重新建立NETCONF会话，使客户端和设备使用相同的命名空间。

1.4.3 建立NETCONF over SOAP会话

1. 功能简介

NETCONF支持封装成SOAP报文后通过HTTP或HTTPS协议传输，即NETCONF over SOAP over HTTP和NETCONF over SOAP over HTTPS，使用该功能后，用户可以通过配置工具给设备下发NETCONF指令来实现对设备的访问。

2. 配置限制和指导

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

3. 配置步骤

(1) 进入系统视图。

system-view

(2) （可选）配置基于HTTPS的NETCONF over SOAP功能与SSL服务器端策略关联。

netconf soap https ssl-server-policy policy-name

缺省情况下，基于HTTPS的NETCONF over SOAP功能未与SSL服务器端策略关联。

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

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

(3) 开启NETCONF over SOAP功能。

netconf soap { http | https } enable

缺省情况下，NETCONF over SOAP处于关闭状态。

(4) （可选）配置基于HTTP的NETCONF over SOAP功能使用的端口号。

netconf soap http port port-number

缺省情况下，基于HTTP的NETCONF over SOAP功能使用的端口号为80。

(5) （可选）配置NETCONF over SOAP关联ACL，只有ACL允许通过的客户端可以与设备建立NETCONF over SOAP会话。

netconf soap { http | https } [ ipv6 ] acl { acl-number | name acl-name }

缺省情况下，未配置NETCONF over SOAP关联ACL。

仅当指定http参数时，支持关联IPv6 ACL。

(6) （可选）配置NETCONF用户的强制认证域。

netconf soap domain domain-name

缺省情况下，未配置NETCONF用户的强制认证域。

配置该功能后，所有用户都会使用强制认证域进行认证。关于认证域的详细介绍请参见“用户接入与认证配置指导”中的“AAA”。

(7) 通过配置工具与设备建立NETCONF over SOAP会话。关于配置工具的使用方法，具体参见配置工具的配置指导。

1.4.4 建立NETCONF over SSH会话

1. 配置准备

建立NETCONF over SSH会话前，请确保配置工具能够通过SSH登录到设备。

2. 配置步骤

(1) 进入系统视图。

system-view

(2) 开启NETCONF over SSH。

netconf ssh server enable

缺省情况下，NETCONF over SSH处于关闭状态。

(3) 配置NETCONF over SSH的监听端口。

netconf ssh server port port-number

缺省情况下，NETCONF over SSH的监听端口为830。

(4) 配置NETCONF over SSH关联的IPv4 ACL。

netconf ssh acl { ipv4-acl-number | name ipv4-acl-name }

缺省情况下，未配置NETCONF over SSH关联的IPv4 ACL。

(5) 通过配置工具与设备建立NETCONF over SSH会话。关于配置工具的使用方法，具体参见配置工具的配置指导。

1.4.5 建立NETCONF over Telnet或NETCONF over Console会话

1. 配置限制和指导

进入XML视图后，用户需要严格按照NETCONF报文格式将报文拷贝、粘贴到XML视图中，请勿手工输入NETCONF报文。

在一次NETCONF操作完成前，请勿进行其他任何操作（例如粘贴NETCONF报文或输入回车），否则可能导致NETCONF配置失败。

在XML视图下进行NETCONF配置时，NETCONF报文最后需要添加“]]>]]>”结束符，否则设备无法识别。本手册举例中，为方便识别XML格式，均未添加该结束符，实际操作中请自行添加。

2. 配置准备

建立NETCONF over Telnet或NETCONF over Console会话前，请先通过Telnet或Console口登录到设备。

3. 配置步骤

请在用户视图下执行本命令，进入XML视图。

xml

进入XML视图，即表示成功建立NETCONF over Telnet或NETCONF over Console会话。

1.4.6 交换能力集

1. 功能简介

建立NETCONF会话后，客户端和设备必须交换各自支持的能力集，双方收到对方的能力集后才可以进行下一步操作。

2. 设备发送给客户端的报文

建立NETCONF会话后，设备会发送如下报文自动告知客户端支持的NETCONF能力集：

<?xml version="1.0" encoding="UTF-8"?><hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"><capabilities>...</capabilities><session-id>1</session-id></hello>]]>]]>

<capabilities>和</capabilities>之间的内容表示设备支持的能力集，以具体设备实际情况为准。

<session-id>和</session-id>之间的内容表示为本次会话分配的会话ID，用来唯一标识本次会话。

3. 客户端发送给设备的报文

客户端收到设备发送的能力集协商报文后，需要给设备发送如下格式的报文，告知设备客户端支持哪些NETCONF能力集。

Hello协商报文格式如下：

capability-set

</capability>

</capabilities>

</hello>

属性	说明
capability-set	客户端支持的能力集，由用户定义一个<capability>和</capability>选项对中只能填写一个能力集，可以使用多个选项对，配置多个能力集

属性

说明

capability-set

客户端支持的能力集，由用户定义

一个<capability>和</capability>选项对中只能填写一个能力集，可以使用多个选项对，配置多个能力集

1.5 获取设备配置信息

1.5.1 配置限制和指导

用户执行<get>、<get-bulk>、<get-config>或<get-bulk-config>操作获取设备数据时：

· 如果所获取数据中包含NETCONF不能识别的字符，则NETCONF将该字符转换为“?”输出到客户端。

· 如果操作中的模块进程未启动，则该操作可能会将空数据通过如下报文反馈给客户端：

<?xml version="1.0"?>

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

<data/>

</rpc-reply>

<get><netconf-state/></get>操作不支持数据过滤。

关于获取设备配置信息操作的详细规则，请参见《NETCONF XML API手册》。

1.5.2 获取运行配置和运行状态

设备支持通过<get>操作获取设备运行状态和运行配置。

设备支持通过<get-bulk>操作从指定索引的下一条开始获取N条运行状态和运行配置（索引行数据不返回）。

<get>操作会返回所有符合条件的数据，在某些情况下，会导致获取数据效率不高。<get-bulk>允许用户从固定数据项开始，向后获取指定条目的数据记录。

<get>和<get-bulk>报文的通用格式如下：

<?xml version="1.0" encoding="UTF-8"?>

指定模块，子模块，表名，列名

</top>

</filter>

</getoperation>

</rpc>

属性	说明
getoperation	可以为get或者get-bulk
filter	用于过滤信息，<filter>中可包括模块名、子模块名、表名和列名： · 如果不指定模块（子模块），则表示全部模块（子模块）。指定模块（子模块）时，则返回数据只包含指定模块（子模块）。 · 如果模块下不指定表，则表示全部表。指定表时，则返回数据只包含指定表 · 如果只指定索引列，则返回的数据包括全部的列。如果同时指定索引列之外的其他列，则返回的数据仅包含索引列和指定的列

属性

说明

getoperation

可以为get或者get-bulk

filter

用于过滤信息，<filter>中可包括模块名、子模块名、表名和列名：

· 如果不指定模块（子模块），则表示全部模块（子模块）。指定模块（子模块）时，则返回数据只包含指定模块（子模块）。

· 如果模块下不指定表，则表示全部表。指定表时，则返回数据只包含指定表

· 如果只指定索引列，则返回的数据包括全部的列。如果同时指定索引列之外的其他列，则返回的数据仅包含索引列和指定的列

· <get-bulk>操作报文中可以携带count和index属性。

属性

说明

index

指定索引。如未指定索引，则以第一条操作为索引

count

获取指定数量的运行状态和运行配置信息。count属性遵循如下约定：

· count属性的位置在可以从top下的节点开始，到表节点为止，即：模块节点，表节点这几个位置都能放置count属性，其他位置的count将不被解释

· 如果count放在模块节点上，则报文中指定的子孙节点（表）中没有count的都默认count属性的值和模块一致

· 如果不指定count，或者数据表中符合条件的数据记录小于count，则获取从指定索引开始的所有数据

如下为一个携带了count和index属性的<get-bulk>操作报文示例：

<?xml version="1.0" encoding="UTF-8"?>

<get-bulk>

<Log>

</Log>

</Logs>

</Syslog>

</top>

</filter>

</get-bulk>

</rpc>

· 获取接口数据时，如果IfIndex和vrfindex元素的值为数字，设备无法识别该值为名称类型还是索引类型。此时，用户可以使用valuetype指定该值的类型。valuetype取值为：

属性	说明
name	值为名称类型
index	值为索引类型
auto	设备先按名称类型进行匹配，如果没有匹配到任何信息，再按照索引类型进行匹配如果不指定valuetype的属性，缺省使用auto

下面以IfIndex元素值为index类型，值为1为例：

<VLAN>

</Interface>

</TrunkInterfaces>

</VLAN>

</top>

</filter >

</getoperation>

</rpc>

设备收到配置获取请求报文后会将相应属性的值通过如下报文反馈给客户端：

<?xml version="1.0"?>

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

<data>

全部配置数据和状态数据

</data>

</rpc-reply>

1.5.3 获取可配置的功能的变量值

设备支持通过<get-config>和<get-bulk-config>操作获取设备所有可配置的功能的变量值。

<get-config>和<get-bulk-config>操作报文中可以包含子标签<filter>，用来对要获取的信息进行过滤。

<get-config>和<get-bulk-config>的通用报文格式为：

<?xml version="1.0"?>

<get-config>

</source>

指定模块，子模块，表名，列名

</top>

</filter>

</get-config>

</rpc>

设备收到配置获取请求报文后会将相应配置通过如下报文反馈给客户端：

<?xml version="1.0"?>

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

<data>

所有指定filter内的数据

</data>

</rpc-reply>

1.5.4 获取NETCONF信息

<get><netconf-state/></get>报文的通用格式为：

<?xml version="1.0" encoding="UTF-8"?>

<get>

<netconf-state xmlns='urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring'>

</netconf-state>

</filter>

</get>

</rpc>

其中，getType可以为capabilities、datastores、schemas、sessions或者statistics：

· 不指定getType时，该操作则获取NETCONF全部信息。

· 当指定getType时，该操作仅返回相应类型的应答数据。其中，getType取值为：

属性	说明
capabilities	该操作用来获取设备能力集
datastores	该操作用来获取设备中的数据库
schemas	该操作用来获取设备中的YANG文件名称列表
sessions	该操作用来获取设备中的会话信息
statistics	该操作用来获取NETCONF的统计信息

# 设备收到NETCONF信息获取请求报文后，将相应属性的值通过如下报文反馈给客户端：

<?xml version="1.0"?>

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

<data>

全部NETCONF全部相关信息

</data>

</rpc-reply>

1.5.5 获取YANG文件的内容

YANG文件中保存了设备支持的NETCONF操作，用户通过获取、并分析YANG文件的内容，从而获知设备支持哪些NETCONF操作。

YANG文件集成在设备软件中，命名格式为yang_identifier@yang_version.yang，用户不能通过dir命令显示YANG文件名，关于如何获取设备上YANG文件名称，详细请参见“1.5.4 获取NETCONF信息”。

如下报文要求返回名称为H3C-syslog-data@2017-01-01.yang的YANG文件中的数据：

<get-schema xmlns='urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring'>

<identifier>H3C-syslog-data</identifier>

</get-schema>

</rpc>

设备的YANG文件名称请以设备的实际情况为准。

设备收到YANG文件获取请求报文后，将相应参数的值通过如下报文反馈给客户端：

<?xml version="1.0"?>

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

<data>

指定YANG文件的内容

</data>

</rpc-reply>

1.5.6 获取NETCONF会话信息

使用该功能用户可以获取当前设备的所有NETCONF会话信息。

获取NETCONF会话信息的格式为：

<?xml version="1.0" encoding="UTF-8"?>

<get-sessions/>

</rpc>

设备收到命令行指令后会回应客户端，当客户端收到如下报文时，表示命令行执行成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<get-sessions>

<SessionID>用户会话ID信息</SessionID>

<Line>line信息</Line>

<UserName>用户登录名称</UserName>

<Since>用户登录时间</Since>

<LockHeld>用户是否持有锁</LockHeld>

</Session>

</get-sessions>

</rpc-reply>

1.5.7 获取运行配置举例

1. 组网需求

获取接口表的一条数据

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

<capability>urn:ietf:params:netconf:base:1.0</capability>

</capabilities>

</hello>

# 获取接口表的一条数据。

请将以下报文拷贝、粘贴到客户端：

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功：

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

<data>

<Ifmgr>

<Name>GigabitEthernet1/0/2</Name>

<Description>GigabitEthernet1/0/2 Interface</Description>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</data>

</rpc-reply>

1.5.8 获取可配置的功能的变量值配置举例

1. 组网需求

获取所有可配置的功能的变量值。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 获取模块所有配置数据。

请将以下报文拷贝、粘贴到客户端：

<get-config>

</source>

</get-config>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功：

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

<data>

<Ifmgr>

</Interface>

</Interface>

</Interface>

</Interface>

</Interface>

</Interfaces>

</Ifmgr>

</LogBuffer>

</Syslog>

<SysName>Sysname</SysName>

</TimeZone>

</Device>

</System>

</top>

</data>

</rpc-reply>

1.5.9 获取Syslog功能的变量值配置举例

1. 组网需求

获取Syslog模块的所有配置数据

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 获取Syslog模块的所有配置数据。

请将以下报文拷贝、粘贴到客户端：

<get-config>

</source>

</top>

</filter>

</get-config>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<data>

</LogBuffer>

</Syslog>

</top>

</data>

</rpc-reply>

1.5.10 获取NETCONF会话信息配置举例

1. 配置需求

获取会话信息。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 获取设备上当前存在的NETCONF会话的信息。

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0" encoding="UTF-8"?>

<get-sessions/>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功。

<?xml version="1.0" encoding="UTF-8"?>

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

<get-sessions>

<LockHeld>false</LockHeld>

</Session>

</get-sessions>

</rpc-reply>

以上信息表明：目前有一个NETCONF连接，SessionID是1，登录用户类型vty0，登录时间是2017-01-07T00:24:57，此用户不持有锁。

1.6 过滤表和列的信息

1.6.1 功能简介

当用户执行<get>、<get-bulk>、<get-config>或者<get-bulk-config>操作时，在XML语言中增加过滤条件，可以使用户只看到自己关心的数据。数据过滤包括基于表的过滤和基于列的过滤：

· 基于表的过滤用于过滤表的信息。

· 基于列的过滤用于过滤单个列的信息。

1.6.2 配置限制和指导

基于表的过滤需要在基于列的过滤之前配置。

1.6.3 基于表的过滤

1. 功能简介

基于表的过滤中，过滤条件类似命令行，命令空间为http://www.h3c.com/netconf/base:1.0，属性名为filter。关于支持该过滤方式表的详细信息，具体请参见模块的XML API手册。

如下要求返回IPv4路由表中匹配IP地址为1.1.1.0和24位掩码最长的数据：

<get>

<Route>

</Ipv4Routes>

</Route>

</top>

</filter>

</get>

</rpc>

2. 配置限制和指导

配置基于表的过滤时，查询条件必须写在行的属性上。

1.6.4 基于列的过滤

1. 功能简介

基于列的过滤包括严格匹配过滤、正则表达式匹配过滤和条件匹配过滤。

同时指定多种过滤时，只有一个生效，其优先级从高到低依次为：严格匹配过滤、正则表达式匹配过滤和条件匹配过滤。

2. 严格匹配过滤

严格匹配包括两种匹配方式，一种是元素值方式，还有一种是属性名方式。

用户在XML语言中直接指定对应的元素值，设备将对这些值进行严格匹配。如果指定了多个元素的值，则返回同时符合这几个条件的数据。只有完全匹配条件才返回成功。

如下为一个NETCONF报文示例，用于获取所有状态为UP的接口的配置信息：

<get>

<Ifmgr>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get>

</rpc>

当用户在行的位置上放置的某个属性的名称和当前表的某个列的名称一致，则这个属性的值将与用户下发配置中同名称的列的值进行严格匹配，例如，上面例子用属性名方式的等价XML请求为：

<get>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get>

</rpc>

以上两个NETCONF报文示例说明通过不同的严格匹配方式都可以获取所有状态为UP的接口的索引和指定列信息。

3. 正则表达式匹配过滤

当过滤条件比较复杂时，可以在指定元素上设置regExp属性为一个正则表达式，以完成过滤的目的。

支持正则表达式匹配的数据类型有整数、日期和时间、字符串、IPv4地址、IPv4掩码、IPv6地址、MAC地址、OID和时区。

如下为一个NETCONF报文示例，用于获取接口的描述信息，并要求这些描述信息全部为大写字母，不能有其他字符。

<get-config>

</source>

<Ifmgr>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-config>

</rpc>

4. 条件匹配过滤

由于正则表达仅能够完成字符匹配，对于数值逻辑的判断过滤实现起来比较麻烦，此时，可使用条件匹配过滤功能。

条件匹配通过在元素中增加match属性完成，属性的值（即过滤条件）可以为数字、字符串。

表1-2 条件匹配命令

操作	命令	说明
大于	match="more:value"	值大于value，支持的数据类型为：日期、数字、字符串
小于	match="less:value"	值小于value，支持的数据类型为：日期、数字、字符串
不小于	match="notLess:value"	值不小于value，支持的数据类型为：日期、数字、字符串
不大于	match="notMore:value"	值不大于value，支持的数据类型为：日期、数字、字符串
等于	match="equal:value"	值等于value，支持的数据类型为：日期、数字、字符串、OID、BOOL
不等于	match="notEqual:value"	值不等于value，支持的数据类型为：日期、数字、字符串、OID、BOOL
包含	match="include:string"	包含字符串string，支持的数据类型为：字符串
不包含	match="exclude:string"	不能包含字符串string，支持的数据类型为：字符串
开始于	match="startWith:string"	以字符串string开头，支持的数据类型为：字符串、OID
结束于	match="endWith:string"	以字符串string结束，支持的数据类型为：字符串

如下为一个NETCONF报文示例，用于获取实体扩展信息中CPU利用率大于50%的实体。

<get>

</Entity>

</ExtPhysicalEntities>

</Device>

</top>

</filter>

</get>

</rpc>

1.6.5 正则表达式过滤配置举例

1. 组网需求

取Ifmgr模块下Interfaces表下Description列包含Gigabit的所有数据。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 取Ifmgr模块Interfaces表下Description列包含Gigabit的所有数据。

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0"?>

<get>

<Ifmgr>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功。

<?xml version="1.0" encoding="UTF-8"?>

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:h3c="http://www.h3c.com/netconf/base:1.0" message-id="100">

<data>

<Ifmgr>

<Description>GigabitEthernet1/0/1 Interface</Description>

</Interface>

<Description>GigabitEthernet1/0/2 Interface</Description>

</Interface>

<Description>GigabitEthernet1/0/3 Interface</Description>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</data>

</rpc-reply>

1.6.6 条件匹配过滤配置举例

1. 组网需求

取Ifmgr模块Interfaces表下ifindex值大于等于5000的Name列信息。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 取Ifmgr模块Interfaces表下ifindex值大于等于5000的Name列信息。

请将以下报文拷贝、粘贴到客户端：

<get>

<Ifmgr>

<Name/>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功。

<?xml version="1.0" encoding="UTF-8"?>

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:h3c="http://www.h3c.com/netconf/base:1.0" message-id="100">

<data>

<Ifmgr>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</data>

</rpc-reply>

1.7 配置加锁和解锁

1.7.1 功能简介

设备支持通过NETCONF、CLI和SNMP等多种方式配置，当用户管理、维护设备或者定位网络问题时，为防止其他用户修改当前配置、引入干扰，可以使用本特性给当前配置加锁。给当前配置加锁后，只有持有锁的用户可以修改设备的当前配置，其他用户只能执行读取操作，不能进行配置。

只有持有锁的用户可以解锁，解锁后其他用户才可以修改设备的当前配置或另外加锁。如果持有锁的用户的当前连接断开，系统会自动解锁。

1.7.2 配置限制和指导

NETCONF加锁操作将锁定配置数据，即<edit-config>操作中指定的配置数据，其他操作（例如<get>操作）不受锁的限制。

目前设备只支持对当前配置加锁，不能对具体的功能模块进行加锁。

只有持有锁的用户才能解锁，其他用户不能解锁。

1.7.3 配置加锁

请将以下报文拷贝、粘贴到客户端，用户即能完成加锁操作：

<?xml version="1.0" encoding="UTF-8"?>

<lock>

</target>

</lock>

</rpc>

设备收到加锁报文后会回应客户端，当客户端收到如下报文时，表示加锁成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.7.4 配置解锁

请将以下报文拷贝、粘贴到客户端，用户即能完成解锁操作：

<?xml version="1.0" encoding="UTF-8"?>

</target>

</unlock>

</rpc>

设备收到解锁报文后会回应客户端，当客户端收到如下报文时，表示解锁成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.7.5 加锁配置举例

1. 组网需求

给设备加锁，以免其他用户使用XML语言修改设备的当前配置。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 对当前配置加锁。

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0" encoding="UTF-8"?>

<lock>

</target>

</lock>

</rpc>

3. 验证配置

# 如果客户端收到如下报文，则表示加锁成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

用户加锁成功后，另一客户端发送加锁报文，设备会返回如下报文：

<?xml version="1.0" encoding="UTF-8"?>

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

<rpc-error>

<error-type>protocol</error-type>

<error-tag>lock-denied</error-tag>

<error-severity>error</error-severity>

<error-message xml:lang="en">Lock failed because the NETCONF lock is held by another session.</error-message>

<error-info>

<session-id>1</session-id>

</error-info>

</rpc-error>

</rpc-reply>

以上报文表明加锁失败，session-id是1的用户已经持有锁。

1.8 下发配置

1.8.1 功能简介

设备支持通过<edit-config>操作下发配置，该操作支持如下配置选项：merge、create、replace、remove、delete、缺省操作选项、缺省错误处理选项、测试处理、增量下发，关于这些选项的详细描述请参见“2 Comware V7支持的NETCONF操作”。

1.8.2 配置步骤

当需要向设备下发配置时，请使用如下格式的NETCONF报文：

<?xml version="1.0"?>

<edit-config>

<error-option>

error-option

</error-option>

指定模块名，子模块名，列名，表名

</top>

</config>

</edit-config>

</rpc>

error-option为下发配置过程中遇到错误时的处理方式，取值为：

属性	说明
stop-on-error	停止下发配置
continue-on-error	继续下发配置
rollback-on-error	回滚到该<edit-config>操作前的配置配置回滚时缺省不能下发<edit-config>操作。因为回滚到该<edit-config>操作前的配置时，如果回滚时间超过客户端等待时间，客户端会认为<edit-config>操作下发失败，此时客户端将重新下发<edit-config>操作，设备再次触发回滚，如此反复，则会导致CPU/内存资源耗尽，设备重启如需回滚配置的同时执行<edit-config>操作，请先执行<action>操作将DisableEditConfigWhenRollback的属性修改为false

设备收到edit-config请求后会回应客户端，当客户端收到如下报文时，表示设置成功：

<?xml version="1.0">

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

<ok/>

</rpc-reply>

用户还可以通过<get>操作可以查看属性的当前值是否和edit-config操作设置的值一致。

1.8.3 下发配置举例

1. 组网需求

修改syslog模块中的日志缓冲区可存储的信息条数为512。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

<capability>urn:ietf:params:netconf:base:1.0</capability>

</capabilities>

</hello>

# 把Syslog模块LogBuffer表中的BufferSize列，改成512。

请将以下报文拷贝、粘贴到客户端：

<edit-config>

</target>

</LogBuffer>

</Syslog>

</top>

</config>

</edit-config>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.9 保存配置

1.9.1 功能简介

用户可以执行保存配置操作将当前配置保存到配置文件中，同时该文件将自动作为下次启动配置文件。

1.9.2 配置限制和指导

保存配置操作消耗系统资源较多，因此，请避免在系统资源占用较大的情况下执行这些操作。

1.9.3 配置步骤

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0" encoding="UTF-8"?>

<file>配置文件的名称</file>

</save>

</rpc>

属性	说明
OverWrite	指定的配置文件名与原有配置文件名相同时，是否覆盖原配置文件。取值为： · true：当指定的配置文件名与原有配置文件名相同时，覆盖原配置文件 · false：当指定的配置文件名与原有配置文件名相同时，当前配置保存失败，同时返回错误提示信息缺省情况下，OverWrite属性取值为true
Binary-only	是否将当前配置只保存到file属性指定的文本配置文件对应的二进制配置文件，从而缩短保存时间。取值为： · true：将当前配置只保存到二进制配置文件中 ¡ 如果file属性指定的文本配置文件不存在，则保存配置操作失败 ¡ 未指定file属性时，设备自动将当前配置保存到下次启动的文本配置文件对应的二进制配置文件中；如果下次启动的文本配置文件不存在，则保存配置操作失败 · false：同时保存文本配置文件（后缀为“.cfg”）和二进制配置文件（后缀为“.mdb”，仅软件能解析）缺省情况下，Binary-only属性取值为false
Safely	是否以安全模式保存配置文件。取值为： · true：存在同名配置文件时，系统会先将当前配置保存到一个临时文件，保存成功后，再用这个临时文件替换原同名文件。因此，即使在保存过程中出现设备重启、断电等问题导致配置保存失败，仍然能够以原同名的配置文件启动设备 · false：存在同名配置文件时，系统先删除该文件，再保存当前配置文件。在保存过程中，如果出现设备重启、断电、内存不足、设备存储空间不足等问题，可能会出现当前配置保存失败、下次启动文件为空的问题缺省情况下，Safely属性取值为false 为了安全起见，在需要将当前配置保存到下次启动配置文件的时候，建议选用Safely属性
file	文本配置文件的名称，后缀为.cfg。该名称包含文件路径时，必须以存储介质的名称开头，例如flash:/startup.cfg 当报文中存在file属性时，必须输入文本配置文件的名称，不能为空 · 如果file属性指定的文件不存在，则自动创建该文本配置文件和对应的二进制配置文件 · 未指定file属性时，设备自动将当前配置保存到下次启动配置文件（包括文本配置文件和对应的二进制配置文件）

设备收到配置保存请求后会回应客户端，当客户端收到如下报文时，表示保存成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.9.4 保存配置举例

1. 组网需求

将设备的当前配置保存到配置文件config.cfg。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 将设备的当前配置保存到配置文件config.cfg。

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0" encoding="UTF-8"?>

<save>

<file>config.cfg</file>

</save>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功。

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.10 加载配置文件

1.10.1 功能简介

用户可以执行<load>操作，将指定配置文件中的配置会被合并到设备的当前配置中。

设备将配置文件中的配置中的配置与当前配置进行比较：

· 对于配置文件中有，但当前配置中没有的配置，则直接运行。

· 对于配置文件与当前配置中不一致的配置，则用配置文件中的配置替换当前配置中的对应配置。

1.10.2 配置限制和指导

加载配置文件操作消耗系统资源较多，因此，请避免在系统资源占用较大的情况下执行这些操作。

如果只有删除设备中现有的配置才能使配置文件中的某些配置生效，则需要先删除当前配置后再加载配置文件，否则这些配置无法生效。

1.10.3 配置步骤

请将以下报文拷贝、粘贴到客户端，用户即可将配置文件中的配置追加到当前配置中：

<?xml version="1.0" encoding="UTF-8"?>

<load>

<file>配置文件的名称</file>

</load>

</rpc>

其中，“配置文件的名称”必须以存储介质的名称开头，后缀为.cfg。

设备收到配置加载请求后会回应客户端，当客户端收到如下报文时，表示配置加载成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.11 回滚配置

1.11.1 配置限制和指导

回滚配置操作消耗系统资源较多，因此，请避免在系统资源占用较大的情况下执行这些操作。

缺省情况下，通过NETCONF回滚配置时，不能执行<edit-config>操作。如果需要在回滚配置的同时执行<edit-config>操作，请先执行<action>操作，将DisableEditConfigWhenRollback的属性修改为false。

1.11.2 回滚配置文件

请将以下报文拷贝、粘贴到客户端，用户即可将设备的当前配置恢复到指定配置文件中的配置：

<?xml version="1.0" encoding="UTF-8"?>

<file>配置文件的名称</file>

</rollback>

</rpc>

设备收到配置回滚请求后会回应客户端，当客户端收到如下报文时，表示配置回滚成功：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.11.3 回滚运行配置

1. 功能简介

设备支持对当前正在运行的配置进行回滚，配置回滚点后，设备可以在如下场景下进行配置回滚：

· NETCONF客户端主动下发配置回滚指令。

· NETCONF客户端在指定的时间内无任何指令，即NETCONF会话空闲时间超过配置的回滚空闲超时时间。

· NETCONF客户端和设备间的连接异常断开。

2. 配置限制和指导

如果存在多个NETCONF会话同时配置设备，建议回滚配置前先用<lock>锁定系统，否则可能导致设备运行配置与回滚前配置不一致。

3. 配置步骤

(1) 对当前系统加锁，具体请参见“1.7 配置加锁和解锁”。

(2) 启动配置回滚功能，下发<save-point>/<begin>操作配置起始回滚点。

请将以下报文拷贝、粘贴到客户端：

<save-point>

<begin>

<confirm-timeout>100</confirm-timeout>

</begin>

</save-point>

</rpc>

属性	说明
confirm-timeout	回滚空闲超时时间，取值范围为1～65535，单位为秒，缺省值为600。该属性为可选

当客户端收到如下报文时，表示配置起始回滚点成功：

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

<data>

<save-point>

<commit-id>1</commit-id>

</commit>

</save-point>

</data>

</rpc-reply>

(3) 下发<edit-config>操作，对设备各功能进行配置。

(4) 下发<save-point>/<commit>操作配置回滚点。

配置<save-point>操作后，系统支持对最近50个回滚点的配置回滚。超过50个回滚点后，进行<commit>操作时需指定force属性强制覆盖最早的回滚点。

请将以下报文拷贝、粘贴到客户端：

<save-point>

<label>SUPPORT VLAN<label>

<comment>vlan 1 to 100 and interfaces.</comment>

</commit>

</save-point>

</rpc>

<label/>和<comment/>为可选。

当客户端收到如下报文时，表示确认成功：

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

<data>

<save-point>

<commit-id>2</commit-id>

</commit>

</save-point>

</data>

</rpc-reply>

(5) 下发<save-point>/<get-commits>操作获取<commit>的操作记录。

<save-point>

<get-commits>

<commit-id/>

<commit-index/>

<commit-label/>

</get-commits>

</save-point>

</rpc>

<commit-id>，<commit-index>，<commit-label>任选一个，也可以都不选，显示所有的commit记录。

请将以下报文拷贝、粘贴到客户端：

<save-point>

<get-commits>

<commit-label>SUPPORT VLAN</commit-label>

</get-commits>

</save-point>

</rpc>

当客户端收到如下报文时，返回对应的commit操作记录：

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

<data>

<save-point>

<commit-information>

<Label>SUPPORT VLAN</Label>

</commit-information>

</save-point>

</data>

</rpc-reply>

(6) 下发<save-point>/<get-commit-information>操作获取对应的commit操作时的配置。

<save-point>

<get-commit-information>

<commit-information>

<commit-id/>

<commit-index/>

<commit-label/>

</commit-information>

<compare-information>

<commit-id/>

<commit-index/>

<commit-label/>

</compare-information>

</get-commit-information>

</save-point>

</rpc>

<commit-id/>，<commit-index/>，<commit-label/>任选一个。<compare-information/>可选。

属性	说明
commit-id	系统唯一标识的commit编号
commit-index	最近50次的commit，0表示最近一次下发commit，49表示最远一次commit
commit-label	回滚点的标签，不同回滚点的标签不能相同
get-commit-information	显示最近的使用的commit配置

请将以下报文拷贝、粘贴到客户端：

<save-point>

<get-commit-information>

<commit-information>

<commit-label>SUPPORT VLAN</commit-label>

</commit-information>

</get-commit-information>

</save-point>

</rpc>

当客户端收到如下报文时，显示对应的配置信息：

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

<data>

<save-point>

<commit-information>

…

interface vlan 1

…

</content>

</commit-information>

</save-point>

</data>

</rpc-reply>

(7) 下发<save-point>/<rollback>进行回滚配置操作。用户可选择对应的回滚点进行配置回滚，或者等待NETCONF会话空闲时间超过配置的回滚空闲超时时间而自动进行配置回滚到最近回滚点的配置。

请将以下报文拷贝、粘贴到客户端：

<save-point>

<commit-id/>

<commit-index/>

<commit-label/>

</rollback>

</save-point>

</rpc>

<commit-id/>、<commit-index/>、<commit-label/>任选一个，或者不选时回滚此前最近commit的配置。

属性	说明
commit-id	系统唯一标识的commit编号
commit-index	最近50次的commit，0表示最近一次下发commit，49表示最远一次commit
commit-label	回滚点的标签，不同回滚点的标签不能相同

当客户端收到如下报文时，表示主动下发配置回滚成功：

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

</rpc-reply>

(8) 下发<save-point>/<end>结束配置回滚或取消回滚配置。

<save-point>

<end/>

</save-point>

</rpc>

请将以下报文拷贝、粘贴到客户端：

<save-point>

<end/>

</save-point>

</rpc>

当客户端收到如下报文时，返回对应的end结果成功。

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

<ok/>

</rpc-reply>

(9) 对当前系统解锁，具体请参见“1.7 配置加锁和解锁”。

1.12 下发命令行

1.12.1 功能简介

通过NETCONF功能，用户可以将命令行封装在XML报文中对设备进行操作。

1.12.2 配置限制和指导

通过NETCONF下发命令行操作消耗系统资源较多，因此，请避免一次下发多个命令行、或多个用户同时进行NETCONF下发命令行操作。

1.12.3 命令行操作

当需要给设备发送命令时，请使用格式如下的NETCONF报文：

<?xml version="1.0" encoding="UTF-8"?>

<CLI>

命令行

</Execution>

</CLI>

</rpc>

一对<Execution>子标签中可以包含多个命令行，一条命令输入完毕，换行，再输入下一条命令即可。

设备收到命令行指令后会回应客户端，当客户端收到如下报文时，表示命令行执行成功（注意命令响应被CDATA节点包含）：

<?xml version="1.0" encoding="UTF-8"?>

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

<CLI>

<![CDATA[对应命令行响应]]>

</Execution>

</CLI>

</rpc-reply>

1.12.4 命令行操作配置举例

1. 配置需求

向设备发送显示VLAN相关信息的命令。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 向设备发送显示VLAN相关信息的命令。

请将以下报文拷贝、粘贴到客户端：

<?xml version="1.0" encoding="UTF-8"?>

<CLI>

display vlan

</Execution>

</CLI>

</rpc>

3. 验证配置

# 如果客户端收到类似如下的报文，则表示操作成功。

<?xml version="1.0" encoding="UTF-8"?>

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

<CLI>

<Execution><![CDATA[

<Sysname>display vlan

Total VLANs: 1

The VLANs include:

1(default)

]]>

</Execution>

</CLI>

</rpc-reply>

1.13 关闭NETCONF会话

1.13.1 功能简介

NETCONF支持用户关闭除自己外的NETCONF会话，被关闭会话的用户退回到用户视图。

1.13.2 Kill-session操作

请将以下报文拷贝、粘贴到客户端，用户即能关闭指定的会话：

<kill-session>

<session-id>

指定session-ID

</session-id>

</kill-session>

</rpc>

设备收到会话关闭请求后会回应客户端，当客户端收到如下报文时，表示指定会话已经被关闭：

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.13.3 Kill-session操作配置举例

1. 配置需求

当前有两个NETCONF登录用户，session ID分别是1和2，session ID为1的用户要关闭session ID为2用户的会话。

2. 配置步骤

# 进入XML视图。

<Sysname> xml

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

urn:ietf:params:netconf:base:1.0

</capability>

</capabilities>

</hello>

# 关闭session ID为2的用户会话。

请将以下报文拷贝、粘贴到客户端：

<kill-session>

<session-id>2</session-id>

</kill-session>

</rpc>

3. 验证配置

如果客户端收到如下报文，则表明session ID为2的NETCONF会话已经被关闭。建立该会话的用户会从XML视图退回到用户视图。

<?xml version="1.0" encoding="UTF-8"?>

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

<ok/>

</rpc-reply>

1.14 退出XML视图

1.14.1 配置限制和指导

进入XML视图后，必须先完成能力交换，再执行退出XML视图操作。

1.14.2 配置步骤

处于XML视图的用户退回到用户视图时，需要将以下报文拷贝、粘贴到客户端：

<close-session/>

</rpc>

设备收到以上请求后会返回如下报文并退回到用户视图：

<?xml version="1.0" encoding="UTF-8"?>

<rpc-reply message-id="100"

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

<ok/>

</rpc-reply>

1.14.3 退出XML视图举例

1. 组网需求

当前已通过xml命令进入XML视图，用户需要退出XML视图。

2. 配置步骤

# 进行能力交换。

请将以下报文拷贝、粘贴到客户端：

<capability>urn:ietf:params:netconf:base:1.0</capability>

</capabilities>

</hello>]]>]]>

# 退出XML视图。

请将以下报文拷贝、粘贴到客户端：

<close-session/>

</rpc>]]>]]>

3. 验证配置

# 如果回到用户视图，则表示成功退出XML视图。

1.15 NETCONF显示和维护

在完成上述配置后，在任意视图下执行display命令可以显示配置后NETCONF的运行情况，通过查看显示信息验证配置的效果。

在用户视图下，执行reset命令可以清除NETCONF的统计信息。

表1-3 NETCONF显示和维护

操作	命令
显示当前NETCONF服务的状态及全局统计信息	display netconf service
显示当前NETCONF会话信息	display netconf session
清除当前NETCONF服务的全局统计信息	reset netconf service statistics
清除当前NETCONF会话的统计信息	reset netconf session statistics

2 Comware V7支持的NETCONF操作

Comware V7平台对NETCONF标准协议做了一些修订，删除了不常用的操作，增加部分新的操作

2.1.1 action

【使用指导】

下发可配置的功能的动作，例如reset操作。

【XML格式样例】

清除全部接口的统计信息，XML请求如下：

<Ifmgr>

<Clear>

</Clear>

</ClearAllIfStatistics>

</Ifmgr>

</top>

</action>

</rpc>

2.1.2 CLI

【使用指导】

执行命令行的命令。

请求消息将命令行语句封装在<CLI>标签中，命令行输出信息被封装在<CLI>标签中返回。

CLI支持Execution和Configuration方式执行命令行：

· Execution：在用户视图下执行命令行。

· Configuration：在系统视图下执行命令行。使用该方式时需要指定exec-use-channel的属性：

¡ false：不使用channel方式执行命令行。

¡ true：使用临时channel执行命令行，执行完成后，自动关闭该channel。

¡ persist：使用保留channel执行命令行。使用该方式时，则需要执行Open-channel操作打开当前对话的channel；使用完成后，执行Close-channel关闭Channel。

· 对于其他视图下命令，则需要在Configuration下先指定进入子视图的命令，再指定配置命令。

一个NETCONF会话只能打开一个保留channel，可以打开多个临时channel。

如果没有执行Open-channel操作，则系统将自动打开channel。

如果没有执行关闭保留channel操作，再次使用保留channel时，系统在上次最后执行的命令行所在视图再次执行命令行。

不支持执行交互式命令。

使用channel方式执行命令行时，不支持执行quit命令退出用户视图。

【XML格式样例】

在系统视图下不使用channel方式执行display this命令：

<CLI>

<Configuration exec-use-channel="false">display this</Configuration>

</CLI>

</rpc>

2.1.3 close-session

【使用指导】

关闭当前NETCONF会话，并释放锁和这个session用到的内部资源（如内存等），退出XML视图。

【XML格式样例】

关闭当前NETCONF会话，并释放锁和这个session用到的内部资源（如内存等），退出XML视图

<close-session/>

</rpc>

2.1.4 edit-config: create

【使用指导】

创建配置。

create操作必须指定配置对象。

· 如果当前配置表支持创建对象，且当前对象不存在，则先创建配置对象，再创建指定的配置。

· 如果配置对象下对应的配置项已经存在，则返回data-exist错误。

【XML格式样例】

将BufferSize设置为120的xml请求如下：

<edit-config>

</target>

</LogBuffer>

</Syslog>

</top>

</config>

</edit-config>

</rpc>

2.1.5 edit-config: delete

【使用指导】

删除配置。

· 当指定的删除对象中只有表索引时，则删除此配置指定对象的所有配置，同时删除指定对象。

· 当指定的删除对象中不仅仅有表索引还存在配置项时，则删除此对象下面的指定配置。

· 如果系统中指定对象不存在，则直接返回不存在的错误消息。

【XML格式样例】

同edit-config: create，把create修改为delete即可。

2.1.6 edit-config: merge

【使用指导】

在当前运行配置的基础上直接运行指定配置。

merge操作的XML数据格式和create类似，只是operation属性需要指定为“merge”。

merge操作必须指定具体的操作对象（行）：

· 如果指定的对象存在，则直接配置该对象。

· 如果指定的对象不存在，但允许创建，则先创建再配置该对象。

· 如果指定的对象不存在且不允许创建，则返回merge失败。

【XML格式样例】

同edit-config: create，把create修改为merge即可。

2.1.7 edit-config: remove

【使用指导】

删除配置。

· 当指定的删除对象中只有表索引时，则删除此配置指定对象的所有配置，同时删除指定对象。

· 当指定的删除对象中不仅仅有表索引还存在配置项时，则删除此对象下面的指定配置。

· 如果系统中指定对象不存在，或者XML消息未指定对象，则直接返回成功。

【XML格式样例】

同edit-config: create，把create修改为remove即可。

2.1.8 edit-config: replace

【使用指导】

替换配置。

· 如果指定的对象存在，则替换指定对象的配置为当前配置。

· 如果指定的对象不存在，但允许创建，则先创建再配置该对象为当前配置。

· 如果指定对象不存在且不允许创建，则不进行replace操作，返回invalid-value错误，提示用户配置对象不存在。

【XML格式样例】

同edit-config: create，把create修改为replace即可。

2.1.9 edit-config测试处理选项

【使用指导】

执行edit-config操作时，可指定一个测试选项，使用<test-option>节点来决定当前配置是否下发。

该节点的缺省值为test-then-set，全部取值为：

· test-then-set：如果没有错误则将配置设置到系统。

· set：将配置设置到系统。

· test-only：只测试，并不下发配置到系统。语法检查通过，就返回ok成功，否则失败。

【XML格式样例】

下发一个接口的配置，仅测试，XML请求如下：

<edit-config>

</target>

<test-option>test-only</test-option>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</config>

</edit-config>

</rpc>

2.1.10 edit-config缺省操作选项

【使用指导】

edit-config操作用于修改当前系统配置。

NETCONF定制了merge、create、delete和replace等修改配置的方式。当XML消息中未指定修改配置方式时，则使用缺省操作作为当前指令的操作方式，不会修改缺省操作的缺省值。

缺省操作的缺省值为merge，可以在XML消息中通过<default-operation>节点设置，取值为：

· merge：当配置方式和缺省操作方式均未指定时，使用该方式。

· replace：当配置方式未指定，缺省操作指定为replace时，edit-config操作缺省为replace操作。

· none：当配置方式未指定，缺省操作指定为none的时候，edit-config操作缺省为none操作。none操作主要用来检查，下发为none操作的配置仅仅做Schema校验，不进行真正的配置下发。语法检查通过，返回ok成功，否则失败。

【XML格式样例】

下发一个空的操作，该操作仅仅验证格式，并不真正下发给系统，xml请求如下：

<edit-config>

</target>

<default-operation>none</default-operation>

<Ifmgr>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</config>

</edit-config>

</rpc>

2.1.11 edit-config缺省错误处理选项

【使用指导】

edit-config将指定的配置设置到系统上，完成配置设置的操作。

在执行edit-config的过程中，如果遇到一个实例配置出错，缺省情况下会直接返回错误，并提供错误选项，通过错误选项取值的不同，在发生错误的时候进行不同的处理操作。

<error-option>节点用于设置一个实例配置出错后，后续实例配置的处理方式，缺省值为stop-on-error，全部取值为：

· stop-on-error：停止处理，返回错误。此选项为缺省选项。

· continue-on-error：继续处理，但是报告错误。

· rollback-on-error：停止并回滚配置。

【XML格式样例】

下发两个接口的配置，当下发第一个接口的配置发生错误时，继续进行下一个接口配置的下发，XML请求如下：

<edit-config>

</target>

<error-option>continue-on-error</error-option>

</Interface>

</Interface>

</Interfaces>

</Ifmgr>

</top>

</config>

</edit-config>

</rpc>

2.1.12 edit-config增量下发

【使用指导】

增量下发选项incremental放置在列上，对于类似vlan permitlist列表集合性质的列，可能支持增量下发，用户请求XML中有增量下发选项时，最终执行结果不影响本列原有的数据。

增量下发只支持edit-config，但不支持edit-config中的replace。

关于支持增量下发的模块，请参见模块对应的NETCONF XML API。

【XML格式样例】

下发一个接口的VLAN配置，使用增量下发，262接口原有untagvlanlist为12～15，下发后为1～10，12～15。XML请求如下：

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

xmlns:h3c="http://www.h3c.com/netconf/base:1.0">

<edit-config>

</target>

</Interface>

</HybridInterfaces>

</VLAN>

</top>

</config>

</edit-config>

</rpc>

2.1.13 get

【使用指导】

获取设备运行状态和运行配置。

【XML格式样例】

获取Syslog模块的全部数据的XML请求如下：

<get>

</Syslog>

</top>

</filter>

</get>

</rpc>

2.1.14 get-bulk

【使用指导】

从指定索引的下一条开始获取N条运行状态和运行配置（索引行数据不返回）。

用户通过index属性指定索引，通过count属性指定N。如未指定索引，则以第一条为索引；如未指定N，或者数据表中符合条件的数据记录不足N条，则返回表中所有剩下的数据条目。

get操作会返回所有符合条件的数据，在某些情况下会导致效率问题。get-bulk允许用户从固定数据项开始，向后获取指定条目的数据记录。

【XML格式样例】

获取全部接口的数据的xml请求如下：

<get-bulk>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-bulk>

</rpc>

2.1.15 get-bulk-config

【使用指导】

从指定索引的下一条批量获取可配置的功能的变量值。

配置限制与get-bulk操作相同。

【XML格式样例】

获取全部接口配置信息的xml请求如下：

<get-bulk-config>

</source>

<Ifmgr>

</Ifmgr>

</top>

</filter>

</get-bulk-config>

</rpc>

2.1.16 get-config

【使用指导】

获取可配置的功能的变量值。如果对应功能未配置，则返回一个空的<data>。

【XML格式样例】

获取接口表内所有配置的XML请求如下：

<get-config>

</source>

<Ifmgr>

</Interfaces>

</Ifmgr>

</top>

</filter>

</get-config>

</rpc>

2.1.17 get-sessions

【使用指导】

获取当前系统中所有NETCONF会话的信息（不能指定sessions-ID）。

【XML格式样例】

获取当前系统中所有NETCONF会话的信息：

<get-sessions/>

</rpc>

2.1.18 kill-session

【使用指导】

关闭其他NETCONF会话。

该操作不支持关闭用户自己的NETCONF会话。

【XML格式样例】

关闭session-id为1的NETCONF会话：

<kill-session>

<session-id>1</session-id>

</kill-session>

</rpc>

2.1.19 load

【使用指导】

加载配置。

执行该操作后，指定配置文件中的配置被合并到当前运行配置中。

【XML格式样例】

将文件a1.cfg中的配置合并到设备的当前配置中：

<load>

</load>

</rpc>

2.1.20 lock

【使用指导】

NETCONF加锁操作将锁定配置数据，即<edit-config>操作中指定配置数据，其他操作（例如<get>操作）不受锁的限制。

用户通过NETCONF加锁操作锁定NETCONF连接后，其他用户既不能使用NETCONF执行下发配置操作，也不能通过CLI或SNMP等其他配置方式对设备进行配置。

【XML格式样例】

禁止NETCONF会话修改设备的当前配置，XML请求如下：

<lock>

</target>

</lock>

</rpc>

2.1.21 rollback

【使用指导】

回滚配置。

该操作必须使用子元素<file>指定需要回滚的配置文件的名称。

执行该操作后，当前运行配置回滚为指定配置文件中的配置。

【XML格式样例】

将设备当前配置回退到文件1A.cfg中配置的状态：

</rollback>

</rpc>

2.1.22 save

【使用指导】

保存运行配置。

该操作可以使用子元素<file>来指定保存的配置文件名称。当save操作中不存在子元素<file>列时，则设备会自动将当前运行配置保存到主用下次启动配置文件中。

OverWrite属性用来判断当指定的配置文件名存在时，当前配置是否覆盖原配置文件并保存成功。

Binary-only属性用来只保存当前使用的二进制配置文件。

Safely属性用来以安全模式保存配置文件。

【XML格式样例】

将设备当前配置保存到文件test.cfg中：

</save>

</rpc>

2.1.23 unlock

【使用指导】

解锁。

当会话结束时锁也会被自动释放。

【XML格式样例】

取消锁保护，允许NETCONF会话修改设备的当前配置：

</target>

</unlock>

</rpc>

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

热门推荐

热门推荐

H3C服务器

HPE服务器

热门推荐

H3C存储

HPE存储

热门推荐

商用台式机

商用笔记本

商用显示器

配件

热门推荐

热门推荐

智能终端

技术解决方案

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

专业安全服务

安全运营服务

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

技术支持

自助服务

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

热门推荐

公司刊物

加入我们

国家/地区

20-网络管理和监控配置指导

目录

05-NETCONF配置

1.1 NETCONF简介

1.1.1 NETCONF协议结构

1.1.2 NETCONF报文格式

1. NETCONF

2. NETCONF over SOAP

1.2 NETCONF配置任务简介

1.3 配置NETCONF使用专用命名空间

1. 功能简介

2. 配置限制和指导

3. 配置步骤

1.4 建立NETCONF会话

1.4.2 配置NETCONF会话公共属性

1. 功能简介

2. 配置步骤

1.4.3 建立NETCONF over SOAP会话

1. 功能简介

2. 配置限制和指导

3. 配置步骤

1.4.4 建立NETCONF over SSH会话

1. 配置准备

2. 配置步骤

1.4.5 建立NETCONF over Telnet或NETCONF over Console会话

2. 配置准备

3. 配置步骤

1.4.6 交换能力集

1. 功能简介

2. 设备发送给客户端的报文

3. 客户端发送给设备的报文

1.5 获取设备配置信息

1.5.2 获取运行配置和运行状态

1.5.4 获取NETCONF信息

1.5.5 获取YANG文件的内容

1.5.6 获取NETCONF会话信息

1. 组网需求

2. 配置步骤

3. 验证配置