About substitution parameters

Device

Substitutes an attribute from the device inventory. The parameter is device inventory field name. For example, ${device.host} substitutes the Host Name/IP Address value assigned in the device inventory. Valid parameter values include:

• access_port: Explicit TCP port for making connections
• aux_access_port: Explicit auxiliary TCP port for making connections
• aux_host: Auxiliary interface Host Name/IP Address
• aux_nat: Auxiliary interface NAT Address
• aux_password: Auxiliary interface DSP Login Password
• aux_priv_password: Auxiliary interface DSP Privileged Password
• aux_priv_user: Auxiliary interface DSP Privileged User Name
• aux_user: Auxiliary interface DSP Login User Name
• context_name: Security context name
• external_id: External identification to communicate with Atrium Configuration Management Database (CMDB)
• field_name: Any dynamic field name, for example, Description, Business Services, VRF
• host: Host Name/IP Address
• key: Database key of the device
• name: Name
• nat: NAT Address
• password: DSP Login Password
• priv_password: DSP Privileged Password
• priv_user: DSP Privileged User Name
• realm: Realm name
• user: Device Security Profile (DSP) Login User Name

Usage: ${device.parameter}

Agent

Substitutes an attribute from the device agent. Valid parameter values include:

• name: Agent name
• localhostFullName: Agent local host full name
• localhostAddress: Agent local host IP address. This is used by BMC Network Automation to communicate to a remote device agent.
• localhostIpv4Address: Agent local host IPv4 address. This is used for file transer between the agent and device.
• localhostIpv6Address: Agent local host IPv6 address. This is used for file transfer between the agent and device.
• localhostName: Local host name
• field_name: Any dynamic field name
• aux_name: Auxiliary interface agent name
• aux_localhostFullName: Auxiliary interface agent local host full name
• aux_localhostAddress: Auxiliary interface agent local host IP address
• aux_localhostName: Auxiliary interface agent name
  
  For information about how localhostFullName and localhostName are resolved see Managing global substitution parameters. Agent substitution parameters are useful when configuring syslog. One Template is used that substitutes the Agent's IP Address when configuring syslog on devices that it manages.

Usage: ${agent.parameter}

Substitutes a localized label for a device attribute or section of attributes as those labels appear inside a BNA Device Attributes configuration. Note that this is the label or name of the attribute, not its value for a particular device. Valid parameter values include:

• accessMode: The label for the access mode attribute

• address: The label for the hostname/IP address/URL attribute

• agent: The label for the device agent attribute

• auxiliaryInterface: The label for the auxiliary interface section

• category: The label for the category attribute

• created: The label for the creation date/time attribute

• deviceType: The label for the device type attribute

• dsp: The label for the device security profile attribute

• externalId: The label for the imported external ID attribute

• fileServer: The label for the remote image file server attribute

• groups: The label for the static groups section

• manager: The label for the manager attribute

• model: The label for the model attribute

• name: The label for the device name attribute

• natAddress: The label for the NAT address attribute

• online: The label for the online attribute

• osImage: The label for the OS image attribute

• primaryInterface: The label for the primary interface section

• realm: The label for the realm attribute

• securityContext: The label for the security context attribute

• systemDynamicFields: The label for the system-assigned dynamic fields section

• transferMode: The label for the transfer mode attribute

• userDynamicFields: The label for the user-assigned dynamic fields section

• vendor: The label for the vendor attribute

Usage: ${label.parameter}

Global

Substitutes a globally defined parameter defined under the Admin tab. The parameter is the global parameter name (such as logServer1, ntpServer1, snmpROAcl). For example, ${global.logServer1} substitutes the logServer1 global parameter. You can assign a default value (for example, ${global.logServer1:10.1.1.56}.

Usage: ${global.parameter:default}

Template

Templates can be substituted into rules and templates. The parameter is the template name. A common use of template substitution is managing Access Control Lists (ACLs). For example, all ACLs require a common set of ACL entries. Define the common ACL entries in a template that is substituted into various ACL Rules.

Note: A template can include nested references to other templates, which the system recursively resolves, for up to 10 layers of nesting.

Usage: ${template.parameter}

Runtime

Substitutes a runtime parameter assigned by the user. The user is prompted to enter the runtime value for the parameter. You can assign a default value (for example, ${runtime.snmpcommunity:w0$y3p9}. If you use this option, the user is presented with a dialog box to enter a runtime value. You can specify up to 2000 characters in the value. 

Usage: ${runtime.parameter:default}

You can also assign a defined set of options. In this case, the user is presented with the list of options to a runtime value.

Usage: ${runtime.parameter:option1, option2, option3,...}

Runtime parameters should not be used in policy-based span actions unless default parameter values are assigned and are intended to be used.

Internal function

Executes an internal or user-defined function and substitutes the function's return value. One level of nested eval or exec inside an eval is permitted. Internal functions can be used to encrypt or update passwords or perform arithmetic operations.

Password encryption functions

The functions listed in this row return an encrypted password that matches a clear-text argument.

Where:

• p1 is a clear-text password string
• p2 is salt required for some encryption methods
  
  See Updating device passwords for how to use these internal functions for managing password changes.

Usage:

• ${eval encrypt_cisco_vigenere_b64 p1 p2}
• ${eval encrypt_gnu_md5_b64 p1 p2}
• ${eval encrypt_gnu_extreme_md5_b64 p1 p2}
• ${eval encrypt_md5_b64 p1}
• ${eval encrypt_md5_hex p1}
• ${eval encrypt_sha_hex p1}

Arithmetic functions

The following functions are defined to perform integer arithmetic:

• add: Returns p1 + p2
• subtract: Returns p1 - p2
• multiply: Returns p1 + p2
• divide: Returns p1 / p2
• modulo: Returns p1 % p2

• Where:

  p1, p2, ... are optional input parameters to the program or script. These input parameters can in turn be any substitution parameter, such as ${runtime.p1}, ${global.p2}, ${container.p3}, etc.

  All of the parameters for these arithmetic functions must resolve as integers.

Usage:

• ${eval add p1 p2}
• ${eval subtract p1 p2}
• ${eval multiply p1 p2} 
• ${eval divide p1 p2}
• ${eval modulo p1 p2}

External program

Executes an external program and substitutes the program's return value.

Where:

• program is the name of the program or script located in the endorsed directory (that is, BCAN_DATA/endorsed).
• p1, p2, ... are optional input parameters to the program or script. These input parameters can in turn be any substitution parameter, such as ${runtime.p1}, ${global.p2}, ${container.p3}, etc.

Usage: ${exec program p1 p2 ...}

User-defined function

You can define your own functions. Use the following procedure to define a function:

1. Create a Java class to implement a user-defined method.
2. Specify the mapping of the function name and the implementation class in a property file named eval.properties, located in the BCAN_DATA directory. Create this file if it does not exist.
3. Put the Java class into a .jar file, and then copy the .jar file to BCAN_DATA/endorsed folder.
4. Restart the Tomcat server.
   
   Usage:
   
   To add two functions, toLowerCase and toUpperCase:* Create a class, say, com.mycompany.bbnaeval.MyStringFunctions.* Implement toLowerCase() and toUpperCase() methods. These methods needs to be public static.* Add the following lines to the eval.properties file:
   
   toLowerCase=com.mycompany.bbnaeval.MyStringFunctions
toUpperCase=com.mycompany.bbnaeval.MyStringFunctions

Device

X

X

X

X

X

X

X

X

X

Agent

X

X

X

X

X

X

X

X

X

Global

X

X

X

X

X

X

X

X

X

Template

X ¹

X

X

X

Run-Time

X

X

X

X

X

Internal
Function

X

X

X

X

X ²

X ²

External
Program

X

X

X

X ²

X ²

Pod

X

X

X

Container

X

X

X