目  录

1 gRPC

1.1 gRPC通用配置命令

1.1.1 display grpc

1.1.2 grpc data-model

1.1.3 grpc enable

1.1.4 grpc pki domain

1.2 gRPC Dial-in模式配置命令

1.2.1 grpc acl

1.2.2 grpc idle-timeout

1.2.3 grpc log dial-in gnmi

1.2.4 grpc log dial-in rpc

1.2.5 grpc port

1.3 gRPC Dial-out模式配置命令

1.3.1 condition

1.3.2 depth

1.3.3 destination-group (subscription view)

1.3.4 destination-group (telemetry view)

1.3.5 dscp

1.3.6 encoding

1.3.7 filter

1.3.8 grpc log dial-out

1.3.9 grpc sensor-mode

1.3.10 ipv4-address

1.3.11 ipv6-address

1.3.12 operator

1.3.13 protocol

1.3.14 sensor-path-flex

1.3.15 sensor path

1.3.16 sensor-group (subscription view)

1.3.17 sensor-group (telemetry view)

1.3.18 source-address

1.3.19 subscription

1.3.20 telemetry

 

1 gRPC

1.1  gRPC通用配置命令

1.1.1  display grpc

display grpc命令用来显示gRPC的相关信息。

【命令】

display grpc [ verbose ]

【视图】

任意视图

【缺省用户角色】

network-admin

network-operator

【参数】

verbose：显示gRPC的详细信息。不指定该参数时，将显示gRPC的概要信息。

【举例】

# 显示gRPC的概要信息。

<Sysname> display grpc

gRPC status : Enabled

PKI domain : --

Current-time: 2021-08-20T17:53:12.880

------------Dial-in mode information------------

gRPC server port: 50051

IPv4 ACL for client filtering: 2002

IPv6 ACL for client filtering: 3000

Session idle-timeout: 5 minutes

Session count: 0

  ID         IP Address:Port                  UserName

   1         192.1.11.254:53030               test

------------Dial-out mode information-----------

Sensor mode: Simple

Sensor group count: 1

Sensor path count: 1

Destination group count: 1

Destination count: 1

Subscription count: 1

Connection ID: 1

  IP address:Port: 1.1.1.1:50051

   Encoding: JSON

   Status: Idle

表1-1 display grpc命令显示信息描述表

	字段	描述
gRPC status		gRPC功能状态： ·     Enabled：表示gRPC功能处于开启状态 ·     Disabled：表示gRPC功能处于关闭状态
PKI domain		设备和采集器建立gRPC连接时引用的PKI域 未配置grpc pki domain命令时，本字段显示为“--”
Current-time		系统当前时间
Dial-in mode information		Dial-in模式相关信息
gRPC server port		gRPC服务使用的端口号
IPv4 ACL for client filtering		过滤gRPC客户端的IPv4 ACL，未配置时本字段不显示
IPv6 ACL for client filtering		过滤gRPC客户端的IPv6 ACL，未配置时本字段不显示
Session idle-timeout		gRPC会话超时时间，单位为分钟
Session count		gRPC会话数量
ID		gRPC会话ID
IP Address:Port		客户端的IP地址和端口号
UserName		用户名
Dial-out mode information		Dial-out模式相关信息
Sensor mode		传感器组的采样模式，取值包括： ·     Flex：灵活模式 ·     Simple：简单模式
Sensor group count		传感器组的数量
Sensor path count		采样路径的数量
Destination group count		目标组的数量
Destination count		采集器的数量
Subscription count		订阅的数量
Connection ID		设备与采集器建立的连接的ID
IP address:Port		采集器的IP地址和端口号
Encoding		订阅报文的编码方式 ·     JSON：对上送数据使用JSON编码格式 ·     GPB：对上送数据使用GPB编码格式
Status		设备与采集器的连接通道状态，取值包括： ·     Init：通道正在初始化 ·     Idle：通道闲置 ·     Connecting：通道正在连接 ·     Connected：通道已连接 ·     Transient failure：通道暂时故障，正在尝试恢复 ·     Shutdown：通道因故障关闭

 

# 显示gRPC的详细信息。

<Sysname> display grpc verbose

gRPC status : Enabled

PKI domain : --

Current-time: 2021-08-20T17:51:28.846

------------Dial-in mode information------------

gRPC server port: 50051

IPv4 ACL for client filtering: abc

IPv6 ACL for client filtering: 3000

Session idle-timeout: 5 minutes

Session count: 1

  Session ID: 1

    User name: test

    Login time:2020-05-19 16:40:16     Idle time : 3 mins 41 s

    Client IP address : 192.1.11.254:53030

    Received RPCs        : 39        Received erroneous RPCs : 6

    Received subscription: 0         Sent notifications: 0

------------Dial-out mode information-----------

Sensor mode: Simple

Sensor group count: 1

Sensor path count: 1

Destination group count: 1

Destination count: 1

Subscription count: 1

Subscription s

Subscription mode: non-gNMI

DSCP value: 0

Source address or interface: Not configured

Telemetry data model:  2-layer

Encoding: JSON

Protocol: GRPC

Sensor group: s

  Sampling interval: 10 seconds

  Sampling type         Effective sampling interval   Sensor path

  Periodic              10 seconds                    ifmgr/statistics

Destination group: d

  Start time: 2021-08-20T17:51:24.377

  IP:Port: 1.1.1.1:50051

    VPN: N/A

    Connection state: Idle

    Periodic sampling statistics:

      Effective count: 0

      Sent successfully: 0                  Failed: 0

    Event-triggered statistics:

      Effective count: 0

      Sent successfully: 0                  Failed: 0

    Queued packets/Queue size: 0/1000

    Total sent bytes: 0

    Total delayed packets: 0

    Total dropped packets: 0

    Last sent time: -

    Heartbeat interval: 0s

    Last error: --

表1-2 display grpc verbose命令显示信息描述表

字段	描述
gRPC status	gRPC功能状态： ·     Enabled：表示gRPC功能处于开启状态 ·     Disabled：表示gRPC功能处于关闭状态
PKI domain	设备和采集器建立gRPC连接时引用的PKI域 未配置grpc pki domain命令时，本字段显示为“--”
Current-time	系统当前时间
Dial-in mode information	Dial-in模式相关信息
gRPC server port	gRPC服务使用的端口号
IPv4 ACL for client filtering	过滤gRPC客户端的IPv4 ACL，未配置时本字段不显示
IPv6 ACL for client filtering	过滤gRPC客户端的IPv6 ACL，未配置时本字段不显示
Session idle-timeout	gRPC会话超时时间，单位为分钟
Session count	gRPC会话数量
Session ID	gRPC会话ID
User name	用户名
Login time	登录时间
Idle time	gRPC会话达到超时前的剩余空闲时间，0表示不超时
Client IP address	客户端的IP地址和端口号
Received RPCs	设备接收到的gRPC请求报文数量
Received erroneous RPCs	设备接收到的错误gRPC请求报文数量
Received subscription	设备接收到的gRPC订阅请求报文数量
Sent notifications	设备上报通知的数量
Dial-out mode information	Dial-out模式相关信息
Sensor mode	传感器组的采样模式，取值包括： ·     Flex：灵活模式 ·     Simple：简单模式
Sensor group count	传感器组的数量
Sensor path count	采样路径的数量
Destination group count	目标组的数量
Destination count	采集器的数量
Subscription count	订阅的数量
Subscription	订阅的名称
Subscription mode	订阅类型，目前仅支持non-gNMI
DSCP value	设备发送订阅报文的DSCP优先级
Source-address or interface	设备发送订阅报文的源地址或源接口 取值为Not-config时表示未配置源地址和源接口
Telemetry data model	gRPC使用的Telemetry数据模型，取值包括： ·     2-layer：二层Telemetry数据模型 ·     3-layer：三层Telemetry数据模型
Encoding	订阅报文的编码方式 ·     JSON：对上送数据使用JSON编码格式 ·     GPB：对上送数据使用GPB编码格式
Protocol	设备发送订阅报文的传输协议，取值包括： ·     GRPC ·     UDP
Sensor-group	传感器组的名称
Sampling interval	数据采样和推送周期 对于事件触发类型的采样路径，该字段的取值始终为0，表示设备不会周期进行数据采样
Sampling type	采样路径的类型，取值包括： ·     Event-triggered：由事件触发采样 ·     Periodic：按固定周期采样
Effective sampling interval	实际生效的数据采样和推送周期
Sensor path	采样路径
Destination group	目标组的名称
Start time	gRPC连接建立的时间
IP:Port	采集器（gRPC服务器）的IP地址和端口号
VPN	采集器所属VPN实例的名称 N/A表示未指定VPN实例，采集器位于公网中
Connection state	gRPC连接建立状态 ·     Idle：连接未建立 ·     Established：连接已建立
Periodic sampling statistics	周期采样的信息统计
Event-triggered statistics	事件触发采样的信息统计
Effective count	有效采集次数，不包括采集到空报文的次数
Sent successfully	发送成功的报文数量
Failed	发送失败的报文数量
Queued packets/Queue size	缓存待发送的报文数量/缓存队列大小
Total sent bytes	发送的总字节数
Total delayed packets	延迟发送的报文总数
Total dropped packets	因缓存队列满而丢弃的报文总数
Last sent time	最近一次发送报文的时间
Heartbeat interval	gRPC通道的Keepalive检测报文发送周期，单位为秒，暂不支持配置 0表示不进行Keepalive检测
Last error	最近一次的错误信息 ·     --：表示无错误信息 ·     VPN doesn’t exist：VPN不存在 ·     PKI failed：gRPC连接引用的PKI出错，例如其中的证书失效 ·     Channel (reason)：gRPC通道告警，reason取值包括： ¡     Init：通道正在初始化 ¡     Idle：通道闲置 ¡     Connecting：通道正在连接 ¡     Transient failure：通道暂时故障，正在尝试恢复 ¡     Shutdown：通道因故障关闭

 

1.1.2  grpc data-model

grpc data-model命令用来配置gRPC使用的Telemetry数据模型。

undo grpc data-model命令用来恢复缺省情况。

【命令】

grpc data-model { 2-layer | 3-layer }

undo grpc data-model

【缺省情况】

设备使用二层Telemetry数据模型上送数据。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

2-layer：使用二层Telemetry数据模型上送数据。

3-layer：使用三层Telemetry数据模型上送数据。

【使用指导】

本命令目前仅用于gRPC Dial-out模式。

设备使用二层Telemetry数据模型上送数据时，不支持对上送数据使用GPB编码格式（encoding gpb）。

关于Telemetry数据模型的介绍，请参见“Telemetry配置指导”中的“gRPC”。

【举例】

# 配置设备使用三层Telemetry数据模型上送数据。

<Sysname> system-view

[Sysname] grpc data-model 3-layer

【相关命令】

·     encoding

1.1.3  grpc enable

grpc enable命令用来开启gRPC功能。

undo grpc enable命令用来关闭gRPC功能。

【命令】

grpc enable

undo grpc enable

【缺省情况】

gRPC功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

只有开启gRPC功能后，才能进行gRPC相关的配置。

如果关闭gRPC功能，所有gRPC相关配置都会被删除。

【举例】

# 开启gRPC功能。

<Sysname> system

[Sysname] grpc enable

1.1.4  grpc pki domain

grpc pki domain命令用来配置设备和采集器建立gRPC连接时引用的PKI域。

undo grpc pki domain命令用来恢复缺省情况。

【命令】

grpc pki domain domain-name

undo grpc pki domain

【缺省情况】

设备和采集器建立gRPC连接时不会引用PKI域。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

domain-name：PKI域名，为1～31个字符的字符串，不区分大小写。

【使用指导】

缺省情况下，设备和采集器建立的gRPC连接是非加密的。配置本命令引用PKI域后，设备和采集器会基于TLS（Transport Layer Security，传输层安全）协议进行通道加密和双向证书认证，从而提高gRPC通信的安全性。

指定的PKI域必须存在，并且PKI域中包含完整的证书和密钥，否则，设备和采集器仍将采用非加密方式建立gRPC连接。关于PKI的详细介绍，请参见“安全配置指导”中的“PKI”。

【举例】

# 配置设备和采集器建立gRPC连接时引用的PKI域为grpc_test。

<Sysname> system-view

[Sysname] grpc pki domain grpc_test

1.2  gRPC Dial-in模式配置命令

1.2.1  grpc acl

grpc acl命令用来使用ACL限制gRPC客户端和gRPC服务器建立连接。

undo grpc acl命令用来取消gRPC客户端和gRPC服务器建立连接的ACL限制。

【命令】

grpc acl [ ipv6 ] { acl-number | name acl-name }

undo grpc acl [ ipv6 ]

【缺省情况】

未使用ACL限制gRPC客户端和gRPC服务器建立连接。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

ipv6：指定ACL类型为IPv6 ACL。如果未指定本参数，则表示IPv4 ACL。

acl-number：ACL的编号，取值范围及其代表的ACL类型如下：

·     2000～2999：表示基本ACL。

·     3000～3999：表示高级ACL。

name acl-name：基本ACL或高级ACL的名称。acl-name表示ACL的名称，为1～63个字符的字符串，不区分大小写，必须以英文字母a～z或A～Z开头。为避免混淆，ACL的名称不允许使用英文单词all。

【使用指导】

应用场景

通过将gRPC功能与ACL关联，可以过滤掉某些gRPC客户端的连接请求，只允许符合ACL规则的gRPC客户端和gRPC服务器建立连接。

注意事项

gRPC功能与ACL关联后，gRPC服务将重启，正在访问的客户端将被断开，客户端需要重新发送连接请求才能继续访问。

通过本命令可以关联一个IPv4 ACL和一个IPv6 ACL。如果多次执行本命令，最新关联的IPv4 ACL和IPv6 ACL生效。

引用ACL时，需要注意：

·     若引用的ACL不存在，或者引用的ACL中没有配置规则，则所有gRPC客户端都不能访问本设备。

·     在引用的ACL中，若某规则指定了vpn-instance参数，则表示该规则仅对VPN报文有效；若规则未指定vpn-instance参数，则表示该规则仅对公网报文有效。

【举例】

# 配置一个IPv4基本ACL，只允许IP地址为1.1.1.1的gRPC客户端和gRPC服务器建立连接。

<Sysname> system-view

[Sysname] acl basic 2001

[Sysname-acl-ipv4-basic-2001] rule 0 permit source 1.1.1.1 0

[Sysname-acl-ipv4-basic-2001] rule 1 deny source any

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

[Sysname] grpc acl 2001

1.2.2  grpc idle-timeout

grpc idle-timeout命令用来配置gRPC会话超时时间。

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

【命令】

grpc idle-timeout minutes

undo grpc idle-timeout

【缺省情况】

gRPC会话超时时间为5分钟。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

minutes：表示gRPC会话超时时间，取值范围为0～30，单位为分钟。0表示设备不会因为超时自动断开用户连接。

【使用指导】

用户登录后，如果在超时时间内设备和用户之间没有gRPC报文交互，则超时时间到达时设备会自动断开该用户的连接。

【举例】

# 配置gRPC会话超时时间为6分钟。

<Sysname> system

[Sysname] grpc idle-timeout 6

1.2.3  grpc log dial-in gnmi

grpc log dial-in gnmi命令用来开启gRPC Dial-in模式的gNMI类操作日志功能。

undo grpc log dial-in gnmi命令用来关闭gRPC Dial-in模式的gNMI类操作日志功能。

【命令】

grpc log dial-in gnmi { all | { capabilities | get | set | subscribe }* }

undo grpc log dial-in gnmi { all | { capabilities | get | set | subscribe }* }

【缺省情况】

gRPC Dial-in模式的gNMI Set操作日志功能处于开启状态，其他gNMI类操作日志功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

all：表示输出所有gNMI类操作日志。

capabilities：表示输出gNMI Capabilities操作日志。

get：表示输出gNMI Get操作日志。

set：表示输出gNMI Set操作日志。

subscribe：表示输出gNMI Subscribe操作日志。

【使用指导】

为了管理员定位gRPC问题的需要，可以开启gRPC日志功能，以便记录设备对gRPC报文的处理信息。

设备生成的gRPC日志信息会交给信息中心模块处理，信息中心模块的配置将决定日志信息的发送规则和发送方向。关于信息中心的详细描述请参见“网络管理和监控配置指导”中的“信息中心”。

多次执行本命令，最终生效的是多次配置的集合。

【举例】

# 配置设备输出gRPC Dial-in模式的gNMI Get操作日志。

<Sysname> system

[Sysname] grpc log dial-in gnmi get

1.2.4  grpc log dial-in rpc

grpc log dial-in rpc命令用来开启gRPC Dial-in模式的RPC（Remote Procedure Call，远程过程调用）类操作日志功能。

undo grpc log dial-in rpc命令用来关闭gRPC Dial-in模式的RPC类操作日志功能。

【命令】

grpc log dial-in rpc { all | { cli | get }* }

undo grpc log dial-in rpc { all | { cli | get }* }

【缺省情况】

gRPC Dial-in模式的RPC类操作日志功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

all：表示输出CLI操作和Get操作的日志。

cli：表示输出CLI操作日志。

get：表示输出Get操作日志。

【使用指导】

为了管理员定位gRPC问题的需要，可以开启gRPC日志功能，以便记录设备对gRPC报文的处理信息。

设备生成的gRPC日志信息会交给信息中心模块处理，信息中心模块的配置将决定日志信息的发送规则和发送方向。关于信息中心的详细描述请参见“网络管理和监控配置指导”中的“信息中心”。

多次执行本命令，最终生效的是多次配置的集合。

【举例】

# 配置设备输出gRPC Dial-in模式的Get操作的日志。

<Sysname> system

[Sysname] grpc log dial-in rpc get

1.2.5  grpc port

grpc port命令用来配置gRPC服务的端口号。

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

【命令】

grpc port port-number

undo grpc port

【缺省情况】

gRPC服务的端口号为50051。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

port-number：gRPC服务的端口号，取值范围为1～65535。

【使用指导】

修改端口号后，gRPC服务将重启，正在访问的客户端将被断开，客户端需要重新发送连接请求才能继续访问。

如果指定的端口号因端口被占用等原因无法用于gRPC服务，则系统使用修改前的端口号重启gRPC服务。

【举例】

# 配置gRPC服务的端口号为50052。

<Sysname> system

[Sysname] grpc port 50052

【相关命令】

·     grpc enable

1.3  gRPC Dial-out模式配置命令

1.3.1  condition

condition命令用来配置过滤条件。

undo condition命令用来删除过滤条件。

【命令】

condition node node operator operator value value

undo condition node node operator operator value value

【缺省情况】

过滤器未配置过滤条件。

【视图】

过滤器视图

【缺省用户角色】

network-admin

【参数】

node node：node表示节点名称，配置时需要完整输入，不区分大小写，执行condition node ?命令，通过帮助信息可获得该参数的取值。

operator operator：比较运算符。支持的比较运算符以具体节点为准。operator的取值包括：

·     eq：等于。

·     ge：大于等于。

·     gt：大于。

·     le：小于等于。

·     lt：小于。

·     ne：不等于。

value value：比较运算的参考值。

【使用指导】

采样路径的过滤器中配置过滤条件后，只有指定节点采样的数据满足比较运算的条件时，该采样路径才会推送数据给采集器。

多次执行本命令可配置多个过滤条件。一个过滤器最多支持配置5个过滤条件。

过滤条件之间的关系缺省为逻辑与，可通过operator命令修改为逻辑或。

【举例】

# 配置传感器组使用灵活模式进行采样，在传感器组test中配置采样路径device/base，在过滤器filter1下设置过滤条件之间的关系为逻辑或，当节点uptime等于377或者等于378时，该采样路径会推送数据给采集器。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor-path-flex device/base

[Sysname-telemetry-sensor-group-test-path] filter filter1

[Sysname-telemetry-sensor-group-test-path-filter] operator or

[Sysname-telemetry-sensor-group-test-path-filter] condition node uptime operator eq value 377

[Sysname-telemetry-sensor-group-test-path-filter] condition node uptime operator eq value 378

【相关命令】

·     filter

·     operator

1.3.2  depth

depth命令用来配置采样路径的采样深度。

undo depth命令用来恢复缺省情况。

【命令】

depth depth

undo depth

【缺省情况】

采样深度为1。

【视图】

采样路径视图

【缺省用户角色】

network-admin

【参数】

depth：采样深度值，取值范围为1～3。各取值的含义为：

·     采样深度为1时，设备只上报当前采样路径的所有列数据。

·     采样深度为2时，设备除了上报当前采样路径的列数据外，还会上报当前采样路径下所有子表的列数据。

·     采样深度为3时，设备除了上报当前采样路径的列数据外，还会上报当前采样路径下所有子表以及这些子表的所有子表的列数据。

【使用指导】

仅多级表（含有子表的采样路径）支持配置本命令。

【举例】

# 配置传感器组使用灵活模式进行采样，在传感器组test中，配置指定采样路径的采样深度为2。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor-path-flex grpc/subscriptions/subscription/destinationprofiles/destinationprofile

[Sysname-telemetry-sensor-group-test-path] depth 2

1.3.3  destination-group (subscription view)

destination-group命令用来配置关联目标组。

undo destination-group命令用来删除关联目标组。

【命令】

destination-group group-name

undo destination-group group-name

【缺省情况】

未配置关联目标组。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

group-name：目标组的名称，为1～31个字符的字符串，区分大小写。

【使用指导】

本命令配置的目标组将会和同一订阅视图下的传感器组自动关联。

本命令指定的目标组需要先在Telemetry视图下使用destination-group命令创建。

每个订阅可关联的目标组数量上限为5。

【举例】

# 在订阅A中配置关联目标组为collector1。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A] destination-group collector1

【相关命令】

·     destination-group (telemetry view)

1.3.4  destination-group (telemetry view)

destination-group命令用来创建目标组，并进入目标组视图。如果指定的目标组已经存在，则直接进入目标组视图。

undo destination-group命令用来删除目标组。

【命令】

destination-group group-name

undo destination-group group-name

【缺省情况】

不存在目标组。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

【参数】

group-name：目标组的名称，为1～31个字符的字符串，区分大小写。

【使用指导】

建议系统中创建的目标组数量不超过5个，否则会影响系统性能。

通过destination-group (subscription view)命令将目标组关联到订阅后，如需删除该目标组，请先解除订阅关系。

【举例】

# 创建名为collector1的目标组。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

[Sysname-telemetry-destination-group-collector1]

【相关命令】

·     destination-group (subscription view)

·     subscription

1.3.5  dscp

dscp命令用来配置设备发送的订阅报文的DSCP优先级。

undo dscp命令用来恢复缺省情况。

【命令】

dscp dscp-value

undo dscp

【缺省情况】

设备发送的订阅报文的DSCP优先级为0。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

dscp-value：订阅报文的DSCP优先级，取值范围为0～63。

【使用指导】

DSCP（Differentiated Services Code Point，差分服务编码点）携带在IPv4报文中的ToS字段或者IPv6报文中的Traffic Class字段，用来体现报文自身的优先等级，决定报文传输的优先程度。DSCP优先级的取值越大，报文的优先级越高。

在同一个订阅视图下多次执行本命令，最后一次执行的命令生效。

【举例】

# 配置设备发送的订阅A的报文的DSCP优先级为12。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A] dscp 12

1.3.6  encoding

encoding命令用来配置上送数据的编码格式。

undo encoding命令用来恢复缺省情况。

【命令】

encoding { gpb | json }

undo encoding

【缺省情况】

上送数据的编码格式为JSON。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

gpb：对上送数据使用GPB编码格式。仅当设备使用三层Telemetry数据模型时，可以对上送数据使用GPB编码格式。

json：对上送数据使用JSON编码格式。

【使用指导】

设备上支持订阅的数据均支持JSON编码格式，可能部分不支持GPB编码格式。当用户配置为GPB编码格式后，不支持GPB编码格式的数据不会上送。

【举例】

# 配置设备使用三层Telemetry数据模型，订阅A的上送数据的编码格式为GPB。

<Sysname> system-view

[Sysname] grpc data-model 3-layer

[Sysname] telemetry

[Sysname-telemetry] subscrption A

[Sysname-telemetry-subscription-A] encoding gpb

【相关命令】

·     grpc data-model

1.3.7  filter

filter命令用来配置采样路径的过滤器，并进入过滤器视图。

undo filter命令用来删除采样路径的过滤器。

【命令】

filter filter-name

undo filter filter-name

【缺省情况】

采样路径未配置过滤器。

【视图】

采样路径视图

【缺省用户角色】

network-admin

【参数】

filter-name：过滤器名称，为1～31个字符的字符串，区分大小写。

【使用指导】

仅周期采样类型的采样路径支持配置过滤器。

过滤器视图下，可以使用condition命令为采样路径配置多个过滤条件。

【举例】

# 配置传感器组使用灵活模式进行采样，在传感器组test中，配置采样路径为ifmgr/devicecapabilities，并配置过滤器filter1。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor-path-flex ifmgr/devicecapabilities

[Sysname-telemetry-sensor-group-test-path] filter filter1

[Sysname-telemetry-sensor-group-test-path-filter]

【相关命令】

·     condition

1.3.8  grpc log dial-out

grpc log dial-out命令用来开启gRPC Dial-out模式的日志功能。

undo grpc log dial-out命令用来关闭gRPC Dial-out模式的日志功能。

【命令】

grpc log dial-out { all | { event | sample }* }

undo grpc log dial-out { all | { event | sample }* }

【缺省情况】

gRPC Dial-out模式的日志功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

【参数】

all：表示输出gRPC Dial-out模式的所有类型的日志。

event：表示输出事件触发采样的日志。

sample：表示输出固定周期采样的日志。

【使用指导】

为了管理员定位gRPC问题的需要，可以开启gRPC日志功能，以便记录设备对gRPC报文的处理信息。

设备生成的gRPC日志信息会交给信息中心模块处理，信息中心模块的配置将决定日志信息的发送规则和发送方向。关于信息中心的详细描述请参见“网络管理和监控配置指导”中的“信息中心”。

gNMI模式的订阅不支持gRPC Dial-out模式的日志功能。

多次执行本命令，最终生效的是多次配置的集合。

【举例】

# 配置设备输出gRPC Dial-out模式的固定周期采样的日志。

<Sysname> system

[Sysname] grpc log dial-out sample

1.3.9  grpc sensor-mode

grpc sensor-mode命令用来配置传感器组的采样模式。

undo grpc sensor-mode命令用来恢复缺省情况。

【命令】

grpc sensor-mode { flex | simple }

undo grpc sensor-mode

【缺省情况】

传感器组使用简单模式进行采样。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

【参数】

flex：灵活模式。

simple：简单模式。

【使用指导】

设备的传感器组支持以简单模式或灵活模式进行采样。其中，灵活模式下可以配置采样路径的过滤条件之间的关系。

·     灵活模式：使用sensor-path-flex命令配置采样路径，并进入采样路径视图。

采样路径视图下，可以配置过滤器来添加多个过滤条件，且可以通过operator命令灵活选择这些条件之间的逻辑关系：

¡     逻辑与（and）：只有所有条件都满足，设备才会将采样路径的数据推送给采集器。

¡     逻辑或（or）：只要任意条件满足，设备就会将采样路径的数据推送给采集器。

·     简单模式：多次配置sensor path命令，可以配置多条采样路径，同时可以指定采样参数。

采样路径相同、condition参数（即过滤条件）不同的多条sensor path命令之间是逻辑与的关系，即只有所有条件都满足时，设备才会将该采样路径的数据推送给采集器。

切换采样模式之前，需要删除设备上已存在的所有传感器组的采样路径配置，或者删除所有传感器组。

【举例】

# 配置传感器组使用灵活模式进行采样。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

【相关命令】

·     operator

·     sensor path

·     sensor-path-flex

1.3.10  ipv4-address

ipv4-address命令用来往目标组中添加IPv4采集器。

undo ipv4-address命令用来将IPv4采集器从目标组中删除。

【命令】

ipv4-address ipv4-address [ port port-number ] [ vpn-instance vpn-instance-name ]

undo ipv4-address ipv4-address [ port port-number ] [ vpn-instance vpn-instance-name ]

【缺省情况】

目标组中没有IPv4采集器。

【视图】

目标组视图

【缺省用户角色】

network-admin

【参数】

ipv4-address：采集器的IPv4地址。

port port-number：采集器接收数据的端口号，取值范围为1～65535，缺省值为50051。本参数的值需要和采集器侧的配置一致，否则采集器接收不到相应数据。

vpn-instance vpn-instance-name：采集器所属的VPN实例。vpn-instance-name表示MPLS L3VPN的VPN实例名称，为1～31个字符的字符串，区分大小写。如果未指定本参数，则表示采集器位于公网中。

【使用指导】

多次执行本命令可配置多个采集器。配置本命令时，只要任意一个参数不同，就算不同的采集器。

每个目标组支持配置的采集器数量上限为5。

通过destination-group (subscription view)命令将目标组关联到订阅后，如需修改该目标组中的采集器配置，请先解除订阅关系。

【举例】

# 在目标组collector1中配置IP地址为192.168.21.21的采集器。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

[Sysname-telemetry-destination-group-collector1] ipv4-address 192.168.21.21

【相关命令】

·     destination-group (subscription view)

·     subscription

1.3.11  ipv6-address

ipv6-address命令用来往目标组中添加IPv6采集器。

undo ipv6-address命令用来将IPv6采集器从目标组中删除。

【命令】

ipv6-address ipv6-address [ port port-number ] [ vpn-instance vpn-instance-name ]

undo ipv6-address ipv6-address [ port port-number ] [ vpn-instance vpn-instance-name ]

【缺省情况】

目标组中没有IPv6采集器。

【视图】

目标组视图

【缺省用户角色】

network-admin

【参数】

ipv6-address：采集器的IPv6地址。

port port-number：采集器接收数据的端口号，取值范围为1～65535，缺省值为50051。本参数的值需要和采集器侧的配置一致，否则采集器接收不到相应数据。

vpn-instance vpn-instance-name：采集器所属的VPN实例。vpn-instance-name表示MPLS L3VPN的VPN实例名称，为1～31个字符的字符串，区分大小写。如果未指定本参数，则表示采集器位于公网中。

【使用指导】

采集器的IPv6地址不能指定为IPv6链路本地地址。有关IPv6链路本地地址的介绍，请参见“三层技术-IP业务配置指导”中的“IPv6基础”。

多次执行本命令可配置多个采集器。配置本命令时，只要任意一个参数不同，就算不同的采集器。

每个目标组支持配置的采集器数量上限为5。

通过destination-group (subscription view)命令将目标组关联到订阅后，如需修改该目标组中的采集器配置，请先解除订阅关系。

【举例】

# 在目标组collector1中配置IPv6地址为1::1的采集器。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

[Sysname-telemetry-destination-group-collector1] ipv6-address 1::1

【相关命令】

·     destination-group (subscription view)

·     subscription

1.3.12  operator

operator命令用来配置过滤条件之间的关系。

undo operator命令用来恢复缺省情况。

【命令】

operator { and | or }

undo operator

【缺省情况】

过滤条件之间的关系为逻辑与。

【视图】

过滤器视图

【缺省用户角色】

network-admin

【参数】

and：表示逻辑与。只有所有条件都满足时，设备才会将采样路径的数据推送给采集器。

or：表示逻辑或。只要任意条件满足时，设备就会将采样路径的数据推送给采集器。

【举例】

# 配置传感器组使用灵活模式进行采样，在传感器组test下，配置采样路径为ifmgr/devicecapabilities，并在过滤器filter1中配置过滤条件之间的关系为or。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor-path-flex ifmgr/devicecapabilities

[Sysname-telemetry-sensor-group-test-path] filter filter1

[Sysname-telemetry-sensor-group-test-path-filter] operator or

【相关命令】

·     Filter

1.3.13  protocol

protocol命令用来配置设备发送订阅报文的传输协议。

undo protocol命令用来恢复缺省情况。

【命令】

protocol { grpc | udp }

undo protocol

【缺省情况】

设备发送订阅报文的传输协议为gRPC。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

grpc：订阅报文的传输协议为gRPC。此时传输层使用TCP协议。

udp：订阅报文的传输协议为UDP。

【使用指导】

多次执行本命令，最新一次执行的命令生效。

订阅绑定传感器组和目标组后，需要移除所有传感器组或目标组，才能配置本命令。

【举例】

# 配置设备发送订阅A的报文的传输协议为UDP。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A] protocol udp

1.3.14  sensor-path-flex

sensor-path-flex命令用来配置采样路径，并进入采样路径视图。

undo sensor-path-flex命令用来删除采样路径。

【命令】

sensor-path-flex path

undo sensor-path-flex path

【缺省情况】

未配置采样路径。

【视图】

传感器组视图

【缺省用户角色】

network-admin

【参数】

path：采样路径名称，配置时需要完整输入，不区分大小写，执行sensor-path-flex ?命令，通过帮助信息可获得该参数的取值。

【使用指导】

配置本命令之前，需要先在Telemetry视图下使用grpc sensor-mode flex命令配置传感器组使用灵活模式进行采样。

设备支持配置的采样路径数量上限为128。

通过sensor-group (subscription view)命令将传感器组关联到订阅后，如需修改该传感器组的采样路径配置，请先解除订阅关系。

采样路径为ifmgr/statistics时，支持在路径后直接附加索引条件[ifindex=”index”]。index表示接口名称或接口索引，不区分大小写。需要注意的是：

·     采样路径附加索引条件时，不支持再配置其他过滤条件。

·     同一采样路径最多支持64个索引条件，只要满足其中一个索引条件，设备就会推送数据。

·     index的最后一个字符可以为通配符“*”，例如sensor-path-flex ifmgr/statistics[ifindex="gigabitethernet1/0/*"]。

【举例】

# 配置传感器组使用灵活模式进行采样，在传感器组test中配置采样路径ifmgr/devicecapabilities，并进入采样路径视图。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] grpc sensor-mode flex

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor-path-flex ifmgr/devicecapabilities

[Sysname-telemetry-sensor-group-test-path]

【相关命令】

·     grpc sensor-mode

·     sensor-group (subscription view)

1.3.15  sensor path

sensor path命令用来配置采样路径。

undo sensor path命令用来删除采样路径。

【命令】

sensor path path [ condition node node operator operator value value | depth depth ]

undo sensor path path [ condition node node operator operator ]

【缺省情况】

未配置采样路径。

【视图】

传感器组视图

【缺省用户角色】

network-admin

【参数】

path：采样路径名称，配置时需要完整输入，不区分大小写，执行sensor path ?命令，通过帮助信息可获得该参数的取值。

condition：为周期采样类型的采样路径配置过滤条件，只有指定节点采样的数据满足比较运算的条件时，该采样路径才会推送数据给采集器。如果未指定本参数，则采样路径不设过滤条件。

node node：表示节点名称，配置时需要完整输入，不区分大小写，执行sensor path path condition node ?命令，通过帮助信息可获得该参数的取值。

operator operator：比较运算符。支持的比较运算符以具体节点为准。operator的取值包括：

·     eq：等于。

·     ge：大于等于。

·     gt：大于。

·     le：小于等于。

·     lt：小于。

·     ne：不等于。

value value：比较运算的参考值。

depth depth：为周期采样类型的采样路径配置采样深度。depth为采样深度值，取值范围为1～3，缺省值为1。各取值的含义为：

·     采样深度为1时，设备只上报当前采样路径的所有列数据。

·     采样深度为2时，设备除了上报当前采样路径的列数据外，还会上报当前采样路径下所有子表的列数据。

·     采样深度为3时，设备除了上报当前采样路径的列数据外，还会上报当前采样路径下所有子表以及这些子表的所有子表的列数据。

【使用指导】

多次执行本命令可配置多个采样路径和过滤条件。同一采样路径最多支持5个过滤条件，只有这些条件都满足时才推送数据。

设备支持配置的采样路径数量上限为128。

通过sensor-group (subscription view)命令将传感器组关联到订阅后，如需修改该传感器组的采样路径配置，请先解除订阅关系。

采样路径为ifmgr/statistics时，支持在路径后直接附加索引条件[ifindex=”index”]。index表示接口名称或接口索引，不区分大小写。需要注意的是：

·     采样路径附加索引条件时，不支持再配置过滤条件（condition参数）；反之亦然。

·     同一采样路径最多支持64个索引条件，只要满足其中一个索引条件，设备就会推送数据。

·     index的最后一个字符可以为通配符“*”，例如sensor path ifmgr/statistics[ifindex="GigabitEthernet1/0/*"]。

【举例】

# 在传感器组test中配置采样路径为ifmgr/devicecapabilities。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor path ifmgr/devicecapabilities

# 在传感器组test中，配置采样路径为device/base，仅当节点uptime大于等于377时，该采样路径才会推送数据给采集器。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test] sensor path device/base condition node uptime operator ge value 377

【相关命令】

·     sensor-group (subscription view)

1.3.16  sensor-group (subscription view)

sensor-group命令用来配置关联传感器组。

undo sensor-group命令用来删除关联传感器组。

【命令】

sensor-group group-name [ sample-interval [ msec ] interval ]

undo sensor-group group-name

【缺省情况】

未配置关联传感器组。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

group-name：传感器组的名称，为1～31个字符的字符串，区分大小写。

sample-interval：配置传感器组以固定的周期采样并推送数据。如果未指定该参数，则表示由事件触发数据采样，传感器组不进行周期采样。

[ msec ] interval：采样周期。

·     未指定msec参数时，取值范围为1～86400，单位为秒。

·     指定msec参数时，取值范围为10或100～900，单位为毫秒。其中100～900之间为100的倍数。

【使用指导】

本命令配置的传感器组将会和同一订阅视图下的目标组自动关联。

本命令指定的传感器组需要先在Telemetry视图下使用sensor-group命令创建。

当传感器组中的采样路径为事件触发类型时，请不要配置sample-interval参数，否则该采样路径不生效；当采样路径为周期采样类型时，必须配置sample-interval参数才会采样和推送数据。

采样周期建议不低于1秒。1秒以下的采样周期与硬件能力相关，采样周期为10毫秒、100毫秒时，可能统计不完整。

配置采样周期为10毫秒时，注意：

·     订阅的传感器组中，只有附加[ifindex=”index”]条件的ifmgr/statistics采样路径支持该采样周期，例如sensor path ifmgr/statistics[ifindex="Ten-GigabitEthernet3/1/1"]。其他采样路径将以其支持的最小采样周期进行采样。

·     订阅报文的传输协议必须配置为UDP（相关命令为protocol），ifmgr/statistics采样路径才支持该采样周期。

·     传感器组中，每个slot上ifmgr/statistics路径支持采样的接口数量上限为4个。

【举例】

# 在订阅A中配置关联传感器组为test，数据采样和推送周期为10秒。

<Sysname> system-view

[Sysname] telemetry

[Device-telemetry] subscription A

[Device-telemetry-subscription-A] sensor-group test sample-interval 10

【相关命令】

·     protocol

·     sensor-group (telemetry view)

1.3.17  sensor-group (telemetry view)

sensor-group命令用来创建传感器组，并进入传感器组视图。如果指定的传感器组已经存在，则直接进入传感器组视图。

undo sensor-group命令用来删除传感器组。

【命令】

sensor-group group-name

undo sensor-group group-name

【缺省情况】

不存在传感器组。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

【参数】

group-name：传感器组的名称，为1～31个字符的字符串，区分大小写。

【使用指导】

设备支持配置的传感器组数量上限为32。

通过sensor-group (subscription view)命令将传感器组关联到订阅后，如需删除该传感器组，请先解除订阅关系。

【举例】

# 创建名为test的传感器组。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test]

【相关命令】

·     sensor-group (subscription view)

·     subscription

1.3.18  source-address

source-address命令用来配置设备发送订阅报文的源地址。

undo source-address命令用来恢复缺省情况。

【命令】

source-address { ipv4-address | interface interface-type interface-number | ipv6 ipv6-address }

undo source-address

【缺省情况】

设备使用路由出接口的主IP地址作为发送订阅报文的源IP地址。

【视图】

订阅视图

【缺省用户角色】

network-admin

【参数】

ipv4-address：设置设备发送订阅报文的源IPv4地址。

interface interface-type interface-number：设置设备发送订阅报文的源接口，interface-type interface-number表示接口类型和接口编号，目前仅支持LoopBack接口。此接口下配置的主IPv4地址即为发送报文的源地址。如果该接口没有配置主IPv4地址，则设备依次使用该接口的从IPv4地址、或路由出接口的主IP地址作为发送订阅报文的源IP地址。

ipv6 ipv6-address：设置设备发送订阅报文的源IPv6地址。

【使用指导】

多次执行本命令，最新一次执行的命令生效。

当设备发送订阅报文的源地址发生变化时，设备将会重新连接gRPC服务器。

【举例】

# 配置设备发送订阅A的报文的源IPv4地址为169.254.1.1。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A] source-address 169.254.1.1

1.3.19  subscription

subscription命令用来创建订阅，并进入订阅视图。如果指定的订阅已经存在，则直接进入订阅视图。

undo subscription命令用来删除订阅。

【命令】

subscription subscription-name

undo subscription subscription-name

【缺省情况】

不存在订阅。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

【参数】

subscription-name：订阅的名称，为1～31个字符的字符串，区分大小写。

【使用指导】

设备支持配置的订阅数量上限为10。

【举例】

# 创建名为A的订阅。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A]

【相关命令】

·     destination-group (subscription view)

·     sensor-group (subscription view)

1.3.20  telemetry

telemetry命令用来从系统视图进入Telemetry视图。

【命令】

telemetry

【视图】

系统视图

【缺省用户角色】

network-admin

【使用指导】

进入Telemetry视图后，可以配置Telemetry功能的相关参数。

【举例】

# 从系统视图进入Telemetry视图。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry]