[an error occurred while processing this directive]

HP OpenVMS Systems Documentation

Content starts here

HP OpenVMS System Management Utilities Reference Manual


Previous Contents Index

The command in this example places the release notes for Version 2.3 of the product XYZ in a file named [RN]XYZ.TXT on your current default device.

FIND

Displays the names of software product kits located in the specified directory, along with kit type and kit format information.

Format

PRODUCT FIND product-name[,...] [/qualifiers]


Parameter

product-name

Names the product, or list of products to find.

Qualifiers

/BASE_SYSTEM=base-system-name

Selects software products whose base system matches the one specified. The base system name identifies both a hardware platform and an operating system. Standard names are:
Name Description
AXPVMS Denotes an OpenVMS Alpha product.
I64VMS Denotes an OpenVMS Integrity servers product.
VAXVMS Denotes an OpenVMS VAX product.
VMS Indicates a product that can be installed on more than one OpenVMS platform.

/FULL

/NOFULL (default)

Displays information in 132-column format. The /NOFULL qualifier displays a subset of available information in 80-column format.

/KIT_ATTRIBUTES=keyword([,...])

Selects kits by kit type or kit format, or both. Keywords are:
FORMAT=
format-type
Designates the format of the product kit as follows:
   
COMPRESSED Compressed format in which a data compression technique has been applied to a sequential kit. A compressed kit has a .PCSI$COMPRESSED file type.
REFERENCE Reference format in which product files exist in a directory tree. A .PCSI$DESCRIPTION file in the top level of the directory tree denotes a reference kit.
SEQUENTIAL Sequential format in which product files are placed in a container file. A file type of .PCSI indicates a sequential kit.
TYPE=
kit-type
Specifies the type of product kit as follows:
FULL Layered product (application) software.
OPERATING_SYSTEM Operating system software.
MANDATORY_UPDATE A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
PARTIAL An upgrade to currently installed software. Installation of this kit changes the version of the product.
PATCH A correction to currently installed software. Installation of this kit does not change the version of the product.
PLATFORM An integrated set of software products (also called a product suite).
TRANSITION Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

/PRODUCER=producer-name

Selects software products that the specified manufacturer produces.

/SOURCE=device-name:[directory-name]

Specifies the disk and directory where the utility searches for the software product kit or kits. If /SOURCE is not specified, the utility searches in the location defined by the logical name PCSI$SOURCE. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, PCSI searches the current default directory.

/SPAN_VERSIONS=keyword([,...])

Selects software products whose versions match the specified version criteria. The keywords are:
ABOVE=version Selects versions greater than the version specified
BELOW=version Selects versions less than the version specified
MINIMUM=version Selects versions greater than or equal to the version specified
MAXIMUM=version Selects versions less than or equal to the version specified

The ABOVE, BELOW, MINIMUM, and MAXIMUM keywords can be used alone or in combination. For example, /SPAN_VERSIONS= (MINIMUM=V2.1,BELOW=V3.0) selects versions greater than or equal to V2.1 and less than (but not including) V3.0. Using the MAXIMUM keyword instead of BELOW would select versions that include V3.0.

/VERSION=version-number

Selects software products that have the specified version.

Example


$ PRODUCT FIND TEST* /BASE_SYSTEM=VAXVMS
      

The command in this example searches for all software product kits located in the user's default directory and displays the names of all versions of products whose names begin with "TEST" and are intended to be installed on OpenVMS VAX.

INSTALL

Installs one or more software products on your system and updates the product database. You can also use this command to install patch and mandatory update kits that modify previously installed products.

Format

PRODUCT INSTALL product-name[,...] [/qualifiers]


Description

To uninstall complete products, including any patches or mandatory updates that might have been applied to them, use the PRODUCT REMOVE command.

To uninstall patches or mandatory updates while still retaining the original product that was installed, use the PRODUCT UNDO PATCH command. However, to use PRODUCT UNDO PATCH, you must have created and retained recovery data sets for these patches. (By default, the PRODUCT INSTALL command creates a recovery data set when patch kits are installed.)

For more information about the use of recovery data sets, see the description of the PRODUCT UNDO PATCH command.


Parameter

product-name

Names the product, or list of products, to install.

Qualifiers

/BASE_SYSTEM=base-system-name

Selects software products whose base system matches the one specified. The base system name identifies both a hardware platform and an operating system. Standard names are:
Name Description
AXPVMS Denotes an OpenVMS Alpha product.
I64VMS Denotes an OpenVMS Integrity servers product.
VAXVMS Denotes an OpenVMS VAX product.
VMS Indicates a product that can be installed on more than one OpenVMS platform.

/CONFIGURATION=(keyword[,...])

Specifies how the configuration choices will be supplied. Keywords are:
CURRENT Uses values from the product database. These values are the configuration choices made when the product was installed or reconfigured.
PRODUCER Uses values specified by the software manufacturer of the product.
INPUT=pcf-name Uses values from the specified product configuration file.
OUTPUT=pcf-name Writes configuration choices to the specified product configuration file. If no file name is supplied, creates a file named DEFAULT.PCSI$CONFIGURATION in the current default directory.

The keywords CURRENT, PRODUCER, and INPUT are mutually exclusive. (CURRENT is the default if none of these keywords is specified.)

The OUTPUT keyword can be used with the CURRENT, PRODUCER, or INPUT keyword.

If you specify only one keyword, you can omit the parentheses.

/DEBUG

/NODEBUG (default)

Specifies options useful to the product kit developer during kit testing. Keywords are:
CONFLICT_DATA Displays supplemental information about file and module conflict resolution. This includes the generation numbers used in the comparison, whether the object is retained or replaced, and the name of the product that supplies the object.

Use /DEBUG=CONFLICT_DATA in conjunction with the /LOG qualifier to display all information about conflict resolution. For more information, see the HP POLYCENTER Software Installation Utility Developer's Guide.

/DESTINATION=device-name:[directory-name]

Specifies the top-level directory where the utility will install software product files. If you omit the device name, the utility uses your current default device. If you omit the directory name, the utility uses [VMS$COMMON] as the default directory.

If you do not use this qualifier to specify a destination, the utility installs the software in the location defined by logical name PCSI$DESTINATION. If this logical name is not defined, the utility installs the software in SYS$SYSDEVICE:[VMS$COMMON], the default top-level directory for software product files.

/HELP

/NOHELP (default)

Controls whether detailed explanations of product options and informational text are displayed. The first time you install a product, these explanations can help you decide which options to select. When you perform subsequent installations or upgrades, you might choose the brief explanations to save time.

When /NOHELP is selected, you can request a detailed explanation about a question by performing one of the following actions at the prompt:

  • Press the Help key or PF2 key
  • Type ? and press the Return key

/KIT_ATTRIBUTES=keyword([,...])

Selects kits by kit type or kit format, or both. Keywords are:
FORMAT=
format-type
Designates the format of the product kit as follows:
   
COMPRESSED Compressed format in which a data compression technique has been applied to a sequential kit. A compressed kit has a .PCSI$COMPRESSED file type.
REFERENCE Reference format in which product files exist in a directory tree. A .PCSI$DESCRIPTION file in the top level of the directory tree denotes a reference kit.
SEQUENTIAL Sequential format in which product files are placed in a container file. A file type of .PCSI indicates a sequential kit.
TYPE=
kit-type
Specifies the type of product kit as follows:
FULL Layered product (application) software.
OPERATING_SYSTEM Operating system software.
MANDATORY_UPDATE A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
PARTIAL An upgrade to currently installed software. Installation of this kit changes the version of the product.
PATCH A correction to currently installed software. Installation of this kit does not change the version of the product.
PLATFORM An integrated set of software products (also called a product suite).

/LOG

/NOLOG (default)

Displays the file specification of each file processed. When logging is enabled, messages notify you whenever product files, libraries, directories, recovery data files, and product database files are created, deleted, or modified. Information about any file and module conflict resolution is also provided.

/OPTIONS=(keyword[,...])

/NOOPTIONS (default)

Specifies PRODUCT command options. The keywords are:
NOCONFIRM Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.

The NOCONFIRM and NODEFAULT_KIT keywords are mutually exclusive.

NODEFAULT_KIT Directs the utility to query the user instead of choosing a default kit when more than one kit that matches the selection criteria for the product is found in the source directory path. The selection criteria include the producer, base system, product name, and product version strings that are embedded in the file name of a kit.

If multiple kits are found for a selected product, and NODEFAULT_KIT is not specified, the utility determines the default kit to use by applying the following rules:

  1. The last character of the kit's file name (1-7) is used to order the kits by kit type. In descending order, the precedence is as follows: full, operating system, partial, patch, platform, transition, and mandatory update.
  2. The file type is used to order the kits by format. In descending order, the precedence is as follows: compressed (.PCSI$COMPRESSED), sequential (.PCSI), and reference (.PCSI$DESCRIPTION).
  3. If multiple kits are found with the same file name and file type, but differ in their directory path names, the case of their file specifications, or their file versions, then the first file found by RMS search rules takes precedence.

The NODEFAULT_KIT and NOCONFIRM keywords are mutually exclusive.

NOVALIDATE_KIT Disables validation of software product kits that are signed and have a manifest file in the source directory.

The NOVALIDATE_KIT and SIGNED_KIT keywords are mutually exclusive.

SHOW_DISK_USAGE Displays estimated disk block usage. Both peak utilization and net change are shown in addition to the amount of free space available before and after the operation.
SIGNED_KIT Requires all software product kits selected for the operation to be signed kits that have passed validation; otherwise, the operation is not performed.

The SIGNED_KIT and NOVALIDATE_KIT keywords are mutually exclusive.

/PRODUCER=producer-name

Selects software products that the specified manufacturer produces.

/RECOVERY_MODE (default)

/NORECOVERY_MODE

Enables or disables product installation in recovery mode. The directories, files, and libraries that are modified or deleted in the installation process are saved in a directory tree on the system disk unless you specify /NORECOVERY_MODE. These files, along with a copy of the product database, comprise the recovery data set.

The recovery data set is handled somewhat differently when an installation ends successfully or if it terminates unsuccessfully.

  • If an installation terminates in its execution phase, either voluntarily (by using Ctrl/Y or Ctrl/C) or involuntarily (because of a fatal error), the saved recovery data is used to roll back all the displaced objects in an attempt to reinstate the product environment prior to the interrupted operation. Then the recovery data set is deleted.
  • At the end of the successful installation of one or more full, platform, or partial kits, the recovery data set is deleted.
  • At the end of the successful installation of one or more patch or mandatory update kits, the recovery data set is automatically retained for possible future use with the PRODUCT UNDO PATCH command unless you specify the /NOSAVE_RECOVERY_DATA qualifier.

/REMARK=string

Records a comment in the product database about the task you are performing. The PRODUCT SHOW HISTORY command displays the recorded comments. For each product, PCSI stores a chronological list of tasks you perform and the associated remarks. The default behavior is that no remark is recorded.

/REMOTE

/NOREMOTE (default)

Selects the product database located on a privately mounted system disk. By default, PCSI searches the currently booted system disk for the product database.

When you use /REMOTE, the following logical names must be defined:

  • PCSI$SYSDEVICE must specify the physical disk name of the target system disk. This disk must be mounted and allocated to the process executing the PRODUCT command.
  • PCSI$SPECIFIC must point to a system root on PCSI$SYSDEVICE. It must be defined in the following form, where x is a valid system root:


    PCSI$SYSDEVICE:[SYSx.] 
    

/SAVE_RECOVERY_DATA (default)

/NOSAVE_RECOVERY_DATA

Enables or disables the retention of recovery data for the PRODUCT UNDO PATCH command to use.

This qualifier applies only to patch and mandatory update kits. It is ignored when full, operating system, platform, partial, or transition kits are installed.

The directories, files, and libraries that are modified or deleted in the process of installation are saved in a directory tree on the system disk unless you specify /NOSAVE_RECOVERY_DATA. These files, along with a copy of the product database, comprise the recovery data set. This recovery data set can be used later to uninstall patch and mandatory update kits.

/SOURCE=device-name:[directory-name]

Specifies the disk and directory where the utility searches for the software product kit or kits. If /SOURCE is not specified, the utility searches in the location defined by the logical name PCSI$SOURCE. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, PCSI searches the current default directory.

/SPAN_VERSIONS=keyword([,...])

Selects software products whose versions match the specified version criteria. The keywords are:
ABOVE=version Selects versions greater than the version specified
BELOW=version Selects versions less than the version specified
MINIMUM=version Selects versions greater than or equal to the version specified
MAXIMUM=version Selects versions less than or equal to the version specified

The ABOVE, BELOW, MINIMUM, and MAXIMUM keywords can be used alone or in combination. For example, /SPAN_VERSIONS= (MINIMUM=V2.1,BELOW=V3.0) selects versions greater than or equal to V2.1 and less than (but not including) V3.0. Using the MAXIMUM keyword instead of BELOW would select versions that include V3.0.

/TEST (default)

/NOTEST

Requests that PCSI run the installation verification procedure (IVP) for the product.

/TRACE

/NOTRACE (default)

Identifies the creation and deletion of subprocesses and the DCL commands and command procedures submitted to these subprocesses for execution during the processing of the PRODUCT command. Also shows the creation and deletion of scratch directories and temporary files that the PCSI utility provides for the subprocess environment. Any output that DCL produces is also displayed.

This qualifier is primarily a debugging aid for product developers to trace the execution of command procedures included in their product kits. For more information, see the HP POLYCENTER Software Installation Utility Developer's Guide.

/VERSION=version-number

Selects software products that have the specified version.

/WORK=device:[directory]

Specifies the name of the device and directory acting as a temporary work area. By default, temporary files are created in subdirectories of the user's login directory.

Example


$ PRODUCT INSTALL POSIX/VERSION=3.0 /CONFIGURATION=OUTPUT=POSIX.PCF
 
      

The command in this example installs POSIX Version 3.0 and creates a product configuration file.

LIST

Lists the names of the files contained in a software product kit. All files are listed unless you use the /SELECT qualifier to specify a subset of the files.

Format

PRODUCT LIST product-name[,...] [/qualifiers]


Parameter

product-name

Names the product, or list of products, whose kit contents are to be listed. This parameter is required.

Qualifiers

/BASE_SYSTEM=base-system-name

Selects software products whose base system matches the one specified. The base system name identifies both a hardware platform and an operating system. Standard names are:
Name Description
AXPVMS Denotes an OpenVMS Alpha product.
I64VMS Denotes an OpenVMS Integrity servers product.
VAXVMS Denotes an OpenVMS VAX product.
VMS Indicates a product that can be installed on more than one OpenVMS platform.

/FULL

/NOFULL (default)

Displays information about files contained in the kit in 132-column format. The /FULL qualifier shows the name of each file, gives its size in blocks, and provides a comment field that can provide additional information---for example, the file is a product description file, a temporary file, or a module file that updates a library file. The /NOFULL qualifier displays only the name of each file in the kit in 80-column format.

/KIT_ATTRIBUTES=keyword([,...])

Selects kits by kit type or kit format, or both. Keywords are:
FORMAT=
format-type
Designates the format of the product kit as follows:
   
COMPRESSED Compressed format in which a data compression technique has been applied to a sequential kit. A compressed kit has a .PCSI$COMPRESSED file type.
REFERENCE Reference format in which product files exist in a directory tree. A .PCSI$DESCRIPTION file in the top level of the directory tree denotes a reference kit.
SEQUENTIAL Sequential format in which product files are placed in a container file. A file type of .PCSI indicates a sequential kit.
TYPE=
kit-type
Specifies the type of product kit as follows:
FULL Layered product (application) software.
OPERATING_SYSTEM Operating system software.
MANDATORY_UPDATE A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
PARTIAL An upgrade to currently installed software. Installation of this kit changes the version of the product.
PATCH A correction to currently installed software. Installation of this kit does not change the version of the product.
PLATFORM An integrated set of software products (also called a product suite).
TRANSITION Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

/OPTIONS=keyword

/NOOPTIONS (default)

Specifies PRODUCT command options. The keywords are:
NOCONFIRM Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.

The NOCONFIRM and NODEFAULT_KIT keywords are mutually exclusive.

NODEFAULT_KIT Directs the utility to query the user instead of choosing a default kit when more than one kit that matches the selection criteria for the product is found in the source directory path. The selection criteria include the producer, base system, product name, and product version strings that are embedded in the file name of a kit.

If multiple kits are found for a selected product, and NODEFAULT_KIT is not specified, the utility determines the default kit to use by applying the following rules:

  1. The last character of the kit's file name (1-7) is used to order the kits by kit type. In descending order, the precedence is as follows: full, operating system, partial, patch, platform, transition, and mandatory update.
  2. The file type is used to order the kits by format. In descending order, the precedence is as follows: compressed (.PCSI$COMPRESSED), sequential (.PCSI), and reference (.PCSI$DESCRIPTION).
  3. If multiple kits are found with the same file name and file type, but differ in their directory path names, the case of their file specifications, or their file versions, then the first file found by RMS search rules takes precedence.

The NODEFAULT_KIT and NOCONFIRM keywords are mutually exclusive.

NOVALIDATE_KIT Disables validation of software product kits that are signed and have a manifest file in the source directory.

/PRODUCER=producer-name

Selects software products that the specified manufacturer produces.

/SELECT=filename[,...]

Specifies the name of a file, or a list of files; these files are in the specified product kit. You can use the asterisk (*) and the percent sign (%) wildcard characters for all or part of the file name. The file name can contain a directory specification that includes an ellipsis (...).

/SOURCE=device-name:[directory-name]

Specifies the disk and directory where the utility searches for the software product kit or kits. If /SOURCE is not specified, the utility searches in the location that the logical name PCSI$SOURCE defines. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, PCSI searches the current default directory.

/SPAN_VERSIONS=keyword([,...])

Selects software products whose versions match the specified version criteria. The keywords are:
ABOVE=version Selects versions greater than the version specified
BELOW=version Selects versions less than the version specified
MINIMUM=version Selects versions greater than or equal to the version specified
MAXIMUM=version Selects versions less than or equal to the version specified


Previous Next Contents Index