System
Use the System template for all Viptela devices.
To configure system-wide parameters using vManage templates:
- Create a System feature template to configure system parameters, as described in this article.
- Create an NTP feature template to configure NTP servers and authentication. See the NTP help topic.
- Configure the organization name and vBond orchestrator IP address on the vManage NMS. See the Settings help topic. These settings are appended to the device templates when the templates are pushed to devices.
Navigate to the Template Screen and Name the Template
- In vManage NMS, select the Configuration ► Templates screen.
- In the Device tab, click Create Template.
- From the Create Template drop-down, select From Feature Template.
- From the Device Model drop-down, select the type of device for which you are creating the template.
- To create a custom template for System, select the Factory_Default_System_Template and click Create Template. The System template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining System parameters.
- In the Template Name field, enter a name for the template. The name can be up to 128 characters and can contain only alphanumeric characters.
- In the Template Description field, enter a description of the template. The description can be up to 2048 characters and can contain only alphanumeric characters.
When you first open a feature template, for each parameter that has a default value, the scope is set to Default (indicated by a check mark), and the default setting or value is shown. To change the default or to enter a value, click the scope drop-down to the left of the parameter field and select one of the following:
|
Parameter Scope |
Scope Description |
|---|---|
|
Device Specific (indicated by a host icon) |
Use a device-specific value for the parameter. For device-specific parameters, you cannot enter a value in the feature template. You enter the value when you attach a Viptela device to a device template. When you click Device Specific, the Enter Key box opens. This box displays a key, which is a unique string that identifies the parameter in a CSV file that you create. This file is an Excel spreadsheet that contains one column for each key. The header row contains the key names (one key per column), and each row after that corresponds to a device and defines the values of the keys for that device. You upload the CSV file when you attach a Viptela device to a device template. For more information, see Create a Template Variables Spreadsheet. To change the default key, type a new string and move the cursor out of the Enter Key box. Examples of device-specific parameters are system IP address, hostname, GPS location, and site ID. |
|
Global (indicated by a globe icon) |
Enter a value for the parameter, and apply that value to all devices. Examples of parameters that you might apply globally to a group of devices are DNS server, syslog server, and interface MTUs. |
Basic System-Wide Configuration
To set up system-wide functionality on a Viptela device, select the Basic Configuration tab and then configure the following parameters. Parameters marked with an asterisk are required.
| Parameter Field | Description |
|---|---|
| Site ID* (on vEdge routers, vManage NMSs, and vSmart controllers) | Enter the identifier of the site in the Viptela overlay network domain in which the device resides, such as a branch, campus, or data center. The site ID must be the same for all Viptela devices that reside in the same site. Range: 1 through 4294967295 (232 – 1) |
| System IP* | Enter the system IP address for the Viptela device, in decimal four-part dotted notation. The system IP address provides a fixed location of the device in the overlay network and is a component of the device's TLOC address. It is used as the device's loopback address in the transport VPN (VPN 0). You cannot use this same address for another interface in VPN 0. |
| Timezone* | Select the timezone to use on the device. |
| Hostname | Enter a name for the Viptela device. It can be up to 32 characters. |
| Location | Enter a description of the location of the device. It can be up to 128 characters. |
| Device Groups | Enter the names of one or more groups to which the device belongs, separated by commas. |
| Controller Groups (on vEdge routers only) | List the vSmart controller groups to which the vEdge router belongs. |
| Description | Enter any additional descriptive information about the device. |
| Console Baud Rate (vEdge routers only) |
Select the baud rate of the console connection on the vEdge router. |
| Maximum OMP Sessions (on vEdge routers only) | Set the maximum number of OMP sessions that a vEdge router can establish to a vSmart controller. Range: 0 through 100 Default: 2 |
| Dedicated Core for TCP Optimization (optional, on vEdge 1000 and 2000 routers only) | Click on to carve out a separate CPU core to use for performing TCP optimization. |
To save the feature template, click Save.
CLI equivalent:
system clock timezone timezone console-baud-rate rate controller-group-list numbers description text device-groups group-name host-name string location string max-omp-sessions number site-id site-id system-ip ip-address tcp-optimization-enabled
To configure the DNS name or IP address of the vBond orchestrator in your overlay network, go to the Administration ► Settings screen and click vBond.
Configure the GPS Location
To configure a device's location, select the GPS tab and then configure the following parameters. This location is used to place the device on the vManage NMS network map. Setting the location also allows the vManage NMS to send a notification if the device is moved to another location.
| Parameter Field | Description |
|---|---|
| Latitude | Enter the latitude of the device, in the format decimal-degrees. |
| Longitude | Enter the longitude of the device, in the format decimal-degrees. |
To save the feature template, click Save.
CLI equivalent:
system gps-location (latitude decimal-degrees | longitude decimal-degrees)
Configure Interface Trackers
To Track the status of transport interfaces that connect to the internet, click the Tracker tab. Then click Add New Tracker and configure the following parameters:
| Parameter Field | Description |
|---|---|
| Name | Name of the tracker. The name can be up to 128 alphanumeric characters. You can configure up to eight trackers. |
| Threshold | How long to wait for the probe to return a response before declaring that the transport interface is down. Range: 100 through 1000 milliseconds Default: 300 milliseconds |
| Interval | How often probes are sent to determine the status of the transport interface. Range: 10 through 600 seconds Default: 60 seconds (1 minute) |
| Multiplier | Number of times to resend probes before declaring that the transport interface is down. Range: 1 through 10 Default: 3 |
| End Point Type: IP Address | IP address of the end point of the tunnel interface. This is the destination in the internet to which the router sends probes to determine the status of the transport interface. For each tracker, you must configure either one DNS name or one IP address. |
| End Point Type: DNS Name | DNS name of the end point of the tunnel interface. This is the destination in the internet to which the router sends probes to determine the status of the transport interface. For each tracker, you must configure either one DNS name or one IP address. |
To save a tracker, click Add.
To save the feature template, click Save.
CLI equivalent:
system tracker tracker-name endpoint-dns-name dns-name endpoint-ip ip-address interval seconds multiplier number threshold milliseconds
To apply a tracker to an interface, configure it in& the VPN Interface Cellular, VPN Interface Ethernet, VPN Interface NAT Pool, or VPN Interface PPP configuration template. You can apply only one tracker to an interface.
Configure Advanced Options
To configure additional system parameters, click the Advanced tab:
| Parameter Name | Description |
|---|---|
| Control Session Policer Rate |
Specify a maximum rate of DTLS control session traffic, to police the flow of control traffic. |
| MTU of DTLS Tunnel |
Specify the MTU size to use on the DTLS tunnels that send control traffic between Viptela devices. |
| Port Hopping |
Click On to enable port hopping, or click Off to disable it. When a Viptela device is behind a NAT, port hopping rotates through a pool of preselected OMP port numbers (called base ports) to establish DTLS connections with other Viptela devices when a connection attempt is unsuccessful. The default base ports are 12346, 12366, 12386, 12406, and 12426. To modify the base ports, set a port offset value. To disable port hopping on an individual TLOC (tunnel interface), use the VPN Interface Ethernet configuration template. |
| Port Offset | Enter a number by which to offset the base port number. Configure this option when multiple Viptela devices are behind a single NAT device, to ensure that each device uses a unique base port for DTLS connections. Values: 0 through 19 |
| DNS Cache Timeout |
Specify when to time out the vBond orchestrator addresses that have been cached by the device. |
| Track Transport |
Click On to regularly check whether the DTLS connection between the device and a vBond orchestrator is up. Click Off to disable checking. By default, transport checking is enabled |
| Local vBond (only on vEdge routers acting as vBond orchestrators) |
Click On to configure the vEdge router to act as a vBond orchestrator. Then specify the DNS name for the vBond orchestrator or its IP address, in decimal four-part dotted notation. |
| Track Interface (on vEdge routers only) | Set the tag string to include in routes associated with a network that is connected to a non-operational interface. Range: 1 through 4294967295 |
| Multicast Buffer (on vEdge routers only) | Specify the percentage of interface bandwidth that multicast traffic can use. Range: 5% through 100% Default: 20% |
| USB Controller (on vEdge 1000 and 2000 series routers only) |
Click On to enable or click Off to disable the USB controller, which drives the external USB ports. If you enable the USB controller, the vEdge router reboots when you attach the device template to the device. |
| Gateway Tracking |
Click On to enable or click Off to Disable tracking of default gateway. Gateway tracking determines, for static routes, whether the next hop is reachable before adding that route to the device's route table. |
| Host Policer Rate (on vEdge routers only) |
Specify the maximum rate at which a policer delivers packets to the control plane. |
| ICMP Error Rate (on vEdge routers only) | Specify how many ICMP error messages a policer can generate or receive. Range: 1 through 200 pps Default: 100 pps |
| Allow Same-Site Tunnel (on vEdge routers only) | Click On to allow tunnels to be formed between vEdge routers in the same site. Note that no BFD sessions are established between the two collocated vEdge routers. Default: Off |
| Route Consistency Check (on vEdge routers only) | Click On to check whether the IPv4 routes in the device's route and forwarding table are consistent. |
| Collect Admin Tech on Reboot | Click On to collect admin-tech information when the device reboots. |
| Idle Timeout | Set how long the CLI is inactive on a device before the user is logged out. If a user is connected to the device via an SSH connection, the SSH connection is closed after this time expires. Range: 0 through 300 seconds Default: CLI session does not time out |
| Eco-Friendly Mode (on vEdge Cloud routers only) | Click On to configure a vEdge Cloud router not to use its CPU minimally or not at all when the router is not processing any packets. |
To save the feature template, click Save.
CLI equivalent:
system admin-tech-on-failure allow-same-site-tunnels (on vEdge routers only) control-session-pps rate eco-friendly-mode (on vEdge Cloud routers only) host-policer-pps rate (on vEdge routers only) icmp-error-pps rate (on vEdge routers only) idle-timeout seconds multicast-buffer-percent percentage (on vEdge routers only) port-hop port-offset number route-consistency-check (on vEdge routers only) system-tunnel-mtu bytes timer dns-cache-timeout minutes track-default-gateway track-interface-tag number (on vEdge routers only) track-transport upgrade-confirm minutes [no] usb-controller (vEdge 1000 and 2000 routers only) vbond (dns-name | ip-address) local (on vEdge routers acting as vBond controllers)
Release Information
Introduced in vManage NMS in Release 15.2.
In Releases 15.3.8 and 15.4.3, add Track Interface field.
In Release 17.1.0, add Route Consistency Check and Collect Admin Tech on Reboot fields.
In Release 17.2.0, add support for CLI idle timeout and ecofriendly mode.
In Release 17.2.2, add support for interface status tracking.