Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Logging

Use the Logging template for all Viptela devices to configure logging to either the local hard drive or a remote host.

Navigate to the Template Screen and Name the Template

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. In the Device tab, click Create Template.
  3. From the Create Template drop-down, select From Feature Template.
  4. From the Device Model drop-down, select the type of device for which you are creating the template.
  5. To create a custom template for Logging, select the Factory_Default_Logging_Template and click Create Template. The Logging template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining Logging parameters. You may need to click a tab or the plus sign (+) to display additional fields.
  6. 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.
  7. 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.

Minimum Logging Configuration

The following logging parameters are configured by default on all Viptela devices:

  • Log event notification system log (syslog) messages are logged to a file on the local device's hard disk, at a priority level of "information."
  • Log files are placed in the directory /var/log on the local device.
  • Log files are readable by the "admin" user.

Configure Logging to the Local Disk

To configure logging of event notification system log messages to the local device's hard disk, select the Disk tab and configure the following parameters:

Parameter Name Description
Enable Disk Click On to allow syslog messages to be saved in a file on the local hard disk, or click Off to disallow it. By default, logging to a local disk file is enabled on all Viptela devices.
Maximum File Size Enter the maximum size of syslog files. Syslog files are rotated on an hourly basis based on the file's size. When the file size exceeds configured value, the file is rotated and the syslogd process is notified.
Range: 1 through 20 MB
Default: 10 MB
Rotations

Enter the number of syslog files to create before discarding the oldest files.
Range: 1 through 10
Default: 10

Priority Select the priority level of the syslog message to save to the log files. The severity indicates the seriousness of the event that generated the message. The default priority value is "informational", so, by default, all syslog messages are recorded.
The priority level can be one of the following (in order of decreasing severity):
• Emergency—System is unusable (corresponds to syslog severity 0).
• Alert— Action must be taken immediately (corresponds to syslog severity 1).
• Critical—Critical: A serious condition (corresponds to syslog severity 2).
• Error—An error condition that does not fully impair system usability (corresponds to syslog severity 3).
• Warning—A minor error condition (corresponds to syslog severity 4).
• Notice—A normal, but significant condition (corresponds to syslog severity 5).
• Informational—Routine condition (the default) (corresponds to syslog severity 6).

To save the feature template, click Save.

CLI equivalent:

system 
  logging
  ​  disk  
      enable
      file
        rotate number
        size megabytes      
      priority priority

Configure Logging to Remote Severs

To configure logging of event notification system log messages to a remote server, click the Server tab. Then click Add New Server and configure the following parameters:

Parameter Name Description
Hostname/IP Address

Enter the DNS name, hostname, or IP address of the system on which to store syslog messages.

To add another syslog server, click the plus sign (+). To delete a syslog server, click the trash icon to the right of the entry.

VPN ID Enter the identifier of the VPN in which the syslog server is located or through which the syslog server can be reached.
Range: 0 through 65530
Source Interface Enter the specific interface to use for outgoing system log messages. The interface must be located in the same VPN as the syslog server. Otherwise, the configuration is ignored. If you configure multiple syslog servers, the source interface must be the same for all of them.
Priority

Select the severity of the syslog message to save. The severity indicates the seriousness of the event that generated the message. priority can be one of the following:
• Emergency—System is unusable (corresponds to syslog severity 0).
• Alert— Action must be taken immediately (corresponds to syslog severity 1).
• Critical—Critical: A serious condition (corresponds to syslog severity 2).
• Error—An error condition that does not fully impair system usability (corresponds to syslog severity 3).
• Warning—A minor error condition (corresponds to syslog severity 4).
• Notice—A normal, but significant condition (corresponds to syslog severity 5).
• Informational—Routine condition (the default) (corresponds to syslog severity 6).

Click Add to save the logging server.

To edit a logging server, click the pencil icon to the right of the entry.

To remove a logging server, click the trash icon to the right of the entry.

To save the feature template, click Save.

CLI equivalent:

system 
  logging 
    ​server (dns-name | hostname | ip-address)
      priority priority
      source-interface interface-name
      vpn vpn-id

Release Information

Introduced in vManage NMS in Release 15.2.

  • Was this article helpful?