swinstall(1M) swinstall(1M)
NAME
swinstall, swcopy - install and configure software products; software products for subsequent installation or distribution; respectively
SYNOPSIS
[XToolkit Options] catalog] session_file] software_file] jobid] date] source] session_file] target_file] option=value] option_file] [soft-
ware_selections] target_selections]
[XToolkit Options] session_file] software_file] jobid] date] source] session_file] target_file] option=value] option_file] [software_selec-
tions] target_selections]
Remarks
o This command supports operation on remote systems. See the section below for details.
o and support an interactive user interface that can be invoked alone or by the command. See below.
o For an overview of all SD commands, see the sd(5) man page by typing on the command line.
DESCRIPTION
The command installs the software_selections from a software source to either the local host or to one or more target_selections (root
filesystems). By default, the software is configured for use on the target after it is installed. (The software is not configured when
installed into an alternate root directory.)
The command copies or merges software_selections from a software source to one or more software depot target_selections. These depots can
then be accessed as a software source by the command.
Remote Operation
You can enable Software Distributor (SD) to manage software on remote systems. To let the root user from a central SD controller (also
called the central management server or manager node) perform operations on a remote target (also called the host or agent"):
1) Set up the root, host, and template Access Control Lists (ACLs) on the remote machines to permit root access from the controller sys-
tem. To do this, run the following command on each remote system:
NOTES:
o controller is the name of the central management server.
o If remote system is 11.00, make sure SD patch PHCO_22526 or a superseding patch is installed on remote system before running
o If remote system is older than 11.00 or for some other reason does not have in place, copy script from an 11.11 or higher system to
the remote system.
2) and have enhanced GUI interfaces for remote operations. Enable the enhanced GUIs by creating the file on the controller. Use this
command:
NOTE: You can also set up remote access by using directly on the remote machines to grant root or non-root access to users from the con-
troller system.
Interactive Operation
and each support a graphical user interface (GUI). (If your terminal or display cannot support the GUI, these commands also provide a ter-
minal user interface, in which screen navigation is done with the keyboard and no mouse.)
To invoke the GUI, enter
or
on the command line (without any command-line options).
You can also invoke the GUI by including the option with any other command-line options.
The command provides an interactive interface for monitoring and scheduling software jobs. You can also use to invoke the and GUIs.
If you have enabled SD's remote operations features, provide enhanced GUIs to support operations on remote targets. See above for details
about enabling remote operations and the enhanced GUIs.
The command-line version of can also function interactively when the option is set to This option executes an interactive request script.
Request scripts can also be executed by and See swconfig(1M) and swask(1M), and the default option for more information.
Updating the Operating System
To perform an operating system update, HP recommends that you use the command. This command replaces to update the operating system to HP-
UX 11.11 or higher. is not available on 11.00 systems. To perform an update from 11.00 to 11.11 or higher, install from the new operating
system media. Then use to update the OS. See update-ux(1M) on an 11i system for more information.
Reinstalling SD
If your copy of SD becomes unusable or if you want to install a newer version of SD, HP recommends that you use the command. This command
reinstalls SD and also installs any SD patches that exist in the source depot.
Installing Kernel Software
In HP-UX, the kernel installation process requires that the system boots using the kernel at Make sure that your system is booted to the
kernel before you install any kernel software or perform an operating system update.
Dependencies Between Software
The command supports dependencies, which is software that must be present or absent before or during the installation of another piece of
software. Dependencies apply between filesets and other filesets and products. SD supports three types of dependencies: prerequisites
that must be installed and configured before the dependent fileset is installed and configured (respectively); corequisites that must be
installed and configured before the dependent is usable. exrequisites that prevent a dependent fileset from being installed or configured
when they are present.
If a software_selection specifies a dependency on other filesets and/or products, automatically select that software.
By default, all dependencies must be resolved before can proceed. You can override this policy using the option.
Note that if you specify a dependency for a fileset and the fileset is superseded by another fileset as part of a patch, still recognizes
the dependency.
Features and Differences between swinstall and swcopy
The key difference between and is that performs the software installation, while copies software into a depot, making it available as a
source for installation by
NOTE: To copy to a tape, see the swpackage(1M) manpage.
Other features (differences) include:
o The command executes several vendor-supplied scripts during the installation and configuration of the software_selections. The
command does not execute these scripts. The command supports the following scripts:
a script that asks the user questions and stores responses in a
file. The response file can then be used by configuration or other scripts.
a script executed during the analysis of a
it checks that the installation can be attempted. If this check fails, the software product is not
installed.
a script executed immediately before the software's files are installed.
a script executed immediately after the software's files are installed.
a script executed during the configuration of a
target_selection, it configures the target for the software (and the software for the target). The and
scripts are not intended to be used for configuration tasks. They are to be used for simple file management
needs such as removing obsolete files from the previous revision (which was just updated).
a script executed immediately after the software's actual files are
restored if the software install will fail and the option is set to The script undoes the steps performed by
script.
a script executed immediately before the software's actual files are
restored if the software install failed and the option is set to The script undoes the steps performed by
script.
o When a depot is created or modified using are built that describe the depot (comparable to the (IPD) files that are built by the
command).
o By default, the command only allows the selection of compatible software from the source. This constraint ensures that the
architecture of the software matches that of the target_selections. No compatibility checks are performed by the command. (A
depot can be a repository of software targeted for a variety of architectures and operating systems.)
o By default, supports updates to higher revisions of software. If a software_selection of the same revision is already installed,
will not reinstall it. If a software_selection has a lower revision than the same software which is already installed, will not
reinstall it. (The user can override these behaviors with control options.)
o The command creates hard links and symbolic links as specified for the software. If it encounters a symbolic link where it
expected a regular file, follows the symbolic link and updates the file to which it points.
o The command does not remove a product's current files before installing the new ones. A fileset's install scripts can do that,
if necessary. Files being replaced are overwritten unless they are in use. If in use, they are unlinked or moved to If the
autorecover_product option is set to all files are saved to and restored if the install fails.
o The command supports kernel building scripts and rebooting. Before or after software that modifies the kernel is installed or
updated, executes system-specific scripts to prepare for or build the new version of the kernel. The remaining software_selec-
tions are then installed. These scripts are defined in options and include: and Please Note: Transition links do not exist on
11.31 and newer releases so there are no install setup and cleanup steps to perform; therefore, the and are never executed for
these releases.
After software that requires a system reboot is installed or updated, automatically reboots the system. The reboot command is
defined by the option:
When updating the operating system (see update-ux(1M) for more information.), you should install kernel software first to ensure
that a new kernel can be generated before the rest of the operating system is updated. After all the software_selections are
updated or installed, reboots using the new kernel, then executes the configure scripts for each software_selection. After these
scripts complete, it reboots the system again to restore it to its normal state.
o No kernel building or system reboots are performed by
o Both the and commands perform various checks prior to installing or copying the software_selections, for example disk space anal-
ysis.
Options
and support the following options:
XToolKit Options
The and commands support a subset of the standard X Toolkit options to control the appearance of the GUI. The sup-
ported options are: and See the X(1) manual page by typing for a definition of these options.
Runs the command in interactive mode (Graphical User Interface). See
the and headings above for details.
Previews an install task by running the session through the analysis phase
only.
Causes to operate on alternate root directories, which must be specified with the option. Configuration scripts are not run
on alternate roots. (This option is not required for alternate root operations but is maintained for backward com-
patibility. See the heading in sd(5) for more information.)
Turns on verbose output to stdout.
(The or logfile is not affected by this option.) Verbose output is enabled by default; see the option below.
Specifies the pathname of an exported catalog which
stores copies of the response file or files created by a request script (if or The response files are also stored in
the after the installation process is complete.
Save the current options and operands to
session_file. You can enter a relative or absolute path with the file name. The default directory for session files
is You can recall a session file with the option.
Read the list of
software_selections from software_file instead of (or in addition to) the command line.
Executes the previously scheduled job. This is the syntax used by the
daemon to start the job.
Schedules the job for this date. You can change the date format by
modifying the
Specifies the source depot (or tape) from which software is installed
or copied. (SD can read both and tape depots.) The default source type is directory. The syntax is:
A host may be specified by its host name, domain name, or Internet address. A directory must be specified by an
absolute path.
Execute or based on the options and operands saved from a previous session, as defined in session_file. You can save session
information from a command-line session with the session_file option.
Read the list of
target_selections from target_file instead of (or in addition to) the command line.
Set the session
option to value and override the default value (or a value in an alternate option_file specified with the option).
Multiple options can be specified.
Read the session options and behaviors from
option_file.
Operands
The and commands support two types of operands: followed by These operands are separated by the "at" character. This syntax implies that
the command operates on "software selections at targets".
Software Selections
The selections operands consist of
and support the following syntax for each software_selection:
o You can specify selections with the following shell wildcard and pattern-matching notations:
For example, the following expression installs all bundles and products with tags that end with "man":
o Bundles and subproducts are recursive. Bundles can contain other bundles and subproducts can contain other subproducts. For
example:
or (using expressions):
o The software specification selects all products. Use this specification with caution.
The component has the form:
o location applies only to installed software and refers to software installed to a location other than the default product direc-
tory.
o and apply only to filesets.
o and apply only to bundles and products. They are applied to the leftmost bundle or product in a software specification.
o The <op> (relational operator) component can be of the form:
or
which performs individual comparisons on dot-separated fields.
For example, chooses all revisions greater than or equal to The system compares each dot-separated field to find matches.
o The (equals) relational operator lets you specify selections with the shell wildcard and pattern-matching notations:
For example, the expression returns any revision in version 10 or version 11.
o All version components are repeatable within a single specification (for example, If multiple components are used, the selection
must match all components.
o include the and version components even if they contain empty strings. For installed software, is also included.
o No space or tab characters are allowed in a software selection.
o The software can take the place of the version component. It has the form:
[instance_id]
within the context of an exported catalog, where is an integer that distinguishes versions of products and bundles with the same
tag.
The software specification selects all products. It is not allowed when removing software from the root directory
Target Selection
The and commands support the following syntax for each target_selection. The colon is required if both a host and directory are specified.
A host may be specified by its host name, domain name, or Internet address. A directory must be specified by an absolute path.
If multiple targets are specified, the first target in the list is used as the basis for selections.
Target Selections with IPv6 Address
The and commands also support specifying the host as an IPv6 address on HP-UX Release 11i v3, as shown below:
If both the hostname and the path are specified, then the first occurrence of a slash is treated as the separator.
The IPv6 address can optionally be enclosed in a pair of square brackets and
EXTERNAL INFLUENCES
Default Options
In addition to the standard options, several SD behaviors and policy options can be changed by editing the default values found in:
the system-wide default values.
the user-specific default values.
Values must be specified in the defaults file using this syntax:
The optional prefix denotes one of the SD commands. Using the prefix limits the change in the default value to that command. If you leave
the prefix off, the change applies to all commands.
You can also override default values from the command line with the or options:
The following section lists all of the keywords supported by the and commands. If a default value exists, it is listed after the
The location for SD logfiles and the default parent directory for the
installed software catalog. The default value is for normal SD operations. When SD operates in nonprivileged mode (that
is, when the default option is set to
o The default value is forced to
o The path element is replaced with the name of the invoking user, which SD reads from the system password file.
o If you set the value of this option to path, SD replaces with the invoking user's home directory (from the system pass-
word file) and resolves path relative to that directory. For example, resolves to the directory in your home direc-
tory.
o If you set the value of the default option to a relative path, that path is resolved relative to the value of this
option.
SD's nonprivileged mode is intended only for managing applications that are specially designed and packaged. This mode
cannot be used to manage the HP-UX operating system or patches to it. For a full explanation of nonprivileged SD, see the
available at the web site.
See also the and options.
Causes the target agent to automatically exit after Execute phase, or after
a failed Analysis phase. This is forced to when the controller is using an interactive UI, or when (preview) is used.
This enhances network reliability and performance. The default is - the target agent automatically exits when appropri-
ate. If set to the target agent will not exit until the controller ends the session.
Causes a target agent to exit if it has been inactive for the
specified time. This can be used to make target agents more quickly detect lost network connections since RPC can take as
long as 130 minutes to detect a lost connection. The recommended value is the longest period of inactivity expected in
your environment. For command line invocation, a value between 10 minutes and 60 minutes is suitable. A value of 60 min-
utes or more is recommended when the GUI is used. The default of 10000 is slightly less than 7 days.
(Applies only to
Prevents the installation of an older revision of fileset that already exists at the target(s). (Many software products
do not support "downdating".) If set to the older revision can be installed.
(Applies only to
Requires that the software products which are being installed be "compatible" with the target selections. (All of the
target selections must match the list of supported systems defined for each selected product.) If set to target compati-
bility is not enforced.
(Applies only to
Prevents the installation of another, independent version of a product when a version already is already installed at the
target.
If set to another version of an existing product can be installed into a new location. Multiple versions can only be
installed if a product is locatable. Multiple configured versions will not work unless the product supports it.
Permits the use of single patch filesets without "sibling" filesets.
In the default state of installation or copying of a single fileset from a multi-fileset patch automatically includes any
other fileset that are part of the patch, based on the ancestor filesets of the target fileset. (This behavior applies to
filesets selected directly by the user and to filesets automatically selected by SD to resolve software dependencies.)
When set to SD allows a single patch fileset to be installed or copied without including the sibling filesets. This allows
a target to contain a patch that has been "split" into its component filesets. WARNING: Splitting a patch can create a
situation in which one fileset in a sibling group would be updated by a patch, while the other filesets would remain at an
earlier release.
(Applies only to
When executes a request script which asks for a user response. If the command first determines if a response file already
exists in the catalog specified in the option or source depot and executes the request script only when a response file is
absent.
If set to or you can use the option to specify the pathname of an exported catalog to store copies of the response file or
files created by the request script.
See swask(1M) for more information on request scripts.
(Applies only to
Prevents the installation of software requiring a reboot from the non-interactive interface. If set to this software can
be installed and the target system(s) will be automatically rebooted.
An interactive session always asks for confirmation before software requiring a reboot is installed.
This option permits automatic recovery of original filesets if an
installation error occurs. The cost is a temporary increase in disk space and slower performance. The default value of
causes to remove the original files as a fileset is updated. If an error occurs during the installation (for example,
network failure), then the original files are lost, and you must reinstall the fileset.
If set to all files are saved as backup copies until the current fileset finishes loading. If an error occurs during
installation, the fileset's original files are replaced, and continues to the next fileset in the product or the product
script.
When set to this option also affects scripts. For example, if a preinstall script fails, this option causes the corre-
sponding unpreinstall script to execute. See for complete information.
(Applies only to
This option permits automatic recovery of original product files if an installation error occurs. The cost is a temporary
increase in disk space and slower performance. The default value of causes to remove any existing product files as a prod-
uct is updated. If an error occurs during installation (for example, network failure), then the original files are lost,
and you must reinstall the product.
If set to all files for a product are saved as backup copies until the entire product finishes loading. Then the files are
removed. If an error occurs during installation, the original product files are replaced, and exits.
When set to this option also affects scripts. For example, if a preinstall script fails, this option causes the corre-
sponding unpreinstall script to execute. See for complete information.
Controls automatic job removal of completed jobs. If the job is
automatically removed, job information (job status or target logfiles) cannot be queried with
Automatically select dependencies when software is being selected.
When set to and any software which has dependencies is selected for install, or makes sure that the dependencies are met.
If they are not already met, they are automatically selected for you. If set to automatic selections are not made to
resolve requisites. When set to autoselected dependencies are operated upon only if the dependency is not already met on
the target.
The GUI and TUI screen does not provide an interface to set the option to The GUI and TUI, however, will maintain the
option setting when it is specified on the or command line.
The option is ignored when this option is set to
Controls the automatic selection
of the first left-most dependency in a list of OR dependencies that satisfies a requisite when another dependency in the
list that also satisfies the requisite is explicitly selected by the user.
When set to the first left-most dependency in a list of OR dependencies that satisfies a requisite is not automatically
selected when another dependency in the list that also satisfies the requisite is explicitly selected. If set to the
first left-most dependency in a list of OR dependencies that satisfies a requisite is automatically selected even when
another dependency in the list that also satisfies the requisite is explicitly selected.
This option is ignored when the option is set to
Automatically selects the latest patches (based on superseding and
ancestor attributes) for a software object that a user selects for a or operation. When set to the patches corresponding
to the selected object, are not automatically selected.
The option can be used in conjunction with
If bundles that are are automatically installed or copied, along with the software it is made up of. If the software can be
installed, or copied, without automatically including sticky bundles that contain it.
Provides the "codeword" needed to unlock protected HP CD-ROM software.
Some HP software products are shipped on CD-ROM as "protected" products. That is, they cannot be installed or copied
unless a "codeword" and "customer ID" are provided. The codeword is found on the CD-ROM certificate which you received
from HP. You may use this default specification on the command line or the SD-UX Interactive User Interface to enter the
codeword.
This default stores the codeword for future reference, and you need to enter the codeword only once. If you purchase a new
HP product and a previous codeword has already been entered for that CD-ROM, just enter the new codeword as usual and the
codewords will be merged internally.
NOTE: For HP-UX B.10.10 and later systems, SD searches the file on the server that is providing protected software to
other hosts. It looks for valid customer_id/codeword pairs. In doing so, SD eliminates the need to enter codewords and
customer_ids on every host that is "pulling" the software.
To properly store the customer_id/codeword for a CD-ROM, run or on the host serving the CD-ROM. After the codeword has
been stored, clients installing or copying software using that host and CD-ROM as a source will no longer need a codeword
or customer_id.
If set to uncompressed files are compressed before transfer from a source. This enhances performance on slower networks for and and
results in smaller depots for and unless the option is also set to
Determines whether SD commands create compressed INDEX and INFO
catalog files when writing to target depots or roots. The default of does not create compressed files. When set to SD
creates compressed and uncompressed INDEX and INFO files. The compressed files are named and and reside in the same direc-
tories as the uncompressed files.
Compressed files can enhance performance on slower networks, although they may increase disk space usage due to a larger
Installed Products Database and depot catalog. SD controllers and target agents for HP-UX 11.01 and higher automatically
load the compressed INDEX and INFO files from the source agent when:
o The source agent supports this feature.
o or exist on the source depot.
o or are not older than the corresponding uncompressed INDEX or INFO files.
The uncompressed INDEX or INFO file is accessed by the source agent if any problem occurs when accessing, transferring, or
uncompressing the or file.
Specifies the location of a depot for the controller to access to
resolve selections. Setting this option can reduce network traffic between the controller and the target. Use the target
selection syntax to specify the location:
The supports the same syntax as the option. This option has no effect on which sources the target uses and is ignored
when used with the Interactive User Interface.
Causes the agent to create the target directory if it does not already
exist. If set to a new target directory is not created. This option can prevent the erroneous creation of new target
depots or new alternate root directories.
For cumulative source depots, this option allows consistent software
selections over time by and The default of zero includes all bundles, products, subproducts, and filesets in the source
depot as candidates for selection (and autoselection of dependencies and patches), based on the software selections and
other options. When set to a time (specified as seconds from epoch), only those bundles, products, and filesets (and the
subproducts in the product) with a create_time less than or equal to the specified value are available for selection (or
autoselection). To list the create_time of bundles, products and filesets, use:
This number, also printed on the Software Certificate,
is used to "unlock" protected software and restrict its installation to a specific site or owner. It is entered using the
customer_id= option or by using the Interactive User Interface. The customer_id can be used on any HP-UX 10.0X or later
system.
(Applies only to
Causes to automatically run configure scripts for the software_selections after they are installed. (Alternate root
directories are not configured.)
When set to true, does not run configure scripts. If you want to configure the software later, you must run the command.
NOTES:
o Multiple versions of a product will not be automatically configured if another version is already configured. Use the
command to configure multiple versions separately.
o SD ignores this option when it installs software that causes a system reboot.
Defines the default location of the source depot (when the
is directory). You can also use the syntax. The option overrides this default.
(Applies only to
Defines the default location of the target depot.
Requires that all dependencies specified by the
software_selections be resolved either in the specified source, or at the target_selections themselves.
The and commands will not proceed unless the dependencies have also been selected or already exist at the target in the
correct state (INSTALLED or AVAILABLE). This prevents unusable software from being installed on the system. It also
ensures that depots contain usable sets of software.
If set to dependencies are still checked, but not enforced. Corequisite dependencies, if not enforced, may keep the
selected software from working properly. Prerequisite dependencies, if not enforced, may cause the installation or con-
figuration to fail.
Prevents the command from proceeding past the analysis phase if the disk
space required is beyond the available free space of the impacted filesystem(s). If set to the install or copy operation
uses the filesystem's minfree space and may fail because it reaches the filesystem's absolute limit.
(Applies only to
Prevents from proceeding past the kernel build phase if the kernel build processes fail. If set to the install operation
continues (without suspension if in the interactive mode) despite failure or warnings from either the system preparation
process or the kernel build process.
When set to the default value of this option generates an error if a command tries to relocate a non-relocatable fileset.
(Relocatable filesets are packaged with the attribute set to When set to the usual error handling process is overridden,
and SD permits the command to relocate the fileset.
Controls the handling of errors generated by scripts. If
and a script returns an error, an error message appears reporting that the execution phase failed. If attempts to con-
tinue operation. A warning message appears saying that the analysis or execution phase succeeded. The message identifies
the specific phase (checkinstall, preinstall, postinstall, or configure).
(Applies only to
Defines the directory path where the Installed Products Database (IPD) is stored. This information describes installed
software. When set to an absolute path, this option defines the location of the IPD. When this option contains a rela-
tive path, the SD controller appends the value to the value specified by the option to determine the path to the IPD. For
alternate roots, this path is resolved relative to the location of the alternate root. This option does not affect where
software is installed, only the IPD location.
This option permits the simultaneous installation and removal of multiple software applications by multiple users or mul-
tiple processes, with each application or group of applications using a different IPD.
Caution: use a specific to manage a specific application. SD does not support multiple descriptions of the same applica-
tion in multiple IPDs.
See also the and options, which control SD's nonprivileged mode. (This mode is intended only for managing applications
that are specially designed and packaged. This mode cannot be used to manage the HP-UX operating system or patches to it.
For a full explanation of nonprivileged SD, see the available at the web site.)
This is an ASCII string giving a title to a job. It is displayed
along with the job ID to provide additional identifying information about a job when or is invoked. The default value is
to have no title. If a title is specified, it should be enclosed in quotes.
Specifies the POSIX
to which the SD commands conform when writing distributions and output. Supported values are "1.0" (default) and "0.8".
SD object and attribute syntax conforms to the specification of the standard. SD commands still accept the keyword names
associated with the older layout version, but you should use only to create distributions readable by older versions of
SD.
See the description of the option in sd(5) for more information.
Controls the amount of detail written to the logfile. When set to
this option adds detailed task information (such as options specified, progress statements and additional summary informa-
tion) to the logfile. This information is in addition to log information controlled by the option.
See and the sd(5) manual page by typing for more information.
This is the default command log file for
the command.
Controls the log level for the events logged to the command logfile, the
target agent logfile, and the source agent logfile. This information is in addition to the detail controlled by the
option. (See and the sd(5) manual page for more information.) A value of:
provides no information to the logfile.
enables verbose logging to the logfiles.
enables very verbose logging, including per-file messages, to the logfiles.
Adds numeric identification numbers at the beginning of SD logfile
messages:
(default) No identifiers are attached to messages.
Adds identifiers to ERROR messages only.
Adds identifiers to ERROR and WARNING messages.
Adds identifiers to ERROR, WARNING, and NOTE messages.
Adds identifiers to ERROR, WARNING, NOTE, and certain other
informational messages.
Controls the time in minutes to cache and re-use the results of hostname
or IP address resolution lookups. A value of 0 disables the facility to cache and re-use lookup results. The maximum
value allowed is 10080 minutes, which is one week.
A value of:
disables the lookup caching mechanism.
is the maximum value allowed.
(Applies only to
If set to software selection is done by locating filesets on the source that match the target system's installed filesets.
If multiple targets are specified, the first target in the list is used as the basis for selections.
When set to a positive integer, SD limits the number of concurrent
install or copy operations to the number specified. As each copy or install operation completes, another target is
selected and started until all targets have been completed.
Server and network performance determines the optimal setting; a recommended starting point is 25 (the default value). If
you set this option to a value of less than one, SD attempts to install or copy to all targets at once.
Attempt to mount all filesystems
in the file at the beginning of the analysis phase, to ensure that all listed filesystems are mounted before proceeding.
This policy helps to ensure that files are not loaded into a directory that may be below a future mount point.
If set to the mount operation is not attempted, and no check of the current mounts is performed.
(Applies only to
This option can be used in conjunction with to specify the desired OS name during an HP-UX update. The option should only
be specified from the command line. Refer to the SD file for correct syntax. You can display the file by entering:
(Applies only to
This option can be used in conjunction with to specify the desired OS release during an HP-UX update. The option should
only be specified from the command line. Refer to the SD file for correct syntax. You can display the file by entering:
This option can be used in conjunction with the
or options to filter the selected patches to meet the criteria specified by software_specification. The default value of
this option is
If multiple targets are specified, the first target in the list is used as the basis for patch selections.
If set to this option selects the latest patches (software identified by the is_patch=true attribute) that correspond to software on
the target root or depot. If multiple targets are specified, the first target in the list is used as the basis for patch
selections.
The option can be used in conjunction with
Saves the original versions of files modified by patches, which
permits the future rollback of a patch. Patched files are saved to When set to patches cannot be rolled back (removed)
unless the base software modified by the patch is removed at the same time.
To commit a patch by removing the corresponding saved files, use the command's option.
Defines the polling interval, in seconds, used by the interactive GUI
or TUI of the controller. It specifies how often each target agent is polled to obtain status information about the task
being performed. When operating across wide-area networks, the polling interval can be increased to reduce network over-
head.
(Applies only to
Preserves the original create time when you copy depots, which produces consistent results when you use the copies. The
default of sets the of software bundles, products, and filesets equal to the time the object was created in the depot.
When set to the of software bundles, products, and filesets is set to that specified in the source depot. Note that using
this option when copying to a master depot can change the objects that are visible when you use the option.
(Applies only to
Do not copy a fileset that is already available on the target at the same version. If copy the fileset in any case.
(Applies only to
Causes to register a newly created depot with the local This action allows other SD commands to automatically "see" this
depot. If set to a new depot is not automatically registered. It can be registered later with the command.
(Applies only to
Causes alternate roots to be registered during These can be listed with
When re-installing an existing revision of a fileset, this option
causes that fileset to be skipped, that is, not re-installed. If set to the fileset is re-installed. See also
Controls the overwriting of files, which may enhance performance on
slow networks or disks. At the default value of false, SD compares each file in a source fileset to corresponding files
on the target system. SD compares the files based on size, timestamp, and (optionally) the checksum (see If the files are
identical the files on the target system are not overwritten.
When set to true, SD does not compare files and overwrites any identical files on the target.
Controls the use of checksum comparisons when the
option is set to false. At the default value of true, this option causes SD to compute and compare checksums to determine
if a new file should overwrite an old file. Use of checksums slows the comparison but is a more robust check for equiva-
lency than size and time stamp.
If set to false, SD does not compute checksums and compares files only by size and timestamp.
(Applies only to
Controls whether automatically removes obsolete filesets from target products in the target depot. If set to removes
obsolete filesets from the target products that were written to during the copy process. Removal occurs after the copy is
complete. Filesets are defined as obsolete if they were not part of the most recent packaging of the product residing on
the source depot.
Defines the number of times a lost source connection is retried during
file transfers in or A lost connection is one that has timed out. When used in conjunction with the option, the success
of installing over slow or busy networks can be increased. If set to zero, any to the source causes the task to abort.
If set from 1 to 9, the install of each fileset is attempted that number of times. The option should also be set to false
to avoid installing files within the fileset that were successfully installed.
This option also applies to the controller contacting the agent. If the agent session fails to start for any reason, the
controller tries to recontact that agent for the number of times specified in using the values from the option to deter-
mine how long to wait between each attempt to recontact the agent.
Specifies in minutes the length of the interval for repeated attempts
to make a connection to a target after an initial failure. Used in conjunction with the option. If the number of values
in this option equals the value of SD tries reestablishing a source connection for the number of times specified in If the
number of values in is less than the value in SD repeats the final interval value until the number of retries matches
For example, if a session failed to start and was set to 9 and was set to {1 2 4 8 15} to allow long waits to handle tran-
sient network failures, the SD controller would attempt to recontact the agent after 1 minute for the first retry, then 2
minutes for the second retry, 4 for the third, then 8, then 15 for all additional retries until nine retries were
attempted. With these values, a file load failure could cause the operation to pause for 90 minutes
(1+2+4+8+15+15+15+15+15). If was set to 5 and was set to {1 2 4 8 15}, the controller would try to contact the target
five times over a 30-minute period.
Defines the protocol sequence(s) and endpoint(s) on which the daemon
listens and the other commands contact the daemon. If the connection fails for one protocol sequence, the next is
attempted. SD supports both the tcp and udp protocol sequence on most platforms. See the sd(5) man page by typing for
more information.
Defines the protocol sequence(s) and endpoint(s) on which commands
contact the daemon for source access only. If the connection fails for one protocol sequence, the next is attempted. If
this is set to no value (default) the values from are used to contact the daemon for source access. See (above) for more
information.
Defines the protocol sequence(s) and endpoint(s) on which commands
contact the daemon for target access only. If the connection fails for one protocol sequence, the next is attempted. If
this is set to no value (default) the values from are used to contact the daemon for target access. See (above) for more
information.
Relative length of the communications timeout. This is a value in the
range from 0 to 9 and is interpreted by the DCE RPC. Higher values mean longer times; you may need a higher value for a
slow or busy network. Lower values give faster recognition on attempts to contact hosts that are not up or not running
Each value is approximately twice as long as the preceding value. A value of 5 is about 30 seconds for the protocol
sequence. This option may not have any noticeable impact when using the protocol sequence.
This option controls SD's nonprivileged mode. This option is ignored
(treated as true) when the invoking user is super-user.
When set to the default value of true, SD operations are performed normally, with permissions for operations either
granted to a local super-user or set by SD ACLs. (See swacl(1M) for details on ACLs.)
When set to false and the invoking user is local and is not super-user, nonprivileged mode is invoked:
o Permissions for operations are based on the user's file system permissions.
o SD ACLs are ignored.
o Files created by SD have the uid and gid of the invoking user, and the mode of created files is set according to the
invoking user's umask.
SD's nonprivileged mode is intended only for managing applications that are specially designed and packaged. This mode
cannot be used to manage the HP-UX operating system or patches to it. For a full explanation of nonprivileged SD, see the
available at the web site.
See also the and options.
(Applies only to
Controls whether or not control scripts are run during an install session. (See above for the list of control scripts
typically run during Control scripts are an important part of software packages and setting this to false may keep soft-
ware from being installed correctly.
If no target_selections are specified, select the default root directory or the default at the local host as the target of the
command.
Defines the default
software_selections. There is no supplied default. If there is more than one software selection, they must be separated
by spaces.
Indicates the software view to be used as the default level for
the software listing in the GUI. It can be set to or a bundle category tag (to indicate to show only bundles of that cat-
egory).
Specify a source to automatically bypass the GUI and CLI source
selection dialog box. This has the same effect as the command line option. Specify the source using the following syn-
tax.
[path]
Defines the default location of the source CD-ROM using the syntax
Defines the default location of the source tape, usually the
character-special file of a local tape device. You can also use the syntax, but the host must match the local host. The
option overrides this value. (Note that SD can read both and tape depots.)
Defines the default source type:
or The source type derived from the option overrides this value. (SD can read both and tape depots.)
Defines the default
target_selections. There is no supplied default (see above). If there is more than one target selection, they must be
separated by spaces.
(Applies only to
If set to files being transferred from a source are uncompressed before store them on the target depot.
Empowers each target agent to use its own, configured alternate source, instead
of the one specified by the user. If each target agent uses the same source (the source specified by the user and vali-
dated by the command). If each target agent uses its own configured value for the source.
Controls the verbosity of the output (stdout). A value of
disables output to stdout. (Error and warning messages
are always written to stderr).
enables verbose messaging to stdout.
Prevents the installation or copying of files to a target which exists
on a remote filesystem. All files destined for a remote filesystem are skipped.
If set to and if the superuser has write permission on the remote filesystem, the remote files are installed or copied.
Session File
Each invocation of the or command defines an installation or copy session. The invocation options, source information, software selec-
tions, and target hosts are saved before the installation or copy task actually commences. This lets you re-execute the command even if
the session ends before proper completion.
Each session is saved to the file This file is overwritten by each invocation of or
You can also save session information from interactive or command-line sessions. From an interactive session, you can save session infor-
mation into a file at any time by selecting the Save Session or Save Session As option from the File menu. From a command-line session,
you can save session information by executing or with the session__file option.
A session file uses the same syntax as the defaults files. You can specify an absolute path for a session file. If you do not specify a
directory, the default location for a session file is
To re-execute a saved session from an interactive session, use the Recall Session option from the File menu. To re-execute a session from
a command-line, specify the session file as the argument for the session__file option of or
Note that when you re-execute a session file, the values in the session file take precedence over values in the system defaults file.
Likewise, any command line options or parameters that you specify when you invoke or take precedence over the values in the session file.
Software and Target Lists
Most SD commands support software and target selections from separate input files (see the and command-line options). Software and targets
specified in these files will be selected for operation. and also support an interactive read and save of target and software groups.
Target and software groups can be saved in files (default location and and then selected in subsequent and operations.
Additionally, the and interactive user interfaces read a default list of hosts on which to operate. The list is stored in:
the system-wide default list of hosts
the user-specific default list of hosts
For each interactive command, target hosts containing roots and target hosts containing depots are specified in separate lists ( respec-
tively). The list of hosts are enclosed in {} braces and separated by white space (blank, tab and newline). For example:
The and interactive user interfaces read a default list of patch filters that you can use as selection criteria for patch software. The
list is stored in:
the system-wide default list of patch filters.
the user-specific default list of patch filters.
The list of patch filters is enclosed in braces {} and separated by white space (blank, tab, or newline). For example:
Environment Variables
The environment variables that affect the command are:
Determines the language in which messages are displayed.
If is not specified or is set to the empty string, a default value of is used. See the lang(5) man page by typing for
more information.
NOTE: The language in which the SD agent and daemon log messages are displayed is set by the system configuration vari-
able script, For example, must be set to or to make the agent and daemon log messages display in Japanese.
Determines the locale to be used to override any values for locale
categories specified by the settings of or any environment variables beginning with
Determines the interpretation of sequences of bytes of text data as
characters (for example, single versus multibyte characters in values for vendor-defined attributes).
Determines the language in which messages should be written.
Determines the format of dates
(create_date and mod_date) when displayed by Used by all utilities when displaying dates and times in and
Determines the time zone for use when displaying dates and times.
Environment variables that affect scripts:
Holds the path to the Installed Products Database (IPD), relative to
the path in the environment variable. Note that you can specify a path for the IPD using the default option.
Defines the current directory of the script being executed, either
a temporary catalog directory, or a directory within in the Installed Products Database (IPD). This variable tells
scripts where other scripts for the software are located (for example, subscripts).
Holds the tag name of the
control_file being executed. When packaging software, you can define a physical name and path for a control file in a
depot. This lets you define the control_file with a name other than its tag and lets you use multiple control file
definitions to point to the same file. A control_file can query the
Defines the location of the product, which may have been changed from
the default product directory. When combined with the this variable tells scripts where the product files are located.
A variable which defines a minimum set of commands available to for use in a script (for example,
Defines the root directory in which the session is operating, either
"/" or an alternate root directory. This variable tells scripts the root directory in which the products are
installed. A script must use this directory as a prefix to to locate the product's installed files. The configure
script is only run when is
Contains the pathname of a file containing the value of every option
for a particular command, including software and target selections. This lets scripts retrieve any command options and
values other than the ones provided explicitly by other environment variables. For example, when the file pointed to by
is made available to a request script, the targets option contains a list of software_collection_specs for all targets
specified for the command. When the file pointed to by is made available to other scripts, the targets option contains
the single software_collection_spec for the targets on which the script is being executed.
This variable contains the fully qualified software specification of
the current product or fileset. The software specification allows the product or fileset to be uniquely identified.
Additional environment variables that affect scripts for
This variable is normally unset. If it is
set, the actions necessary for preparing the system file cannot be accomplished from within the postinstall scripts,
but instead must be accomplished by the configurescripts. This occurs whenever software is installed to a directory
other than such as for a cluster client system. This variable should be read only by the configure and postinstall
scripts of a kernel fileset. The command sets these environment variables for use by the kernel preparation and build
scripts.
This variable is normally unset. If it is
set, the session is being run as the back end of an initial system software installation ("cold" install).
The path to the kernel. The default value is
defined by the option or
Indicates whether a kernel build is scheduled for the current
install/remove session. A value indicates that the selected kernel fileset is scheduled for a kernel build and that
changes to are required. A null value indicates that a kernel build is not scheduled and that changes to are not
required.
The value of this variable is always equal to the value of
Indicates whether a reboot is scheduled for a fileset selected for
removal. Because all HP-UX kernel filesets are also reboot filesets, the values of this variables is always equal to
the value of
A value of indicates the SD command was invoked by the command during an Operating System update. This variable is set by the
command.
The path to the kernel's system file. The
default value is
Signals
The and commands catch the signals SIGQUIT, SIGINT, and SIGUSR1. If these signals are received, the command prints a message, sends a
Remote Procedure Call (RPC) to the agents to wrap up after completion, and then exits.
The agent ignores SIGHUP, SIGINT, and SIGQUIT. It immediately exits gracefully after receiving SIGTERM, SIGUSR1, or SIGUSR2. Killing the
agent may leave corrupt software on the system, and thus should only be done if absolutely necessary. Note that when an SD command is
killed, the agent does not terminate until completing the task in progress.
The daemon ignores SIGHUP, SIGINT and SIGQUIT. It immediately exits gracefully after receiving SIGTERM and SIGUSR2. After receiving
SIGUSR1, it waits for completion of a copy or remove from a depot session before exiting, so that it can register or unregister depots if
necessary. Requests to start new sessions are refused during this wait.
Locking
SD commands use a common locking mechanism for reading and modifying the Installed Products Database (IPD) and software depots. This mecha-
nism allows multiple readers but only one writer on an IPD or depot: commands that modify the IPD are restricted from simultaneous modifi-
cation using locking on the file (for example,
commands that modify a software depot are restricted from simultaneous modification using locking on the file (for example, Both and com-
mands set read locks on source depots using the file mentioned above. When a read lock is set, it prevents all SD commands from performing
modifications (that is, from setting write locks).
Terminal Support
For in-depth information about terminal support refer to:
o The manual
o Start the GUI or TUI, select the menu, then select the option to access the
RETURN VALUES
An interactive or session always returns 0. A non-interactive or session returns:
The software_selections were successfully installed/copied.
The install/copy operation failed on
all target_selections.
The install/copy operation failed on
some target_selections.
DIAGNOSTICS
The and commands write to stdout, stderr, and to specific logfiles.
Standard Output
An interactive or session does not write to stdout. A non-interactive or session writes messages for significant events. These include:
o a begin and end session message,
o selection, analysis, and execution task messages for each target_selection.
Standard Error
An interactive or session does not write to stderr. A non-interactive or session writes messages for all WARNING and ERROR conditions to
stderr.
Logging
Both interactive and non-interactive and sessions log summary events at the host where the command was invoked. They log detailed events
to the logfile associated with each target_selection.
Command Log
The and commands log all stdout and stderr messages to the the logfile Similar messages are logged by an interactive and session.
The user can specify a different logfile by modifying the option.
Target Log
A process performs the actual install or copy operation at each target_selection. For install tasks, the logs messages to the file
beneath the root directory (for example, or an alternate root directory). For copy tasks, the logs messages to the file beneath the
depot directory (for example,
You can view the command and target log files with the or command.
Source Depot Audit Log
If both source and target machine are updated to SD revision B.11.00 or later, the system administrator at the source depot machine
can track which user pulls which software from a depot on the source machine and when the software is pulled. (Note that a user run-
ning from a target machine cannot set this option; only the administrator of the source depot machine can set it. See the
source_depot_audit option in the swagent(1M) man page.)
swagentd Disabled
If the daemon has been disabled on the host, it can be enabled by the host's system administrator by setting the entry in to and executing
EXAMPLES
swinstall
To invoke an interactive session of
Select the C and Pascal products from the network source software server (sw_server) and start an interactive session:
Install the C and Pascal products to a set of remote hosts:
Update the HP Omniback product from a CD-ROM mounted at
Install an incompatible version of HP Omniback into the directory
Install all products from the cartridge tape
Reinstall the software_selections listed in the file on the hosts listed in the file
Execute interactively using the session file as a basis:
Install all the software from local depot using any response files generated by request scripts:
Install from remote depot on host and use an existing response file (previously generated by the command) located in
Install all products in remote depot on host use any response files generated by request scripts, create catalog and copy all response
files to the new catalog:
Install all products in remote depot use response files, run request scripts only when a response file is absent, create catalog and copy
all response files to the new catalog:
Install all patches in the depot that correspond to currently installed software and are of the category:
swcopy
Invoke an interactive session of
Invoke an interactive session, using default depot at hostX as the source:
Copy all products from the cartridge tape to the default depot on the local host:
Load the software_selections listed in the file using the default source/depot:
Copy the C and Pascal products to some local and remote depots:
FILES
Contains the user-specific default values for some or all SD
options. If this file does not exist, SD looks for user-specific defaults in
Contains the user-specific default list of hosts to manage.
Contains the user-specific default list of patch filters.
Contains session files automatically saved by the SD commands or
explicitly saved by the user.
Contains the master list of current SD options with their default values.
The directory which contains all of the configurable
and non-configurable data for SD. This directory is also the default location of logfiles.
Contains the active system-wide default values for some or all SD options.
Contains the system-wide default list of hosts to manage.
Contains the system-wide default list of patch filters.
Contains the set of date/time templates used when scheduling jobs.
The Installed Products Database (IPD), a catalog of all products
installed on a system.
The directory which contains the information about all active and complete
install jobs, copy jobs, and other jobs initiated by the SD commands.
The default location of a source and target software depot.
AUTHOR
and were developed by the Hewlett-Packard Company and Mark H. Colburn (see pax(1)).
SEE ALSO
swacl(1M), swagentd(1M), swask(1M), swconfig(1M), swjob(1M), swlist(1M), swmodify(1M), swpackage(1M), swreg(1M), swremove(1M), swver-
ify(1M), update-ux(1M), sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swinstall(1M)