HP OpenVMS System Management Utilities Reference Manual

REGISTER PRODUCT

Records information in the product database about one or more installed products that are not yet registered in the database.

Format

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

Description

The PRODUCT REGISTER PRODUCT command only updates the product database; it does not copy any files ' to your system.
You can use this command to add information to the product database about products that have been installed by a mechanism other than PCSI, such as VMSINSTAL. You can also use this command to store information about products previously installed by the PCSI utility if the product database needs to be rebuilt due to file corruption or deleted database files.
To register a product, you need to have a file in the source directory to supply details about the product being registered. This file can be one of the following:

A complete product kit
The product description file (PDF) extracted from the product kit or database
A special transition kit that identifies files installed by a mechanism other than the PCSI utility.

If you do not have a kit available to provide detailed information about a product, you can use the command procedure SYS$UPDATE:PCSI$REGISTER_PRODUCT.COM to register the name of the product and its version, producer, and base system in the product database. After you register a product using the command procedure, other products can reference it, and the PRODUCT SHOW PRODUCT command displays it as an installed product.

Parameter

product-name
Names the product, or list of products, to register.

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 I64 product.

VAXVMS Denotes an OpenVMS VAX product.

VMS Indicates a product that can be installed on more than one OpenVMS platform.

/CHECK_ONLY
Concludes the action of the command after performing file conflict detection, searching the destination device for all files listed in the product description file, and displaying file lookup summary data. This option allows you to perform a "dry run" of the registration operation without modifying the product database.
/DESTINATION=device-name:[directory-name]
Specifies the location where the installed product resides. If you omit the device name, the utility uses your current default device. If you omit the directory name, the utility uses the [VMS$COMMON] directory as the default directory.
If you do not use this qualifier to specify a destination, the utility uses the location defined by logical name PCSI$DESTINATION. If this logical name is not defined, the utility uses the location SYS$SYSDEVICE:[VMS$COMMON], the top-level directory.
/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.

PARTIAL An upgrade to currently installed software. Installation of this kit changes 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.

/LOG

/NOLOG (default)
Displays the file specifications of the product files and directories that are registered in the product database.
/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:

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.
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).
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.

REGISTER_ALL_FILES Registers all files listed in the product description file of the kit, even if they are not currently present on the destination device.

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.
/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.]
/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.

Name	Description
AXPVMS	Denotes an OpenVMS Alpha product.
I64VMS	Denotes an OpenVMS I64 product.
VAXVMS	Denotes an OpenVMS VAX product.
VMS	Indicates a product that can be installed on more than one OpenVMS platform.

Example


$ PRODUCT REGISTER PRODUCT TOOLCHEST /SOURCE=DKB500:[TOOLCHEST.KIT]

The command in this example registers the product TOOLCHEST in the product database. TOOLCHEST was installed by VMSINSTAL, and a special transition kit is in the source directory to supply details about the product.

REGISTER VOLUME

For a volume containing installed products, records a change in volume label in the product database.
For device independence, the product database identifies the destination device of an installed product by its logical volume name, not by its physical device name. The logical volume name (usually in the form DISK$labelname) is defined by the MOUNT command and associated with the device.

Format

PRODUCT REGISTER VOLUME old-volume-label device-name [/qualifiers]

Description

You can check the logical volume name of a mounted device by issuing a command in the following format:
$ WRITE SYS$OUTPUT F$GETDVI("device","LOGVOLNAM")
When you use the SET VOLUME command to change the volume label of a nonsystem device that contains installed products, you must also use the PRODUCT REGISTER VOLUME command to update the product database with this information. Register the new volume label after you dismount and remount the volume so that the new logical volume name (DISK$labelname) is defined.
If you change the volume label of the system device, you do not need to use the PRODUCT REGISTER VOLUME command because PCSI automatically detects the change after the volume is remounted following a system reboot.

Parameters

old-volume-label
Names the old (existing) volume label.
device-name
Names the device for which the volume label is to be changed in the product database.

Qualifiers

/LOG

/NOLOG (default)
Displays the file specifications of the product database files that are created or modified.
/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.]

Example


$ PRODUCT REGISTER VOLUME AXPVMSV62 DKA0:

The command in this example replaces all occurrences of the old volume label in the PCSI database with the current volume label of the specified disk.

REMOVE

Uninstalls one or more software products from your system and updates the product database. This command operates on complete products. Any patches or mandatory updates that might have been applied to complete products are also removed.
To uninstall patches or mandatory updates while still retaining the original product that was installed, use the PRODUCT UNDO PATCH command.

Format

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

Parameter

product-name
Names the installed product or list of installed products to remove. Specify only the names of complete products, not the names of patches or mandatory updates applied to products.

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 I64 product.

VAXVMS Denotes an OpenVMS VAX product.

VMS Indicates a product that can be installed on more than one OpenVMS platform.

/LOG

/NOLOG (default)
Displays the file specification of each file processed. When logging is enabled, messages notify you whenever product files, libraries, directories, and product database files are created, deleted, or modified.
/OPTIONS=(keyword[,...])

/NOOPTIONS (default)
Specifies PRODUCT command options. Keywords are:

NOCONFIRM Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.

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.

/PRODUCER=producer-name
Selects software products that the specified manufacturer produces.
/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.]
/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. See the POLYCENTER Software Installation Utility Developer's Guide for more information.
/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 the user's login directory.

Name	Description
AXPVMS	Denotes an OpenVMS Alpha product.
I64VMS	Denotes an OpenVMS I64 product.
VAXVMS	Denotes an OpenVMS VAX product.
VMS	Indicates a product that can be installed on more than one OpenVMS platform.

Example


$ PRODUCT REMOVE FTAM

The command in this example uninstalls the product named FTAM and updates the product database to remove all information about the product.

SHOW HISTORY

Displays a chronological log of operations performed on the specified products.

Format

PRODUCT SHOW HISTORY product-name[,...] [/qualifiers]

Description

For each operation performed, the following information is displayed:

Name of the product
Type of product kit: full LP, operating system, mandatory update, partial, patch, platform, or transition
Kit validation status
Date of the operation

If you specify /FULL, the following additional information is also included:

Complete date and time of the operation
Number of times the user chose to continue from an error
Account name from which the operation was performed
Any text found in the remark field

The kit validation status field (VAL) codes are the following:

Code Meaning

Val Kit was successfully validated.

Sys Kit was not validated, but it was installed from OS media as part of an OpenVMS installation or upgrade.

(U) Kit was not validated because it was unsigned.

(M) Kit was not validated because its manifest file was not found in the source directory.

(D) Kit was not validated because validation was disabled by a user request.

(C) Kit was not validated because CDSA was not operational.

- Not applicable for the operation (such as product removal).

A blank entry indicates that the version of PCSI used did not support secure delivery.

Code	Meaning
Val	Kit was successfully validated.
Sys	Kit was not validated, but it was installed from OS media as part of an OpenVMS installation or upgrade.
(U)	Kit was not validated because it was unsigned.
(M)	Kit was not validated because its manifest file was not found in the source directory.
(D)	Kit was not validated because validation was disabled by a user request.
(C)	Kit was not validated because CDSA was not operational.
-	Not applicable for the operation (such as product removal).
	A blank entry indicates that the version of PCSI used did not support secure delivery.

Parameter

product-name
Names the product or list of products to include in the display. This is an optional parameter. If you omit it, operations performed on all products will be shown.

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 I64 product.

VAXVMS Denotes an OpenVMS VAX product.

VMS Indicates a product that can be installed on more than one OpenVMS platform.

Parentheses (()) are optional only when you specify a single base system name. They are required when you specify multiple base system names.
/BEFORE=time
Selects entries that were created before the specified date and time. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the following keywords:
TODAY (default)
TOMORROW
YESTERDAY

For information about specifying time values, see the OpenVMS User's Manual.
/FULL

/NOFULL (default)
Displays information in 132-column format. The /NOFULL qualifier displays a subset of available information in 80-column format.
/OPERATION=(keyword[,...])
Specifies one or more of the following operations as the value for keyword:
INSTALL
RECONFIGURE
REGISTER_PRODUCT
REGISTER_VOLUME
REMOVE

Parentheses (()) are optional only when you specify a single keyword. They are required when you specify multiple keywords.
/PRODUCER=(producer-name[,...])
Selects software products that the specified manufacturer produces.
Parentheses (()) are optional only when you specify a single producer name. They are required when you specify multiple producer names.
/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.]
/SINCE=time
Selects entries that were created on or after the specified date and time. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the following keywords:
TODAY (default)
YESTERDAY

For information about specifying time values, the OpenVMS User's Manual.
/USER=(username[,...])
Displays information about the products installed, configured, or removed by the specified user.
Parentheses (()) are optional only when you specify a single user name. They are required when you specify multiple user names.
/VERSION=(version-number[,...])
Selects software products that have the specified version.
Parentheses (()) are optional only when you specify one version number. They are required when you specify more than one version number.

Name	Description
AXPVMS	Denotes an OpenVMS Alpha product.
I64VMS	Denotes an OpenVMS I64 product.
VAXVMS	Denotes an OpenVMS VAX product.
VMS	Indicates a product that can be installed on more than one OpenVMS platform.

Example


$ PRODUCT SHOW HISTORY * /OPERATION=INSTALL /BEFORE=22-MAY-2002

The command in this example lists all the products that were installed before May 22, 2002.

Contents

Index

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: 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. 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). 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.
REGISTER_ALL_FILES	Registers all files listed in the product description file of the kit, even if they are not currently present on the destination device.
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.

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

NOCONFIRM	Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.
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.