Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Before creating the quick action you will need to have your Command Set file created. opConfig lets you organize whatever commands you'd like it to run into an arbitrary number of groups which we call command sets. Let's create a basic command set using df to check the disc space on a Linux device for the purposes of this How-To however, these command sets can be as simple or as complicated as needed to complete the required desired tasks.

Command sets are stored in the single file conf/command_sets.nmis in opConfig before 2.2.4, and since 2.2.4 opConfig supports this and individual command set files in conf/command_sets.d/. It is recommended that you use individual files (as that makes things easier to maintain and more robust, e.g. should one file have syntactical problems). For backwards compatibility the old single file is consulted first, then any individual ones. opConfig loads a command set when it's seen for the first time, and any subsequent occurrences of a clashing config set (i.e. same name) will be ignored but logged.

...

namestringName which is shown at the top of the quick action element
descriptionstringText shown under the quick action name, useful to describe what the action does
command_setsarray of stringsCommand set keys which you wish to be run
nodesarray of stringsNames of nodes which you wish the command sets to be run against
buttonLabelstringText of the run button
buttonClassstring

Css class applied to the button to colour it.

  • btn-default
  • btn-primary (default, blue)
  • btn-success (green)
  • btn-warning (orange)
  • btn-danger (red)

Step 3: Confirm your Quick Action is working

After adding your Quick Action entry to the opConfig_action-elements.json file, navigate to opConfig and select 'Virtual Operator'. As shown in the screenshot below the newly created Quick Action 'Linux Disc Space Test' is now displaying. Click on the button to start the Quick Action.

Image Added

After clicking the Quick Action button the page below will auto fill the nodes provided in the opConfig_action-elements.json file as well as the Command Sets we created in the df_test.nmis file. Schedule a time for the Quick Action to run, give it a name and a description then click 'Schedule'.

Image Added

Once the job has been completed you can view the results and details of the Quick Command. To view the command output click on the command in the Commands table as indicated by the arrow in the screenshot below.

Image Added

The page below displays the command output as well as the Command Summary and the Most Recent Revisions. That's it, that's all there is to it! Your Quick Action is working!

Image AddedImage Removed

...