13-Telemetry Command Reference

HomeSupportSwitchesH3C S10500X-G Switch SeriesReference GuidesCommand ReferencesH3C S10500X-G Switch Series Command References-R7753Pxx-6W10013-Telemetry Command Reference
02-Telemetry stream commands
Title Size Download
02-Telemetry stream commands 68.85 KB

Telemetry stream commands

MDC is supported only when the device operates in standalone mode. For more information about MDC, see Virtual Technologies Configuration Guide.

display telemetry stream

Use display telemetry stream to display telemetry stream configuration and deployment state.

Syntax

In standalone mode:

display telemetry stream [ slot slot-number ]

In IRF mode:

display telemetry stream [ chassis chassis-number slot slot-number ]

Views

Any view

Predefined user roles

network-admin

network-operator

mdc-admin

mdc-operator

Parameters

slot slot-number: Specifies a card by its slot number. If you do not specify a card, this command displays entries for the active MPU. (In standalone mode.)

chassis chassis-number slot slot-number: Specifies a card on an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the card. If you do not specify this option, the command displays entries for the global active MPU. (In IRF mode.)

Examples

# Display telemetry stream configuration and deployment state.

[Sysname] display telemetry stream

Telemetry stream status          : Enabled

Telemetry stream timestamp status: Disabled

Telemetry stream device ID       : 1.1.1.1

Telemetry stream action:

  Ten-GigabitEthernet3/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: (Configuration succeeded)

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

  Output Interface: Ten-GigabitEthernet3/0/1

  Truncation      : Enable

Table 1 Command output

Field

Description

Telemetry stream status

Telemetry stream status:

·     Enabled.

·     Disabled.

Telemetry stream timestamp status

On the switch series, the telemetry stream timestamp feature is enabled by default and cannot be disabled. Both the Enabled and Disabled values indicate that the telemetry stream timestamp feature is enabled.

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: (Configuration succeeded)

Whether the telemetry stream collector command configuration was successfully deployed to the driver, and the addressing parameters for telemetry stream packets.

·     Configuration succeeded—The configuration was successfully deployed.

·     Configuration failed—The configuration failed to be deployed. A possible reason is that the chip resources are insufficient.

·     Destination MAC.

·     VLAN ID.

·     Output Interface—Output interface name.

·     Truncation—This field is displayed only if the truncation function is enabled.

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

Layer 2 Ethernet interface view

Layer 3 Ethernet interface view

Layer 3 Ethernet subinterface view

Predefined user roles

network-admin

mdc-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, the sampling rate is 2:1, that is, 500 packets are sampled from 1000 packets.

Usage guidelines

When receiving a packet on an interface configured with a telemetry stream action, the device copies the packet, encapsulates the copied packet with the configured addressing parameters, and 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.

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

When specifying an ACL, follow these restrictions and guidelines:

·     If the specified ACL does not exist or does not have any rules, no traffic will match the ACL, and no packets will be copied.

·     In the specified ACL, a rule with the vpn-instance keyword specified takes effect only on VPN packets, and a rule without the vpn-instance keyword specified takes effect on both packets in the public network and VPN packets.

You can configure a maximum number of 24 telemetry stream actions on an interface by executing this command multiple times.

Examples

# Configure telemetry stream action 1 on Ten-GigabitEthernet 3/0/1 to use sampler samp.

<Sysname> system-view

[Sysname] interface ten-gigabitethernet 3/0/1

[Sysname-Ten-GigabitEthernet3/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 ] [ truncation ]

undo telemetry stream collector

Default

No addressing parameters are configured for telemetry stream packets.

Views

System view

Predefined user roles

network-admin

mdc-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.

truncation: Enables the truncation function. If you do not specify this keyword, the truncation function is disabled.

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 outgoing interface for the destination IP address cannot be the following interfaces:

·     Management Ethernet interface.

·     VXLAN tunnel interface.

·     GRE tunnel interface.

·     Any other IPv4 tunnel interface.

·     VXLAN AC.

The truncation function can save the link bandwidth consumed between the device and the collector and reduce the parsing load of the collector. With the truncation function, the device will encapsulate the packet carrying collected data, truncates a portion from the tail of the packet, and send it to the collector. The truncated packets retain complete input interface, timestamp, and output interface,information.

For SF interface cards, the destination-port destination-port and source-port source-port options cannot take effect, and packets sent to the collector do not contain the source or destination port number.

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

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

mdc-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.

Examples

# Specify IPv4 address 1.1.1.1 as the device ID.

<Sysname> system-view

[Sysname] telemetry stream device-id 1.1.1.1

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

mdc-admin

Examples

# Enable telemetry stream.

<Sysname> system-view

[Sysname] telemetry stream enable

 

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