<< Click here to display Table of Contents >>

Variable

Contents

Variable refers to semantic metrics that are extracted and parsed from network data.

This section contains the following topics:

▪Variable Type

▪Built-in Variables

▪Variables in Instant Qapp

Variable Type

The system supports the following types of variables. The format of variables is $<variable type>:<variable name>.

Type	Description	Format
String	Can be any string text, such as V13.1(12a).	$var1
Integer	Natural number, such as 0, and 1.	$int:var2
Double	Floating number, such as 3.1415926.	$double:var3
Boolean	True or false.	$bool:var4
Configlet	Similar to the String type, but mainly used to parse a specific configuration, such as OSPF and EIGRP, and display the configuration on maps as a note.	$configlet:var8

Tip: The variable type is allocated automatically when you select and define a variable. For example, the default format of a variable named CPU is $percent:cpu, and you can manually change it to $int:cpu for threshold analysis purpose.

Built-in Variables

The following table introduces the system built-in variables in a Qapp. For more built-in variables, refer to the Global Data Repository (GDR).

Variable Name	Description
$_device	A global PyDevice object representing the device on which the Qapp is running. It is a simple PyDevice object and not an array of PyDevice objects. The Qapp automatically loops through each of the selected devices.
$_device_queue	A variable representing the device queue table that the Qapp loops through.
$_command	The command on which the output is based.

Variable Name

Description

$_device

A global PyDevice object representing the device on which the Qapp is running.

It is a simple PyDevice object and not an array of PyDevice objects. The Qapp automatically loops through each of the selected devices.

$_device_queue

A variable representing the device queue table that the Qapp loops through.

$_command

The command on which the output is based.

Parser Variable Types in Instant Qapp

The following table introduces the available types of parser variables supported in Instant Qapp:

Parser Variable Type	Icon	Description
Single Variable	N/A	A basic variable type defined in a keyword parser.
Table Variable		A table-formatted variable defined in a table parser. It contains sub variables. Note: You can only drag this variable type to device labels directly.
Paragraph Variable		A paragraph-formatted variable defined in a paragraph parser. It contains sub-variables. Note: You can only drag this variable type to device labels directly. If its sub-variables contain an interface key, you can drag one or more sub-variables to interface labels.
Key Variable		An interface variable that has been configured as an interface key.

Two Levels of Variables in Instant Qapp

Both device-level and interface-level variables are highlighted in the result of Instant Qapp, with different background colors.

The following table introduces the background colors for the two levels of variables.

Variable Level	Icon
Device-level Variables	Icons are highlighted with a blue background color. For example: .
Interface-level Variables	Icons are highlighted with a green background color. For example: .