12-Telemetry Command Reference

HomeSupportResource CenterH3C S6520X & S6520-SI & S5560X-HI & S5000-EI Switch Series Command References-R65xx-6W10012-Telemetry Command Reference
Table of Contents
Related Documents
01-gRPC commands
Title Size Download
01-gRPC commands 101.62 KB

gRPC commands

Generic gRPC commands

grpc enable

Use grpc enable to enable the gRPC service.

Use undo grpc enable to disable the gRPC service.

Syntax

grpc enable

undo grpc enable

Default

The gRPC service is disabled.

Views

System view

Predefined user roles

network-admin

Usage guidelines

You must enable the gRPC service before you can configure gRPC-related settings.

Disabling the gRPC service deletes all gRPC-related settings.

Examples

# Enable the gRPC service.

<Sysname> system

[Sysname] grpc enable

grpc pki domain

Use grpc pki domain to specify the PKI domain for secure gRPC connections to collectors.

Use undo grpc pki domain to restore the default.

Syntax

grpc pki domain domain-name

undo grpc pki domain

Default

No PKI domain is specified for secure gRPC connections to collectors.

Views

System view

Predefined user roles

network-admin

Parameters

domain-name: Specifies a PKI domain by its name, a case-insensitive string of 1 to 31 characters.

Usage guidelines

By default, the gRPC connection between the device and a collector does not provide data encryption service or require authentication. After you specify a PKI domain, the device and the collector will use TLS for data encryption and bidirectional certificate-based authentication to improve communication security.

For the device to establish gRPC connections to collectors successfully, make sure the PKI domain already exists and has correct certificate and key settings. For more information about PKI configuration, see Security Configuration Guide.

Executing this command reboots the gRPC service and closes all gRPC connections to collectors. In dial-in mode, the collectors must re-initiate the connections. In dial-out mode, the device will automatically re-initiate the connections.

Examples

# Specify the PKI domain for secure gRPC connections to collectors.

<Sysname> system-view

[Sysname] grpc pki domain grpc_test

gRPC dial-in mode commands

display grpc

Use display grpc to display gRPC dial-in mode information.

Syntax

display grpc

Views

Any view

Predefined user roles

network-admin

network-operator

Examples

# Display gRPC dial-in mode information.

<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:2018-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

Table 1 Command output

Field

Description

gRPC status

Status of the gRPC service:

·     enabled—The gRPC service is enabled.

·     disabled—The gRPC service is disabled.

gRPC idle-timeout

Setting for the gRPC session idle timeout timer.

Session count

Number of gRPC sessions.

Idle time

Duration in which the session idle timeout timer will expire. If the value of this field is 0, gRPC sessions will never be timed out.

Received error RPCs

Number of received erroneous gRPC requests.

Received subscription

Number of received gRPC subscription requests.

 

grpc idle-timeout

Use grpc idle-timeout to set the gRPC session idle timeout timer.

Use undo grpc idle-timeout to restore the default.

Syntax

grpc idle-timeout minutes

undo grpc idle-timeout

Default

The gRPC session idle timeout timer is 5 minutes.

Views

System view

Predefined user roles

network-admin

Parameters

minutes: Specifies the gRPC session idle timeout timer in minutes, in the range of 0 to 30. To disable gRPC sessions from being timed out, set it to 0.

Usage guidelines

If no gRPC packet exchanges occur on the session between a gRPC and the server before the idle timeout timer expires, the device closes the session.

Examples

# Set the gRPC session idle timeout timer to 6 minutes.

<Sysname> system

[Sysname] grpc idle-timeout 6

grpc log dial-in gnmi

Use grpc log dial-in gnmi to enable gRPC logging for gNMI operations in dial-in mode.

Use undo grpc log dial-in gnmi to disable gRPC logging for gNMI operations in dial-in mode.

Syntax

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

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

Default

In dial-in mode, gRPC logging is enabled for gNMI Set operations and disabled for other gNMI operations.

Views

System view

Predefined user roles

network-admin

Parameters

all: Specifies all gNMI operations.

capabilities: Specifies the gNMI Capabilities operations.

get: Specifies the gNMI Get operations.

set: Specifies the gNMI Set operations.

subscribe: Specifies the gNMI Subscribe operations.

Usage guidelines

To identify gRPC issues, enable gNMI operations logging in dial-in mode.

This command generates gNMI operation logs in dial-in mode and sends them to the information center. With the information center, you can configure log destinations and output rules. For more information about the information center, see Network Management and Monitoring Configuration Guide.

If you execute this command multiple times, the most recent configuration takes effect.

Examples

# Enable gRPC logging for gNMI Get operations in dial-in mode.

<Sysname> system

[Sysname] grpc log dial-in gnmi get

grpc log dial-in rpc

Use grpc log dial-in rpc to enable gRPC logging for RPC operations in dial-in mode.

Use undo grpc log dial-in rpc to disable gRPC logging for RPC operations in dial-in mode.

Syntax

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

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

Default

In dial-in mode, gRPC logging is disabled for RPC operations.

Views

System view

Predefined user roles

network-admin

Parameters

all: Specifies both RPC CLI and Get operations.

cli: Specifies the RPC CLI operations.

get: Specifies the RPC Get operations.

Usage guidelines

To identify gRPC issues, enable RPC operations logging in dial-in mode.

This command generates RPC operation logs in dial-in mode and sends them to the information center. With the information center, you can configure log destinations and output rules. For more information about the information center, see Network Management and Monitoring Configuration Guide.

If you execute this command multiple times, the most recent configuration takes effect.

Examples

# Enable gRPC logging for RPC Get operations in dial-in mode.

<Sysname> system

[Sysname] grpc log dial-in gnmi get

grpc port

Use grpc port to specify the gRPC service port number.

Use undo grpc port to restore the default.

Syntax

grpc port port-number

undo grpc port

Default

The gRPC service port number is 50051.

Views

System view

Predefined user roles

network-admin

Parameters

port-number: Specifies the gRPC service port number, in the range of 1 to 65535.

Usage guidelines

Changing the gRPC service port number reboots the gRPC service and disconnects all sessions established between the gRPC server and its gRPC clients. The gRPC clients must reinitiate the sessions.

If the specified port number is not available (for example, the port number is already used), the gRPC service reboots to use the original port number.

If you execute this command multiple times, the most recent configuration takes effect.

Examples

# Set the gRPC service port number to 50052.

<Sysname> system

[Sysname] grpc port 50052

Related commands

grpc enable

gRPC dial-out mode commands

destination-group (subscription view)

Use destination-group to specify a destination group for a subscription.

Use undo destination-group to remove a destination group from a subscription.

Syntax

destination-group group-name

undo destination-group group-name

Default

A subscription does not have a destination group.

Views

Subscription view

Predefined user roles

network-admin

Parameters

group-name: Specifies a destination group by its name, a case-sensitive string of 1 to 31 characters.

Usage guidelines

A subscription binds sensor groups to destination groups. Then, the device pushes data from the specified sensors to the collectors.

The specified destination group must have been created by using the destination-group command in telemetry view.

You can specify a maximum of five destination groups for a subscription.

Examples

# Specify destination group collector1 for subscription A.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

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

Related commands

destination-group (telemetry view)

destination-group (telemetry view)

Use destination-group to create a destination group and enter its view, or enter the view of an existing destination group.

Use undo destination-group to delete a destination group.

Syntax

destination-group group-name

undo destination-group group-name

Default

No destination groups exist.

Views

Telemetry view

Predefined user roles

network-admin

Parameters

group-name: Specifies the destination group name, a case-sensitive string of 1 to 31 characters.

Usage guidelines

As a best practice, configure a maximum of five destination groups. Configuring too many destination groups might degrade the system performance.

To delete a destination group that is already used by a subscription, you must remove the destination group from the subscription first.

Examples

# Create a destination group named collector1.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

[Sysname-telemetry-destination-group-collector1]

Related commands

destination-group (subscription view)

subscription

dscp

Use dscp to set the DSCP value for packets sent to collectors.

Use undo dscp to restore the default.

Syntax

dscp dscp-value

undo dscp

Default

The DSCP value for packets sent to collectors is 0.

Views

Subscription view

Predefined user roles

network-admin

Parameters

dscp-value: Specifies the DSCP value for packets sent to collectors, in the range of 0 to 63.

Usage guidelines

A greater DSCP value represents a higher priority.

If you execute this command multiple times in the same view, the most recent configuration takes effect.

Examples

# Set the DSCP value for packets sent to collectors to 12 for subscription A.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A] dscp 12

grpc log dial-out

Use grpc log dial-out to enable gRPC logging in dial-out mode.

Use undo grpc log dial-out to disable gRPC logging in dial-out mode.

Syntax

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

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

Default

In dial-out mode, gRPC logging is disabled.

Views

System view

Predefined user roles

network-admin

Parameters

all: Specifies all sampling types.

event: Specifies event-triggered sampling.

sample: Specifies periodical sampling.

Usage guidelines

To identify gRPC issues, enable gRPC sampling logging in dial-out mode.

This command generates gRPC sampling logs in dial-out mode and sends them to the information center. With the information center, you can configure log destinations and output rules. For more information about the information center, see Network Management and Monitoring Configuration Guide.

If you execute this command multiple times, the most recent configuration takes effect.

Examples

# Enable gRPC logging for periodical sampling in dial-out mode.

<Sysname> system

[Sysname] grpc log dial-in gnmi get

 

ipv4-address

Use ipv4-address to add an IPv4 collector to a destination group.

Use undo ipv4-address to remove an IPv4 collector from a destination group.

Syntax

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 ]

Default

A destination group does not have IPv4 collectors.

Views

Destination group view

Predefined user roles

network-admin

Parameters

ipv4-address: Specifies the IPv4 address of the collector.

port port-number: Specifies the listening port of the collector, in the range of 1 to 65535. The default is 50051.

vpn-instance vpn-instance-name: Specifies the VPN instance to which the collector belongs. The vpn-instance-name argument represents the VPN instance name, a case-sensitive string of 1 to 31 characters. If the collector belongs to the public network, do not specify this option.

Usage guidelines

To add multiple collectors to a destination group, execute this command multiple times.

One collector must have a different address, port, or VPN instance than the other collectors.

You can specify a maximum of five collectors for a destination group.

To modify the collector configuration for a destination group that is already used by a subscription, you must remove the destination group from the subscription first.

Examples

# Add a collector that uses IPv4 address 192.168.21.21 and the default port number to destination group collector1.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

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

Related commands

destination-group (subscription view)

subscription

ipv6-address

Use ipv6-address to add an IPv6 collector to a destination group.

Use undo ipv6-address to remove an IPv6 collector from a destination group.

Syntax

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 ]

Default

A destination group does not have IPv6 collectors.

Views

Destination group view

Predefined user roles

network-admin

Parameters

ipv6-address: Specifies the IPv6 address of the collector. The IPv6 address cannot be a link-local address. For more information about link-local addresses, see IPv6 basics configuration in Layer 3—IP Services Configuration Guide.

port port-number: Specifies the listening port of the collector, in the range of 1 to 65535. The default is 50051.

vpn-instance vpn-instance-name: Specifies the VPN instance to which the collector belongs. The vpn-instance-name argument represents the VPN instance name, a case-sensitive string of 1 to 31 characters. If the collector belongs to the public network, do not specify this option.

Usage guidelines

To add multiple collectors to a destination group, execute this command multiple times.

One collector must have a different address, port, or VPN instance than the other collectors.

You can specify a maximum of five collectors for a destination group.

To modify the collector configuration for a destination group that is already used by a subscription, you must remove the destination group from the subscription first.

Examples

# Add a collector that uses IPv6 address 1::1 and the default port number to destination group collector1.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] destination-group collector1

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

Related commands

destination-group (subscription view)

subscription

sensor path

Use sensor path to configure a sensor path.

Use undo sensor path to delete a sensor path.

Syntax

sensor path path

undo sensor path path

Default

No sensor paths exist.

Views

Sensor group view

Predefined user roles

network-admin

Parameters

path: Specifies a data path. For information about the available paths, enter a question mark (?) in the position of this argument.

Usage guidelines

To configure multiple sensor paths, execute this command multiple times.

The device supports a maximum of 128 sensor paths.

A sensor path can have a maximum of five data push conditions. The device pushes data of the sensor path to collectors only when all relevant conditions are met.

To modify the sensor path configuration for a sensor group that is already used by a subscription, you must remove the sensor group from the subscription first.

Examples

# Configure sensor path ifmgr/devicecapabilities/ for sensor group test.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] sensor-group test

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

Related commands

sensor-group (subscription view)

subscription

sensor-group (subscription view)

Use sensor-group to specify a sensor group for a subscription.

Use undo sensor-group to remove a sensor group from a subscription.

Syntax

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

undo sensor-group group-name

Default

A subscription does not have a sensor group.

Views

Subscription view

Predefined user roles

network-admin

Parameters

group-name: Specifies a sensor group by its name, a case-sensitive string of 1 to 31 characters.

sample-interval: Specifies that the sensor group sample and push data at intervals. If you do not specify this keyword, the sensor group samples and pushes data only when triggered by events.

msec: Specifies the data sampling interval in milliseconds. If you do not specify this keyword, specify the data sampling interval in seconds.

interval: Specifies the data sampling interval. If you do not specify the msec keyword, the value range is 1 to 86400. If you specify the msec keyword, the data sampling interval must be a multiple of 100 in the range of 100 to 900.

Usage guidelines

Specify the sample-interval interval option for periodic sensor paths and only for periodic sensor paths.

·     If you specify the option for event-triggered sensor paths, the sensor paths do not take effect.

·     If you do not specify the option for periodic sensor paths, the device does not sample or push data.

The specified sensor group must have been created by using the sensor-group command in telemetry view.

To change the data sampling interval for a sensor group after you specify a destination group for the subscription, you must complete the following tasks:

1.     Remove the sensor group from the subscription.

2.     Specify the sensor group for the subscription again and set the new data sampling interval for the sensor group.

Examples

# Specify sensor group test for subscription A. Set the data sampling interval to 10 seconds.

<Sysname> system-view

[Sysname] telemetry

[Device-telemetry] subscription A

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

Related commands

sensor path

sensor-group (telemetry view)

sensor-group (telemetry view)

Use sensor-group to create a sensor group and enter its view, or enter the view of an existing sensor group.

Use undo sensor-group to delete a sensor group.

Syntax

sensor-group group-name

undo sensor-group group-name

Default

No sensor groups exist.

Views

Telemetry view

Predefined user roles

network-admin

Parameters

group-name: Specifies the sensor group name, a case-sensitive string of 1 to 31 characters.

Usage guidelines

The device supports a maximum of 32 sensor groups.

To delete a sensor group that is already used by a subscription, you must remove the sensor group from the subscription first.

Examples

# Create a sensor group named test.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] sensor-group test

[Sysname-telemetry-sensor-group-test]

Related commands

sensor-group (subscription view)

subscription

source-address

Use source-address to specify the source IP address for packets sent to collectors.

Use undo source-address to restore the default.

Syntax

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

undo source-address

Default

The device uses the primary IPv4 address of the output interface for the route to the collectors as the source address.

Views

Subscription view

Predefined user roles

network-admin

Parameters

ipv4-address: Specifies an IPv4 address.

interface interface-type interface-number: Specifies an interface by its type and number. In the current software version, you must specify a loopback interface. The device will use the interface's primary IPv4 address as the source address. If the interface does not have a primary IPv4 address, the device uses the primary IPv4 address of the output interface for the route to the collectors.

Usage guidelines

If you execute this command multiple times, the most recent configuration takes effect.

Changing the source IP address for packets sent to collectors causes the device to re-establish the connection to the gRPC server.

Examples

# Specify the source IPv4 address of 169.254.1.1 for packets sent to collectors.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

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

subscription

Use subscription to create a subscription and enter its view, or enter the view of an existing subscription.

Use undo sensor-group to delete a subscription.

Syntax

subscription subscription-name

undo subscription subscription-name

Default

No subscription exists.

Views

Telemetry view

Predefined user roles

network-admin

Parameters

subscription-name: Specifies the subscription name, a case-sensitive string of 1 to 31 characters.

Usage guidelines

The device supports a maximum of 10 subscriptions.

Examples

# Configure a subscription named A.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry] subscription A

[Sysname-telemetry-subscription-A]

Related commands

destination-group (subscription view)

sensor-group (subscription view)

telemetry

Use telemetry to enter telemetry view.

Syntax

telemetry

Views

System view

Predefined user roles

network-admin

Usage guidelines

In telemetry view, you can configure telemetry parameters.

Examples

# Enter telemetry view.

<Sysname> system-view

[Sysname] telemetry

[Sysname-telemetry]