End of Support

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Telemetry Platform Components

Arista's streaming Telemetry platform consists of a set of components, all of which are essential to the proper operation of the platform.

The components of the Telemetry platform are:

NetDB State Streaming Component
CloudVision Analytics Engine Component
REST and Websocket based APIs are available to programatically get data from the CloudVision Analytics Engine. Contact your Arista Sales Engineer for more information.

NetDB State Streaming Component

The NetDB State Streaming component is an agent that runs on Arista switches. It is the Telemetry platform component that streams device-state data from devices to the CloudVision Analytics Engine, which is the back-end component of platform.

CloudVision Analytics Engine Component

The CloudVision Analytics Engine is the back-end component of the Telemetry platform. It is a set of processes that run on CVP. Collectively, the processes perform the following operations:

Receives all of the device-state data streamed by the NetDB State Streaming component from devices that have been configured to stream device-state data.
Runs automated data analysis on the device-state data received from the NetDB State Streaming component. The analytics processes aggregate the device-state data across devices, monitor device state, and generate events if something goes wrong. The processes also normalize data so it is easier for other applications to use.
Stores all of the streamed device-state data received from the NetDB State Streaming component, and then makes the stored data available in CloudVision.
Provides CloudVision Analytics Engine Viewer, which is referred to as the Aeris Browser. You use it to directly view device-state data received from devices that have been configured to stream device-state data. The Aeris Browser enables you to view raw device-state data.
REST and Websocket based APIs are available to programatically get data from the CloudVision Analytics Engine. Contact your Arista Sales Engineer for more information.

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Supplementary Services: Splunk

For more information on the requirements for CVP to manage Splunk extensions on EOS devices, go to https://www.arista.com/en/support/software-download and download the PDF from Extensions > Splunk > AristaTelemetry.pdf.

Requirement

EOS 4.15.2 or later is required.

Installation

You can access the Splunk Telemetry App directly from CVP by completing the following steps. From your browser.

Copy the RPM to and install it on the switch.

show extensions
Name Version/Release Status RPMs

Install the Splunk Universal Forwarder RPM on EOS.

copy <source>/splunkforwarder-6.1.4-233537.i386.rpm extension:
extension splunkforwarder-6.1.4-233537.i386.rpm

Install the AristaAppForSplunk on EOS.

copy <source>/AristaAppForSplunk-1.3.2.swix extension:
extension AristaAppForSplunk-1.3.2.swix

Note: Extensions must be installed on all supervisors.

Restart the SuperServer agent.

(config)# agent SuperServer shutdown
(config-mgmt-api-http-cmds)# no agent SuperServer shutdown

Verify the extensions are loaded.

show extensions
Name Version/Release Status RPMs
------------------------------------------ ------------------------- ---
AristaAppForSplunk-<version>.swix <version>/1.fc14 A, I 3
splunkforwarder-6.1.4-233537.i386.rpm 6.1.4/233537 A, I 1
EosSdk-1.7.0-4.15.2F.i686.rpm 1.7.0/2692966.gaevanseoss A, I 1
A: available | NA: not available | I: installed | NI: not installed | F: f

Quick Start

Use the configuration to enable forwarding to the Splunk indexer. This assumes that a username/password and eAPI have been configured for the AristaAppForSplunk extension previously.
```
daemon SplunkForwarder
	exec /usr/bin/SplunkAgent
	no shutdown 
```
Configure and turn on the desired indexes for data collection. The credentials must match 'username <name> secret <passphrase>' configured on the switch.
```
option eapi_username value <username>
	option eapi_password value 7 <encrypted-password>
	option eapi_protocol value https 
```

Turn on desired indexes for data collection.

option index-inventory value on
	option index-interface-counters value on
	option index-lanz value on
	option index-topology value on
	option index-syslog value on
	option index-data value <index-name

Configure Splunk server IP and destination port.
```
option splunk-server value <Server-IP:Port>
```
Start Splunk data forwarding.
```
option shutdown value off
```

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Architecture

Telemetry Platform Architecture shows the architecture of the Telemetry platform, including all of the platform components and the data path of the streamed device-state data.

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Accessing the Telemetry Browser Screen

You can access the CloudVision Telemetry Browser screen directly from CVP by completing the following steps. Open your browser.

Point your browser to the CVP IP address or hostname.
Login to CVP.

The CVP Home screen appears.

Figure 1. CVP Home Screen
Click the gear icon at the upper right corner of the screen.

Figure 2. Gear Icon
Click Telemetry Browser in the left pane.
The system opens the Telemetry Browser screen that allows exploring the raw data stored in CVP telemetry.

Figure 3. CloudVision Telemetry Browser Screen

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Viewing Devices

You can quickly view information about devices that are currently configured to stream device-state data to CVP. Starting with 2018.2.0, the inventory management screen is available under Devices in the CVP user interface.

Related topics:

Tiles View

The tiles view allows search by device hostname, serial number, or EOS version. The screen updates to show all of the devices currently configured to stream device-state data to CVP. For each device, the name and the version of the EOS image are shown on the Devices screen.

Figure 1. Viewing Devices (View Showing all Devices)

Tabular View

The tabular view lists device status, model, software, TerminAttr agent, IP address, MAC address, and serial number. You can search for devices based on device hostname, serial number, or EOS version.

Note: In the status column, hover the cursor over the following images for specified tasks:

Check and exclamatory marks to view streaming status
Bug image to view the count of available vulnerability updates
Hourglass to view the End Of Life (EOL) status
An amber hourglass signifies that the end of life is within 6 months, a red hourglass signifies that the End of Life has been reached.

Viewing the PTP Slave Port Interface Metric in Devices

You can view the slave port interface metric in Devices and Dashboards for any device with PTP enabled. The metric communicates which interface is marked as the slave port at a given time, according to the PTP algorithm.

To view PTP metrics, including the Slave Port Interface Metric, for a PTP-enabled device:

Click Devices>Inventory.

Figure 3. Select Inventory from Devices
Select an enabled device from the Inventory table, and then click System.
PTP status metrics will appear at the bottom of the page. Move the cursor across the data visualization to view PTP metrics at different points in time.

Figure 4. PTP Status
Use the Timepicker to adjust the timeframe.

Event Rollup

Event Rollup allows you to manage the volume of identical events and can be used to flag when an event is recurring. Event Rollup groups events that are identical, except for their timestamps. It does this two ways: dynamically via the Event List and according to a 24-hour window via the Detailed Event View. It can be enabled or disabled, using the Roll Up toggle.

Event List

Identical events are rolled up to the most recent occurrence of the event. The number of times the event occurred appears in parentheses next to the event title in the Event List.

The number of events rolled up is dynamic and depends on the number of events shown in the Event List. As you scroll and CloudVision loads additional older events, those that are identical to more recent events will be rolled up and added to the totals shown in parentheses.CloudVision will roll up a maximum of 100 events. Events that occur more than 100 times are identified in the Event List.

To view additional events, disable Rollup and filter the Event List by Type. The start time and status displayed in the Event List are those of the most recent event occurrence. Clicking on the plus (+) icon next to the event name will unroll previous instances of the event, so that you can view them all separately.

Detailed Event View

Clicking on an event in the Event List opens the Detailed Event View. Unlike the Event List, the Detailed Event View shows you the number of times an identical event occurred within a fixed period, 24-hours preceding the start time of the event you have selected.

You can also click the Sync Data Visualizations link provided to sync data visualizations of relevant event metrics to the time frame that rolled up events occurred in. Use the targeted overview of metric data to help you better diagnose and troubleshoot the cause of the events.

Interface Rates Breached Thresholds Events

CloudVision now notifies users when there are multiple threshold events triggered on a single interface. This group event is generated when default or user-defined thresholds for the following rates are breached on an interface: alignment errors, RX discards, RX errors, TX discards, TX errors, FCS errors, runts, giants, and symbol errors.

PTP Events

PTP events allow you to better monitor the accuracy and consistency of device times within PTP domains. These include Inconsistent PTP Domain ID, Inconsistent PTP Grandmaster ID, and Unexpected Grandmaster PTP ID events. You will enable CloudVision to generate PTP events by configuring event rules in Event Generation. Using device tags, you will set PTP domains and approved grandmasters that CloudVision will use to check against the state of PTP domain devices.

To view PTP events, ensure that the Additional Events toggle is enabled in General Settings > Features. PTP grouped events do not need to be configured, but you must enable the Event Grouping toggle to view them.

Configuring PTP Events

To generate PTP events, create rules that specify the expected domain or domains and grandmaster IDs.

If you have a single-domain deployment, create a single rule for each event that identifies the expected domain, DefaultDomain, or the approved grandmaster IDs. If you have a multi-domain deployment, create one event rule for each PTP domain in your network.

Related Topics

Creating PTP Domains

PTP events are configured differently, depending if you have one or multiple PTP domains deployed. If you have a single-domain deployment, CloudVision will assume all devices belong to the default PTP domain DefaultDomain.

If you have a multi-domain deployment, you will use tags to classify devices into domains.

Navigate to Provisioning > Tags to create tags.
Create one ptp_domain tag for each PTP domain in your network.

For example, you can tag devices dev0 ~ dev20 with ptp_domain: video and devices dev21 ~ dev40 with ptp_domain: audio.

Note: Make sure touse ptp_domain as the label and assign only one ptp_domain:<value> tag per device.Do not use the tag value DefaultDomain, it is only used to generate PTP events for single-domain deployments.

Configuring PTP Events

To generate PTP events, you need to create rules that specify the expected domain or domains and grandmaster IDs.

If you have a single-domain deployment, you need to create a single rule for each event that identifies the expected domain, DefaultDomain, or the approved grandmaster IDs. If you have a multi-domain deployment, you need to create one event rule for each PTP domain in your network.

Related Topics

Inconsistent PTP Domain ID

This event alerts you when a device’s PTP domain ID does not match the expected domain ID. To enable the event you need to create a rule or rules to specify the expected domain ID.

Click Add Rule.
Enter the domain ID in the Threshold field.

If you are configuring the rule for a multi-domain deployment, you need to also enter the ptp_domain tag in the Active Devices field.

Figure 7. Inconsistent PTP Domain ID
Enable the Generate an Event checkbox.
(Optional)Use the dropdown to select a severity level and enter a Rule Label.
Click Save.

Note: If you have a multi-domain deployment, repeat steps 1-5 for each PTP domain.

Unexpected PTP Grandmaster ID

This event is generated when the grandmaster ID of a device is not on the user-configured approved list. To enable the event you will create a rule or rules to specify the approved grandmaster IDs.

Click Add Rule.
Click Add Grandmaster ID in the Threshold field and enter the EUI-64 identifier of an approved grandmaster.

If you are configuring the rule for a multi-domain deployment, you will also enter the ptp_domain tag in the Active Devices field.

Figure 8. Unexpected PTP Grandmaster ID

Note: You can add multiple grandmaster IDs, as long as they are separate entries.
Enable the Generate an Event checkbox.
Optionally, use the dropdown to select a severity level and enter a Rule Label.
Click Save

Note: If you have a multi-domain deployment, repeat steps 1-5 for each PTP domain.

Inconsistent PTP Grandmaster ID

This event is raised when devices in the same domain are not all listening to the same grandmaster.

If you have a single-domain deployment, the event will be generated automatically, according to the default rule.If you have a multi-domain deployment, the event will be generated automatically, as long as you have created a ptp-domain tag for each PTP domain in your network.

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Viewing Device Details

From the Inventory screen, you can quickly drill down to view details about a particular device by clicking the device icon. In the tabular view, click the device name to view the corresponding device details.

The screen refreshes to show the device-state data streamed from the device to CVP.

Figure 1. Viewing Devices Details (Single Device)

Device details include the information on overview, system, compliance, environment, switching, routing, and interfaces.

Related topics:

Compliance

The Compliance section provides information on vulnerability to known bugs.

Device Overview

The Device Overview section provides an overview of system details, telemetry status, and interface counts. Click More to reach corresponding sections for detailed information.

The Historical Comparison sub-section provides the information on EOS version, 5-minute CPU load average, MLAG status, IPv4 attached routes, IPV4 learned routes, configured BGP, IPv6 attached routes, IPV6 learned routes, and MAC addresses learned.

The system displays only Device Overview and System information for third-party devices.

Environment Details

The Environment section provides statistics on temperature, fan speeds, and output power.

Switching Information

The Switching section provides the count of VLANs in which MAC address learning is enabled, count of total VLANs, count of configured VLANs, and detailed information on configured VLANs.

Sub-sections provide switching data like ARP table, NDP table, bridging capability, MAC address table, MLAG, and VXLAN.

Routing Information

The Routing section provides statistics on IPV4 route count by type, IPv6 route count by type, and routing statistics by VRF.

Sub-sections provide routing data like IPv4 and IPv6 routing tables, routing table changes, multicast data like sparse mode PIM and static, and BGP information.

System Information

The System section provides an overview of device details, telemetry status, and PTP status.

Sub-sections provide information on processes, storage, log messages, hardware capacity, running config, and snapshots.

802.1X Metrics

802.1X information shows which endpoints have authenticated, are undergoing authentication, or have failed to authenticate to the network. This information is available to view primarily from the 802.1X page in the Devices application.

Accessing 802.1X Metrics

To access 802.1X Metrics From the Inventory screen in the Devices tab, select a device. In the scrolling menu on the left side of the page, select 801.X. The 801.X Metrics page is displayed.

The graphs display the total number of interfaces and the status of each.

The table lists all of the endpoints with additional information. The columns show the following:

Identity: the MAC address of the endpoint. The username, if provided, is displayed in parenthesis.
IP Address: the IP address of the endpoint.
Interface: which interface the endpoint is on. Selecting the interface will display a table showing all of the endpoints on that specific interface.
Host Mode: the host mode of the endpoint (Single-Host, Multi-Host, Multi-Host Authenticated) with an optional Mac-Based VLAN Assignment. Place the cursor over Mac-Based VLAN Assignment to display the full name.
Auth Status: the authentication status of the endpoint.
Auth Mode: how the endpoint is authenticated.
VLAN: the VLAN the endpoint is on.
VLAN Type: the type of VLAN being used.

802.1X Dashboard View

802.1X metrics is also available from the Dashboard View. Refer to Dashboards for more information about creating a dashboard.

Viewing Traffic Flows

CloudVision lets you analyze the network traffic routed through a single device or through all devices that have flow tracking configured.

Note: Traffic flows return tunneled flows when the inner packet headers matches the user's query.

You can drill down into the details of global and device specific network flow activities using bar charts, stacked time series graphs, and tables of usage statistics. See Accessing the Global Traffic Flows Screen and Accessing the Device Specific Traffic Flows Screen.

Note: You can drill down the details of device specific network flow activities using heatmaps also.

To view the data on traffic flows, you must enable traffic flow tracking in devices to get data. See Enabling Traffic Flow Tracking.

Enabling Traffic Flow Tracking

Enabling flow tracking on a device allows CloudVision to provide a detailed breakdown of the forwarded network traffic. Traffic flow tracking is enabled through either of the following methods:

Enable sFlow Sampling on a Device

Arista switches provide a single sFlow agent instance that samples ingress traffic from all Ethernet and port channel interfaces.

Run the following commands to enable sFlow sampling on a device:

switch(config)#sflow sample <sampling rate>
switch(config)#sflow polling-interval <polling interval>
switch(config)#sflow destination 127.0.0.1
switch(config)#sflow source-interface <source interface>
switch(config)#sflow run

sFlow monitors a random sample of packets at the configured sampling rate. Reported bandwidth and packet measurements are scaled up using the sampling rate to provide estimates of actual bandwidth usage and packet counts.

Enable Hardware Based IPFIX Flow Tracking

Arista switches also allow exporting flow information using the IPFIX format.

Run the following commands to enable hardware based IPFIX flow tracking:

switch(config)#flow tracking hardware
switch(config)#!
switch(config)#tracker <tracker name>
switch(config)#record export on inactive timeout <inactive timeout>
switch(config)#record export on interval <interval>
switch(config)#record format ipfix standard timestamps counters
switch(config)#!
switch(config)#exporter <exporter name>
switch(config)#collector <loopback interface ip>
switch(config)#local interface <loopback interface>
switch(config)#template interval <interval>
switch(config)#no shutdown
switch(config)#exit
switch(config)#interface <interface>
switch(config)#flow tracker hardware <tracker name>
switch(config)#no shutdown

Accessing the Global Traffic Flows Screen

To view the global traffic flows screen, navigate to Devices > Traffic Flows on the CloudVision portal. This screen displays information about traffic flows captured by all devices on the network with flow monitoring enabled.See the figure below.

Note: This screen may present multiple values reported by different devices for the same flow or flow category.

Use the following search filters for customised presentation of the traffic flows data:

Host filters
- Source Hosts
  - Show autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the source host that needs to be displayed
  - Hide autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the source host that needs to be concealed
- Destination Hosts
  - Show autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the destination host that needs to be displayed
  - Hide autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the destination host that needs to be concealed
- Bidirectional checkbox - Select the checkbox to view the traffic flows between specified hosts.
  Note: When you select the Bidirectional checkbox, the Source Hosts and Destination Hosts fields change to Hosts and To/From Hosts.
Port filters
- Source Ports autocomplete field - Provide port numbers or service names of the source port
- Destination Ports autocomplete field - Provide port numbers or service names of the destination port
- Show/Hide dropdown - Select either Show or Hide to view or conceal the traffic flow data of specified source and destination ports respectively.
- Bidirectional checkbox - Select the checkbox to view the traffic flows between specified ports.
  Note: When you select the Bidirectional checkbox, the Source Ports and Destination Ports fields change to Ports and To/From Ports.
Protocol filter - Provide IP protocols of the required traffic flow data in the autocomplete field.

Select either Show or Hide to view or conceal the traffic flow data of specified protocols respectively.
More filters
- Locality - Select Public and Private checkboxes to view traffic flows of corresponding networks
- Fragmentation checkbox - Selecting the checkbox displays only flows with fragmented packets
Clear all filters - Clears all specified filters
Top dropdown menu - As per your selection, the top n items are displayed for each break down.
by dropdown menu - Select the required method to measure traffic.

The global traffic flows dashboard provides the following display types for analyzing the flow data in different ways:

Note:

Click the View in Topology link to see the data from the perspective of the topology flows view.
The refresh icon provides countdown in seconds for refreshing the traffic flow data. The data in live mode gets updated every 30 seconds.

Charts View

The Charts display option presents the summary of global traffic flows in charts. The traffic flow data is arranged based on the breakdown selected from the dropdown list. See the figure below.

Figure 12. Global Traffic Flow Summary in Charts

Bar charts represent the device specific traffic flows over the selected time period. The bar length represents the traffic flow of a device with highest usage.

Note:

Click on a bar in the bar chart in the stacked graph to set the clicked-on item as a filter wherever it is possible. For example, hosts or ports of source and destination.
Hover the cursor on the dot in a bar to find the observing device.

Summary Table View

The Summary Table display option presents the summary of global traffic flows in a tabular format. See the figure below.

Figure 13. Global Traffic Flow Summary in Table

The traffic flow data is grouped based on the selected breakdowns. If multiple options are selected in the Group By field, the table displays a summary of usage statistics that is broken down according to the selected criteria. The summary can be sorted by bytes, packets, or flows in descending order.

Note: Click on a device name to view the traffic flows for the respective device.

Flow Records View

The Flow Records display option presents the record of all traffic flows in a tabular format. See the figure below.

Note: Click on a device name to view the traffic flows for the respective device.

Accessing the Device Specific Traffic Flows Screen

On the CloudVision portal, navigate to Devices > Inventory > Device_Name > Traffic Flows to view the Traffic Flows screen. See the figure below.

This screen displays the summary of flows, bandwidth, packets, active hosts, and sampling rate. Provide the following details to view custom information of traffic flows:

Inband Telemetry Data
- Flow tracking (sFlow or IPFIX)
- Inband telemetry
Host filters
- Source Hosts
  - Show autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the source host that needs to be displayed
  - Hide autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the source host that needs to be concealed
- Destination Hosts
  - Show autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the destination host that needs to be displayed
  - Hide autocomplete field - Provide hostnames, IP addresses, or subnets in CIDR notation of the destination host that needs to be concealed
Port filters
- Source Ports autocomplete field - Provide port numbers or service names of the source port
- Destination Ports autocomplete field - Provide port numbers or service names of the destination port
- Show/Hide dropdown - Select either Show or Hide to view or conceal the traffic flow data of specified source and destination ports respectively.
Protocol filter - Provide IP protocols of the required traffic flow data in the autocomplete field.

Select either Show or Hide to view or conceal the traffic flow data of specified protocols respectively
Interface filters
- Show autocomplete field - Select the interfaces of which the traffic flow needs to be displayed
- Hide autocomplete field - Select the interfaces of which the traffic flow needs to be concealed
More filters
- Locality - Select Public and Private checkboxes to view traffic flows of corresponding networks
- Fragmentation checkbox - Selecting the checkbox displays only flows with fragmented packets
Clear all filters - Clears all specified filters
Top dropdown menu - As per your selection, the top n items are displayed for each break down.
by dropdown menu - Select the required method to measure traffic.

The device specific traffic flows dashboard provides the following display types for analyzing the flow data in different ways:

Note:

Click the View in Topology link to see the data from the perspective of the topology flows view.
The refresh icon provides countdown in seconds for refreshing the traffic flow data. The data in live mode gets updated every 30 seconds.

Charts View

The Charts display option presents the summary of device specific traffic flows in charts. The traffic flow data is arranged based on the breakdown selected from the dropdown list. See the figure below.

Figure 16. Device Specific Traffic Flow Summary in Charts

The following information is provided for each break down:

Bar charts that display the total usage over the time period for items
Note: Clicking on a bar in the bar chart or a time series in the stacked graph sets the clicked-on item as a filter wherever it is possible. For example, hosts or ports of source and destination.
Stacked time series graphs that provide the following information:
- The rate of usage vs. time
  Note: This information is provided only when the Sort By option is either Bandwidth (bytes) or Packets.
- The number of flows active vs. time
  Note: This information is provided only when the Sort By option is Flow Count.

Charts View

Figure 17. Device Specific Traffic Flow Summary in Charts

The following information is provided for each break down:

Bar charts that display the total usage over the time period for items
Note: Clicking on a bar in the bar chart or a time series in the stacked graph sets the clicked-on item as a filter wherever it is possible. For example, hosts or ports of source and destination.
Stacked time series graphs that provide the following information:
- The rate of usage vs. time
  Note: This information is provided only when the Sort By option is either Bandwidth (bytes) or Packets.
- The number of flows active vs. time
  Note: This information is provided only when the Sort By option is Flow Count.

Heatmap View

The Heatmap display option presents the summary of device specific traffic flows in a heatmap. See the figure below.

Figure 18. Device Specific Traffic Flow Summary in Heatmap

The heatmap plots two breakdowns against each other. For example, the user selects top 20 source hosts vs. top 20 destination hosts. The system displays the top 20 destination hosts that communicated with any of those top 20 source hosts.

Each pairing of source host and destination host is shown as a cell in the grid. Cells are displayed in various shades of green based on their usage. The higher the usage, the darker the green shade.

Note: The system displays an empty cell if there is no usage.

Summary Table View

The Summary Table display option presents the summary of device specific traffic flows in a table. See the figure below.

Figure 19. Device Specific Traffic Flow Summary in Table

Flow Records View

The Flow Records display option presents the record of device specific traffic flows in a tabular format. See the figure below.

When viewing individual flow records, the path of a flow, complete with ingress and egress interfaces, TTLs and latencies for each hop, can be inspected using the Hops column.

Note: Filters and fields related to packet fragmentation, tunnelling, and user identity are not available for inband telemetry data.

Address Search

Address Search supports searching MAC addresses, IP addresses of all formats,device IDs, and hostnames of inventory devices.

The Address Search page can be found in the primary Devices view on the sidebar. Navigating to it will open the Address Search page.

Enter the search information and press Enter to view the search results.

There are two tabs available in the search results view.

Network Location is the default view.This view displays detailed information from the MAC, ARP, and LLDP Tables.
Flow Visibility view displays the traffic that is being sent and received by all IP addresses associated with the search result.

Status of Interfaces

The Interfaces section provides status of Ethernet interfaces, VLAN interfaces, IP interfaces, and port channels.

Sub-sections provide detailed information on Ethernet interfaces, routed ports, port channels, traffic counters, LLDP neighbors, and Power Over Ethernet.

Power Over Ethernet

Power Over Ethernet (PoE) is a technology for delivering electrical power along with network data over physical Ethernet connections. Some benefits of PoE are provided below:

Reduces the need of extension cables and additional outlets
Provides a reliable power source on difficult terrain
Prevents data transmission hiccups
Substantial reductions in space usage, cost, and time

In CloudVision, the Power Over Ethernet screen provides a summary of all interfaces along with information on each interface.

The Power Over Ethernet screen displays the following information:

Summary of All Interfaces
- Total Approved Power - Sum of the approved maximum power amounts configured for each Ethernet port
- Total Granted Power - Sum of the approved power amounts minus power loss to transmission over Ethernet cables
- Total Output Power - Sum of actual power amounts delivered to each powered Ethernet device

Information on Individual Interfaces
- Interface - Interface name
- Port Class - Maximum power in watts (W)
- Port State - Operational status of a PoE device connected to the port
- Approved Power - Configured maximum power output in watts (W) for the interface
- Granted Power - Maximum power available to the device
- Output Power - Power drawn by the device
- Output Current - Current available on the PoE link in milliamps (mA)
- Output Voltage - Voltage available over the PoE link in volts (V)

Note: PoE metrics are also available in the Metrics Explorer and can be built into custom metrics dashboards. Data on individual interfaces is available under the Interfaces metric type.

Viewing 802.1x Details for Endpoint Search

From the 2023.2.0 release onward, you can view additional functionality (Endpoint Authentication tab) when you search for the device details using the Devices > Endpoint Search page from the CloudVision portal. You can view the device details by entering the MAC address, IP address, device name, or device ID in the search window. For example:

Based on the configuration, the device details are displayed, with three tabs: Network Location, Flow Visibility, and Endpoint Authentication. For details on Network Location and Flow Visibility, see the Address Search sections. From the 2023.2.0 release onward, the Endpoint Authentication tab is also visible as in the example here:

The Endpoint Authentication tab displays 802.1x information for the MAC addresses associated with the searched device or endpoint. If there is no 802.1x information for the searched MAC Addresses, a "No data found" page is displayed as here:

If there is 802.1x information associated with the searched MAC address, a card with Operational, AAA, and Quick Links are displayed for that MAC address as in the example here.

Figure 28. Endpoint_Authentication_Results

The following 802.1x details are displayed for the searched device or endpoint:

Operational tab
- User Name
- Authentication Method
- Authentication Mode
- Authentication Status
- Supplicant State
- Fallback Applied
- Calling-Station-Id
- Reauthentication Behavior
- Reauthentication Interval
- Time until Reauthentication
- VLAN ID
- VLAN Type
- Accounting Session ID
- Captive Portal
AAA tab
- Arista-WebAuth
- Filter-Id
- IP Address
- NAS-Filter-Rule
- Service Type
- Session Timeout
- Termination Action
- Tunnel Private Group ID
- Arista Periodic Identity
- Arista Dynamic Host Mode
- Arista Device Type
Quick Links tab
- Link to the associated device in Topology
- Link to the Dot1x sections for the associated device
- Link to the Dot1x sections via Ethernet for the associated interface
- Link to the Telemetry Browser to view the additional fields that are not displayed in Endpoint Search

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Key CV-CUE Operations and Directories

CV-CUE is containerized as a service on CV. See the Wifimanager CLI Commands section for a list of CV-CUE CLI commands and their descriptions.

For details on how to configure, monitor, and troubleshoot WiFi using CV-CUE, see the CV-CUE User Guide on the Arista CV-CUE Support Portal at https://www.arista.com/support/customer-portal. You can access the portal from the WiFi - Support Portal tile on your dashboard. For details and credentials to access the portal, contact This email address is being protected from spambots. You need JavaScript enabled to view it..

CVPI Commands for CV-CUE

The following table lists the operations you can perform on wifimanager and the corresponding CVPI commands used.

Table 1. CVPI Commands
Operation	CVPI Command
start	cvpi start wifimanager
stop	cvpi stop wifimanager
status	cvpi status wifimanager
restart	cvpi restart wifimanager
reset	cvpi reset wifimanager
backup	cvpi backup wifimanager
restore	cvpi restore wifimanager </path/to/backup/file>
debug	cvpi debug wifimanager

Note: The backup restore fails if the user running the restore command does not have access to the path where the backup file is stored.

The restart command restarts the wifimanager service, whereas the reset command resets wifimanager settings and data to factory default values. The debug command generates a debug bundle containing log files and configuration files that can be used to troubleshoot issues.

The following table lists the operations you can perform on aware and the corresponding CVPI commands used.

Table 2. Aware CVPI Commands
Operation	CVPI Command
start	cvpi start aware
stop	cvpi stop aware
status	cvpi status aware

Wifimanager Directories

CV-CUE stores its data in docker volumes that reside under the /data/wifimanager directory on the CV. The following table lists the important wifimanager directories and the information they contain.

Table 3. Contents of wifimanager Directories
Directory on CV	Contains
/data/wifimanager/log/glog	Application logs
/data/wifimanager/data/conf	Configuration files
/data/wifimanager/data/data	System data files/directories
/data/wifimanager/data/instances	Customer data files/directories
/data/wifimanager/data/pgsql_data	Postgres data
/data/wifimanager/log/slog	System logs
/data/wifimanager/backup	On-demand backups

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Wifimanager CLI Commands

The following table provides the list of wifimanager CLI commands and their descriptions.

Table 1. Wifimanager CLI Commands
Command	Description
db backup	Backs up the database to the specified remote server.
db clean	Cleans up resources without disrupting services.
db restore	Restores the database from a previous backup on a remote server.
db reset	Resets the database to factory defaults but maintains network settings.
get cert	Generates a self-signed certificate.
get openconfig mode	Displays current OpenConfig mode.
get cors	Displays the current status of CORS support.
get certreq	Generates a Certificate Signing Request.
get db backup info	Displays scheduled DB backup information.
get debug	Creates a debug information tarball file. This file can be used for debugging.
get debug verbose	Creates a basic debug information tarball.
get debug ondemand	Displays the debug information.
get device upgrade bundles	Displays information about device upgrade bundles available in the local repository.
get device repo config	Displays configuration (Mode and Hostnames) for repositories that store upgrade bundles and device capability information.
get idle timeout	Displays the current idle timeout value. A value of 0 indicates no timeout.
get integrity status	Checks the integrity of critical server components.
get ha	Displays High Availability (HA) Pair configuration and service status.
get lldp	Displays the LLDP configuration.
get remote logging	Displays the remote logging configuration.
get log config	Displays the logger configuration.
get log level gui	Displays log levels of GUI modules.
get log level aruba	Displays the log level of Aruba Mobility Controller Adapter module.
get log level wlc	Displays the log level of the Cisco WLC Adapter module.
get log level msmcontroller	Displays the log level of HP MSM Controller Integration.
get msmcontroller cert	Generates a self-signed certificate for HP Adapter.
get msmcontroller certreq	Generates a Certificate Signing Request for HP Adapter.
get access address	Shows access IP Address/Hostname of this server.
get server config	Displays complete server configuration.
get server cert	Uploads server certificate to a remote host.
get server check	Runs a server consistency check and displays results. If any fatal item fails, a failure result is recorded.
get server tag	Displays the custom tag set by the user.
get serverid	Displays the server ID.
get sensor debug logs	Uploads AP debug logs to the specified upload URL.
get sensor list	Displays the list of APs.
get sensor reset button	Displays the state of the AP's pinhole reset button.
get status	Displays the status of server processes.
get ssh	Displays the SSH server status.
get version	Displays the version and build of all the server components.
get packet capture	Captures packets on Public and HA/Management network interface(s).
set scan config	Modify AP background scanning parameters.
set openconfig mode	Enable/disable OpenConfig mode.
set cert	Installs a signed SSL certificate.
set cors	Enables or disables CORS support.
set dbserver	Starts/stops database server.
set db backup info	Sets scheduled DB backup information.
set device capability	Updates the device capability information.
set device upgrade bundles	Upload/delete device upgrade bundles in the local repository.
set device repo config	Sets configuration (Mode and Hostnames) for repositories that store upgrade bundles and device capability information.
set erase	Configures the backspace key.
set ha dead time	Changes the Dead Time of High Availability (HA) service.
set ha link timeout	Sets the timeout in seconds to signal Data Sync Link failure.
set idle timeout <timeout-in-minutes>	Sets the idle timeout for the command shell. A value of 0 disables the idle timeout.
set lldp	Sets LLDP configuration.
set remote logging	Sets remote logging configuration.
set log config	Sets the configuration of the logger.
set log level gui	Sets log levels of GUI modules.
set log level aruba	Sets the log level of Aruba Mobility Controller Adapter Module.
set log level wlc	Sets log level of Cisco WLC Adapter Module.
set log level msmcontroller	Sets log level of HP MSM Controller Integration.
set msmcontroller cert	Installs a signed SSL certificate for HP Adapter.
set loginid case sensitivity	Toggles login ID case sensitivity.
set server	Starts/stops application server.
set server discovery	Changes server discovery settings on given AP(s).
set server tag	Configure a custom tag for files generated by this server.
set access address	Sets access IP Address/Hostname of the server.
set serverid	Sets server ID.
set ssh	Starts/stops SSH access to the server.
set communication passphrase	Sets the communication passphrase used for AP-server authentication and to encrypt the communication between APs and the server.
set communication key	Sets the communication key used for AP-server authentication and to encrypt the communication between APs and the server.
set communication key default	Resets the communication key used for AP-server authentication and to encrypt the communication between APs and the server.
set sensor legacy authentication	This allows/disallows APs running on versions lower than 6.2 to connect to the server.
set sensor reset button	Sets the state of the AP's pinhole reset button (select AP models only).
set smart device oui	Add, remove MAC OUI's for specific smart device type IDs.
set webserver	Starts/stops web server.
set wlc mapper	Manage Cisco WLC Custom Mapper file.
exit	Exits the config shell session.
ping <Hostname/IP Address>	Ping a host.
reset locked gui	Unlocks Graphical User Interface (GUI) account for the "admin" user.
reset password gui	Sets Graphical User Interface (GUI) password for the "admin" user to factory default value.
upload db backup	Uploads successful DB backup(s) to an external server.
application signature update	Updates app visibility signature.

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

General Customizations

CloudVision Portal (CVP) enables you to customize the grid columns of CVP graphical user interface (GUI) pages. You can customize the grid columns of all CVP GUI grids.

CVP also enables you to easily paginate (navigate) through the pages of the grids of the GUI. The pagination controls are available in all grids.

The configuration guide is no longer being updated. Please refer to the CloudVision Help Center going forward.

Column Customization

CloudVision Portal (CVP) enables you to customize the columns of the grids of CVP graphical user interface (GUI) pages. You can customize columns of any grid of the CVP GUI.

You use the Columns Settings dialog to customize the columns of the active grid. You can open the Columns Settings dialog by clicking the column customization icon, which is available of every page of the GUI.

Complete these steps to customize grid columns.

Go to a page that has the grid you want to customize.
Click the column customization icon.
Figure 2. Column Settings dialog
Use the arrow icons to rearrange the columns of the grid as needed.
Once you are done rearranging the grid columns, click OK to save the changes.

Page 15 of 19

End of Support

Telemetry Platform Components

NetDB State Streaming Component

CloudVision Analytics Engine Component

Supplementary Services: Splunk

Requirement

Installation

Quick Start

Architecture

Accessing the Telemetry Browser Screen

Viewing Devices

Tiles View

Tabular View

Viewing the PTP Slave Port Interface Metric in Devices

Event Rollup

Event List

Detailed Event View

Interface Rates Breached Thresholds Events

PTP Events

Configuring PTP Events

Creating PTP Domains

Configuring PTP Events

Inconsistent PTP Domain ID

Unexpected PTP Grandmaster ID

Inconsistent PTP Grandmaster ID

Viewing Device Details

Compliance

Device Overview

Environment Details

Switching Information

Routing Information

System Information

802.1X Metrics

Accessing 802.1X Metrics

802.1X Dashboard View

Viewing Traffic Flows

Enabling Traffic Flow Tracking

Enable sFlow Sampling on a Device

Enable Hardware Based IPFIX Flow Tracking

Accessing the Global Traffic Flows Screen

Charts View

Summary Table View

Flow Records View

Accessing the Device Specific Traffic Flows Screen

Charts View

Charts View

Heatmap View

Summary Table View

Flow Records View

Address Search

Status of Interfaces

Power Over Ethernet

Viewing 802.1x Details for Endpoint Search

Key CV-CUE Operations and Directories

Wifimanager Directories

Wifimanager CLI Commands

General Customizations

Column Customization