Version 1.3:
On UNIX:
_proinventory [<file-name>] [-e <email-address>] [-f <Plugins file>] [-fathom] [-logfile <list> ]
[-propertyfile <conmgr file>] [-wa [<Apache-Dir>]] | [-wn <Netscape / IPlanet-Dir> [-wnsrv <Server config name>]] ]
On Windows:
_proinventory [<file-name>] [-dynamics] [-e <email-address>] [-fathom] [-logfile <list> [-logprover <Progress Version>]]
[-p <ProgId>] [ -evt <evtloglist> ] [ [-wa [<Apache-Dir>]] | [-wi] | [-wn <Netscape / IPlanet-Dir> [-wnsrv <Server config name>]] ]
WHERE
<file-name>
The name of the archive file to create. The filename will be <archivename>.tar.Z on UNIX, and <archivename>.zip on Windows. If you omit this parameter, the filename will be proinventory.tar.Z for UNIX, and proinventory.zip for Windows.
-dynamics
Log information about a Dynamics installation. This parameter is for Windows only.
-e <e-mail address>
Address to e-mail the archive to. ProInventory will e-mail the archive to the specified e-mail address. If you omit this parameter, ProInventory will not send e-mail.
-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.
-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. You must specify a list of Ubroker or ConMgr instance names if you specify -logfile. 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, you must 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 you omit this parameter, 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 you omit this parameter, and ProInventory detects more than one Progress version 9 installation, ProInventory will provide a list of valid versions, and exit. If you provide an invalid version for <Pro Version>, ProInventory will give a list of valid versions, and exit.
-p <ProgId>
Log the full registry settings for the COM object identified by ProgId. You may specify more than one -p parameter . 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.
-evt <evtloglist>
Log information from the Windows Event Logs.
ProInventory generates a text r.epresentation 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 will generate output larger than 1MB, ProInventory logs only the last 1MB of information from these logs. If you omit <evtloglist>, ProInventory will capture all Windows Event Logs (Application, Security and System). If you omit this parameter, ProInventory will not log Windows Event Log information. This parameter is for Windows only.
-wa <Apache-dir>
Log information about the Apache web server installed on this machine. <Apache-dir> specifies the Apache installation directory.
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 you omit this parameter, ProInventory will not log Apache information.
You may specify -wa only once on the command line. To log information about another Apache installation, you must run ProInventory again.
-wi
Log information about the IIS web server installed on this machine. This parameter is for Windows only. You must have Administrator privileges to use -wi with ProInventory, otherwise ProInventory will generate an error and exit. If you omit this parameter, ProInventory will not log IIS information.
-wn <Netscape-dir>
Log information about the Netscape/iPlanet web server installation on this machine. <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 you omit this parameter, ProInventory will not log Netscape/iPlanet information.
You may specify -wn only once on the command line. To log information about
another Netscape/iPlanet installation, you must run ProInventory again.
-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.
If you omit this parameter, 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 asking you to use the -wnsrv parameter, and stop.
You may specify -wnsrv only once on the command line. To log information about another Netscape/iPlanet web server, you must run ProIventory again.
.epresentation 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 will generate output larger than 1MB, ProInventory logs only the last 1MB of information from these logs. If you omit <evtloglist>, ProInventory will capture all Windows Event Logs (Application, Security and System). If you omit this parameter, ProInventory will not log Windows Event Log information. This parameter is for Windows only.
-wa <Apache-dir>
Log information about the Apache web server installed on this machine. <Apache-dir> specifies the Apache installation directory.
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 you omit this parameter, ProInventory will not log Apache information.
You may specify -wa only once on the command line. To log information about another Apache installation, you must run ProInventory again.
-wi
Log information about the IIS web server installed on this machine. This parameter is for Windows only. You must have Administrator privileges to use -wi with ProInventory, otherwise ProInventory will generate an error and exit. If you omit this parameter, ProInventory will not log IIS information.
-wn <Netscape-dir>
Log information about the Netscape/iPlanet web server installation on this machine. <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 you omit this parameter, ProInventory will not log Netscape/iPlanet information.
You may specify -wn only once on the command line. To log information about
another Netscape/iPlanet installation, you must run ProInventory again.
-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.
If you omit this parameter, 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 asking you to use the -wnsrv parameter, and stop.
You may specify -wnsrv only once on the command line. To log information about another Netscape/iPlanet web server, you must run ProIventory again.
.
- 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:
- 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.
- The archive will contain these files/directories for each Fathom 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 initialisation 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> subdirectorybeneath the logfiles subdirectory. The name of the database log will be preserved.
e.g. 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 you specify -evt. The possible files are EventApp.log, EventSec.log and EventSys.log.
- The archive will contain a webclientapps directory if there are any WebClient applications installed on the system. 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.
e.g. 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).
- ProInventory is a command-line tool, even on Windows. If you execute ProInventory by double-clicking on _proinventory.exe in Windows Explorer,ProInventory might not be able to load proinventory.dll, and will fail to execute. Instead, you m.ust execute ProInventory from a command prompt.
- If you do not specify an absolute or relative path for the archive, ProInventory will create the archive in the current working directory.
- You must have 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.
- 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 the 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.
- The user can hit CTRL-C to abort ProInventory at any time.
- For ProInventory to send e-mail from UNIX, you must have sendmail correctly configured. Please refer to UNIX documentation for more on sendmail.
- For ProInventory to send e-mail from Windows, you must have a correctly configured MAPI-compliant e-mail client installed on your machine.
e.g. MS Outlook Express, Netscape Communicator. Please refer to e-mail 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 your current directory is the Progress working directory, the default.log file may already exist, containing messages related to the AdminServer or Ubroker instances. If your current directory is not the Progress working directory, it is safe to delete the default.log file.
.
