目  录

1 gRPC

1.1 gRPC通用配置命令

1.1.1 grpc enable

1.1.2 grpc pki domain

1.2 gRPC Dial-in模式配置命令

1.2.1 display grpc

1.2.2 grpc idle-timeout

1.2.3 grpc port

1.3 gRPC Dial-out模式配置命令

1.3.1 destination-group (subscription view)

1.3.2 destination-group (telemetry view)

1.3.3 dscp

1.3.4 ipv4-address

1.3.5 ipv6-address

1.3.6 sensor path

1.3.7 sensor-group (subscription view)

1.3.8 sensor-group (telemetry view)

1.3.9 source-address

1.3.10 subscription

1.3.11 telemetry

 

1 gRPC

1.1  gRPC通用配置命令

1.1.1  grpc enable

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

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

【命令】

grpc enable

undo grpc enable

【缺省情况】

gRPC功能处于关闭状态。

【视图】

系统视图

【缺省用户角色】

network-admin

context-admin

【使用指导】

只有开启gRPC功能后，才能进行gRPC相关的配置（grpc pki domain命令除外）。

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

【举例】

# 开启gRPC功能。

<Sysname> system

[Sysname] grpc enable

1.1.2  grpc pki domain

grpc pki domain命令用来指定与采集器进行SSL通信时使用的PKI域。

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

【命令】

grpc pki domain domain-name

undo grpc pki domain

【缺省情况】

未指定与采集器进行SSL通信时使用的PKI域。

【视图】

系统视图

【缺省用户角色】

network-admin

context-admin

【参数】

domain-name：表示与采集器进行SSL通信时使用的PKI域名称，为1～31个字符的字符串，区分大小写。指定的PKI域必须存在，并且PKI域中包含完整的证书和密钥，否则设备不能和采集器建立gRPC连接。PKI域的详细介绍，请参见“安全配置指导”中的“PKI”。

【使用指导】

与采集器进行SSL通信时需要通过本命令指定PKI域。

请在开启gRPC功能之前配置本功能。如果已经开启了gRPC功能，则配置不会生效。

【举例】

# 指定与采集器进行SSL通信时使用的PKI域为grpc_test，然后开启gRPC功能。

<Sysname> system-view

[Sysname] grpc pki domain grpc_test

[Sysname] grpc enable

【相关命令】

·     grpc enable

1.2  gRPC Dial-in模式配置命令

1.2.1  display grpc

display grpc命令用来显示gRPC Dial-in模式的相关信息。

【命令】

display grpc

【视图】

任意视图

【缺省用户角色】

network-admin

network-operator

context-admin

context-operator

【举例】

# 显示gRPC Dial-in模式的相关信息。

<Sysname> display grpc

gRPC status : enabled.

gRPC port : 50051

gRPC idle-timeout : 3 minutes

Session count: 1.

  Session ID: 1

    User name: test

    Login time:2011-01-05 06:46:43 Idle time : 2 mins 56 s

    Client IP address : 169.254.100.170:40810

    Received RPCs        : 0         Received error RPCs : 0

    Received subscription: 0         Output notifications: 0

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

字段	描述
gRPC status	gRPC功能状态： ·     enabled：表示gRPC功能处于开启状态 ·     disabled：表示gRPC功能处于关闭状态
gRPC port	gRPC服务使用的端口号
gRPC 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 error RPCs	设备接收到的错误gRPC请求报文数量
Received subscription	设备接收到的gRPC订阅请求报文数量
Output notifications	设备上报通知的数量

 

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

context-admin

【参数】

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

【使用指导】

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

【举例】

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

<Sysname> system

[Sysname] grpc idle-timeout 6

1.2.3  grpc port

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

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

【命令】

grpc port port-number

undo grpc port

【缺省情况】

gRPC服务的端口号为50051。

【视图】

系统视图

【缺省用户角色】

network-admin

context-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  destination-group (subscription view)

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

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

【命令】

destination-group group-name

undo destination-group group-name

【缺省情况】

未配置关联目标组。

【视图】

订阅视图

【缺省用户角色】

network-admin

context-admin

【参数】

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

【使用指导】

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

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

每个订阅可关联的目标组数量上限与设备的型号有关，请以设备的实际情况为准。

【举例】

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

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

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

【相关命令】

·     destination-group (telemetry view)

1.3.2  destination-group (telemetry view)

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

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

【命令】

destination-group group-name

undo destination-group group-name

【缺省情况】

不存在目标组。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

context-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)

1.3.3  dscp

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

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

【命令】

dscp dscp-value

undo dscp

【缺省情况】

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

【视图】

订阅视图

【缺省用户角色】

network-admin

context-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.4  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

context-admin

【参数】

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

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

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

【使用指导】

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

每个目标组支持配置的采集器数量上限与设备的型号有关，请以设备的实际情况为准。

通过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)

1.3.5  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

context-admin

【参数】

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

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

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

【使用指导】

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

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

每个目标组支持配置的采集器数量上限与设备的型号有关，请以设备的实际情况为准。

通过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)

1.3.6  sensor path

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

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

【命令】

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

undo sensor path path [ condition node node operator operator ]

【缺省情况】

未配置采样路径。

【视图】

传感器组视图

【缺省用户角色】

network-admin

context-admin

【参数】

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

condition：表示设置采样路径的推送条件，只有当指定节点满足指定条件时才会将采样路径的数据推送给采集器。如果未指定本参数，则采样路径不设推送条件。

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

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

·     eq：等于。

·     ge：大于等于。

·     gt：大于。

·     le：小于等于。

·     lt：小于。

·     ne：不等于。

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

【使用指导】

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

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

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

【举例】

# 在传感器组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.7  sensor-group (subscription view)

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

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

【命令】

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

undo sensor-group group-name

【缺省情况】

未配置关联传感器组。

【视图】

订阅视图

【缺省用户角色】

network-admin

context-admin

【参数】

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

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

msec：表示配置的周期为毫秒级。不指定该参数时，表示配置的周期为秒级。

interval：数据采样和推送周期。

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

·     指定msec参数时，取值范围为100～900，且为100的倍数，单位为毫秒。

【使用指导】

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

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

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

传感器组与订阅中的目标组关联后，如需修改该传感器组的sample-interval参数，请先解除订阅关系。

【举例】

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

<Sysname> system-view

[Sysname] telemetry

[Device-telemetry] subscription A

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

【相关命令】

·     sensor path

·     sensor-group (telemetry view)

1.3.8  sensor-group (telemetry view)

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

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

【命令】

sensor-group group-name

undo sensor-group group-name

【缺省情况】

不存在传感器组。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

context-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)

1.3.9  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

context-admin

【参数】

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

interface interface-type interface-number：设置设备发送订阅报文的源接口，interface-type interface-number表示接口类型和接口编号，目前仅支持LoopBack接口。此接口下配置的主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.10  subscription

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

undo subscription命令用来删除订阅。

【命令】

subscription subscription-name

undo subscription subscription-name

【缺省情况】

不存在订阅。

【视图】

Telemetry视图

【缺省用户角色】

network-admin

context-admin

【参数】

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

【使用指导】

设备支持配置的订阅数量上限与设备的型号有关，请以设备的实际情况为准。

【举例】

# 创建名为A的订阅。

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A]

【相关命令】

·     destination-group (subscription view)

·     sensor-group (subscription view)

1.3.11  telemetry

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

【命令】

telemetry

【视图】

系统视图

【缺省用户角色】

network-admin

context-admin

【使用指导】

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

【举例】

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

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry]