17-Telemetry Command Reference

HomeSupportResource CenterSwitchesS12500R SeriesS12500R SeriesTechnical DocumentsReference GuidesCommand ReferencesH3C S12500R Switch Router Series Command References(R51xx)-6W10117-Telemetry Command Reference
02-Telemetry stream commands
Title Size Download
02-Telemetry stream commands 66.72 KB

Telemetry stream commands

This feature does not take effect on traffic of Layer 3 aggregate interfaces and subinterfaces.

display telemetry stream

Use display telemetry stream to display telemetry stream configuration.

Syntax

display telemetry stream

Views

Any view

Predefined user roles

network-admin

network-operator

Examples

# Display telemetry stream configuration.

[Sysname] display telemetry stream

Telemetry stream status          : Enabled

Telemetry stream timestamp status: Disabled

Telemetry stream device ID       : 10.0.0.3

Telemetry stream action:

  HundredGigE1/0/1:

    Telemetry stream action 1:

      ACL    : user-defined abc

      Sampler: samp

    Telemetry stream action 2:

      ACL    : user-defined abcd

      Sampler: samp

Telemetry stream collector:

  Source IP       : 20.0.0.2

  Destination IP  : 30.0.0.1

  Source port     : 12

  Destination port: 14

  VPN instance    : abc

  Destination MAC : 0CDA-411D-9F4C

  VLAN ID         : N/A

  Output Interface: HundredGigE1/0/1(Failed)

Table 1 Command output

Field

Description

Telemetry stream status

Telemetry stream status:

·     Enabled.

·     Disabled.

Telemetry stream timestamp status

Telemetry stream timestamp status:

·     Enabled.

·     Disabled.

Telemetry stream action

Telemetry stream action:

·     Inactive indicates that the action is not issued because telemetry stream is disabled.

·     Failed indicates that the action fails to be issued.

Telemetry stream collector

Addressing parameters for telemetry stream packets. The following fields appear only if telemetry stream timestamp is disabled:

·     Destination MAC.

·     VLAN ID.

·     Output Interface—Output interface name.

telemetry stream action

Use telemetry stream action to configure a telemetry stream action.

Use undo telemetry stream action to delete a telemetry stream action.

Syntax

telemetry stream action action-id [ acl [ ipv6 | mac | user-defined ]  { acl-number | name acl-name } | sampler sampler-name ] *

undo telemetry stream action action-id

Default

No telemetry stream action is configured.

Views

Interface view

Predefined user roles

network-admin

Parameters

action-id: Specifies an action ID in the range of 1 to 32.

acl: Specifies an ACL.

·     ipv6: Specifies the IPv6 ACL type.

·     mac: Specifies the Layer 2 ACL type.

·     user-defined: Specifies the user-defined ACL type.

·     acl-number: Specifies the ACL number. The following are available value ranges:

¡     2000 to 2999 for basic ACLs.

¡     3000 to 3999 for advanced ACLs.

¡     4000 to 4999 for Layer 2 ACLs.

¡     5000 to 5999 for user-defined ACLs.

·     name acl-name: Specifies the ACL name, a case-insensitive string of 1 to 63 characters.

sampler sampler-name: Specifies a sampler by its name, a case-insensitive string of 1 to 31 characters. If you do not specify a sampler, all matching packets are mirrored.

Usage guidelines

When receiving a packet on an interface configured with a telemetry stream action, the device performs the following operations:

·     Copies the packet.

·     Encapsulates the copied packet with the configured addressing parameters.

·     Sends it to the collector.

Specifying an ACL limits telemetry stream to the traffic that matches the ACL. To specify an IPv4 ACL, do not specify the mac, ipv6, or user-defined keyword. To specify a Layer 2 or user-defined ACL, you must specify the mac or user-defined keyword before specifying the ACL number or name.

If the specified ACL does not exist or does not contain rules, no packets match the ACL and no packets are copied.

Specifying a sampler reduces the number of packets copied and sent to the collector, but provides less granular monitoring.

If no VPN instance is specified in an ACL rule, the rule applies to both non-VPN packets and VPN packets.

To collect data on MPLS packets, you must specify a Layer 2 ACL that matches the link layer protocol type 8847.

For information about ACLs, see ACL and QoS Configuration Guide.

Examples

# Configure telemetry stream action 1 on HundredGigE 1/0/1 to use sampler samp.

<Sysname> system-view

[Sysname] interface hundredgige 1/0/1

[Sysname-HundredGigE1/0/1] telemetry stream 1 sampler samp

telemetry stream collector

Use telemetry stream collector to configure the addressing parameters to encapsulate in telemetry stream packets sent to the collector.

Use undo telemetry stream collector to restore the default.

Syntax

telemetry stream collector source source-address destination destination-address source-port source-port destination-port destination-port [ vpn-instance vpn-instance-name ]

undo telemetry stream collector

Default

No addressing parameters are configured for telemetry stream packets.

Views

System view

Predefined user roles

network-admin

Parameters

source source-address: Specifies the source IP address for telemetry stream packets.

destination destination-address: Specifies the destination IP address for telemetry stream packets.

source-port source-port: Specifies the source port number for telemetry stream packets.

destination-port destination-port: Specifies the destination port number for telemetry stream packets.

vpn-instance vpn-instance-name: Specifies a VPN instance by its name, a case-sensitive string of 1 to 31 characters. If you do not specify a VPN instance, the device forwards the telemetry stream packets to the collector according to the routing table of the public network.

Usage guidelines

The device uses the addressing parameters to route the telemetry stream packets to the collector.

The destination IP address must be the IP address of the collector, and the destination port number must be the listening port number on the collector.

The vpn-instance vpn-instance-name option of this command is mutually exclusive with the telemetry stream timestamp enable command.

Examples

# Specify source IP address 10.10.10.10, destination IP address 20.20.20.20, source port number 10, and destination port number 20 for telemetry stream packets.

<Sysname> system-view

[Sysname] telemetry stream collector source 10.10.10.10 destination 20.20.20.20 source-port 10 destination-port 20

Related commands

telemetry stream timestamp enable

telemetry stream device-id

Use telemetry stream device-id to specify a device ID.

Use undo telemetry stream device-id to restore the default.

Syntax

telemetry stream device-id address

undo telemetry stream device-id

Default

No device ID is specified.

Views

System view

Predefined user roles

network-admin

Parameters

address: Specifies an IPv4 address as the device ID. You can specify any IPv4 address other than 0.0.0.0. The specified IP address is encapsulated in a copied packet for the collector to identify the source of the packet.

Usage guidelines

This command takes effect only if telemetry stream timestamp is enabled.

Examples

# Specify IPv4 address 10.10.10.10 as the device ID.

<Sysname> system-view

[Sysname] telemetry stream device-id 10.10.10.10

telemetry stream enable

Use telemetry stream enable to enable telemetry stream.

Use undo telemetry stream enable to disable telemetry stream.

Syntax

telemetry stream enable

undo telemetry stream enable

Default

Telemetry stream is enabled.

Views

System view

Predefined user roles

network-admin

Examples

# Enable telemetry stream.

<Sysname> system-view

[Sysname] telemetry stream enable

telemetry stream timestamp enable

Use telemetry stream timestamp enable to enable telemetry stream timestamping.

Use undo telemetry stream timestamp enable to disable telemetry stream timestamping.

Syntax

telemetry stream timestamp enable

undo telemetry stream timestamp enable

Default

Telemetry stream timestamping is disabled.

Views

System view

Predefined user roles

network-admin

Examples

# Enable telemetry stream timestamping.

<Sysname> system-view

[Sysname] telemetry stream timestamp enable

Related commands

telemetry stream collector

  • Cloud & AI
  • InterConnect
  • Intelligent Computing
  • Security
  • SMB Products
  • Intelligent Terminal Products
  • Product Support Services
  • Technical Service Solutions
All Services
  • Resource Center
  • Policy
  • Online Help
All Support
  • Become a Partner
  • Partner Resources
  • Partner Business Management
All Partners
  • Profile
  • News & Events
  • Online Exhibition Center
  • Contact Us
All About Us
新华三官网