The definition of an information collection source is composed of the following:
Definition of the collection items
Collection items of the software information and patch information collected by the information collection source.
Software Patch Collection Script
A script to collect the information of the software installed on a business server and the applied patch information.
Define the information collected from an information collection source as the collection items. Define the collection items for each software and patch. Multiple collection items can be defined. For details on the collection items which can be defined, refer to "1.1.2 List of Collection Items". There are the following categories of collection items.
Identification item
The identification item is the information used to identify a software or patch. Multiple identification items can be defined, and the software and patches whose combinations of collection items are the same are managed as the same software or patch.
Definition item
The definition item is the information used as the definition for a software or patch. The definition information of a software or patch is used as the default value when registering the software information or patch information as an installed software or applied patch in CMDB.
To register the same software as multiple instances of installed software in the same server, use the collection item of the installation location. When installing the same software in different locations, it is registered in CMDB as another installed software.
The software patch collection script is a script which collects the information of software installed on a business server and the applied patch information. This script is forwarded to the server and runs on it. The information collected from a server is output to the software information CSV file and the patch information CSV file. This file is transferred to the admin server and registered in CMDB as installed software and applied patches.
A software patch collection script is composed of multiple files. In addition, a software patch collection script is created according to the OS type of the target server. The batch file used in Windows and the shell script used in Linux and Solaris are fixed. These files are described below.
Discovery script
The discovery script is always the first script to be called, and the name of the file is fixed. The name of the batch file is discover.cmd, and the name of the shell script is discover.sh. In this script processing, the software information and patch information collected from a server are always output to the software information CSV file and the patch information CSV file. The script results are also returned. Other CSV files can be created depending on the corresponding information collection sources.
File attachments
The desired files which can be used with a discovery script. The file and the discovery script will be forwarded to the server. If a file attachment includes a shell script, configure execution privileges within the discovery script of the shell script.
The discovery script outputs the information of the software installed on a server and the applied patch information. A description of this file is shown below.
Software information CSV
Output the information of the software installed on a server to a collection information CSV file. For details, refer to "6.2.3 Collection Information CSV File".
The name of this file is fixed. The file name is softwareinfo.csv.
Patch information CSV
Output the information of patches applied to a server to a collection information CSV file.
The name of this file is fixed. The file name is patchinfo.csv. For details, refer to "6.2.3 Collection Information CSV File".
Discovery script format (batch files) [Windows]
Create the discovery script for batch files (discover.cmd) using the format below.
The -dir option must be specified as the first argument (%1), and the directory to which the software and patch information should be output must be specified as the second argument (%2). Output the information collected in this directory to the software information CSV file (softwareinfo.csv) and to the patch information CSV file (patchinfo.csv). The script returns 0 if successful, or another value otherwise.
The standard output and standard error output are directed to the agent log.
@echo off setlocal @rem Process to collect the software information and patch information from a server <Process of each information collection source> <Process to output the software and patch information to the %2 directory> @rem Return results (normal) if ERRORLEVEL 1 goto ERROR_END endlocal exit /B 0 @rem Return results (error) : ERROR_END echo ERROR0002 Software and Patch collecting failed. 1>&2 endlocal exit /B 1
Discovery script format (shell scripts) [Linux/Solaris]
Create the discovery script for shell scripts (discover.sh) using the format shown below.
The -dir option must be specified as the first argument ($1), and the directory to which the software and patch information should be output must be specified as the second argument ($2) of the shell script. Output the information collected in this directory to the software information CSV file (softwareinfo.csv) and to the patch information CSV file (patchinfo.csv). The script returns 0 if successful, or another value otherwise.
The standard output and standard error output are directed to the agent log.
#!/bin/sh # Process to collect the software information and the patch information from a server <Process of each information collection source> <Process to output the software and patch information to the $2 directory> # Return results if [ $? = "0" ]; then # Returns normal exit 0 else # Returns normal echo "ERROR0002 Software and Patch collecting failed." 1>&2 exit 1 fi
Output directory for discovery script
When using the discovery script to output software and patch information, output using the directory format shown below. A software information CSV file is created only when the information of the software installed on a server can be collected. A patch information CSV file is created only when the information of patches applied to a server can be collected. The creation of only a patch information CSV file cannot be performed.
+ <output directory>
+ Software information CSV file (softwareinfo.csv)
+ Patch information CSV file (patchinfo.csv)Software information CSV file and patch information CSV file format
Create the discovery script so that the software information and the patch information collected using the discovery script can be output to the software information CSV and patch information CSV file. The software information CSV file and patch information CSV file are in the format of a collection information CSV file. For details, refer to "6.2.3 Collection Information CSV File".
Script package
A script package is a file containing multiple software parameter collection scripts compressed in a ZIP file. This file is used when defining the information collection source. This file is forwarded to the server and unpacked on it.
This ZIP file must be stored using the structure shown below. Place a software patch collection script for use with each OS type under directories with names corresponding to each OS type. It is not necessary to place a software patch collection script for the OS types of servers of which information cannot be collected from the information collection source. Do not create an OS type directory for a software patch collection script of OS types whose data cannot be collected. Place the software patch collection script for at least one OS type. This ZIP file must be stored using the structure shown below. The file attachment can contain directories.
<ZIP file root> + Windows (*) + Discovery script (discover.cmd) + File attachment + Linux (*) + Discovery script (discover.sh) + File attachment + Solaris (*) + Discovery script (discover.sh) + File attachment
* Note: A directory.