Supported Built-in Functions in Network Intent

Convert storage units (such as KB, MB, GB, etc.) to byte.
Note:

• Returning “-1” if the input is not a valid storage unit.
• The input parameter is case-insensitive, and abbreviations are allowed, e.g., GB, G, g.

ByteConverter("35MB")
Return: 36,700,160 Bytes

(35x1024x1024)

Calculate interface traffic (bit) based on given traffic (byte) data and system uptime information.
Note: RFC 1213 defines sysUp Time as a 32-bit counter in 1/100 second.

Return formalized interface traffic and traffic utilization string based on given traffic (byte), system uptime, and bandwidth information.
Note:

• RFC 1213 defines sysUp Time as a 32-bit counter in 1/100 second.
• The format of bandwidth is GAUGE32.

Check whether a device still exists in the current domain.

Note: IP address can also be passed in as hostname variable.

DoesDeviceExist(“BJ*POP”)

Return: True/False

DeleteMap("Public\\OpenTopo")

Return: N/A

This function calls the Golden Config service to validate the config file of a specified device against the specified golden config rule.

Obtain the number of rows by using a given table name.
Note:

• Returning “-1” if the input is not a valid table.
• Only applies to Compound Variables.

Convert an IP address to the hostname. The input can be an IP or a masked IP, e.g., "192.168.91.1/28".
Note:

• Returns NULL if the IP is invalid.
• If configured on multiple devices, returns one hostname randomly.

Obtain a device interface full name by using a given IP address. Masked IP is allowed.
Note:

• Returns NULL if invalid.
• If configured on multiple interfaces, returns one randomly.

Return the subnet of an IP address. Masked or full address with subnet mask is allowed.
Note:

• Returns NULL if the IP is invalid.
• IP without mask follows class A|B|C boundary.

Map("Public\\OpenTopo")

Return: map

Create a new text file in NetBrain files.
Note:

• Type can be "Text", "CSV", "Json".
• Default is "Text". Name should not contain extension.

NewMap("Public\\DeviceNeighbor")

Return: map

Replace the characters matched by the pattern with the string defined in the replacement.

Based on the input, match the characters to be replaced according to the defined pattern, and then replace these characters with the string defined in the replacement.

0: Specifies that no options are set.

1: Specifies case-insensitive matching.

2: For multiline mode, change the meaning of ^ and $ so they can match each line's beginning and end, not just the beginning and the end of the entire string.

RegexReplace(”{$enablepwd}”,"^!enable password ([^!]+)\n!","!enable password {$pwd}"),0)

Return: "!enable password {$pwd}"

Create a site object with an existing site for further operation.

Split a string by specified separators, each separator can be unique character.

The items spitted will form new string with each item as separate line. 

SplitToLines($IPs, "\ ")

Return: 

"10.10.10.1

10.10.10.2"

SplitByChars($site, "/| ", 1) 

Return: NA

This function is used to get the result of the latest golden config check result (against golden config rule) of the specified golden config rule for the specified device. 

Get_FHRP_Interfaces(string Virtual_IP)

Note: This function is supported in the following patch: [12.1.0.7]. Ensure your system is upgraded to this patch to use this function.

Get_FHRP_Interfaces("10.10.10.1", )

Note: The return is a List of Interface object.