Using the DirX Diag Tool

In the following example, the DirX Diag tool runs the default configuration set for all tenants and creates a ZIP file named diagnosis_YYYYMMDD_HHmm_default.zip in the current working directory.

dxtdirxdiag.bat

In the following example, the DirX Diag tool runs the default and manager configuration set for a specific tenant and creates a ZIP file in the current working directory.

dxtdirxdiag.bat -tenantid f4ba80a6-648c-4868-90f6-06cd5b1f0a0e manager

In the following example, the DirX Diag tool runs the default, manager and server configuration sets for a specific tenant and creates a ZIP file named diag2.zip in the current working directory.

dxtdirxdiag.bat -o diag2.zip -tenantid f4ba80a6-648c-4868-90f6-06cd5b1f0a0e manager server

In the following example, the DirX Diag tool runs the system_info configuration set for all tenants and creates a ZIP file in the current working directory.

dxtdirxdiag.bat system_info

Configuration files are in XML format using the scheme install_path/bin/config.xsd to check the validity and giving hints for XML editors.

Example of configuration file:

A configuration file consists of one or more configuration sets you can select via command line parameters.
Each configuration set consists of configuration elements.

Each set in a configuration file can contain one or more of the following configuration elements. These configuration elements define one or more files to be added to the zip file.

addSystemInformation – adds system information into a file

Collects and adds system information into the file system_info.txt.
Optional parameter osName (see below).

Example:
<addSystemInformation/>

addOutput – allows running any command. The output is written to a file.

Required parameter command specifies the command to be executed.
You can add parameters to the command by using the <param value="…​"/> sub-elements.
Optional parameter osName lets you restrict the command execution to a specific operating system (see below).
Filename: command_<number>_<command>.txt

Example:

Executes the command net start on Windows platforms. The output is written to the file command_1_net.txt which is zipped to the output file.

addDirList – directory listing

Adds a list of all files and directories under the defined path into a file.
You can use placeholders (see below) and wildcards * and ? in the path definition.
Optional parameters are fileMask, recursive and osName (see below).
Filename: dir_list_<number>.txt

Example:

addFile – adds a single file

Adds a specific file to the zip file.
You can specify a path that can contain place holders (see below) and wildcards * and ?. Optional parameter osName (see below).

Example:

This definition adds all idmsvc.ini files from all directories that start with ids-j- to the zip file.

addPath – adds a collection of files

Adds a collection of files to the zip file.
You can specify a path that can contain place holders (see below) and wildcards * and ?.
Optional parameters are fileMask, recursive, osName and notOlderThanDays (see below).

Example:

This definition adds all files with the extension .bat in all directories that start with ids-j- to the zip file.

addSet – executes an existing set

Adds an already defined set to the current one. Meaning, that all items from the specified set will be added to the current set.
Required parameter name specifies the name of the set, which is to be inserted.
The specified set must be defined within the config file, otherwise the command will be skipped.

The sets can contain addSet operations and refer to each other, creating a tree-like structure of an arbitrary depth. However, each set will be executed at most once. Therefore, if there are mutliple addSet operations of the same set, the set will be executed exactly once, and any subsequent calls to the same set will be ignored.
This functionality restriction prevents the creation of cycles of reference.

Example:
<addSet name="system_info"/>

This definition executes a set named system_info. If such set does not exist, the program skips the operation.

addSql – executes a SQL query and adds the output to a file

The parameters are:

The queries can contain placeholders. In the case of queryFile parameter, the ${<placeholder>} will be replaced in the file content.
In the case of query parameter, the ${<placeholder>} syntax must be escaped with additional $ in order to work.
The syntax for adding parameters is used in provided example.

Example:

Every configuration element <add…​> can contain (optional) parameters.

osName – restricts the element to a specific operating system.

Recommended values are: "Windows" and "Linux", but in fact you can type any prefix of the system property "os.name".
For example: "Windows Server" matches any Windows Server only while "Windows" matches any Windows system.
The value of this property is shown when you use <addSystemInformation/>.

recursive – indicates whether you want to include or exclude sub directories.

If you omit it, sub directories are included by default.

fileMask – allows defining a file mask using wildcards * and ?.
Omitting the parameter is equivalent to *.* and * meaning any file.

notOlderThanDays – allows exclusion of files that are older (last modified) than current datetime minus the given number of days.

You can use placeholders in any attribute value string. For example ${XXX} is replaced by value of XXX.
An attribute value string can contain an unlimited number of placeholders. Placeholders cannot be sinked-in. Currently there is no escape character to represent ${.

Example:
<addDirList path="${install.path.comp.message_broker}"/>
is replaced by
<addDirList path="C:\Program Files\Atos\DirX Audit\message_broker"/>

The value is searched in