Configuring Viptela Observer jobs
You use the Viptela Observer to load managed Viptela SD-WAN control plane, vEdge and their associated network resources, and then visualize this data as a topology view.
Before you begin
Important: The Viptela Observer supports version 18.4.302 of Cisco SD-WAN.
Ensure you have the server details to hand, such as the username and password.
About this task
The Viptela Observer targets the Cisco SD-WAN (or 'Cisco Viptela') system. A Viptela Observer job extracts server information and its associated network resources from Viptela through REST API. The observer loads and updates the resources and their relationships and then displays them as a topologgy view.
You define and start the following job.
Full Topology Upload job
By default, Load jobs are one-off, transient jobs that do a full upload of all requested topology data as soon as they are triggered.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: See the Configuring observer jobs security topic for more information.
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| Data center name | Specify the data center the vEdge runs in. | Required. If you want to discover multiple vEdge locations or sets, then provide a different data center, for example EURDC01,USDC01. |
| Cisco Viptela vManage host IP | Enter the Cisco SD-Wan Viptela vManage host IP. | Required |
| Cisco Viptela API port. | Specify the Cisco SD-Wan Viptela vManage API port. | Required. The default value is 8443. |
| Username to login to Cisco Viptela service | Specify the Cisco SD-Wan Viptela vManage username. | Required |
| Password for Cisco Viptela user | Specify the Cisco SD-Wan Viptela vManage password. | Required. A plain text password can be entered. |
| Include the control plane data | Select true to load the control plane data. | Optional |
| vEdge grouping preference for defined topology | Specify the vEdge grouping preference for your topology. | Optional. Supported grouping: device-group (default), site-id Data Tenant |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| Generate debug support file | Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. | Optional |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |