2023-Nov-03-R11.1a

Device Driver Properties

The properties of the device driver contain the following tabs of information.

Live Access Tab

The Live Access tab is used to define how to log into a device and commands to send in different modes.

Property

Description

SNMP port

The SNMP port to access a device.

Telnet port

The telnet port to access a device.

SSH port

The SSH port to access a device.

Device CPU/Memory Usage OID

The OIDs used for monitoring the CPU and memory usage of a device.

Multi page prompt

The prompt to display the next line/screen of output. By default, the prompt is "--more--".

The command to exit

The command used to exit from the current command mode to the next highest command mode.

Yes/No prompt string

A prompt string to confirm or cancel.
By default, the prompt string includes "Yes or NO||Y/N||Yes/NO".

Interval to pause before entering password

The time in milliseconds that the system waits before entering the password.
Note: Generally, the system enters the password immediately after receiving the password prompt. But for a catalyst switch device, the system must wait some time to enter the password before the password is recognized as valid input. This default value is 0, except for the catalyst switch type device.

Invalid return

Determine whether a command return is invalid.

If the number of characters contained in the show command result is larger than the specified value (180 by default), the result will be treated as valid.
If the number of characters in the show command result is less than or equal to the specified value (180 by default), the system will further check whether the returned result contains the specified keywords. If yes, it will be recognized as an invalid result, indicating that it fails to execute the command.

Interactive Commands for Live Data Retrieval

Define the generic interactive commands for devices that use the same driver. Besides the existing two pairs of expected prompt and responsive commands, you can add more.

	Note: Use \|\| to separate multiple expected prompts. For more rules and formats, refer to Prompt and Command Definition on GUI.

Standard login script: define the command (such as enable) to enter the privileged mode and the command (such as terminal length 0) to stop the CLI paging.

Customized login script: customize the CLI login modes and scripts to access devices that use the same driver. Refer to Customizing Interactive CLI Prompts for a device for more details.

	Note: When multiple CLI modes are defined in a driver, the system polls them from top to bottom during the live access to a device until addressing the matching one.

Config File Tab

The Config File tab is used to specify how the system retrieves and parses the configuration file. The system uses both SNMP and CLI commands to build configuration files. When discovering a device, the system will first use SNMP to retrieve its hostname, vendor, and model information, then try to enter the non-privilege and privileged mode to obtain its full configurations file with the CLI commands. If the CLI commands work, then the contents obtained via SNMP will be overwritten. Therefore both of the methods are selected by default.

Category	Property	Description
Retrieve configuration file by CLI command	Config CLI Command	The CLI commands or command block used to retrieve configuration files.
	Auxiliary CLI Command	The CLI commands used to obtain and parse data, ensuring that the information stored in the config file is more concise. The commands are not stored in the config file.
	Identify device type and driver by keywords in config file	The keywords in the configuration file to identify the device type and driver of the device.
	Transform config file to known format by	If you specify an existing driver for a new device type, the format of the configuration file to be parsed might be different from an existing configuration file in the system. Use either way to transform the configuration file into a known format. Replacing equivalent keywords — Enter the keyword used in the new format of the configuration file in the Keyword column, and enter the known keyword used in the existing format of the configuration file that the system can parse in the Known equivalent keyword column. When the system uses the driver to parse the new configuration file, it will first replace the keywords in the configuration file with the equivalent keywords configured in this table. Python Script — select the python script and design a parser to translate the keywords to a known format.
	Parse transformed config file via	Select a device driver or the above python script to parse the transformed configuration file.
Use SNMP to Build Device or Build Configuration File	Use SNMP to build configuration file	Use either way to retrieve the configuration file to build the device model. Use MBI-2 OID Use Customized OID
Use SNMP to Build Device or Build Configuration File	Use SNMP to build device	Define python scripts to retrieve data, build a data model for a device and finally add the device to a domain.
Define comparison logic		Enter the number in the Skip from top field to specify which lines can be skipped during the comparison. The lines are counted from the top of the configuration files. Enter the regular expressions in the Option field to specify which lines can be ignored during the comparison.

Table Tab

This Table tab is used to specify how the system retrieves and parses Route Table, MAC Table, ARP Table, NDP Table, BGP Route Table and NCT (Network Control Table). By default, the system retrieves these data tables via SNMP, and you can also set it to retrieve them by executing CLI commands.

	Note: The JSON sub-tab defines the NCT to retrieve, and the NCT sub-tab defines the way to parse to a specific NCT table.

Take Route Table for example:

Category

Description

Retrieve route table by CLI command Up to pages

The maximum route table pages that the system can retrieve. The default value is 500. If the route table pages exceed the limit, the system will discard the exceeded pages.

CLI command for global route table — enter a CLI command or command block to retrieve global routing tables, such as show ip route.
CLI command for VRF route table — enter a CLI command or command block to retrieve VRF route tables, such as show ip route vrf $VrfName.
Note: The $VrfName variable represents a vrf name.
Parse CLI route table by script — enter scripts to retrieve and parse route tables.

Build route entry by SNMP

Calculate live path and retrieve routing table entries via SNMP.

Use MIB-2 route default — use the route MIB files to retrieve route tables.
Use MIB-2 forwarding MIB — use the forwarding MIB files to retrieve route tables.
Customized script — define a Python script to retrieve route tables.
Max number of rows in route table — limit the size of route entries that can be retrieved.

Advanced Tab

The Advanced tab specifies the python scripts used to retrieve device information (such as serial number and software version) and interface data (such as interface speed and duplex) of the same device type.