Configuring URWB Telemetry Protocol

Configuring URWB Telemetry Protocol

The URWB Telemetry Protocol is introduced from UIW Release 17.12.1 and it allows for 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 that recording the network

Configuration of URWB Telemetry Protocol using CLI

By default, the telemetry data is disabled. To generate the telemetry packet, use the following CLI command:

To set the IP address and UDP port of the receiver, use the following CLI command (multicast addresses are supported):

Device# configure telemetry server <dest IP [port]>
To enable or disable the URWB Telemetry Protocol transmission to the configured receiver, use the following CLI command (multicast addresses are supported):
Device# configure telemetry server <dest IP [port]>
To enable or disable raw UDP telemetry transmission to the configured server, use the following CLI command: 
Device# configure telemetry export [ enable | disable ]
Example:
Device# configure telemetry export enable
Device# configure telemetry server 10.115.11.56 1234
Device# write
Device# reload

Note

  • Ensure the IP address is configured before you execute the export enable CLI 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 export disable CLI command.

To verify telemetry configuration, use the following show command:
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

Device# configure telemetry live
Export : enable/disable telemetry export
Server : set telemetry server IP address (and port)

Note

Server configuration is mandatory before you enable the live telemetry export.
Example:
Device# configure telemetry live export enable
Error: please configure the telemetry server IP first
Example (telemetry export after server configuration):
Device# configure telemetry live server 10.115.11.56 1234
Device# configure telemetry live export enable
Device# show telemetry config
Telemetry export: enabled, current (live): enabled
Telemetry server: 10.115.11.56 1234, current (live): 10.115.11.56 1234

Note

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.

Configuration of GNSS Telemetry Protocol using CLI

To enable GNSS telemetry, use the following CLI command:

Device# configure gnss telemetry enable

To disable GNSS telemetry, use the following CLI command:

Device# configure gnss telemetry disable

To show GNSS telemetry, use the following CLI command:

Device# show gnss telemetry