Creating

Toolkit

h6 { font-size: 0.95em; margin: 2em 0 1em; } pre { white-space: pre-wrap; }

Commands

(top)

Options
Option	Option Name	Required	Definition
--		Always When using: Always for this command

Generic Toolkit Information

The toolkit is a comprehensive suite of diagnostic tools and system actions. This has been designed to ensure a consistent structure to all diagnostic and updates tools for zymonic systems, run via the command line. In this way many functions are now easier to perform via the command line than previously.

All zymonic_toolkit.pl functions are formatted one of the following ways:


        zymonic_toolkit.pl [MODULE] [COMMAND] [COMMAND ARGUMENTS]
        zymonic_toolkit.pl [CONFIG FILE]

The MODULE element of the format is the category of command to be used. A list of the current available MODULES can be found on the manual index

If zymonic_toolkit.pl [MODULE] is entered on the command line the COMMANDs which are available for use, within that category of the toolkit, are listed. For example, if 'zymonic_toolkit.pl System' was to be entered on the command line, amongst the list of available commands will be 'create_admin - the ability to create an admin users for your zymonic system.'

The COMMAND element of the format is the function. If zymonic_toolkit.pl [MODULE] [COMMAND] is entered on the command line the options that are available for use in conjunction with the chosen command are listed. The list of available COMMAND ARGUMENTS will be displayed together with a brief description and if they are required for the function to be carried out successfully. For example, if 'zymonic_toolkit.pl System create_admin' was to be entered on the command line, amongst the list of available COMMAND ARGUMENTS will be '--username - Username - The username of the user (defaults to admin).'

The COMMAND ARGUMENTS element of the tookit format encompasses all the options that can and should be used to carry out the required function. Each COMMAND ARGUMENT is separated with a space. For example to create an admin user, via the command line 'zymonic_toolkit.pl System create_admin --system SYSTEM --username USERNAME'

The CONFIG FILE variant can be used when there are a lot of COMMAND ARGUMENTS. All of the above; the MODULE and COMMAND, together with all the COMMAND ARGUMENTS can be put into an xml file using the following format:


<ZymonicToolkitConfig>
  <module>MODDULE</module>
  <method>COMMAND</method>
  <COMMAND_ARGUMENT_1>...</COMMAND_ARGUMENT_1>
  <COMMAND_ARGUMENT_2>...</COMMAND_ARGUMENT_2>
  ...
  <COMMAND_ARGUMENT_N>...</COMMAND_ARGUMENT_N>
</ZymonicToolkitConfig>

An example for config building with the full flag and debugs enabled would be:


        zymonic_toolkit.pl System config_build --system a_zymonic_system --full yes --debugfile debug.log

Converting this to using a CONFIG FILE would look like this:


        zymonic_toolkit.pl config_build_test_system.conf

Where the file config_build_test_system.conf contains:


<ZymonicToolkitConfig>
  <module>System</module>
  <method>config_build</method>
  <system>a_zymonic_system</system>
  <full>yes</full>
  <debugfile>debug.log</debugfile>
</ZymonicToolkitConfig>