URWB Telemetry Protocol

URWB telemetry protocol

he URWB Telemetry Protocol was introduced in UIW Release 17.12.1. It allows custom external monitoring of real-time wireless performance. Third-party and custom applications can use this data. Pre-defined structured UDP packets sent at regular intervals contain various network metrics.

Each access point exports data for its radios. This data can be interpreted live by the receiving application or captured and processed later.

For more information about the protocol format, contact Cisco Support to request URWB Telemetry Protocol reference document.

The telemetry UDP packet contains the following information:

  • Signal strength of packet

  • Packet throughput and migration rate

  • Number of transmission and retransmission

  • Modulation rate

  • Details of packet loss

  • Operating frequency of each radio

  • Information about the events recorded on the network

Configure URWB Telemetry Protocol using CLI

The URWB telemetry protocol transmits raw UDP data to a specified receiver.

Before you begin

By default, the telemetry data is disabled.

Procedure

Step 1

Use the configure telemetry server dest-ip port command to set the IP address and UDP port of the receiver.

Example:

Device# configure telemetry server 10.115.11.56 1234

Multicast addresses are supported.

Step 2

Use the configure telemetry export { enable | disable } command to enable raw UDP telemetry transmission to the configured server.

Example:

Device# configure telemetry export enable

Note

 

  • Ensure the IP address is configured before you rune the configure telemetry export enable command. If not, the command rejects with an error please configure the telemetry server IP first.

  • The IP server is simultaneously set to 0.0.0.0 (the port value is unchanged) when you execute the configure telemetry export disable command.

Step 3

Use the show telemetry config command to verify telemetry configuration.

Example:

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

Live Configuration of URWB Telemetry Protocol using CLI

Configure live telemetry settings using the live modifier for immediate effect.

The command immediately affects the current configuration when the live modifier is specified. Only the configuration file is changed if the live modifier is not used.

Procedure

Step 1

Use the configure telemetry live server ip-address port command to configure live telemetry settings using the live modifier for immediate effect.

Example:

Device# configure telemetry live server 10.115.11.56 1234

Note

 

Server configuration is mandatory before you enable the live telemetry export.

Step 2

Use the configure telemetry live export enable command to enable live telemetry export.

Example:

Device# configure telemetry live export enable

Step 3

Use the show telemetry config command to view the telemetry information.

Example:


Device# show telemetry config
Telemetry export: enabled, current (live): enabled
Telemetry server: 10.115.11.56 1234, current (live): 10.115.11.56 1234

Configure GNSS Telemetry Protocol using CLI

Enables the GNSS telemetry protocol on the device.

Procedure

Step 1

Use the configure gnss telemetry enable command to enable GNSS telemetry.

Example:

Device# configure gnss telemetry enable

Step 2

Use the configure gnss telemetry disable command to disable GNSS telemetry when needed.

Example:

Device# configure gnss telemetry disable

Step 3

Use the show gnss telemetry command to view GNSS telemetry status.

Example:

Device# show gnss telemetry