swconfig(1M)swconfig(1M)NAMEswconfig - configure, unconfigure, or reconfigure installed software
SYNOPSIS
catalog] session_file] software_file] jobid] date] session_file] tar‐
get_file] option=value] option_file] [software_selections] tar‐
get_selections]
Remarks
· This command supports operation on remote systems. See
below.
· can perform limited interactive operations. See below.
· For an overview of all SD commands, see the sd(5) man page by
typing on the command line.
DESCRIPTION
The command configures, unconfigures, or reconfigures installed soft‐
ware products for execution on the specified targets. The command
transitions software between INSTALLED and CONFIGURED states. Although
software is automatically configured as part of the command and uncon‐
figured as part of the command, lets you configure or unconfigure soft‐
ware independently when the need arises.
Configuration primarily involves the execution of vendor-supplied con‐
figure scripts. These scripts perform configuration tasks which enable
the use of the software on the target hosts. A vendor can also supply
unconfigure scripts to "undo" the configuration performed by the con‐
figure script.
NOTES:
· You should execute when an initial configuration by failed,
was deferred, or needs to be changed.
· With you can defer configuration by using the default option.
· does not perform configuration on multiple versions of soft‐
ware.
· The command only operates on software installed to the pri‐
mary root file system.
· and do not run configure or unconfigure scripts when you
specify an alternate root directory with those commands.
Other features of include:
· By default, the command supports only configuration of com‐
patible software.
· If a fileset specifies a prerequisite on other software, that
software must be in a "configured" state before the software
specifying the dependency will be configured.
· The command configures multiple versions of a product if you
set The vendor must therefore detect and prevent multiple
configured versions in their configure scripts, if that is
necessary.
· Configure scripts are useful for software updates and rein‐
stallation, as well as first-time installation.
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 opera‐
tions 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:
· controller is the name of the central management server.
· If remote system is 11.00, make sure SD patch PHCO_22526 or a
superseding patch is installed on remote system before running
· 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 sys‐
tem to the remote system.
2) have enhanced GUI interfaces for remote operations. Enable the
enhanced GUIs by creating the file on the controller. Use this com‐
mand:
See sd(5), swinstall(1M), swcopy(1M), swjob(1M), swlist(1M) or
swremove(1M) for more information on interactive operations.
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 controller
system.
Interactive Operation
can perform limited interactive operations when the option is set to
This option executes an interactive request script. Request scripts
can also be executed by and See the default option for more informa‐
tion. See also swinstall(1M) and swask(1M).
Options
supports the following options:
Specifies the pathname of an exported catalog which
stores copies of the response file or files cre‐
ated by a request script (if or Response files
are also stored in the
Save the current options and operands only to the
session_file. You can enter a relative or abso‐
lute path with the file name. The default direc‐
tory for session files is Without this option, by
default, the session file is saved only in the
default directory
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.
Previews a configuration task by running the session through the
analysis phase only.
Schedules the job for this date. You can change the date format
by editing the
Execute based on the options and operands saved from a
previous session, as defined in session_file.
You can save session information to a file with
the option.
Read the list of
target_selections from target_file instead of (or
in addition to) the command line.
Causes to unconfigure the software instead of configur‐
ing it.
Turns on verbose output to stdout.
(The logfile is not affected by this option.)
Verbose output is enabled by default; see the
option below.
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 speci‐
fied.
Read the session options and behaviors from
option_file.
Operands
Most SD commands support two types of operands: followed by These oper‐
ands are separated by the "at" character. This syntax implies that the
command operates on "software selections at targets".
Software Selections
The command supports the following syntax for each software_selection:
· You can specify selections with the following shell wildcard
and pattern-matching notations:
· Bundles and subproducts are recursive. Bundles can contain
other bundles and subproducts can contain other subproducts.
· The software specification selects all products. Use this
specification with caution.
The component has the form:
· location applies only to installed software and refers to
software installed to a location other than the default prod‐
uct directory.
· and apply only to filesets.
· and apply only to bundles and products. They are applied to
the leftmost bundle or product in a software specification.
· 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.
· 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.
· All version components are repeatable within a single speci‐
fication (for example, If multiple components are used, the
selection must match all components.
· Fully qualified software specs include the and version compo‐
nents even if they contain empty strings.
· No space or tab characters are allowed in a software selec‐
tion.
· 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 inte‐
ger 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 Selections
supports this syntax for each target_selection.
A host may be specified by its host name, domain name, or Internet
address. If host is specified, the directory must be an absolute path.
To specify a relative path when no host is specified, the relative path
must start with or otherwise, the specified name is considered as a
host.
Target Selections with IPv6 Address
The command also supports 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 occur‐
rence of a slash is treated as the separator.
The IPv6 address can optionally be enclosed in a pair of square brack‐
ets 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 com‐
mands. If a default value exists, it is listed after the "=".
The policy options that apply to are:
The location for SD logfiles and the default par‐
ent 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
· The default value is forced to
· The path element is replaced with the
name of the invoking user, which SD
reads from the system password file.
· If you set the value of this option
to path, SD replaces with the invok‐
ing user's home directory (from the
system password file) and resolves
path relative to that directory. For
example, resolves to the directory in
your home directory.
· 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 spe‐
cially designed and packaged. This mode
cannot be used to manage the HP-UX oper‐
ating 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 will automatically exit
when appropriate. 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 inac‐
tive 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 com‐
mand line invocation, a value between 10
minutes and 60 minutes is suitable. A
value of 60 minutes or more is recom‐
mended when the GUI will be used. The
default of 10000 is slightly less than 7
days.
Requires that the software products which are
being configured 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.
Prevents the configuration of another, independent
version of a product when a version
already is configured at the target.
If set to another version of an existing
product 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.
When executes a which asks for a user
response. If the command first deter‐
mines if a response file already exists
in the control directory and executes
the script only when a response file is
absent.
If set to or you can use the option to
specify the pathname of an exported cat‐
alog to store copies of the response
file or files created by the script.
See swask(1M) for more information on
scripts.
Controls automatic job removal of completed jobs.
If the job is
automatically removed, job information
(job status or controller/agent log‐
files) cannot be queried with
Controls the automatic selection of prerequisite,
corequisite, and
exrequisite software that is not explic‐
itly selected by the user. This option
does not apply to The default is: The
requisite software will be automatically
selected for configuration. Specifying
causes requisite software, which is not
explicitly selected, to not be automati‐
cally selected for configuration.
The option is ignored when this option
is set to
Controls the automatic selection of dependent
software that is not
explicitly selected by the user. A
dependent is the opposite of a requi‐
site. A dependent fileset has estab‐
lished either a prerequisite or a coreq‐
uisite on the selected fileset. Speci‐
fying causes dependent software to be
automatically selected for unconfigura‐
tion. The default, causes dependent
software, which is not explicitly
selected, to not be automatically
selected for unconfiguration.
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 depen‐
dency in a list of OR dependencies that
satisfies a requisite is not automati‐
cally selected when another dependency
in the list that also satisfies the req‐
uisite 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 explic‐
itly selected.
This option is ignored when the option
is 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 uncom‐
pressed INDEX and INFO files. The com‐
pressed files are named and and reside
in the same directories as the uncom‐
pressed 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 tar‐
get agents for HP-UX 11.01 and higher
automatically load the compressed INDEX
and INFO files from the source agent
when:
· The source agent supports this fea‐
ture.
· or exist on the source depot.
· or are not older than the correspond‐
ing uncompressed INDEX or INFO files.
The uncompressed INDEX or INFO file is
accessed by the source agent if any
problem occurs when accessing, transfer‐
ring, or uncompressing the or file.
Location of a depot for the controller to access
to resolve
selections. This has no effect on which
sources the target uses. Specify this
as host, or Useful for reducing network
traffic between controller and target.
Requires that all dependencies specified by the
software_selections be resolved at the
target_selections.
The command will not proceed unless the
dependencies have also been selected or
already exist at the target in the cor‐
rect state (INSTALLED or CONFIGURED).
This prevents unusable software from
being configured on the system.
If set to dependencies will still be
checked, but not enforced. Corequisite
dependencies, if not enforced, may keep
the selected software from working prop‐
erly. Prerequisite and exrequisite
dependencies, if not enforced, may cause
the configuration to fail.
Controls the handling of errors generated by
scripts. If
and the vendor-supplied script returns
an error, the configure or unconfigure
operation stops. An error message
appears reporting that the execution
phase failed. If attempts to continue
operation. A warning message appears
reporting that the execution succeeded.
Controls the behavior of the
command by checking the available.
If set to the command proceeds if one or
more software selections are available.
If set to the command proceeds only if
all the software selections are avail‐
able.
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 con‐
troller 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 multiple processes, with each appli‐
cation or group of applications using a
different IPD.
Caution: use a specific to manage a spe‐
cific application. SD does not support
multiple descriptions of the same appli‐
cation 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 pack‐
aged. This mode cannot be used to man‐
age 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 addi‐
tional identifying information about a
job when is invoked.
Controls the handling of corequisites in determin‐
ing the order in
which filesets are loaded.
If promotes the corequisite of a prereq‐
uisite to prerequisite. If corequisites
are not used in determining load order.
Adds numeric identification numbers at the begin‐
ning 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 amount of detail written to the log‐
file. When set
to this option adds detailed task infor‐
mation (such as options specified,
progress statements, and additional sum‐
mary information) to the logfile. This
information is in addition to log infor‐
mation controlled by the option.
See below 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 above and the sd(5) manual
page, by typing , for more information.)
A value of:
provides no information to the logfile.
enables verbose logging to the logfiles.
enables very verbose logging to the log‐
files.
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.
By default, the
command attempts to automatically 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.
Prevents software which is already in the CONFIG‐
URED state from being
reconfigured. If set to CONFIGURED
software can be reconfigured.
This option controls the exit code returned by
SD's controller commands.
This option is applicable only for a
single target operation, and ignored
when multiple targets are used.
When set to the default value of swcon‐
fig returns:
0 If there were no errors, with or
without warnings.
1 If there were errors.
When set to swconfig returns :
0 If there were no warnings and no
errors.
1 If there were errors.
2 If there were warnings but no errors.
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 con‐
nection fails for one protocol sequence,
the next is attempted. SD supports both
the tcp and udp protocol sequence on
most platforms.
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 the Each value is approxi‐
mately twice as long as the preceding
value. A value of 5 is about 30 seconds
for 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, nonpriv‐
ileged mode is invoked:
· Permissions for operations are based
on the user's file system permis‐
sions.
· SD ACLs are ignored.
· Files created by SD have the uid and
gid of the invoking user, and the
mode of created files is set accord‐
ing to the invoking user's umask.
SD's nonprivileged mode is intended only
for managing applications that are spe‐
cially designed and packaged. This mode
cannot be used to manage the HP-UX oper‐
ating system or patches to it. For a
full explanation of nonprivileged SD,
see the available at the web site.
See also the and options.
If no target_selections are specified, select
the local host as the target of the com‐
mand.
Defines the default
software_selections. There is no sup‐
plied default. If there is more than
one software selection, they must be
separated by spaces.
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.
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 configuring of files on a target
which exists
on a remote (NFS) filesystem. All files
on a remote filesystem will be skipped.
If set to and if the superuser has write
permission on the remote filesystem, the
remote files will not be skipped, but
will be configured.
Session File
Each invocation of the command defines a configuration
session. The invocation options, source information,
software selections, 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 automatically saved to the file This file
is overwritten by each invocation of
You can also save session information to a specific file
by executing with the session_file option.
A session file uses the same syntax as the defaults
files. If you do not specify a specific path for the
session file, the default location is
To re-execute a session file, specify the session file as
the argument for the session_file option of
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 take
precedence over the values in the session file.
Environment Variables
The environment variables that affect the command are:
Determines the language in which messages are dis‐
played.
If is not specified or is set to the
empty string, a default value of is
used. See lang(5) for more informa‐
tion.
NOTE: The language in which the SD
agent and daemon log messages are
displayed is set by the system con‐
figuration variable script, For exam‐
ple, 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 ver‐
sus 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 dis‐
played 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 are:
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.
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.
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 vari‐
able tells scripts where other con‐
trol 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 con‐
trol_file can query the variable to
determine which tag is being exe‐
cuted.
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 prod‐
ucts 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 script, the targets
option contains a list of soft‐
ware_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_collec‐
tion_spec for the targets on which
the script is being executed.
This variable contains the fully qualified soft‐
ware specification of
the current product or fileset. The
software specification allows the
product or fileset to be uniquely
identified.
Signals
The command catches the signals SIGQUIT and SIGINT, and
SIGUSR1. If these signals are received, prints a mes‐
sage, sends a Remote Procedure Call (RPC) to the agents
to wrap up, and then exits.
The agent ignores SIGHUP, SIGINT, and SIGQUIT. It imme‐
diately 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 imme‐
diately exits gracefully after receiving SIGTERM and
SIGUSR2. After receiving SIGUSR1, it waits for comple‐
tion 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.
Each agent will complete the configuration task (if the
execution phase has already started) before it wraps up.
This avoids leaving software in a corrupt state.
RETURN VALUES
The command returns:
The software_selections were successfully config‐
ured.
The configure operation failed on
all target_selections.
The configure operation failed on
some target_selections.
DIAGNOSTICS
The command writes to stdout, stderr, and to specific
logfiles.
Standard Output
The command writes messages for significant events.
These include:
· a begin and end session message,
· selection, analysis, and execution task mes‐
sages for each target_selection.
Standard Error
The command also writes messages for all WARNING and
ERROR conditions to stderr.
Logging
The command logs summary events at the host where the
command was invoked. It logs detailed events to the log‐
file associated with each target_selection.
Command Log
The command logs all stdout and stderr messages to
the the logfile (The user can specify a different
logfile by modifying the option.)
Target Log
A process performs the actual configure operation
at each target_selection. The logs events to the
file You can view the command and target log files
with the or command.
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
Configure the C and Pascal products on the local host:
Configure use any associated response files generated by
a request script, and save response files under
Reconfigure the HP Omniback product:
Configure the version of HP Omniback that was installed
at
Unconfigure the software_selections listed in the file on
the hosts listed in the file
Configure the C and Pascal products on remote hosts:
LIMITATIONS
The SD-UX version of does not support the configuration,
unconfiguration, or reconfiguration of installed software
on remote targets.
FILES
Contains the user-specific default values for some or all
SD software
management command options.
Contains session files automatically saved by the SD
software management
commands, or explicitly saved by the user.
Contains the master list of current SD options with their
default values.
The directory which contains all configurable
and non-configurable data for SD software manage‐
ment commands. This directory is also the
default location of logfiles.
Contains the active system-wide default values for some
or all SD software
management command options.
Contains the set of date/time templates used when sched‐
uling jobs.
The Installed Products Database (IPD), a catalog of all
products
installed on a system.
AUTHOR
was developed by the Hewlett-Packard Company.
SEE ALSOinstall-sd(1M), swacl(1M), swagentd(1M), swask(1M),
swcopy(1M), swinstall(1M), swjob(1M), swlist(1M), swmod‐
ify(1M), swpackage(1M), swreg(1M), swremove(1M), swver‐
ify(1M)sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swconfig(1M)
