FlexConfig System Variables
System variables are replaced with information obtained from the device itself or from policies configured for it.
You must use the menu in the FlexConfig object editor to add the variable for the first time to the script in the FlexConfig to establish the association with the system variable. Simply typing in the name of the system variable preceded by a $ sign does not create a system variable within the context of the FlexConfig object.
The following table explains the available system variables. Before using a variable, examine what is typically returned for the variable; see How to See What a Variable Will Return for a Device.
|
Name |
Description |
|---|---|
|
SYS_FW_OS_MODE |
The operating system mode of the device. Possible values are ROUTED or TRANSPARENT. |
|
SYS_FW_OS_MULTIPLICITY |
Whether the device is running in single or multiple context mode. Possible values are SINGLE, MULTI, or NOT_APPLICABLE. |
|
SYS_FW_MANAGEMENT_IP |
The management IP address of the device |
|
SYS_FW_HOST_NAME |
The device hostname |
|
SYS_FTD_INTF_POLICY_MAP |
A map with interface name as key and policy-map as value. This variable returns nothing if there are no interface-based service policies defined on the device. |
|
SYS_FW_ENABLED_INSPECT_PROTOCOL_LIST |
The list of protocols for which inspection is enabled. |
|
SYS_FTD_ROUTED_INTF_MAP_LIST |
A list of routed interface maps on the device. Each map includes a set of named values related to routed interface configuration. |
|
SYS_FTD_SWITCHED_INTF_MAP_LIST |
A list of switched interface maps on the device. Each map includes a set of named values related to switched interface configuration. |
|
SYS_FTD_INLINE_INTF_MAP_LIST |
A list of inline interface maps on the device. Each map includes a set of named values related to inline set interface configuration. |
|
SYS_FTD_PASSIVE_INTF_MAP_LIST |
A list of passive interface maps on the device. Each map includes a set of named values related to passive interface configuration. |
|
SYS_FTD_INTF_BVI_MAP_LIST |
A list of Bridge Virtual Interface maps on the device. Each map includes a set of named values related to BVI configuration. |
|
SYS_FW_INTERFACE_HARDWARE_ID_LIST |
A list of the hardware names for interfaces on the device, such as GigabitEthernet0/0. |
|
SYS_FW_INTERFACE_NAME_LIST |
A list of logical names for interfaces on the device, such as inside. |
|
SYS_FW_INLINE_INTERFACE_NAME_LIST |
A list of logical names for interfaces configured as passive or ERSPAN passive. |
|
SYS_FW_NON_INLINE_INTERFACE_NAME_LIST |
A list of logical names for interfaces that are not part of inline sets, such as all routed interfaces. |