Networking UFM Telemetry Documentation

Distributed Telemetry - Switch Telemetry Agent

Overview

Distributed Telemetry is a UFM Telemetry mode in which the telemetry of the whole fabric is sampled from managed switches and hosts.

  • A managed switch samples itself and the hosts connected directly to it.

  • Each managed switch Telemetry Instance (TI) reports to one of several host TIs through management datagrams (MADs).

  • If a switch cannot sample a fabric GUID or port that can be sampled, the host TI samples it.

The whole process is orchestrated by UFM Telemetry Manager (UTM) on the top load balancer.

Switch telemetry is organized as a Docker container (the Switch Agent) with a telemetry package inside.

Distributed Telemetry components relation
Distributed Telemetry Component Relationships

Terminology

The Switch Telemetry Docker image contains:

  • The Switch Agent, an HTTP server running inside the container.

  • A Switch Telemetry Instance (Switch TI), which you can start or stop within the container.

Deploying or removing the Switch Agent means deploying or removing the Switch Telemetry container.

Deployment

The deployment process is described in the UFM Telemetry Manager (UTM) documentation.

The deployment script pulls the Switch Telemetry Docker image.

After you prepare the setup, enable Distributed Telemetry in utm_config.ini, as explained in the chapter Configuration File.

Running Distributed Telemetry via HTTP API

The commands in this section apply to UTM standalone mode only.

Access to the UTM HTTP API depends on the UTM run mode. For more details, see the section REST API of UFM Telemetry Manager (UTM).

To get help for all HTTP API endpoints, use the /help endpoint:

UTM HTTP API Help
Bash
curl -sk https://127.0.0.1:8888/help

With the UTM HTTP API, you can:

  • Get the status of Switch Agent and Switch Telemetry instances

  • Deploy or remove Switch Agent containers

  • Start or stop Switch Telemetry inside deployed containers

  • Set the list of switch IP addresses to monitor periodically

To work with Distributed Telemetry, follow this recommended flow:

  • Deploy:

    • Check the switch status and identify the switch IP addresses to use

    • Set the list of switches to monitor

    • Deploy Switch Agents to the switches on this list

    • Start the switch TIs

  • Cleanup:

    • Stop the switch TIs

    • Remove the Switch Agents

    • Check the switch status

The following sections describe the Switch Agent and Switch Telemetry APIs.

API for Switch Agents

  • Get the status of the managed switches in JSON format.

    get managed switches status

    Bash
    # all managed switches
    curl -sk https://127.0.0.1:8888/managed_switches_status
    
    # managed switches set to periodic monitoring only:
    curl -sk https://127.0.0.1:8888/managed_switches_status?monitored_only=1
    

    The /managed_switches_status endpoint provides a JSON object for each managed switch. The object shows basic information about the switch and the status of the Switch Agent and Switch Telemetry (if the Switch Agent is installed on the switch).

  • If the switches use non-default credentials, upload them to UTM.

    Configure switch credentials

    Bash
    curl -s "http://127.0.0.1:8888/set_switch_creds?ip={SWITCH_IP}&user={SWITCH_USER}&pass={SWITCH_PASSWORD}"
    
  • Set the list of switch IP addresses to monitor periodically. Monitoring updates the switch information that the /managed_switches_status endpoint returns.

    set monitoring IP list

    Bash
    # monitor only IP1,IP2:
    curl -sk https://127.0.0.1:8888/switch_mon_list?ip_list=IP1,IP2
    
    # monitor all managed switches
    curl -sk https://127.0.0.1:8888/switch_mon_list?ip_list=all
    
  • Deploy Switch Agents to a list of managed switches.

    deploy Switch Agents

    Bash
    # deploy to all the managed switches:
    curl -sk https://127.0.0.1:8888/deploy_switch_agents?ip_list=all
    
    # deploy to switches with IPs IP1 and IP2:
    curl -sk https://127.0.0.1:8888/deploy_switch_agents?ip_list=IP1,IP2
    
  • Remove Switch Agents from a list of managed switches.

    remove Switch Agents

    Bash
    # remove from all the managed switches:
    curl -sk https://127.0.0.1:8888/remove_switch_agents?ip_list=all
    
    # remove from switches with IPs IP1 and IP2:
    curl -sk https://127.0.0.1:8888/remove_switch_agents?ip_list=IP1,IP2
    

API for Switch Telemetry

  • Start Switch Telemetry. Note that at least one managed host TI should be running.

    start Switch Telemetry

    Bash
    # for all running Switch Agents
    curl -sk https://127.0.0.1:8888/start_switch_telemetry
    
    # at a specific switch IP:
    curl -sk https://127.0.0.1:8888/start_switch_telemetry?ip=IP1
    
  • Stop Switch Telemetry:

    stop Switch Telemetry

    Bash
    # for all running Switch Agents
    curl -sk https://127.0.0.1:8888/stop_switch_telemetry
    
    # at a specific switch IP:
    curl -sk https://127.0.0.1:8888/stop_switch_telemetry?ip=IP1
    

Last updated: