View Source

1. Objective

An example of how to use TextFSM-Based Structured Processing

Create an opConfig Command Set for Cisco IOS devices (IOS_HOURLY) that:

· Runs IOS CLI commands (e.g. show interfaces)

· Uses TextFSM-based plugins: TextFsm, TextFsmTable, TextFsmInventory, AlertTextFsmMTU

· Produces structured parsed output

· Generates custom table data

· Updates inventory

· Creates user-based alerts (e.g. MTU)

2. Command Set Definition (IOS_INTERFACE_INVENTORY)

Create the file under:

/usr/local/omk/conf/command_sets.d/IOS_INTERFACE_INVENTORY.json
and adds the FSM plugins to command set .
use_processing_plugins : which plugins to run during process_configuration step,
custom_table_configuration : How many table configurations are needed and their title and columns (This only works if TextFsmTable is part of use_processing_plugins)


"use_processing_plugins" : [
        "TextFsm","TextFsmTable","TextFsmInventory","AlertTextFsmMTU"
    ],
"custom_table_configuration" : [
        {
            "title" : "Custom Table Data 01",
            "labels" :[ "INTERFACE","DESCRIPTION", "BANDWIDTH", "MTU","SPEED", "PROTOCOL_STATUS"]
        },
        {
            "title" : "Custom Table Data 02",
            "labels" :[ "INTERFACE","DESCRIPTION"]
        }
    ],

Example configuration:

{
   "IOS_INTERFACE_INVENTORY" : {
      "active" : "true",
      "os_info" : {
         "os" : "IOS"
      },
      "modified" : 1770074947,
      "scheduling_info" : {
         "run_local" : null,
         "run_commands_on_separate_connection" : "false",
         "attempt_timeout_recovery" : 1,
         "parameters_required" : null
      },
      "parameters" : [],
      "purging_policy" : {
         "purge_older_than" : null,
         "keep_last" : 0,
         "autoprotect_first_revision" : null
      },
      "commands" : [
         {
            "command" : "show interfaces",
            "compare_to_previous_revision" : null,
            "use_collection_plugin" : "",
            "tags" : [
               "DAILY",
               "detect-change",
               "inventory",
               "report-change"
            ],
            "use_processing_plugins" : [
               "TextFsm","TextFsmTable","TextFsmInventory","AlertTextFsmMTU"
            ],
            "custom_table_configuration" : [
               {
                  "title" : "Custom Table Data 01",
                  "labels" :[ "INTERFACE","DESCRIPTION", "BANDWIDTH", "MTU","SPEED", "PROTOCOL_STATUS"]
               },
               {
                  "title" : "Custom Table Data 02",
                  "labels" :[ "INTERFACE","DESCRIPTION"]
               }
            ], 
            "report_level_min_changes" : null,
            "privileged" : "false",
            "multipage" : "true",
            "active" : "true"
         }
      ]
   }
}

3. Plugin Roles

TextFsm

· Parses raw CLI output using NTC templates

· Produces structured JSON data

TextFsmTable

· Generates structured table output using Command Set parameter: custom_table_configuration

TextFsmInventory

· Updates node inventory data

AlertTextFsmMTU

· Evaluates MTU values

· Creates alerts in opEvents when thresholds are triggered

4. Running the Command Set

Run using opconfig-cli:

/usr/local/omk/bin/opconfig-cli.pl act=run_command_sets nodes=omk-core2 names="IOS_INTERFACE_INVENTORY" debug=9

Or
Create a VO Job to run Command Set on selected nodes.

5. Expected Results

· Structured parsed output from show interfaces

· Custom tables visible in opConfig UI

· Inventory updates for interfaces

· Alerts created in opEvents for MTU conditions