NAME

swconfig − Configure, unconfigure, or reconfigure installed software

SYNOPSIS

swconfig [-p] [-v] [-u] [-x option=value] [-X option_file] [-f software_file] [-t target_file]
[-C session_file] [-S session_file] [-Q date] [-J jobid] [software_selections] [ @  target_selections]

Remarks:

SD-UX commands are included with the HP-UX Operating System and manage software on the local host only.  To install and manage software simultaneously on multiple remote hosts (including PCs) from a central controller, you must purchase the HP OpenView Software Distributor (HP Prod. No. B1996AA) which provides extended software management, multi-site software distribution capabilities and distribution to PCs.  While most of the information in this manual page applies to both SD-UX commands and the OpenView product, some applies only to the OpenView product. Where this is the case, you will see:

The following xxx applies only to HP OpenView Software Distributor

DESCRIPTION

The swconfig command configures, unconfigures, and reconfigures installed and linkinstalled software products for execution on the specified targets.  The swconfig command transitions software between INSTALLED and CONFIGURED states. 

Software is automatically configured and unconfigured as part of the swinstall and swremove commands (respectively).  The user can defer configuration when software is installed.  The swconfig command can (un)configure software independent of swinstall and swremove, e.g. to configure (unconfigure) hosts that share software from a server host where the software is actually installed.  The swconfig command must also be executed when the initial configuration by swinstall failed, was deferred, or needs to be changed. 

Configuration primarily involves the execution of vendor-supplied configure scripts.  These scripts perform configuration tasks which enable the use of the software on the target hosts.  The swconfig command also allows software to unconfigure the hosts on which it no longer will be run.  A vendor can supply unconfigure scripts to "undo" the configuration performed by the configure script. 

The configure scripts are not run by swinstall and swremove when an alternate root directory is specified.  Instead, the swconfig command must be run after that software has been made available to client hosts, to configure those hosts.  Similarly, swconfig must be used on client hosts to unconfigure those hosts.  Configuration can also be deferred on software installed to the root directory /, for example when multiple configured versions have been allowed, by using the defer_configure option with swinstall. 

Other features of swconfig include:

• The swconfig command supports only configuration of compatible software by default, controllable through the allow_incompatible option. 

• 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 swconfig command will configure multiple versions of a product if the user has set allow_multiple_versions=true.  The vendor must therefore detect and prevent multiple configured versions in their configure scripts, if that is necessary. 

• A vendor’s configure script is as useful for operations required for software updates as for new installs.  The scripts must also be designed to handle reinstall. 

Options

swconfig supports the following options:

-p Previews a configuration task by running the session through the analysis phase only. 

-v Turns on verbose output to stdout.  (The swconfig logfile is not affected by this option.)  Verbose output is enabled by default, see the verbose option below. 

-u Causes swconfig to unconfigure the software instead of configuring it. 

-x option=value Set the session option to value and override the default value (or a value in an alternate option_file specified with the -X option).  Multiple -x options can be specified. 

-X option_file Read the session options and behaviors from option_file.

-f software_file Read the list of software_selections from software_file instead of (or in addition to) the command line. 

-t target_file Read the list of target_selections from target_file instead of (or in addition to) the command line. 

-C session_file Save the current options and operands to session_file. You can enter a relative or absolute path with the file name. The default directory for session files is /.sw/sessions/.  You can recall a session file with the -S option. 

-S session_file Execute swconfig 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 -C option. 

The -Q and -J options apply only to HP OpenView Software Distributor

-Q date Schedules the job for this date.  The date’s format can be changed by modifying the file /var/adm/sw/getdate.templ.

-J jobid Executes the previously scheduled job.  This is the syntax used by the daemon to start the job. 

Operands

The swconfig command supports the following syntax for each software_selection:

bundle[.product[.subproduct][.fileset]][,version]

or

product[.subproduct][.fileset][,version]

The version component has the form:

[,r <op> revision][,a <op> arch][,v <op> vendor][,c <op> category]

or

[instance_id]

where <op> can be: ==, >=, <=, <, >, or != which performs individual comparisons on dot-separated fields.  For example, r>=B.10.00 means choose all revisions that are greater than or equal to B.10.00. The system will compare each dot-separated field to find matches. Software will only be selected when matches within each field are satisfied. Wildcards are not allowed with these operators. 

The = (equals) relational operator is also allowed to specify a particular version component. 

All version components are repeatable within a single specification (e.g.  r>=A.12, r<A.20). If multiple components are used, the selection must match all components.  No isspace(3) characters are allowed. 

The \* software specification selects all products. 

For complete information, see the sd(4) manual page.

The swconfig command supports the following syntax for each target_selection. The : (colon) is required if both a host and directory are specified.

[host][:][/]

(For swconfig, the directory component of a target_selection must be /.) 

EXTERNAL INFLUENCES

Defaults File

In addition to the standard options, several swconfig behaviors and policy options can be changed by editing the default values found in:

/var/adm/sw/defaults - the system-wide default values,

$HOME/.sw/defaults - the user-specific default values. 

Values must be specified in the defaults file using this syntax:

swconfig.option=value

The default values can be overridden by specifying an options file with the -X option, or by specifying -x option=value on the command line.  The policy options that apply to swconfig are:

agent_auto_exit=true
Causes the target agent to automatically exit after Execute phase, or after a failed Analysis phase.  This is forced to false when the controller is using an interactive UI, or when -p (preview) is used.  This enhances network reliability and performance.  The default is true - the target agent will automatically exit when appropriate.  If set to false, the target agent will not exit until the controller ends the session. 

agent_timeout_minutes=1440
Causes a target agent to exit if it has been inactive for the specified time. The default of 1440 (24 hours) applies only when the interactive UI is used. Usually, the command line controller resets this to 10 minutes.  If you change this value to anything other than 1440, that value will be used even if the controller is using an interactive UI.  When using command line invocation of HP OpenView Software Distributor with multiple targets and you have not changed this value from 1440, the value will be reset to 9 minutes plus the number of targets.

allow_incompatible=false
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 true, target compatibility is not enforced. 

allow_multiple_versions=false
Prevents the configuration of another, independent version of a product when a version already is already configured at the target.

If set to true, 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. 

The following option applies only to HP OpenView Software Distributor

autoremove_job = false
Controls automatic job removal of completed jobs. If the job is automatically removed, job information (job status or controller/agent logfiles) cannot be queried with swjob. 

autoselect_dependencies=true
Controls the automatic selection of prerequisite and corequisite software that is not explicitly selected by the user.  This option does not apply to swconfig -u.  The default is: true The requisite software will be automatically selected for configuration.  Specifying false causes requisite software, which is not explicitly selected, to not be automatically selected for configuration. 

autoselect_dependents=false
Controls the automatic selection of dependent software that is not explicitly selected by the user.  A dependent is the opposite of a requisite.  A dependent fileset has established either a prerequisite or a corequisite on the fileset under discussion. Specifying true causes dependent software to be automatically selected for unconfiguration.  The default, false causes dependent software, which is not explicitly selected, to not be automatically selected for unconfiguration. 

enforce_dependencies=true
Requires that all dependencies specified by the software_selections be resolved at the target_selections.

The swconfig, command will not proceed unless the dependencies have also been selected or already exist at the target in the correct state (INSTALLED or CONFIGURED).  This prevents unusable software from being configured on the system. 

If set to false, dependencies will still be checked, but not enforced.  Corequisite dependencies, if not enforced, may keep the selected software from working properly. Prerequisite dependencies, if not enforced, may cause the configuration to fail. 

The following option applies only to HP OpenView Software Distributor

job_title=
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 swjob is invoked. 

logdetail=false[true]
The SD loglevel and logdetail options allow you to choose what amount of information you need in your logfiles - from no detail to complete information. 
 
The loglevel=0 option allows no information to be written to the logfile.  This essentially turns off the logfile process. 
 
The logdetail=true[false] option controls the amount of detail written to the logfile.  Here are the possible combinations of loglevel and logdetail options:

logfile=/var/adm/sw/swconfig.log

This is the default command log file for the swconfig command. 

loglevel=1
Controls the log level for the events logged to the command logfile, and the target agent logfile. A value of 0 prevents information from being logged.  A value of 1 enables verbose logging to the logfiles.  A value of 2 enables very verbose logging to the logfiles. 

log_mesgid=0
Controls whether numeric identification numbers are prepended to logfile messages produced by SD. A value of 0 (default) indicates no such identifiers are attached.  Values of 1-4 indicate that identifiers are attached to messages:

• 1 applies to ERROR messages only

• 2 applies to ERROR and WARNING messages

• 3 applies to ERROR, WARNING, and NOTE messages

• 4 applies to ERROR, WARNING, NOTE, and certain other logfile messages. 

mount_all_filesystems=true
By default, the swconfig command attempts to automatically mount all filesystems in the /etc/checklist 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 false, the mount operation is not attempted, and no check of the current mounts is performed. 

reconfigure=false
Prevents software which is already in the CONFIGURED state from being reconfigured. If set to true, CONFIGURED software can be reconfigured. 

rpc_binding_info=ncadg_ip_udp:[2121]
Defines the protocol sequence and endpoint which will be used to contact swagentd.  This value should be consistent among all hosts that work together.  See sd(5) for details on specifying this option. 

rpc_timeout=7(=5 for OpenView Software Dist.)
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 swagentd.  Each value is approximately twice as long as the preceding value.  A value of 5 is about 30 seconds for ncadg_ip_udp. 

select_local=true
If no target_selections are specified, select the local host as the target of the command. 

software=
Defines the default software_selections. There is no supplied default. If there is more than software selection, they must be separated by spaces.

targets=
Defines the default target_selections. There is no supplied default (see select_local above).  If there is more than target selection, they must be separated by spaces. 

verbose=1
Controls the verbosity of the swconfig output (stdout).  A value of 0 disables output to stdout.  (Error and warning messages are always written to stderr).  A value of 1 enables verbose messaging to stdout. 

write_remote_files=false
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 true 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 swconfig 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 $HOME/.sw/sessions/swinstall{swcopy}.last.  This file is overwritten by each invocation of swconfig. 

You can also save session information to a specific file by executing swconfig with the -C session__file option. 

A session file uses the same syntax as the defaults files.  You can specify an absolute path for the session file.  If you do not specify a directory, the default location for a session file is /.sw/sessions/ . 

To re-execute a session file, specify the session file as the argument for the -S session__file option of swconfig. 

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 swconfig take precedence over the values in the session file. 

Environment Variables

The swconfig program sets these environment variables for use by the configure scripts being executed:

LANG

Determines the language in which messages are displayed.  If LANG is not specified or is set to the empty string, a default value of C 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 variable script, /etc/rc.config.d/LANG.  For example, /etc/rc.config.d/LANG, must be set to LANG=ja_JP.SJIS or LANG=ja_JP.eucJP to make the agent and daemon log messages display in Japanese. 

SW_PATH

A PATH variable which defines a minimum set of commands available to for use in a control script. 

SW_ROOT_DIRECTORY

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 SW_LOCATION to locate the product’s installed files.  The configure script is only run when SW_ROOT_DIRECTORY is "/". 

SW_LOCATION

Defines the location of the product, which may have been changed from the default product directory.  When combined with the SW_ROOT_DIRECTORY, this variable tells scripts where the product files are located. 

SW_SOFTWARE_SPEC

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. 

SW_CONTROL_DIRECTORY

Defines the current directory of the script being executed, either a temporary catalog directory, or a directory within the Installed Products Database (IPD).  This variable tells scripts where other control scripts for the software are located (e.g. subscripts). 

Signals

The swconfig command catches the signals SIGQUIT and SIGINT.  If these signals are received, swconfig prints a message, sends a Remote Procedure Call (RPC) to the agents to wrap up, and then exits. 

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 swconfig command returns:

0 The software_selections were successfully configured. 

1 The configure operation failed on all target_selections.

2 The configure operation failed on some target_selections.

DIAGNOSTICS

The swconfig command writes to stdout, stderr, and to specific logfiles. 

Standard Output

The swconfig command writes messages for significant events.  These include:

• a begin and end session message,

• selection, analysis, and execution task messages for each target_selection.

Standard Error

The swconfig command also writes messages for all WARNING and ERROR conditions to stderr. 

Logging

The swconfig command logs summary events at the host where the command was invoked.  It logs detailed events to the swagent logfile associated with each target_selection.

Command Log
The swconfig command logs all stdout and stderr messages to the the logfile /var/adm/sw/swconfig.log. (The user can specify a different logfile by modifying the logfile option.) 

Target Log
A swagent process performs the actual configure operation at each target_selection. The swagent logs events to the file /var/adm/sw/swagent.log.

The following line applies only to HP OpenView Software Distributor

Command and target log files can be viewed using the swjob command. 

EXAMPLES

Configure the C and Pascal products on the local host:

swconfig cc pascal

The following example applies only to HP OpenView Software Distributor

Configure the C and Pascal products on remote hosts:

swconfig cc pascal @  hostA hostB hostC

Reconfigure the HP Omniback product:

swconfig -x reconfigure=true Omniback

Configure the version of HP Omniback that was installed at /opt/Omniback_v2.0:

swconfig Omniback,l=/opt/Omniback_v2.0

Unconfigure the software_selections listed in the file /tmp/install.products on the hosts listed in the file /tmp/install.hosts:

swconfig -u -f /tmp/install.products -t /tmp/install.hosts

LIMITATIONS

The SunOS and SD-UX versions of swconfig do not support the configuration, unconfiguration, or reconfiguration of installed software on remote targets. 

The following paragraph applies only to HP OpenView Software Distributor

The swconfig command does not apply to PC Controllers or PC targets.  For PC targets, configuration operations are packaged into the PC product as one or more of its actions, and then executed when the PC product is installed. 

FILES

/var/adm/sw/

The directory which contains all of the configurable (and non-configurable) data for SD software management commands.  This directory is also the default location of logfiles. 

/usr/lib/sw/sys.defaults

Contains the master list of current SD options (with their default values). 

/var/adm/sw/defaults

Contains the active system-wide default values for some or all SD software management command options. 

$HOME/.sw/defaults

Contains the user-specific default values for some or all SD software management command options. 

/var/adm/sw/getdate.templ

Contains the set of date/time templates used when scheduling jobs. 

$HOME/.sw/sessions/

Contains session files automatically saved by the SD software management commands, or explicitly saved by the user. 

/var/adm/sw/products/

The Installed Products Database (IPD), a catalog of all products installed on a system. 

AUTHOR

swconfig was developed by the Hewlett-Packard Company. 

SEE ALSO

sd(4), sd(5), swacl(1M), swagentd(1M), swcluster(1M), swconfig(1M), swcopy(1M), swgettools(1M), swinstall(1M), swjob(1M), swlist(1M), swmodify(1M), swpackage(1M), swpackage(4), swreg(1M), swremove(1M), swverify(1M), update(1M), and the HP OpenView Software Distributor Administrator’s Guide or Managing HP-UX Software with SD-UX manuals. 

Hewlett-Packard Company  —  HP-UX Release 10.20:  July 1996