Custom Inventory steps

This group contains all steps concerned with the generation of the custom inventory, such as collecting specific data or values from registries or configuration files.

Collect Environment Variable Value

This step allows you to collect the value of system environment variables.

Parameter

Description

Environment Variable

Enter the name of the environment variable for which the value is to be recovered, for example, CLASSPATH.

Custom Inventory Instance Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

Collect Ini File Value

This step collects the value of an entry in a configuration file and stores it in the custom inventory.

Parameter

Description

Custom Inventory Instance Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

Entry Type (String or Integer)

Specifies if the value to be recovered is a string or an integer value.

Entry Name

The name of the entry of which the value is to be recovered. Make sure you enter it correctly, including lower and upper case letters, as the entry is case sensitive.

File Path

The complete or relative path to the configuration file. If you enter the path as a relative path it is relative to the <InstallDir>/Master/config directory.

Section Name

Enter the name of the section without its enclosing brackets, that is, Security for the [Security] section of the mtxagent.ini file.

Collect Registry Key Value

This step searches the value(s) of specific registry key(s) and integrates them into the custom inventory.

Parameter

Description

Custom Inventory Instance Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

Custom Inventory Object Name

The name of the object under which it appears in the Console under the Custom Inventory node. If you listed a number of key names in the field above this field must contain the list of value names in the same order as the key names above, separated either by comma ( , ) or semi-colon ( ; ) as well.

Registry Key

The name of the registry key for which the value is to be found. You may also enter a list of key names in this field separated either by comma ( , ) or semi-colon ( ; ).

Value Name

The name of the value of this key. If you listed a number of key names in the field above this field must contain the list of value names in the same order as the key names above, separated either by comma ( , ) or semi-colon ( ; ) as well.

Configuration File

Specifies the location and name of the custom inventory .xml file. This file defines all attributes and values which is recovered from the remote clients to set up the custom inventory. The path to the file may be entered as a local path such as ../data/CustomInventory/CustomInventory.xml or as a URL such as ftp://master/custominventory.xml. The path is relative to the agent configuration file. You may modify the entry, but be aware, that if you wrongly modify, the custom inventory may not longer work.

File Analysis via Regular Expression

This step finds entries matching a provided regular expression and integrates the data into the custom inventory.

Parameter

Description

File Path

The complete or relative path to the file. If you enter the path as a relative path it is relative to the <InstallDir>/Master/config directory . The file path may use wildcard characters, such as the asterisks ( * ), for example, ../log/mtxagent* to search in all stored log files of the agent for a specific expression.

Regular Expression (PCRE)

Enter the regular expression to be found in the file(s).

Match Case

Check this box if the string entered in the field above is to be case sensitive, that is, if the searched string is error, it finds error, Error and ERROR.

Return Complete Line

Defines if the complete line is to be included in the custom inventory or only the part corresponding to the regular expression.

Custom Inventory Object Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

List of Attribute Names

Specifies the names of the attributes that are to be stored for the found expression. This is a list of names separated by a semi-colon, for example, Date;Module;Detail.

Delete previous entries of this object

Determines if any possibly existing previous entries of the object are to be erased.

Maximum number of entries to preserve (0: unlimited)

Defines the number of entries to keep before overwriting them, that is, how may entries the object does have. If for example you are searching for errors of a specific type, and there are 15 of them, only the 10 last ones is stored here.

Generate Error If Not Found

Defines if an error is generated if no match is found for the regular expression.

Send an alert

Check this box to send an alert.

Alert Description

Description of the alert to be sent. The values within the parenthesis are data that is replaced during execution. The description can contain environment variables (${}).

Alert Severity

Select the severity to be assigned to the alert.

Alert Sub-category

Enter the sub-category to which the alert is to be added. Be aware that this sub-category name may not have more that 64 characters.

Monitor Manufacturer Information

This step allows you to collect information about the screens connected to a device. The information will be added to the Custom Inventory. It is applicable to Windows only.

Parameter

Description

VESA Manufacturer ID

Check this box if the VESA Manufacturer ID is to read and added to the custom inventory.

Screen ID

Check this box if the screen ID is to be read and added to the custom inventory.

Manufacturing Date

Check this box if the manufacturing date of the screen is to be read and added to the custom inventory.

Serial Number

Check this box if the serial number of the monitor is to be read and added to the custom inventory.

Model Name

Check this box if the model name of the monitor is to be read and added to the custom inventory.

Version

Check this box if the version number of the screen is to be read and added to the custom inventory.

Custom Inventory Instance Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

Printer Inventory

This step finds all printers within a specified IP address range via SNMP and provides information on them.

Parameter

Description

Address Range

Defines the IP address range in which the printer is to be located. The range may be entered as single IP addresses or in form of address ranges:

  • Dotted notation, for example, 94.24.127.24 or 2001:db8:85a3::8a2e:370:7334
  • With the short or complete network name such as scotty or scotty.enterprise.com
  • A mixture of both: 94.24.127.24,2001:db8:85a3::8a2e:370:7334,scotty.enterprise.com. Several ranges must be separated by a comma ( , ) or a semi colon ( ; ).

TCP Timeout (sec)

The timeout in seconds after which the search operation is regarded as failed.

SNMP TCP Port

The port on which the frame is sent.

TCP Retries

Specifies how many retries are executed before the step is declared as failed.

SNMP Read Community

Defines the community string used when sending the SNMP request, for example, public.

Verify File Existence

This step checks if one or more files exist and returns their full file path(s) which are added to the custom inventory of the respective device(s).

Parameter

Description

File Names

Enter the names of the files, for which you want to verify if they exist. The names are to be listed separated by commas ( , ).

Minimum File Size (KB)

The size that the file must have at least in KB.

Maximum File Size (KB)

The maximum size that the file can have in KB.

Minimum File Date

The date of the file must be this value or a later date. The date must be entered in the following format: YYYY/MM/DD HH:MM:SS.

Maximum File Date

The date of the file must be this or an earlier date. The date must be entered in the following format: YYYY/MM/DD HH:MM:SS.

Directory List

Enter here the directories in which to search for the listed files types. The path may be defined as the relative or absolute local path. If the file is located on a network drive map the network resource to a "local" letter before entering the path. If the parameter is left empty, the path is either / or the first valid drive letter found, for example, c:.

Include Subdirectories

Check this box if the subdirectories of the above listed directories are to be searched as well.

Fail if files do not exist

If this option is set to true, the 'oprule' execution will fail if the files do not exist. Otherwise, it will work successfully. 

Custom Inventory Instance Name

Enter the prefix for the instance name for the custom inventory item, for example, entering Instance here labels the columns Instance0, Instance1, etc.

Verify File Types

This step allows you to verify the presence of one or more file types and to return their number as well as the disk space used by each of them. This information is added to the custom inventory of the respective device(s).

Parameter

Description

File Extensions

Enter the list of file types for which to check, in the format of exe,bat,ini,txt.

Directory List

Enter here the directories in which to search for the listed files types. The path may be defined as the relative or absolute local path. If the file is located on a network drive map the network resource to a "local" letter before entering the path.

Include Subdirectories

Check this box if the subdirectories of the above listed directories are to be searched as well.

Was this page helpful? Yes No Submitting... Thank you

Comments