URWB Telemetry Protocol

URWB telemetry protocol

The URWB telemetry protocol is a monitoring feature that

  • performs external monitoring of real-time wireless performance on IEC6400 gateways

  • sends pre-defined structured UDP packets at regular intervals containing network metrics such as packet throughput and migration rate, and

  • enables third-party and custom applications to interpret telemetry data live or capture and process it later.

From IEC6400 Release 1.1.0, the IEC6400 gateway supports the URWB Telemetry Protocol feature.

The telemetry packet from the gateway contains the packet throughput and migration rate.

Additional information

For information about the Type-Length-Values (TLVs) for the gateway, contact Cisco Support.

Manage URWB telemetry export parameters using CLI

This task enables URWB telemetry export functionality on the gateway to transmit telemetry data to a configured receiver.

By default, this feature is disabled on the gateway. Use this procedure when you need to configure and enable telemetry data transmission for monitoring purposes.

Before you begin

Follow these steps to enable the telemetry export:

Procedure

Step 1

Use one of the following commands:

  • Use the telemetry server IP-address UDP-port-value command to enter the IP address and UDP port of the telemetry receiver.
    Device#telemetry server 192.168.0.100 1234

    Multicast IP addresses are supported.

    Or

  • Use the telemetry live server IP-address UDP-port-value command to manage the IP address and UDP port of the telemetry receiver.
    Device#telemetry live server 192.168.0.100 1234

Step 2

Use one of the following commands:

  • Use the telemetry export enable command to enable the telemetry transmission to the configured telemetry receiver. 
    Device#telemetry export enable

    Note

     

    • Use the telemetry export disable command to disable the telemetry transmission to the configured telemetry receiver.

    • When you run the telemetry export disable command, the device defaults the IP address to 0.0.0.0, but retains with the UDP port value.

    Or

  • Use the telemetry live export enable command to enable the telemetry transmission to the configured telemetry receiver. 

    Device#telemetry live export enable

Step 3

Use the write command to apply the configuration permanently. 

Device#write

Note

 

  • If you include live keyword in the command, the configuration takes effect immediately.

  • If you do not include live keyword in the command, you need to run write and reboot commands.

Step 4

Use the reboot command to reboot the device. 

Device#reboot

URWB telemetry protocol configuration example

CLI command without live:

Use these commands to export the telemetry data when you do not include live keyword in the command. 

Device#telemetry server 192.168.0.100 1234
      Device#telemetry export enable
      Device#write
      Device#reboot

CLI command with live:

Use these commands to export the telemetry data when you include live keyword in the command. 

Device#telemetry live server 192.168.0.100 1234
        Device#telemetry live export enable

Manage telemetry level

This reference provides information about telemetry level commands for managing statistics sent to the telemetry server.

Telemetry level default

Use the telemetry level default command to send the default statistics to the telemetry server. 

Device#telemetry level default

Telemetry level detailed

Use the telemetry level detailed command to send the detailed statistics to the telemetry server. Detailed telemetry includes information for each handoff occurring in the network. 

Device#telemetry level detailed

Verify telemetry configuration

Use the telemetry command to view the telemetry configuration. 

Device#telemetry 
Telemetry export: enabled, current (live): disabled
Telemetry server: 192.168.0.100 1234, current (live): 0.0.0.0 30000

Note

The current (live) status in the show output section reflects the current status, which may differ from the stored status due to the live command.

  • If you use live option to disable telemetry export, the telemetry output shows current (live): disabled .

  • If you use live option to enable telemetry export, the telemetry output shows current (live): enabled .

  • If you do not use live option to configure telemetry server, the telemetry output shows current(live): 0.0.0.0 30000 .

  • If you use live option to configure telemetry server to 192.168.0.100 1234, the telemetry output shows current(live): 192.168.0.100 1234 .