cqs(CDMT)

cqs -- component query script

Syntax

cqs [keyword_list] package_list

Description

The component query script (cqs), located in SSOroot/cntl/cqs, is responsible for prompting the user for information and then passing that input to the ccs. The custom(ADM) utility calls the cqs during installations and upgrades, but not during removals.

The cqs takes two arguments:

$1

keyword_list

The keyword_list is a space-separated list of one or more keywords that apply to the current query being performed by the cqs:

UPGRADE: Upgrades an older version of an SSO-based component to the new version of an SSO-based component (installation only).
OLD_CUSTOM_UPGRADE: Upgrades an old-custom component to an SSO component.
FOR_LOCAL_CLIENT: The cqs is running on the CPU of the target system and can query the kernel or take other actions to provide the user with intelligent defaults.
TRUE_CLIENT_ROOT: The cqs is running with a root directory equal to the root directory of the target system. TRUE_CLIENT_ROOT is always specified when FOR_LOCAL_CLIENT is specified; this keyword might be specified alone if the cqs is running on the server system of a diskless client, but with a chroot(S) area specified that is equal to the real root of the client.

$2

package_list

The package_list is a space-separated list of the fully-qualified package names in the component. Package names are in the form:

vendorCode:componentCode:packageCode.

See ``Component identifiers'' in Developer's Topics.

To use the simpler package instead, use the getPackageCode function in the ccsSetup(CDMT) library. Note that packages are listed if any of its subpackages are selected, but this does not mean that a package is fully selected.

In addition to these arguments, the cqs receives information from custom by way of environment variables. See ``Component script environment variables'' in Developer's Topics for more information.

Exit values

Component query scripts should exit with one of the following values:

Value Variable Description

0 OK script executed successfully.

1 FAIL script execution was unsuccessful and the installation or removal is aborted; the user can choose to STOP the component.

2 WARN script execution logged warnings, but the installation or removal proceeded; the user can choose to STOP or continue the component.

3 STOP script stopped processing on this component (the component is left in the state it was in when the cqs returned STOP), but continued other component installation without user intervention.

Value	Variable	Description
0	OK	script executed successfully.
1	FAIL	script execution was unsuccessful and the installation or removal is aborted; the user can choose to STOP the component.
2	WARN	script execution logged warnings, but the installation or removal proceeded; the user can choose to STOP or continue the component.
3	STOP	script stopped processing on this component (the component is left in the state it was in when the cqs returned STOP), but continued other component installation without user intervention.

Limitations

The following limitations apply to cqs operation:

Do not use the cqs to perform configuration; use ccs instead. The cqs cannot alter any files except those in the CCS_PERSISTENT_STORAGE directory.
Make sure that the cqs can take its own output as input, to allow users to install multiple targets with the same input values.
Make sure that the cqs can run in different modes at different times during the installation. The cqs always runs prior to the PRE_ATTACH step of the ccs.
The cqs can only reference files in the component's SharedControl package.
The cqs can only reference utilities that are either part of the component itself or are located in the /ibin directory.
The cqs only allows character-based tty I/O.
Use the FOR_LOCAL_CLIENT and TRUE_CLIENT_ROOT to tell the cqs whether it is running on the target CPU and has access to the target root filesystem so that it can query the system hardware for default settings. However, if neither keyword is specified, the cqs must be able to run on another system, without accessing the target root filesystem.
During an upgrade, when the cqs receives either the UPGRADE or OLD_CUSTOM_UPGRADE keyword, the ccs should run non-interactively and save any old configuration information in the directory specified by the CCS_PERSISTENT_STORAGE variable. See ``Component script environment variables'' in Developer's Topics for more information on CCS_PERSISTENT_STORAGE.

Files

SSOroot/cntl/cqs

Standards conformance

cqs is not part of any currently supported standard; it is an extension of AT&T System V provided by The Santa Cruz Operation, Inc.