The following information is extracted from the "README" in the Version 2 ProInventory archive.
To install the ProInventory Tool,
-
To download ProInvetory, refer to Article 000011492
, What is the ProInventory Tool?- Create a new directory and extract the archive into this directory.
Windows: Use Winzip or other appropriate zip tool.
UNIX: Use the tar command: e.g. tar xf <archive-name>
To Run ProInventory: The simplest execution that will use all defaults is to run the executable without any parameters.
This will create a proinventory.tar.Z for Unix, and proinventory.zip for Windows.
UNIX:
proinventory [ <archivename> ]
[ -e <email address> ]
[ -logfile <list> ]
[ -f <plugins.dat> ] [ -propertyfile <conmgr-file> ]
[ -wa <Apache-dir> ]
[ -wn <Netscape/iPlanet-dir> [ -wnsrv <web-server-name> ] ]
[ -fathom ]
[ -nopro ]
[ -exe <cmd> ]
[ -dll <dll,entrypt> ]Windows: _proinventory [ <archivename> ]
[ -e <email address>]
[ -p <ProgId> ] [-p <ProgId> ...]
[ -logfile <list> [ -logprover <Pro Version> ] ]
[ -propertyfile <conmgr-file> ]
[ -wi ]
[ -wa [ <Apache-dir> ] ]
[ -wn [ <Netscape-dir> ] [ -wnsrv <web-server-name> ] ]
[ -dynamics ]
[ -fathom ]
[ -evt <evtloglist> ]
[ -nopro ]
[ -exe <cmd> ]
[ -dll <dll,entrypt> ]Where: <archivename>: The name of the archive file to create.
The filename will be <archivename>.tar.Z on UNIX, and <archivename>.zip on Windows.
If this parameter is omitted, the filename will be proinventory.tar.Z for UNIX, and proinventory.zip for Windows.
-e <email address>: Address to email the archive to.
ProInventory will email the archive to the specified email address.
If this parameter is omitted, ProInventory will not send email.
-p <ProgId>: Log the full registry settings for the COM object identified by ProgId.
More than one -p <ProgId> parameter can be specified.
The value of ProgId must be the COM object's name to use when creating the object (using late binding) and is the registry key name under HKEY_CLASSES_ROOT.
For example, the ProgId for the Crescent Spin Control object is: CSSPIN.CSSpinCtrl.1.
-logfile <list>: List of UBroker and database log files to log.
<list> is a comma-separated list of UBroker instance names (e.g. wsbroker1, NS1, aia1) or ConMgr instance names (the databases configured through the AdminServer).
To capture AdminServer logs (admserv.log etc), specify 'admsrv' in <list>.
The instance names in the list are not case-sensitive.
Specify a list of UBroker or ConMgr instance names if -logfile is specified.
If an instance name refers to both a UBroker instance and a Conmgr instance, then ProInventory will capture the UBroker instance. In such a
case, to capture the database log from the ConMgr instance, prefix the instance name with 'db:'.
For example, proinventory -logfile "db:sports" will cause ProInventory to capture the log related to the "sports" database instance set up through the AdminServer.
If a log file is larger than 1MB, ProInventory will capture the last 1MB of the file, and will write a message indicating this at the top of the captured log file.
If this parameter is omitted, ProInventory will not capture any UBroker or ConMgr log files.
-logprover <Pro Version>: Identifies which version of Progress to capture UBroker logs from.
Use this parameter in conjunction with the -logfile parameter.
This parameter is valid only on Windows, where ProInventory may identify more than one Progress installation within the Registry.
ProInventory will capture UBroker logs from Progress version <Pro Version>.
<Pro Version> must be version 9.0 or greater.
If this parameter is omitted, and ProInventory detects more than one Progress version 9 installation, ProInventory will provide a list of valid versions, and exit.
If an invalid version for <Pro Version> is provided, ProInventory will give a list of valid versions, and exit.
-f <plugins.dat>: Indicates the path of the AdminServerPlugins.dat file to use (in Progress Version 9) or AdminServerPlugins.properties file to use (for OpenEdge Release 10 and later), when validating the ubroker.properties file.
The AdminServerPlugins.dat or AdminServerPlugins.properties file gives the path of the ubroker.properties file the AdminServer uses.
Use -f only if a non-default location for AdminServerPlugins.dat, AdminServerPlugins.properties and ubroker.properties are used.
If this parameter is omitted, ProInventory will use the default $DLC/AdminServerPlugins.dat, $DLC/properties/AdminServerPlugins.properties and $DLC/properties/ubroker.properties files.
-propertyfile <conmgr-file>: Indicates the path of the conmgr.properties file to use, when validating the conmgr.properties file.
Use -propertyFile only if a non-default location for conmgr.properties is used.
If this parameter is omitted, ProInventory will use the default $DLC/properties/conmgr.properties file.
-wi: Log information about the IIS web server installed on this machine.
This parameter is for Windows only.
Local Administrator privileges are needed to use -wi with ProInventory, otherwise ProInventory will generate an error and exit.
If this parameter is omitted, ProInventory will not log IIS information.
-wa <Apache-dir>: Log information about the Apache web server installed on this machine.
<Apache-dir> specifies the Apache installation directory.
-wa may be specified only once on the command line. To log information about another Apache installation, ProInventory needs to be run again.
For Windows, <Apache-dir> is optional, unless:
- There is more than one Apache installation on the machine; or
- The installation has only been installed for the current user; or
- The installation was built from source, or from a distribution that does not update the registry.
For Linux, if <Apache-dir> is blank, ProInventory will assume Apache to be installed from a non-relocatable RPM, or built from source, with the configuration file /etc/httpd/conf/httpd.conf.
For UNIX, <Apache-dir> must be specified.
If this parameter is omitted, ProInventory will not log Apache information.
-wn <Netscape-dir>: Log information about the Netscape/iPlanet web server installation on this machine.
-wn may be specified only once on the command line. To log information about another Netscape/iPlanet installation, ProInventory needs to be run again.
<Netscape-dir> specifies the Netscape/iPlanet installation directory.
For Windows, <Netscape-dir> is optional, unless there is more than one Netscape/iPlanet installation on the machine.
For UNIX, <Netscape-dir> must be specified.
If this parameter is omitted, ProInventory will not log Netscape/iPlanet information.
-wnsrv <web-server-name>: Identifies a particular web server configured within a Netscape/iPlanet installation.
If there are multiple web servers defined within a Netscape/iPlanet installation, -wnsrv identifies the web server to log.
<web-server-name> is the name the Netscape Administration Console uses to identify a web server.
-wnsrv may be specified only once on the command line. To log information about another Netscape/iPlanet web server, ProInventory needs to be run again.
If this parameter is omitted, and there is only one web server defined in the Netscape/iPlanet installation, ProInventory will log information from this web server, otherwise ProInventory will generate an error requesting the -wnsrv parameter to be used, and stop.
-dynamics: Log information about a Dynamics installation.
This parameter is for Windows only.
-fathom: Log information about Fathom installations.
For UNIX, ProInventory will log the Fathom installation that is glued to the Progress installation in $DLC.
For Windows, ProInventory will log all Fathom installations identified in the registry.
-evt <evtloglist>: Log information from the Windows Event Logs.
This parameter is for Windows only.
ProInventory generates a text representation of the information contained in the events in an Event Log.
<evtloglist> is a comma-separated list of the values "app", "sec" and/or "sys", corresponding to the Application Event Log, Security Event Log and System Event Log respectively.
If the number of events in an Event Log generates output larger than 1MB, ProInventory logs only the last 1MB of information from these logs.
If <evtloglist> is omitted, ProInventory will capture all Windows Event Logs (Application, Security and System).
If the -evt parameter is omitted, ProInventory will not log Windows Event Log information.
-nopro: Do not log Progress/OpenEdge-specific information.
ProInventory will not capture any Progress / OpenEdge information when -nopro is specified.
It will only capture the following information:
- Operating system version
- Java version(s)
- DLLs and OCXs in the system32 directory, for Windows
- Environment variables
- Other system information
If -nopro is used, none of the following Progress-specific parameters can be specified: -dynamics, -fathom, -logfile, -logprover.
-exe <cmd>: Execute this command and capture the output.
<cmd> is a command which must be specified.
ProInventory captures stdout and stderr from the command to a log file.
If the program or batch file is not in the PATH, then the absolute path to the batch file or executable must be specified.
To include parameters to the command, enclose the entire command in quotes: proinventory -exe "ls -lR"
If the -exe parameter is omitted, ProInventory will not execute the command.
-dll <dll,entrypt>: Load a DLL/shared object and invoke the specified entry point, and capture any files the entry point generates in the local directory.
<dll> is the absolute pathname of the DLL/shared object to load.
<entrypt> is the name of the entry point within the DLL to call.
The entry point can take no parameters, as ProInventory will not pass it any.
<dll,entrypt> must be specified.
If the -dll parameter is omitted, ProInventory will not execute the entry point in the DLL/shared object.
What is in the ProInventory Archives?- The archive will contain the following files:
- Versions.log - OS version, Progress versions, Java versions.
OCX and DLL versions for Windows only.
- Environment.log - environment variables.
Progress Registry settings for Windows only.
- SysInfo.log - OS-specific system information.
- Copyerrors.log - output from file copy operations.
If a copy operation failed in ProInventory, this file will hopefully capture the error message to explain why the archive does not contain a log file.
- The archive will also contain these files for each version of Progress installed (unless -nopro is specified):
- ProCfg<ver>.log - information from progress.cfg, and installd.ini and addons if available.
- ProInstall<ver>.log - list of files installed by Progress.
For Windows, information about AdminService and ProService, if any.
- Properties<ver>.log - output from the validation of the ubroker.properties and conmgr.properties files, for version 9.X, if any.
- ubroker.properties.<ver> - the ubroker.properties file used by this Progress installation, for Progress versions 9.X, if it exists.
- conmgr.properties.<ver> - the conmgr.properties file used by this Progress installation, for Progress versions 9.X, if it exists.
- The archive will contain these files for each Dynamics installation, if -dynamics is specified:
- DynCfg<ver>.log - information from configuration file and installd.ini
- DynInstall<ver>.log - list of files from the Dynamics install directory.
- DynInfo<ver>.log - contents of default Dynamics configuration files, and Start menu shortcuts.
If -dynamics is not specified, ProInventory will still capture a DynInfo<ver>.log for each OpenEdge installation containing Dynamics (unless -nopro is specified).
- The archive will contain these files/directories for each Fathom (OpenEdge Explorer, OpenEdge Management) installation, if -fathom is specified:
- FathomCfg<ver>Pro<prover>.log - information from $fathomLicenseFile and $fathomInstallDir/installd.ini
- FathomInstall<ver>Pro<prover>.log - list of files in $fathomInstallDir
- Fathom<ver>Pro<prover> directory, containing
- Fathom initialization file ($FATHOMINIT)
- fathomweb.xml, from $fathomConfigDir
- fathom.xml, from $fathomConfigDir
- AdminServerPlugins.dat, from the glued Progress installation
- The archive will contain a logfiles subdirectory if the -logfile parameter is specified, which will contain the requested logs.
Logs from databases will appear under the <instance-name> subdirectory beneath the logfiles subdirectory.
The name of the database log will be preserved.
Example:
For ConMgr instance "production", with database "sports.db",
ProInventory captures the file "logfiles/production/sports.lg".
- The archive will contain an Event*.log for each Event Log, if the -evt parameter is specified.
The possible files are EventApp.log, EventSec.log and EventSys.log depending on the <evtloglist> value(s).
- The archive will contain a webclientapps directory if there are any WebClient applications installed on the system (unless -nopro is specified).
- This directory contains a subdirectory for each vendor of the WebClient applications, and
- A subdirectory beneath the vendor directory for each application from that vendor.
This application subdirectory contains the WebClient application install log, and a file called InstallFiles.log which contains a recursive directory listing of the application's files.
Example:
For the WebClient application SportsPro, distributed by Progress, the proinventory archive will contain the directory: webclientapps\Progress\SportsPro
Containing two files: InstallFiles.log, and _SportsPro.log (the application install log).
- The archive will contain an ExecCmd.log file if the -exe or -dll was specified on the command line.
A subdirectory will be created for each command or dll entry point executed, with a file capturing the stdout and stderr of any -exe command, and any files generated by the -exe or -dll commands.
The name of each subdirectory is the name of the command (for -exe) or the name of the DLL/shared object (for -dll), suffixed by a sequential number.
Example:
$ proinventory -exe "ls -lR"
ProInventory captures the subdirectory "ls0001",
With a file "ls0001.lg" containing stdout and stderr from the "ls -lR" command.
Considerations when running ProInventory:- ProInventory is a command-line tool.
On Windows, ProInventory is executed by double-clicking on _proinventory.exe in Windows Explorer, ProInventory might not be able to load proinventory.dll, and will fail to execute.
ProInventory must be executed from a command prompt.
- If an absolute or relative path for the archive, is not specified, ProInventory will create the archive in the current working directory.
- The user running ProInventory needs write access to the archive destination directory (by default, the current directory).
- ProInventory will not execute if it cannot locate an installed Progress (or WebClient) version, and the -nopro parameter is not specified.
- For Windows, ProInventory will check the registry for Progress and WebClient versions. The Progress information collected will be for all the Progress versions installed.
- For UNIX, the DLC environment variable must be set to a Progress installation directory. The Progress information collected will be only for this installation of Progress.
- Extracting the OS-specific system information may take a long time.
On Windows, ProInventory uses a Windows-specific process to extract system information.
If this child process runs for more than 10 minutes, ProInventory will assume the process is hung, and will not wait for the process to complete.
This can happen on slow and/or heavily loaded machines.
- ProInventory can be aborted at any time by hiting CTRL-C.
- For ProInventory to send email from UNIX, sendmail needs to be correctly configured. Please refer to UNIX documentation for further information on sendmail.
- For ProInventory to send email from Windows, a correctly configured MAPI-compliant email client must be installed on the machine. Please refer to email client documentation for more information on MAPI.
- ProInventory will create or append to a file called default.log, in the current directory, as part of the validation of the ubroker.properties file.
If the current directory is the Progress working directory, the default.log file may already exist, containing messages related to the AdminServer or UBroker instances.
If the current directory is not the Progress working directory, it is safe to delete the default.log file.
