The NMIS Support Tool collects all relevant information regarding an NMIS server's status and configuration which can be used to provide support. It will also create a simple report that users can use for self-diagnostics.
This tool is run from a command prompt.
sudo /usr/local/nmis9/admin/support.pl action=collect |
Once completed, the support tool will generate a list of any simple errors that it finds, such as low disk space or invalid names. It will also create a support file containing the critical information and tell the user where that support file is - please include that support file in any requests for support.
The Support Tool also runs the NMIS selftest, displays any problems detected, and runs NMIS' automatic repair procedure if correctables are detected (i.e. file ownerships, permissions and directory existence are verified and fixed if incorrect). The Support Tool will report any errors when it runs and also create a support_report.html file which contains an easy-to-read report containing useful information for troubleshooting.
The Support Tool:
The tool will collect information about your installation which will help Opmantek support in fixing your problem and place it in a support file in the directory given for report_dir (/tmp in the example above). Please attach this file in your request to Opmantek support.
Running support.pl without arguments shows a help screen.
The syntax for support.pl is:
support.pl action=[collect/run-bot] [report_dir=...] [public=t/f] [node=nodeA] [node=nodeB ...] [bot=0] [support_file=] [maxzipsize=] [maxlogsize=] [maxopstatus=] [maxoperrors=] |
action
: this can be set to collect
or run-bot
. collect will collect data and use it to generate a report, run-bot will use data collected from a previous collect to create the report. If run-bot is used, you must specify support_file=
support.pl action=collect |
support_file
: Specify the location of the support file if using run-bot for action.support.pl action=run-bot support_file=/tmp/myfile.zip |
public
: If set to false all credentials and other sensitive information will be removed and are not included in the support file.
support.pl action=collect public=f |
node
: if defined, the tool will also collect node specific information. This can be set to * to collect on all nodes, but may make the data file larger than desirable.
support.pl action=collect node=NodeName |
bot
: if set to 0, support.pl will not create a support_report.html containing an easy-to-read summary.
support.pl action=collect bot=0 |
report_dir
: Determines where the support file will be saved. Needs to be full path defined, Default is /tmp
support.pl action=collect report_dir=/home/nmis/reports/ |
maxzipsize
: Defines the maximum size of the support file in bytes. Default is 10 MiB.
support.pl action=collect maxzipsize=2000000 |
maxlogsize
: Defines the maximum size of the log file in bytes. Default is 4 MiB.
support.pl action=collect maxlogsize=104857600 |
maxopstatus
: Defines the maximum number of status messages. Default is 500.
support.pl action=collect maxopstatus=138 |
maxoperrors
: Defines the maximum number of errors. Default is 100.
support.pl action=collect maxopstatus=50 |
You most likely already have the support tool installed.
NMIS 8.5G and NMIS 9.1.0G and newer ship with the support tool preinstalled. It can be found in the admin folder - typically /usr/local/nmis9/admin for NMIS9 and /usr/local/nmis8/admin for NMIS8.
If your installation is older, the tool can be downloaded from the following links: