sd(5) File Formats Manual sd(5)
NAME
sd - Software Distributor, commands to create, distribute, install, monitor, and manage software
SYNOPSIS
[XToolkit Options] attribute] catalog] session_file] acl_entry] software_file] acl_file] jobid] level] acl_entry] date] source] ses-
sion_file]
target_file] option=value] option_file] [software_selections] target_selections]
Remarks
o You can enable Software Distributor (SD) for software management on remote systems. See the section below for details.
o Type to view the sd(4) manual entry for descriptions of all SD objects, attributes and data formats.
o Type to view the swpackage(4) manual entry for description of the Product Specification File (PSF) used as input to the command.
DESCRIPTION
See the available at for a complete description of SD.
The SD command and related programs:
o - Lets you interactively create, schedule, and monitors software jobs and log files. Also lets you launch the install, copy, and
remove commands.
o - Modifies Access Control Lists (ACLs), which control SD security.
o - Daemon that serves local or remote SD software management tasks and starts the SD agent.
o - Runs scripts that request user responses to be used in software installation or configuration.
o - Configures diskless clients (HP-UX 10.X only).
o - Configures, unconfigures, or reconfigures installed software.
o - Copies software products into depots for subsequent installation or distribution.
o - Installs and configures software products.
o - Creates and monitors software jobs and log files.
o - Displays information about software products.
o - Modifies software product information in a target root or depot.
o - Packages software products into a distribution directory or serial-format depot.
o - Registers or unregisters software depots or roots.
o - Removes and unconfigures software products.
o - Verifies software products.
o - Retrieves and installs the SD product (and any related patches) from new media.
The following sections highlight the features that these commands support.
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):
Set up the root, host, and template Access Control Lists (ACLs) on the
remote machines to permit root access from the controller system. 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 the script from an 11.11 or higher system
to the remote system.
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 the command directly on the remote machines to grant root or non-root access to users from
the controller system.
Interactive Operation
By default, all SD commands except and operate in a non-interactive mode. The and commands also support a graphical user interface (GUI).
(If your terminal or display cannot support the GUI, these commands also provide a terminal user interface, in which screen navigation is
done with the keyboard and no mouse.)
To invoke the GUI, enter the command without any command-line options or add the option with other command-line options when you invoke the
command. You must specify the option to invoke the GUI.
The and the command-line version of work interactively when the option is set to This option executes an interactive request script.
The command is an interactive interface for monitoring and scheduling software jobs. It provides the same functionality as the command.
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.
Distributed Operation
All SD commands except and use a distributed model of operation. The commands act as the controller for distributed operations, managing
the specific software management tasks. For each target_selection, an SD agent process performs the task:
o - perform software management tasks as the agent of an SD command.
Communication between the command and each agent, plus other target host activities are facilitated by an SD daemon process:
o - serve local or remote software management tasks.
Software Job Management
The commands create job information that records the job definition (in a session file), status, and log information for the job. You can
execute jobs immediately, or schedule them for later execution. You can browse the scheduled, active, and completed jobs using either the
command or the interactive interface.
Secure Operation
SD uses Access Control Lists (ACLs) to authorize users attempting to create, modify, or read software products in a depot or installed to a
root file system. The superuser can grant specific local and remote users specific access permissions to a target host, a target depot,
and/or a target root file system. (Note that SD does not use ACLs for tasks invoked by a local root user.)
Because files are loaded and scripts are run as superuser, granting write permission (to install software) on a root file system or insert
permission (to create a new root) on a host, effectively gives the user superuser privileges.
SD uses a method based on credentials and passwords to authenticate the user and the SD command performing a given operation.
SD also has a nonprivileged mode that replaces ACL authorizations with user file permissions. See the default option and the for more
information.
Flexible Policy Control
You can control many policies and behaviors for the SD commands by using the command default options. You can define these options in sys-
tem-wide or user-specific SD defaults files, specify them on the command-line when you invoke a command, or specify selected options in the
GUI. See the heading below for more information.
Preview, Diagnostics and Logging
All commands except and log major events on the controller host and detailed events on the target hosts.
If both source and target machine are running HP-UX version 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. Refer to the swagent(1M) option for
more information.
You can use the SD interactive interface (invoked using the command) and the command line interface to monitor job progress and to view
controller and target log files.
The and commands support a preview mode, where the commands will proceed through the analysis phase, then exit.
Software Products
Software products are organized in a multi-level hierarchy: bundles, products, subproducts, and filesets. The actual files that make up a
product are packaged into filesets. The software_selections for an SD command can specify bundles, products, individual subproducts,
and/or individual filesets.
Compatible Software
Software products specify what machine types and operating systems they support (that is, are compatible with). The and commands can
detect and/or enforce the use of compatible software.
Vendor-Defined Attributes
You can create your own software attributes when packaging software. Keywords in a product specification file that are not recognized by
SD are preserved, along with their associated values, by being transferred to the resulting INDEX or INFO files created by or (Refer to
swpackage(4) for more information on INDEX and INFO files.)
Vendor-defined attributes are noted during packaging or when modified with These attributes can be listed with
Dependencies Between Software
The and commands support 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, the commands will automatically select that software. An
exception is which can automatically select dependent software (filesets and/or products that depend on the software_selections).
By default, all dependencies must be resolved before a command will proceed.
Note that if you specify a dependency for a fileset and the fileset is superseded by another fileset as part of a patch, SD still recog-
nizes the dependency.
Product Location and Multiple Versions
The command can install a software product to an alternate product location instead of the default product directory specified by the ven-
dor. (This directory location is the root directory of all the product's files.)
The command can also install multiple versions of a software product to a single target system, each in a unique product location.
The software management commands, and let you select a specific product from the multiple installed versions by specifying the product
location as part of the software_selection.
Alternate Root Directory and Depot Directory
By default, the and commands operate on the primary root file system of a target host, These commands let you specify an alternate root
directory using the syntax and the command-line option. (This option is not required and is maintained primarily for backward compatibil-
ity.)
NOTES:
o Alternate root directories are root file systems other than the default primary root (The alternate root directory will eventu-
ally become the root of a target host.)
o Operations on alternate root directories do not include compatibility filtering.
o Configure, unconfigure, and verify scripts are not run for operations on alternate root directories.
o You cannot use this option to relocate software during installation. You must use the syntax in the software selection compo-
nent.
o Alternate root operations are not the equivalent of a command.
Alternate roots provide advantages for some test environments (such as building a test system by mounting its root file system). You can
also use them to quickly get files from a depot onto your system for viewing or other purposes.
When operating on a depot, the and commands by default use the depot located at You can also specify an alternate depot directory to these
commands.
Disk Space Analysis
The and commands perform a disk space analysis on the target_selections to ensure that enough free disk space is available to perform the
task.
When packaging software, you can define space files for filesets to define additional space needed. (Space files are accounted for in disk
space analysis.)
Before performing any disk space analysis, and (also and execute the command to mount all file systems listed in each target's file system
table or equivalent). This ensures that files are not loaded into a directory below a future mount point. You can override this mounting
policy using the option.
Control Scripts
The and commands can execute vendor-defined control scripts to perform checks or other tasks beyond those usually performed by the com-
mands.
In general, SD uses scripts with product or fileset objects. Scripts usually do not accompany software that HP manufactures onto new sys-
tems in the factory.
SD supports these types of scripts:
o - (Applies to A check script that analyses each target_selection (target host) for an installation to determine if the installa-
tion and configuration can take place.
o - (Applies to A script executed immediately before installation of software files to perform additional file install operations
(such as removing obsolete files).
o - (Applies to An "undo" preinstall script in case SD must initiate recovery during the install process.
o - (Applies to A script executed immediately after a fileset or product has been installed to perform additional remove operations
(such as resetting default files).
o - (Applies to An "undo" postinstall script in case SD must initiate recovery during the installation process.
o - (Applies to and A script that configures installed filesets or products.
o - (Applies to and A script to "undo" configurations performed by configure scripts.
o - (Applies to A script that verifies the configuration of filesets or products. (The script performs these checks in addition to
the standard checks for file consistency with SD database entries.)
o - (Applies to A check script that analyses each target_selection (target host) before removal to determine if the removal and
unconfiguration can take place.
o - (Applies to A script executed immediately before removal of software files to perform additional file operations (such as
removing files created by a preinstall script).
o - (Applies to A script executed immediately after a fileset or product has been removed to perform additional remove operations
(such as restoring "rollback" files).
o - (Applies to and An interactive script that requests a response from the user as part of the installation or configuration
process.
o - You can include other specialized scripts as subscripts to standard SD control scripts.
See the for more information on using control scripts.
Software States
The SD commands transition products and filesets through a number of states.
During installation, software is transitioned through the following states:
o non-existent
o TRANSIENT
o INSTALLED
o CONFIGURED
During removal, software is transitioned through these states:
o CONFIGURED
o INSTALLED
o TRANSIENT
o non-existent
When packaging or copying software into a depot, the software is transitioned through the following states:
o non-existent
o TRANSIENT
o AVAILABLE
When removing software from a depot, the software is transitioned through these states:
o AVAILABLE
o TRANSIENT
o non-existent
If a task fails during any TRANSIENT state, the state is set to CORRUPT.
Options
The following options are supported by one or more of the SD commands. Refer to the manual pages for each command for the options specific
to that command.
XToolKit Options The interactive commands support a subset of the standard X Toolkit options to control the appearance of the GUI.
The supported options are: and See the X(1) manual page for a definition of these options.
Causes the command to operate on
target_selections which are software depots rather than root directories.
Causes SD commands to operate on alternate root directories, which
must be specified in the option. (This option is not required for alternate root operations but is maintained for backward
compatibility.
See the heading above for more information.)
Runs the command in interactive mode (Graphical User Interface). See
the and headings above for additional details.
Previews the task by executing the session through the analysis phase
and exiting before the command begins to perform the actual task.
For recursively includes all objects to the fileset level.
For recursively includes all objects to the end_target level.
Undo variation of the operation, unconfiguring software using
unregistering the specified objects using or removing the specified jobs using the command.
Turns on verbose output to stdout. (The command log file is not affected
by this option.) By default, verbose output is enabled for all the SD commands.
List the supported data model revisions.
Specifies particular attributes to display or modify using
or the command.
Specifies the pathname of the directory containing an exported
catalog. For this catalog stores copies of the response files created by request scripts. For and this catalog stores out-
put or input for these commands.
Saves the current options and operands to
session_file. (You can recall a session file with the session_file option.) See the heading in this manpage for more infor-
mation.
Deletes an existing entry from the ACL associated with the
specified objects using
Read the list of
selections from software_file instead of (or in addition to) the command line operands.
Assigns the ACL contained in
acl_file to the specified object using
Executes the previously scheduled job. This option is used by the
to initiate scheduled jobs.
List all objects at the specified
level when using or define the level of the objects when using or
Adds a new ACL entry or changes the permissions of an existing entry
using
Schedules the command for the specified date and time.
Specifies source depot, PSF file, or tape from which software will be
installed, copied, listed, or packaged. (SD can read both and tape depots.)
Executes the command based on the options and operands saved from a
previous session in session_file. (You can save session information to a file with the session_file option.) See the heading
in this manpage for more information.
Read the list of
target_selections from target_file instead of (or in addition to) the command line operands.
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. These values defined in this file override the default values.
Operands
Most SD commands support two types of operands: followed by These operands are separated by the "at" character. This syntax implies that
the command operates on "selections at targets".
Software Selections
The selections operands consist of software_selections for most SD commands. For the and commands, the selections can be job_ids and
roots_or_depots respectively.
The SD commands 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. Shell
patterns are not allowed with these operators.
o The (equals) relational operator lets you specify selections with the following 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.
Target Selections
The SD commands support this syntax for each target_selection.
The colon is required if both a host and directory are specified.
Target Selections with IPv6 Address
SD 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 INPUTS AND 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 SD commands. The keywords that are supported for individual commands are
also listed in each command's manual page. If a default value exists, it is listed after the The commands that this option applies to are
also specified.
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.
Applies to all SD commands except and
The location of the agent program invoked by the daemon.
Applies to
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 value of means the target agent automatically exits
when appropriate. When set to the target agent will not exit until the controller ends the session.
Applies to
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 will be used. The default of 10000 is slightly less than 7 days.
Applies to
Prevents the installation of an older revision of fileset that already
exists at the targets. (Many software products do not support "downdating".) If set to the older revision can be
installed.
Applies 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 compatibility is not enforced.
Applies to and
Prevents the installation or configuration of another, independent
version of a product when a version already is already installed or configured at the target.
If set to another version of an existing product can be installed into a new location, or can be configured in its new
location. Multiple versions can only be installed if a product is locatable. Multiple configured versions will not work
unless the product supports it.
Applies to and
Permits the use of single patch filesets without "sibling" filesets.
In the default state of installation, copy, or removal 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 behav-
ior 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, copied, or removed 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 or removed by a patch, while the other file-
sets would remain at an earlier release or fail to be removed.
Applies to
Defines the alternate source which the agent will use
when the option is set to The alternate source is specified using the syntax:
If the host portion is not specified, then the local host is used. If the path portion is not specified, then the path
sent by the command is used. The protocol sequence and endpoint given by the option are used when the agent attempts to
contact an alternate source depot.
Applies to
Executes a
which asks for a user response. If executes the request script only if a response file does not already exist in the con-
trol directory. See swask(1M) for more information on request scripts.
Applies to and
Normally set to true. Specifies whether the removal of a kernel
fileset should rebuild the kernel or not. If the kernel rebuild succeeds, the system automatically reboots. If set to
false, the system continues to run the current kernel.
If the option is set to the option must also be set to If the option is set to the value of the option does not matter.
Applies to only.
Prevents the installation or removal of software requiring a reboot
from the non-interactive interface. If set to then software can be installed or removed, after which the target system(s)
will automatically reboot.
An interactive session always asks for confirmation before software requiring a reboot is installed or removed.
If the option is set to the option must also be set to If the option is set to the value of the option does not matter.
Applies to and
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 the 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 product 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.
Applies only to
Controls automatic job removal of completed jobs. If the job is
automatically removed, job information (job status or target log files) cannot be queried with
Controls the automatic selection of prerequisite, corequisite, and
exrequisite software that SD automatically selects. When set to the requisite software is automatically selected for con-
figuration. When set to requisite software which is not explicitly selected is not automatically selected for configura-
tion. When set to autoselected dependencies are operated only if the dependency is not already met on the target.
Applies to and
Controls whether or not SD automatically selects dependent software.
A dependent fileset has established either a prerequisite, corequisite, or exrequisite on the selected fileset. Specify-
ing causes SD to automatically select dependent software. The default value of prevents SD from automatically selecting
dependent software.
Applies to and
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 corre-
sponding to the selected object will not be automatically selected.
The option can be used in conjunction with
Applies to and
If bundles that are will be automatically installed, or copied, along with the software it is made up of. If the software
can be installed, or copied, without automatically including bundles that contain it.
For if set to any bundle with the is_sticky attribute set to true is removed automatically when the last of its contents
is removed. If set to the sticky bundles will not be automatically removed.
Applies to and
Causes to verify the time stamp, size, and checksum attributes of files. If set to these attributes are not verified.
Applies to
(This option is ignored if
is set to Controls whether or not validates the size and checksum for compressed files. In the default state of checks
only the mtime, size and cksum attributes of the compressed file. If set to uncompresses the file in memory and verifies
the size and cksum attributes of the uncompressed contents.
Only files compressed with SD's internal compressor can be uncompressed during a operation. See the option of the command
for more information.
Applies to
(This option is ignored if
is set to Controls whether or not computes a checksum on the contents of the file. In the default state of checks all
file attributes including the checksum. If set to checks only the file timestamp and size.
Applies to
Causes to verify the mode, owner, UID, group, and GID attributes of installed files. If set to these attributes are not veri-
fied.
Applies to
Causes to verify that the prerequisite, corequisite, and exrequisite dependencies of the software selections are being met. If
set to these checks are not performed.
Applies to
Causes to run the fileset/product verify scripts for installed software. If set to these scripts are not executed.
Applies to
Causes to not verify those files marked as volatile (that is, can be changed). If set to volatile files are also checked (for
installed software).
Applies to
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. This option stores the codeword for future reference; you needs to enter the codeword only once.
Defines the command called to compress files
before installing, copying or packaging. If the option is set to other than or this path must be changed.
Applies to and
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
Applies to and
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
directories 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.
Applies to
Defines the default compression type used by the agent when it compresses
files during or after transmission. If is set to false, the is recorded for each file compressed so that the correct
uncompression can later be applied during a or a with set to true. The specified must produce files with the specified.
The must be able to process files of the specified unless the format is which is uncompressed by the internal uncompressor
Applies to
Defines the script called by the agent to perform release-specific
configure cleanup steps.
Applies to
Please Note: Transition links do not exist on 11.31 and newer releases so there are no configure cleanup steps to per-
form, therefore the is never executed for these releases.
When adding or deleting control file objects, this option lists the tags
of those control files. There is no supplied default. If there is more than one tag, they must be separated by white-
space and surrounded by quotes.
Applies to
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:
This option has no effect on which sources the target uses and is ignored when used with an Interactive User Interface.
Applies to
If creating a target depot,
will create Access Control Lists (ACLs) for the depot (if it is new) and all products being packaged into it. If set to
and if the user is the superuser, will not create ACLs. (The command never creates ACLs when software is packaged on to a
distribution tape.)
Applies to
Causes the agent to create the target directory if it does not already
exist. If set to a new target directory will not be created. This option can prevent the erroneous creation of new tar-
get depots.
Applies to and
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 less than or equal to the specified value are available for selection (or autoselec-
tion). To list the of bundles, products and filesets, use:
Applies to and
This number, printed on the Software Certificate, "unlocks" protected
software and restricts installation to a specific site or owner. You can enter the number with the customer_id= option or
by using the Interactive User Interface. The customer_id can be used on any HP-UX 10.X or later system.
Applies 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.
Applies to
Defines the default location of the source depot (when the
is directory). You can also use the syntax. The option overrides this default.
Applies to and
Defines the default distribution directory of the target depot.
The target_selection operand overrides this default.
Applies to and
Defines the default location of the target tape device file.
The target_selection operand overrides this default.
Applies to
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, CONFIGURED, or AVAILABLE). This prevents unusable software from being installed on the system.
It also ensures that depots contain usable sets of software.
For if a selected fileset has dependents (that is, other software depends on the fileset) and they are not selected, do
not remove the selected filesets.
If set to dependencies are checked, but not enforced. Corequisite dependencies, if not enforced, may keep the selected
software from working properly. Prerequisite or exrequisite dependencies, if not enforced, may cause the installation or
configuration to fail.
Applies to and
Prevents a command from proceeding past the analysis phase if the disk
space required is beyond the available free space of the impacted file systems. If set to then the install, copy, or
package operation will use the file systems' minfree space and may fail because it reaches the file system's absolute
limit.
Applies to and
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 pack-
aged with the attribute set to When set to the usual error handling process is overridden, and SD permits the command to
relocate the fileset.
Note that although this option is defined for there is no behavior associated with the option.
Applies to and
The default value of true prevents
from proceeding past the kernel build phase if the kernel build processes fail. If set to the install operation continues
despite failures or warnings in the system preparation process or the kernel build process.
Applies to
Controls the handling of errors generated by scripts. If
and a script returns an error, the command halts, and an error message appears reporting that the execution failed. If
script-generated errors are treated as warnings, and the command attempts to continue. A warning message appears and
reports that the command was successful. Where appropriate, the message identifies the phase in which the error occurred
(configure/unconfigure, preinstall/postinstall, preremove/postremove, etc.).
Applies to and
When adding or deleting file objects, this option lists the pathnames
of those file objects. There is no supplied default. If there is more than one pathname, they must be separated by
whitespace.
Applies to
Do not follow symbolic links in the package source files, but include
the symbolic links in the packaged products. A value of for this keyword causes to follow symbolic links in the package
source files and include the files they reference in the packaged products.
Applies to
Do not include each source file's revision attribute in the products being packaged.
Because this operation is time consuming, by default the revision attributes are not included. If set to will execute and
possibly (in that order) to try to determine a file's revision attribute.
Applies to
Defines the script called by the agent to perform release-specific install
cleanup steps immediately after the last postinstall script has been run. For an OS update, this script should at least
remove commands that were saved by the script. This script is executed after all filesets have been installed, just
before the reboot to the new operating system.
Applies to
Please Note: Transition links do not exist on 11.31 and newer releases so there are no install cleanup steps to perform,
therefore the is never executed for these releases.
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 relative 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.)
Applies to all SD commands except and
Defines the script called by the agent to perform release-specific install
preparation. For an OS update, this script should at least copy commands needed for the checkinstall, preinstall, and
postinstall scripts to a path where they can be accessed while the real commands are being updated. This script is exe-
cuted before any kernel filesets are loaded.
Applies to
Please Note: Transition links do not exist on 11.31 and newer releases so there are no install setup steps to perform,
therefore the is never executed for these releases.
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 is invoked.
Applies to and
Defines the script called by the agent for kernel building.
Applies to
Defines the path to the system's bootable kernel. This path is passed
to the via the environment variable.
Applies to
Specifies the POSIX
to which the SD commands conform when writing distributions and output. Supported values are "1.0" (default) and "0.8".
SD for HP-UX version 10.10 and later can read or write either layout version.
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.
The version used by can be controlled by specifying the layout_version attribute in the product specification file (PSF).
However, if the layout_version attribute in the PSF is 1.0, the is_locatable attribute defaults to true in all cases, and
must be explicitly set to false. (See swpackage(4) for more information on PSFs.)
Layout version 1.0 adds significant functionality not recognized by systems supporting only 0.8, including:
o Category class objects (formerly the attributes within the bundle or product class).
o Patch-handling attributes, including
o The fileset attribute, which permits you to specify the architecture of the target system on which the product will
run.
In addition to adding new attributes and objects, layout_version 1.0 changes the following preexisting 0.8 objects and
attributes as follows:
o Replaces the depot with the object with a attribute.
o Replaces the definition within products and bundles with a attribute and a corresponding object defined outside the
product or bundle.
o Pluralizes the and fileset attributes (to and
o Changes the attribute to
Applies to and
Specifies a software
level for or
For
Lists all objects down to the specified level. Both the specified level(s) and the depth of the specified software_selec-
tions control the depth of the output. The supported software levels are:
Show all objects down to the bundle level.
Show all objects down to the product level. Also use
to show bundles.
Show all objects down to the subproduct level.
Show all objects down to the fileset level. Also use
to show subproducts and filesets.
Show all objects down to the file level (that is, depots, products,
filesets, and files).
Show all objects down to the control_file level.
Show all categories of available software objects.
Show all applied patches.
The supported depot and root levels are:
Show only the depot level (that is, depots which exist at the
specified target hosts).
List all alternate roots.
List all registered shared roots
(HP-UX 10.X only).
List all registered private roots
(HP-UX 10.X only).
For
The option defines the level of ACLs to view or modify:
View/modify the ACL protecting the host system(s) identified by the
target_selections.
View/modify the ACL protecting the software depot(s) identified by the
target_selections.
View/modify the ACL protecting the root file system(s) identified by the
target_selections.
View/modify the ACL protecting the software product identified by the
software_selection. Applies only to products in depots, not installed products in roots.
View/modify the template ACL used to initialize the ACL(s) of future
product(s) added to the software depot(s) identified by the target_selections.
View/modify the template ACL used to initialize the ACL(s) of future
software depot(s) or root file system(s) added to the host(s) identified by the target_selections.
View/modify the template ACL used to initialize the
ACL(s) of future software depot(s) added to the host(s) identified by the target_selections.
For
The option defines the level of object to register or unregister:
Depots which exist at the specified target hosts.
All alternate roots.
All registered shared roots
(HP-UX 10.X only).
All registered private roots
(HP-UX 10.X only).
Applies to and
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.
Applies to and
The option controls the amount of detail written to the log file. When set to this option adds detailed task information
(such as options specified, progress statements, and additional summary information) to the log file. This information is
in addition to log information controlled by the option.
Here are the possible combinations of and options:
| |
Log Level | Log Detail | Information Included
-----------+-----------------+----------------------
loglevel=0 | | No information is
| | written to the log-
| | file.
-----------+-----------------+----------------------
loglevel=1 | logdetail=false | Only key events are
| | logged; this is the
| | default.
-----------+-----------------+----------------------
loglevel=1 | logdetail=true | Event detail as
| | above plus task
| | progress messages.
| | Setting loglevel=1
| | is not necessary, it
| | is the default.
-----------+-----------------+----------------------
loglevel=2 | logdetail=false | Event and file level
| | messages only. Set-
| | ting the logde-
| | tail=false option is
| | not necessary.
-----------+-----------------+----------------------
loglevel=2 | logdetail=true | All information is
| | logged. Setting
| | both loglevel=2 and
| | logdetail=true
| | options is required.
| | This combination may
| | produce the same
| | logfile behavior as
| | previous HP-UX 10.x
| | releases.
Applies to and
Defines the default log file for each SD command.
(The agent log files are always located relative to the target depot or target root, for example, and
Applies to all commands except and
Controls the log level for the events logged to the command logfile,
the target agent logfile, and the source agent logfile by prepending identification numbers to SD logfile messages. This
information is in addition to the detail controlled by the option. See for more information.
A value of:
provides no information to the log files.
enables verbose logging to the log files.
enables very verbose logging to the log files.
Applies to and
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 to and
If set to software selection is done by locating filesets on the source that match the target system's installed filesets. If mul-
tiple targets are specified, the first in the list is used as the basis for selections.
Applies to
The maximum number of agents that are permitted to run simultaneously.
The value of -1 means that there is no limit.
Applies to
When set to a positive integer, this option limits the number of
concurrent install or copy operations to the number specified. As each copy or install operation completes, another tar-
get is selected and started until all targets are 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.
Applies to and
If creating a distribution tape or multiple-directory media such as a
CD-ROM, this keyword specifies the capacity of the tape in one million byte units (not Mbytes). This option is required
if the media is not a DDS tape or a disk file. Without this option, sets the size to the default of 1,330 Mbytes for tape
or to the amount of free space on the disk up to for a disk file. SD uses the same format across multiple directory media
as it does for multiple serial media, including calculations of the correct size based partitioning of filesets and set-
ting of the attributes.
Applies to
Defines the type of distribution to create. The recognized types are
and
Applies to
Defines in minutes how often the daemon wakes up to scan the job queue
for scheduled jobs that must start. If set to 0, no scheduled jobs are initiated.
Applies to
By default, the SD
commands 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, and that the expected files are available for a remove or verify operation.
If set to the mount operation is not attempted, and no check of the current mounts is performed.
Applies to and
Defines the command called by the agent to mount all filesystems.
Applies to
Defines the default
objects to register or unregister. There is no supplied default (see above). If there is more than one object, they must
be separated by spaces.
Applies to
Defines the attributes which are listed in the non-verbose listing.
Applies to and
This option can be used in conjunction with
to specify fileset selection for an HP-UX update. should only be specified from the command line. Refer to the SD file
for correct syntax. You can display the file by entering:
Applies to
This option can be used in conjunction with
to specify fileset selection for an HP-UX update. should only be specified from the command line. Refer to the SD file
for correct syntax. You can display the file by entering:
Applies to
If set to will package the specified products such that the target depot will not contain the files that make up a product.
Instead, inserts references to the original source files used to build a product. This behavior allows products to be
packaged without consuming the full disk space of copying all the source files into the target depot.
Applies to
Commits a patch by removing files saved for patch rollback. When set to
and run with you cannot roll back (remove) a patch unless you remove the associated base software that the patch modified.
Applies to
Specifies a
software_specification for a patch filter. The default value is
This option can be used in conjunction with the and options to filter the selected patches to meet the criteria specified
by software_specification.
Applies to and
If set to this option selects the latest patches (software identified by the is_patch attribute) that correspond to software on the
target root or depot.
The option can be used in conjunction with
Applies to and
Specifies the attributes displayed for each object listed when the
option is invoked and when no or option is specified. The default display attributes are and
Applies to
Saves patched files, which permits future rollback of patches. When set to
patches cannot be rolled back (removed) unless the base software modified by the patch is removed at the same time.
Applies to
Defines in seconds the polling interval used by interactive (GUI)
sessions. It specifies how often each target agent will be polled to obtain status information about the task being per-
formed. When operating across wide-area networks, the polling interval can be increased to reduce network overhead.
Applies to and
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 to
Defines the command called by the agent to reboot the system.
Applies to
Prevents software which is already in the CONFIGURED state from being
reconfigured. If set to CONFIGURED software can be reconfigured.
Applies to
This option prevents SD from recopying (overwriting) an existing
revision of a fileset. If set to the fileset will be recopied.
Applies 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 will not be automatically registered. (It can be registered later with the command.)
Applies to
Causes to register a newly created alternate root with the local This action allows other SD commands to automatically "see" this
root. If set to a new root will not be automatically registered. (It can be registered later with the command.)
Applies to
This option prevents SD from re-installing (overwriting) an existing
revision of a fileset. If set to the fileset will be overwritten.
Applies to
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.
Applies to and
(For the default value for this option is 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 equivalency than size and time stamp.
If set to false, SD does not compute checksums and compares files only by size and timestamp.
Applies to and
Remove an empty depot when the last product is removed.
If set to an empty depot will not be removed, preserving any depot ACLs.
Applies 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. File-
sets are defined as obsolete if they were not part of the most recent packaging of the product residing on the source
depot.
Applies to
Defines the script called by the agent to perform release-specific
removal preparation. For an OS update, this script invokes the command when a fileset is removed.
Applies to
Please Note: Transition links do not exist on 11.31 and newer releases so there are no remove preparation steps to per-
form, therefore the is never executed for these releases.
Defines the number of times a lost (timed out) source connection will
be retried during file transfers. 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, then the
install of each fileset will be attempted that number of times. (You can use the option to specify the length of the
interval between each retry attempt.)
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.
Applies to and
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 an agent session failed to start and was set to 9 and was set to {1 2 4 8 15} to allow long waits to han-
dle transient 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.
Applies to and
Defines the protocol sequence(s) and endpoint(s) on which the daemon
listens and on which the other commands use to contact the daemon. If the connection fails for one protocol sequence, the
next is attempted. SD supports both the and protocol sequence on most platforms.
The value (or values for can have following form:
o A DCE string binding containing a protocol sequence and an endpoint. The syntax is:
o The name of a DCE protocol sequence with no endpoint specified. The syntax is: for example or (A trailing can be
attached to the protocol sequence, it has no effect.) Since no endpoint is specified, the DCE endpoint mapper rpcd
must be running and will be used to find the endpoint registered by the
o The literal string This entry means to use (try) all protocol sequences supported by the DCE RPC. It should be the
only entry in the list. The DCE endpoint mapper also must be running in order to use this option.
Applies to all commands except and
Defines the protocol sequence(s) and endpoint(s) used when the agent
attempts to contact an alternate source depot specified by the option. SD supports both the and protocol sequence/end-
point.
Applies to
Defines the protocol sequence(s) and endpoint(s) used to contact the
daemon for source access. If set to no value (default) the value of is used.
Applies to and
Defines the protocol sequence(s) and endpoint(s) used to contact the
daemon for target access. If set to no value (default) the value of is used.
Applies to and
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 will give faster recognition on attempts to contact hosts that are not up, or are not
running Each value is approximately twice as long as the preceding value. A value of 5 is about 30 seconds for the proto-
col sequence. This option may not have any noticeable impact when using the protocol sequence.
Applies to all commands except and
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 to all SD commands except and
Displays or hides superseded patches in
output. In the default state of will not display superseded patches even if you perform a command on the superseded
patch. Setting this option to permits display of superseded patches.
Applies to
If no target_selections are specified, select the default of the local host as the target_selection for the command.
Applies to and
Defines the default
software_selections. There is no supplied default. If there is more than one software selection, they must be separated
by spaces. Software is usually specified in a software input file, as operands on the command line, or in the GUI.
Applies to all commands except and
Indicates the software view to be used by the interactive interface of the
commands and by for the default listing level. It can be set to products, all_bundles, or a bundle category tag (to indi-
cate to show only bundles of that category).
Applies to and
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]
Applies to and
Defines the default location of the source CD-ROM using the syntax
[host][path].
Applies to
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 set this option to track which user pulls which soft-
ware from a depot on the source machine and when the software is pulled. (Note that a user running from a target machine
cannot set this option; only the administrator of the source depot machine can set it.)
When is set to a file is created on the source depot (for writable directory depots) or in (for tar images, CD-ROMs, or
other non-writable depots).
Users can invoke the interactive user interface (using to view, print, or save the audit information on a remote or local
depot. Users can view audit information based on language preference, as long as the system has the corresponding SD mes-
sage catalog files on it. For example, a user can view the source audit information in Japanese during one invocation of
then view the same information in English at the next invocation.
Applies to
Defines the default location of the source product specification file
(PSF). The host:path syntax is not allowed, only a valid can be specified. The option overrides this value.
Applies to and
Defines the default location of the source tape, usually the
character-special file of a local tape device. You can also use the host:path syntax, but the host must match the local
host. The option overrides this value. (Note that SD can read both and tape depots.)
Applies to and
Defines the default source type:
or The source type derived from the option overrides this value. (Note that SD can read both and tape depots.)
Applies to and (The values and apply to and only. The value applies to only.)
Defines the path to the kernel's template file. This path is passed
to the via the environment variable.
Applies to
Defines the kernel build preparation script called by the agent.
This script must do any necessary preparation so that control scripts can correctly configure the kernel about to be
built. This script is called before any kernel filesets have been loaded.
Applies to
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. Targets are usually specified in a target input file, as operands on the command line, or in the
GUI.
Applies to all commands.
Defines the command to uncompress files
when installing, copying, or packaging. This command processes files which were stored on the media in a compressed for-
mat. If the of the file is then the internal uncompression is used instead of the external
Applies to and
If the files being transferred from a source are compressed, setting
this option will uncompress the files before storing them on the target depot.
Applies to and
Lets each target agent use its own configured alternate source,
instead of the one specified by the user. If each target agent will use the same source, namely the source specified by
the user and validated by the command. If each target agent will instead use its own configured value for the source.
Applies to and
Controls the verbosity of a non-interactive command's output:
disables output to stdout. (Error and warning messages
are always written to stderr).
enables verbose messaging to stdout.
for and enables very verbose messaging to stdout.
For the command, a verbose listing includes all attributes that have been defined for the appropriate level of each soft-
ware_selection operand. The attributes are listed, one per line, prefaced by the attribute keyword.
The option overrides this default if it is set to 0.
Applies to all commands.
Prevents file operations on remote (NFS) file systems. All files
destined for installation, copy, removal, or packaging on targets on a remote (NFS) file systems are skipped.
If set to true and if the superuser has write permission on the remote file system, the remote files are not skipped, but
are installed, copied, packaged, or removed.
Applies to and
Session Files
Each invocation of an SD command defines a task session. Most SD commands automatically save task session information (options, source
information, software selections, and target selections) before the task actually commences. This lets you re-execute the command even if
the session ends before the task is complete. You can also save session information from command-line and interactive sessions.
From the command-line, you can save session information by executing the command with the option. You can specify a relative or absolute
path for a session file. If you do not specify a directory, the default location is
From an interactive session, you can save session information into a file at any time by selecting the Save Session or Save Session As
option from the File menu.
Session information is saved to the file:
For example:
This file is overwritten by each invocation of the command. Contents of the session file use this syntax:
The prefix denotes the name of the SD command that saved the session information. For example:
To re-execute a session from a command-line, specify the session file as the argument for the option.
To re-execute a saved session from an interactive session, use the Recall Session option from the File menu.
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 and parameters 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, commands that support an interactive interface read a list of possible hosts to operate on from the values found in:
the system-wide default list of hosts,
the user-specific default list of hosts.
Hosts in this file are not marked for operation, but provide a default list from which to choose. For each interactive command, target
hosts containing roots and depots are specified in separate lists ( and respectively). The list of hosts are enclosed in {} braces and
separated by white space (blank, tab and newline). For example:
Most SD commands support patch filtering with the option. In addition, the interactive user interface commands, and read a list of possi-
ble patch filters. You can use the values from this list for selection criteria. The lists are stored in:
the system-wide default list of patch filters.
the user-specific default list of patch filters.
Filters in this file are not marked for selection use but provide a default list from which you can choose. The list of patch filters is
enclosed in braces {} and separated by white space (blank, tab, or newline). For example:
Environment Variables
SD programs are affected by external environment variables, set environment variables for use by the control scripts, and set additional
environment variables that affect scripts run by and
External environment variables that affect the SD commands:
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 lang(5) 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.
This variable applies to all SD commands.
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 control 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 variable to determine which tag is being executed.
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 for use in a control script (for example,
Defines the root directory in which the session is operating, either
or an alternate root directory. This variable tells control 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 tar-
gets 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 run by and
This variable should be read only by the
script. If this is set to any value it indicates the script was invoked by the command during system startup. This
variable is set by the system startup script.
Only applies to
This variable is normally unset. If it is set, the actions necessary for preparing the system file cannot be accom-
plished 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.
Only applies to
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).
Only applies to
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.
Only applies to
The path to the kernel's system file. The default value is
Signals
The SD 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.
The following paragraph applies only to swconfig, swcopy, swinstall, swremove, and swverify.
For SIGUSR1, the command sends an RPC to the agents to quit immediately, as if the agent had received a SIGTERM signal. When SIGUSR1 is
sent to the SD Controller, it shuts down target agents with SD revision B.11.01 or later, then shuts itself down. When the target agent
receives the shutdown RPC, it invokes its handler for signal 15 (SIGTERM), which resembles what happens if a superuser on the target
machine used a command on the target agent process.
Locking
SD commands use a common locking mechanism for reading and modifying both root directories and software depots. This mechanism allows mul-
tiple readers but only one writer on a root or depot.
The SD commands which modify software in an (alternate) root directory are restricted from simultaneous modification using locking on the
file
relative to the root directory (for example,
The SD commands which modify software in a depot are restricted from simultaneous modification using locking on the file
relative to the depot directory (for example,
All commands set read locks on roots and depots using the file mentioned above. When a read lock is set, it prevents other SD commands
from performing modifications (that is, from setting write locks).
If an SD process has died prematurely and no other SD agents are running, you can remove the file to unlock the root or depot.
RETURN VALUES
Each SD command invocation returns:
The sw<task> successfully completed.
The sw<task> failed on all
target_selections.
The sw<task> failed on some
target_selections.
DIAGNOSTICS
The and commands support a preview mode, where operation will proceed through the analysis of each target_selection, then exit before the
actual task is performed.
You can use the interactive interface or the command to view the current status of any job or the controller and target log files.
Standard Output
When non-interactive, the commands write messages for significant events. These events include:
o a begin and end task message,
o a message for starting the task on each host, and
o a message for completing the task on each host.
When the option is set, summary messages about the task are also sent to the standard output.
Standard Error
When non-interactive, the commands also write messages for the following significant error events:
o a message for each host failing analysis and
o a message for each host failing the actual task.
Logging
All commands log major events on the host where the command was invoked. They log detailed events to the log associated with each tar-
get_selection.
Command Log
The commands log messages to (You can specify a different logfile by modifying the option.)
Target Log
A process performs the actual and operation at each target_selection. For operations on target root objects, the logs messages to
the file beneath the root directory (for example, or an alternate root directory). For operations on target depot objects, the
logs messages to the file beneath the depot directory (for example,
The running on a host logs events to the file
Source Depot Audit Log
If both source and target machine are updated to SD revision B11.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. Refer to the option
in swagent(1M) for more information.
FILES
Default source tape location. (Note that SD can read both
and tape depots.)
List of volumes that should be mounted.
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 software files explicitly saved by the user.
Contains target files explicitly saved by the user.
The SD agent.
The SD message catalogs.
The directory which contains the help files used by the
SD GUIs' on-line help facility.
Contains the master list of current SD options (with their default values).
The directory which contains the description files used by the
SD Graphical User Interfaces (GUIs).
The directory containing the configurable data shipped for the SD
product, which is conditionally copied into based on the existing configuration.
The SD commands.
The directory which contains all of the configurable
(and non-configurable) data for SD. This directory is also the default location of log files.
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 file which stores the list of depots registered at the local host.
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, remove, and other jobs initiated by the SD commands.
The directory which contains ACLs for the system itself, template ACLS,
and the secrets file used to authenticate remote requests.
The cache file created by a
or process which contains target hostnames and their relevant uname attributes.
The default location of a source and target software depot.
The directory containing an example depot and example swpackage data.
AUTHOR
Software Distributor was developed by the Hewlett-Packard Company. and were developed by the Hewlett-Packard Company and Mark H. Colburn
(see pax(1)).
SEE ALSO
install-sd(1M), swacl(1M), swagentd(1M), swask(1M), swconfig(1M), swcopy(1M), swinstall(1M), swjob(1M), swlist(1M), swmodify(1M), swpack-
age(1M), swreg(1M), swremove(1M), swverify(1M), sd(4), swpackage(4).
available at
SD customer web site at
sd(5)