Cisco Catalyst 9800 Series Wireless Controller Software Configuration Guide, Cisco IOS XE Cupertino 17.7.x

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco Catalyst 9800 Series Wireless Controller Software Configuration Guide, Cisco IOS XE Cupertino 17.7.x

Chapter Title

Streaming Telemetry

Results

Updated:
May 19, 2023

Chapter: Streaming Telemetry

Streaming Telemetry

Information About Streaming Telemetry

Streaming telemetry is a new paradigm in monitoring the health of a network. It provides a mechanism to efficiently stream configuration and operational data of interest from the Cisco Catalyst 9800 Series Wireless Controller. This streamed data is transmitted in a structured format to remote management stations for monitoring and troubleshooting purposes.

This topic explains how to enable the telemetry support the Wi-Fi and system health-related data. Not that telemetry support can be enhanced up to a scale of 1000 access points (APs) and 15000 clients. A single collector setup can be used to subscribe to the requested XPaths. A telemetry feed can be used to subscribe to data elements to monitor APs and clients effectively. Data is provided through the native Cisco wireless models.

Gather Points

Gather points are the top-level XPaths and act as the smallest unit of data exported by a target. Any subscription to an XPath raises to the level of the Gather point, and the target sends updates comprising of all the leaves defined under this Gather point. For example, when you subscribe to an XPath /access-point-operdata/radio-oper-data/vap-oper-config/ssid, which is part of the Gather point /access-point-operdata/radio-oper-data/vap-oper-config, the reply will comprise of all the attributes that are a part of the Gather point, in this case, AP-VAP-ID, SSID, and WLAN ID.

The following lists the supported Gather points for an XPaths.

Table 1. Supported Gather Points and Subscription Intervals

Supported Gather Point

Subscription Interval (seconds)

/access-point-oper-data/radio-oper-data/vap-oper-config

>= 30

/access-point-oper-data/radio-oper-data/radio-band-info

>= 30

/access-point-oper-data/radio-oper-data/phy-ht-cfg/cfg-data

>= 30

/access-point-oper-data/radio-oper-data

>= 30

/access-point-oper-data/radio-oper-stats

>=30

/access-point-oper-data/ssid-counters

>=180

/access-point-oper-data/ap-radio-neighbor

>=180

/access-point-oper-data/capwap-data

>=30

/access-point-oper-data/oper-data

>=30

/client-oper-data/traffic-stats

>=30

/client-oper-data/sisf-db-mac

>=30

/client-oper-data/dot11-oper-data

>=30

/client-oper-data/common-oper-data

>=30

/rrm-oper-data/rrm-measurement/load

>=30

Subscription

A subscription binds one or more Gather points and destinations. A Multicast Default (MDT) streams data for each Gather point at the configured frequency (cadence-based streaming).

Transport

The protocol that is used for the connection between a publisher and a receiver is known as the transport protocol, and this decides how data are transmitted. This protocol is independent of the management protocol for configured subscriptions. The supported transport protocols are gNMI and gRPC. The gNMI transport protocol supports JSON encoding of data, while gRPC supports Key-value Google Protocol Buffers (kvGPB) encoding.

Scale Considerations

The following table provides the scale numbers that are applicable to the native model for an XPath set.

Table 2. Scaling Considerations to the Native Model

Attribute

Scale

AP

1000

Client

15000

SSID Per AP

6

BSSID per AP

12

Neighbors per AP

60 (30x2)

Number of Physical Neighbor APs

12

Number of Neighbor Records

60000 records

Session

You can choose to initiate the subscription by establishing a telemetry session between the controller and the receiver. A telemetry session can be initiated using:

  • gNMI Dial-In Mode

  • gRPC Dial-Out Mode

gNMI Dial-In-Mode

In a dial-in mode, a Model-Driven Telemetry (MDT) receiver dials in to the controller, and subscribes dynamically to one or more Gather points or subscriptions. The controller acts as the server, and the receiver as the client. The controller streams telemetry data through the same session. The dial-in mode of subscriptions is dynamic, which gets terminated when the receiver cancels the subscription or when the session is terminated.

gRPC- Dial-Out-Mode

In a dial-out mode, the controller dials out to the receiver. Here the controller acts as a client and receiver acts as a server. In this mode, Gather points and destinations are configured and bound together into one or more subscriptions. The controller continually attempts to establish a session with each destination in the subscription, and streams data to the receiver. The dial-out mode of subscriptions is persistent.
Figure 1. Telemetry Session

The following figure explains the telemetry session:

Configuring Telemetry on a Cisco Catalyst 9800 Series Wireless Controller

To configure telemetry on a Cisco Catalyst 9800 Series Wireless Controller, perform the following:

  1. Enable gNXI in an Insecure Mode

  2. Enable gNXI in a Secure Mode

  3. Verify the Status of the Subscription

  4. Manage Configured Subscriptions

Enabling gNXI in Insecure Mode (CLI)

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device# enable

Enables privileged EXEC mode

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

gnxi

Example:

Device(config)# gnxi

Starts the gNXI process.

Step 4

gnxi server

Example:

Device(config)# gnxi server

Enables the gNXI server in insecure mode.

Step 5

gnxi port port-number

Example:

Device(config)# gnxi 50000

Sets the gNXI port.

The default insecure gNXI port is 9339.

Step 6

end

Example:

Device(config)# end

Returns to privileged EXEC mode.

Step 7

show gnxi state

Example:

Device# show gnxi state

Displays the status of gNXI server.

Example

The following is a sample output of the show gnxi state command: 

Device# show gnxi state
State Status
--------------------------------
Enabled Up

Enabling gNXI in Secure Mode (CLI)

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device# enable

Enables privileged EXEC mode

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

gnxi

Example:

Device(config)# gnxi

Starts the gNXI process.

Step 4

gnxi secure-server

Example:

Device(config)# gnxi secure-server

Enables the gNXI server in secure mode.

Step 5

gnxi secure-trustpoint trustpoint-name

Example:

Device(config)# gnxi secure-trustpoint

Specifies the trustpoint and certificate set that gNXI uses for authentication.

Step 6

gnxi secure-client-auth

Example:

Device(config)# gnxi secure-client-auth

(Optional) The gNXI process authenticates the client certificate against the root certificate.

Step 7

gnxi secure-port

Example:

Device(config)# gnxi secure-port

(Optional) Sets the gNXI port.

  • The default insecure gNXI port is 9339.

Step 8

end

Example:

Device(config)# end

Returns to privileged EXEC mode.

Step 9

show gnxi state

Example:

Device# show gnxi state

Displays the gNXI servers status.

Example

The following is sample output from the show gnxi state command: 

Device# show gnxi state 
State Status
--------------------------------
Enabled Up

Verifying the Status of a Telemetery Subscription on a Cisco Catalyst 9800 Series Wireless Controller

To verify the status of a subscription, use the following command:


Device# show telemetry ietf subscription all
Device# show telemetry ietf subscription 101
Device# show telemetry ietf subscription 101 detail
Device# show telemetry ietf subscription 101 receiver
Device# show telemetry internal connection
Device#show telemetry internal subscription all stats

Managing Configured Subscriptions on a Cisco Catalyst 9800 Series Wireless Controller

Use the show platform software ndbman switch {switch-number | active | standby } models command to display the list of YANG models that support on-change subscription.

Note

Currently, you can only use the gRPC protocol for managing configured subscriptions.

Procedure

  Command or Action Purpose

Step 1

enable

Example:

Device# enable

Enables privileged EXEC mode

Enter your password, if prompted.

Step 2

configure terminal

Example:

Device# configure terminal

Enters global configuration mode.

Step 3

telemetry ietf subscription id

Example:

Device(config)#  telemetry ietf subscription 112

Creates a telemetry subscription and enters telemetry-subscription mode.

Step 4

encoding encode-kvgpb

Example:

Device(config-mdt-subs)# encoding encode-kvgpb

Specifies the Key-value Google Protocol Buffers (kvGPB) encoding.

Step 5

filter xpath path

Example:

Device(config-mdt-subs)# filter xpath /wireless-access-point-oper:access-point-oper-data/capwap-data

Specifies the XPath filter for the subscription.

Step 6

source-address{ A.B.C.D | X:X:X:X::X }

Example:

Device(config-mdt-subs)# source-address ip-address
10.1.1.1 | 2000:1:1:11::11

Configures the source IP address on the telemetry subscription interface.

Step 7

stream yang-push path

Example:

Device(config-mdt-subs)# stream yang-push

Configures a stream for the subscription.

Step 8

update-policy {on-change | periodic} period

Example:

Device(config-mdt-subs)# update-policy periodic
3000

Configures a periodic update policy for the subscription.

Step 9

receiver ip address ip-address receiver-port protocol protocol profile name

Example:

Device(config-mdt-subs)# receiver ip address
9.1.0.3 57557 protocol grpc-tcp

Configures a periodic update policy for the subscription.

Step 10

end

Example:

Device(config-mdt-subs)# end

Exits telemetry-subscription configuration mode and returns to privileged EXEC mode.

On-Change Telemetry Support

From Cisco IOS XE Cupertino 17.7.1 onwards, on-change telemetry support is provided to a subset of XPaths.

Supported XPaths for On-Change Subscription

The following table lists the supported XPaths for on-change subscription.

Table 3. Supported Gather Points and XPaths

Gather Points

XPaths

/access-point-oper-data/radio-operdata/

/access-point-oper-data/radio-operdata/

phy-ht-cfg/cfg-data/curr-freq

/access-point-oper-data/radio-operdata/

phy-ht-cfg/cfg-data/chan-width

/access-point-oper-data/radio-oper-data/current-band-id

/access-point-oper-data/capwap-data

/access-point-oper-data/capwap-data/name

/access-point-oper-data/capwapdata/

device-detail/wtp-version/sw-ver/version

/access-point-oper-data/capwap-

data/device-detail/wtp-version/sw-ver/release

/access-point-oper-data/capwapdata/

device-detail/wtp-version/sw-ver/maint

/access-point-oper-data/capwapdata/

device-detail/wtp-version/sw-ver/build

/access-point-oper-data/capwap-data/ap-state/ap-

operation-state

/access-point-oper-data/capwapdata/

device-detail/static-info/board-data/wtp-serial-num

/access-point-oper-data/oper-data

/access-point-oper-data/oper-data/ap-ip-data/ap-ip-addr

/access-point-oper-dat/oper-data/ap-pow/power-type

The following table lists the XPaths that are introduced in Cisco-IOS-XE-wireless-mesh-rpc.yang model to support the mesh-related EXEC commands:

Table 4. Supported EXEC CLIs and XPaths

EXEC CLI

XPath

ap name <ap-name> [no] mesh ethernet [0|1|2|3] mode trunk vlan allowed <vlan-id>

/set-rad-mesh-ethernet-trunk-allowed-vlan

ap name <ap-name> [no] mesh ethernet [0|1|2|3] mode trunk vlan native

/set-rad-mesh-ethernet-trunk-native-vlan

ap name <ap-name> mesh linktest <dst AP MAC> <data rate> <packets/sec> <packet size> <duration>

/exec-linktest-ap

ap name <ap-name> [no] mesh ethernet [0|1|2|3] mode access <vlan-id>

/set-rad-mesh-ethernet-access-vlan

ap name <ap-name> [no] mesh block-child

/set-rad-mesh-block-child

ap name <ap-name> [no] mesh vlan-trunking

/set-rad-mesh-trunking

ap name <ap-name> [no] mesh daisy-chaining strict-rap

/set-rad-mesh-daisy-chain-strict-rap

ap name <ap-name> [no] mesh daisy-chaining

/set-rad-mesh-daisy-chain-mode

ap name <ap-name> [no] mesh parent preferred

/set-rad-mesh-preferred-parent-ap

ap name <ap-name> mesh backhaul rate dot11ac mcs <mcs-index> ss <1-4>

/set-rad-mesh-bhaul-tx-rate

ap name <ap-name> mesh backhaul radio dot11 5ghz [slot <slot-id>]

/set-rad-mesh-bhaul-radio

ap name <ap-name> mesh security psk provisioning delete

/set-rad-mesh-security-psk-provisioning-delete

ap name <ap-name> mesh vlan-trunking native <vlan-id>

 /set-rad-mesh-trunking-vlan

The following table lists the XPaths that are introduced in Cisco-IOS-XE-wireless-ap-global-oper-transform.yang model that is displayed through telemetry feed.

Table 5. Supported Gather Points and XPaths

Gather Points

XPaths

/ap-global-oper-data/ap-join-stats/wtp-mac

/ap-global-oper-data/ap-join-stats/ap-join-info/ap-ethernet-mac

/ap-global-oper-data/ap-join-stats/ap-join-info/ap-name

/ap-global-oper-data/ap-join-stats/ap-join-info/ap-ip-addr

/ap-global-oper-data/ap-join-stats/ap-join-info/is-joined

/ap-global-oper-data/ap-join-stats/ap-join-info/last-error-type

/ap-global-oper-data/ap-join-stats/ap-disconnect-reason

The following are the Xpaths that are introduced in the Cisco-IOS-XE-wireless-mesh-rpc.yang model that exposes the mesh action definitions corresponding to the EXEC CLIs.

  • /set-rad-mesh-ethernet-trunk-allowed-vlan

  • /set-rad-mesh-ethernet-trunk-native-vlan

  • /exec-linktest-ap

  • /set-rad-mesh-ethernet-access-vlan

  • /set-rad-mesh-block-child

  • /set-rad-mesh-trunking

  • /set-rad-mesh-daisy-chain-strict-rap

  • /set-rad-mesh-daisy-chain-mode

  • /set-rad-mesh-preferred-parent-ap

  • /set-rad-mesh-bhaul-tx-rate

  • /set-rad-mesh-bhaul-radio

  • /set-rad-mesh-security-psk-provisioning-delete

  • /set-rad-mesh-trunking-vlan

Was this Document Helpful?

FeedbackFeedback

Contact Cisco