swremove(1M) swremove(1M)
NAME
swremove - unconfigure and remove software products
SYNOPSIS
[XToolkit Options] session_file] software_file] jobid] date] session_file] target_file] option=value] option_file] [software_selections]
target_selections]
Remarks
o supports an interactive user interface (GUI) that can be invoked alone or by the command. See below.
o This command supports operations on remote systems. See below.
o For an overview of all SD commands, see the sd(5) man page by typing on the command line.
DESCRIPTION
The command removes software_selections from target_selections (for example, root file systems). When removing installed software, also
unconfigures the software before it is removed. The software is not unconfigured when removed from an alternate root directory since it
was not configured during installation. When removing available software (within a depot), also does not perform the unconfiguration task.
NOTE : Selecting a bundle for removal does not always remove all filesets in that bundle. If a particular fileset is required by another
bundle, that fileset will not be removed. For example, if the bundles and both use the fileset Debugger.Run and you try to remove the
fileset Debugger.Run will not be removed because it is also used by the bundle This prevents the removal of one bundle from inadvertently
causing the removal of filesets needed by another bundle.
Remote Operation
You can enable Software Distributor (SD) to manage software on remote systems. To let the root user from a central SD controller (also
called the central management server or manager node) perform operations on a remote target (also called the host or agent):
1) Set up the root, host, and template Access Control Lists (ACLs) on the remote machines to permit root access from the controller sys-
tem. To do this, run the following command on each remote system:
NOTES:
o controller is the name of the central management server.
o If remote system is 11.00, make sure SD patch PHCO_22526 or a superseding patch is installed on remote system before running
o If remote system is older than 11.00 or for some other reason does not have in place, copy script from an 11.11 or higher system to
the remote system.
2) and have enhanced GUI interfaces for remote operations. Enable the enhanced GUIs by creating the file on the controller. Use this
command:
NOTE: You can also set up remote access by using the directly on the remote machines to grant root or non-root access to users from the
controller system.
Interactive Operation
supports a graphical user interface (GUI) or a terminal user interface (in which screen navigation is done with the keyboard and no mouse)
if your terminal or display cannot support the GUI.
To invoke the GUI, type
on the command line (without command-line arguments) or include with any other command-line options when you invoke from the command
line.
The command provides an interactive interface for monitoring software jobs. You can also use it to invoke the or GUIs.
If you have enabled SD's central management features, and provide enhanced GUIs to support operations on remote machines. See above.
Removing Patches or Patch Rollback Files
To remove patch software, rollback files corresponding to the patch be available for rollback. You must remove the base software modified
by the patch. (Removing the base software also removes the patches associated with that software.)
To commit (make permanent) a patch, use the command's option to remove the files saved for patch rollback, or use the command's
save_patch_files option to not save them initially. See swmodify(1M) and swinstall(1M) for more information.
Control Scripts
When removing installed software, the command executes several vendor-supplied scripts (if they exist) during the removal of the soft-
ware_selections. The command supports the following scripts:
a script executed during the analysis of each
target_selection, it checks to make sure the removal can be attempted. If this check fails, the software product will not be
removed.
a script executed immediately before the software files are removed.
a script executed immediately after the software files are removed.
a script executed during the unconfiguration of each
target_selection, it unconfigures the host for the software (and the software for the host). The and scripts are not
intended for unconfiguration tasks. They are to be used for simple file management needs such as restoring files moved dur-
ing install. The script allows the command to unconfigure the hosts on which it has been running before removing the soft-
ware specified.
Options
The supports the following options:
XToolKit Options
The command supports 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.
Operate on a depot rather than installed software.
Operates on an alternate root directory, which must be specified in the
option. Note that unconfigure scripts are not run when removing software from an alternate root directory. (This
option is not required for alternate root operations but is maintained for backward compatibility. See the heading
in sd(5) for more information.)
Runs the command in interactive mode (Graphical User Interface).
See the and headings above for additional details.
Previews a remove task by running the session through the analysis
phase only.
Turns on verbose output to stdout.
(The log file is not affected by this option.) Verbose output is controlled by the default
Save the current options and operands to
session_file. You can enter a relative or absolute path with the file name. The default directory for session files
is You can recall a session file with the option.
Read the list of
software_selections from software_file instead of (or in addition to) the command line.
Executes a previously scheduled job. This is the syntax used by the
daemon to start the job.
Schedules a job for the specified date. You can change the date
format by modifying the file
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.
Set the session
option to value and override the default value (or a value in an alternate option_file specified with the option).
Multiple options can be specified.
Read the session options and behaviors from
option_file.
Operands
supports two types of operands: followed by These operands are separated by the "at" character. This syntax implies that the command oper-
ates on "software selections at targets".
Software Selections
The selections operands consist of
supports 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 removes 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 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 Fully qualified software specs include the and version components even if they contain empty strings.
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
supports the following syntax for each target_selection:
The colon is required if both a host and directory are specified.
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 occurrence of a slash is treated as the separator.
The IPv6 address can optionally be enclosed in a pair of square brackets and
EXTERNAL INFLUENCES
Default Options
In addition to the standard options, you can change behavior and policy options 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 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 parent directory for the
installed software catalog. The default value is for normal SD operations. When SD operates in nonprivileged mode (that
is, when the default option is set to
o The default value is forced to
o The path element is replaced with the name of the invoking user, which SD reads from the system password file.
o If you set the value of this option to path, SD replaces with the invoking user's home directory (from the system pass-
word file) and resolves path relative to that directory. For example, resolves to the directory in your home direc-
tory.
o If you set the value of the default option to a relative path, that path is resolved relative to the value of this
option.
SD's nonprivileged mode is intended only for managing applications that are specially designed and packaged. This mode
cannot be used to manage the HP-UX operating system or patches to it. For a full explanation of nonprivileged SD, see the
available at the web site.
See also the and options.
Causes the target agent to automatically exit after Execute phase, or after
a failed Analysis phase. This is forced to when the controller is using an interactive user interface, or when (preview)
is used. This enhances network reliability and performance. The default value of causes the target agent to automati-
cally exit when appropriate. When set to the target agent will not exit until the controller ends the session.
Causes a target agent to exit if it has been inactive for the
specified time. This can be used to make target agents more quickly detect lost network connections since RPC can take as
long as 130 minutes to detect a lost connection. The recommended value is the longest period of inactivity expected in
your environment. For command line invocation, a value between 10 minutes and 60 minutes is suitable. A value of 60 min-
utes or more is recommended when the GUI will be used. The default of 10000 is slightly less than 7 days.
Permits the use of single patch filesets without "sibling" filesets.
In the default state of 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 behavior applies to filesets
selected directly by the user and to filesets automatically selected by SD to resolve software dependencies.)
When set to SD allows a single patch fileset to be 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 removed by a patch, while the other filesets would not.
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.
Prevents the removal of software requiring a reboot from the
non-interactive interface. If set to then this software can be removed and the target system(s) will be automatically
rebooted.
An interactive session always asks for confirmation before software requiring a reboot is 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.
Controls automatic job removal. If the job is automatically removed,
job information (job status or controller/agent log files) cannot be queried with
Automatically selects all software that depends on the specified
software. When set to and any software that other software depends on is selected for removal, automatically selects that
other software. If set to automatic selections are not made to resolve requisites.
If bundles that have the is_sticky attribute set to will be automatically removed when the last of its contents is removed.
If the sticky bundles will not be automatically removed.
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.
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 the Interactive User Interface.
Defines the default location of the target depot.
Requires that all dependencies specified by the
software_selections be resolved at the target_selections. For if a selected fileset has dependents (that is, other soft-
ware depends on the fileset) and they are not selected, do not remove the selected filesets. If set to dependencies will
still be checked, but not enforced.
Controls the handling of errors generated by scripts. If
and a script returns an error, the operation halts. An error message appears reporting that the execution phase failed.
If all script errors are treated as warnings, and attempts to continue operation. A warning message appears reporting
that the execution succeeded. The message wording identifies whether the failure occurred in the configure/unconfigure,
checkremove, preremove, or postremove phases.
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.)
Specifies 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.
Adds numeric identification numbers at the beginning of SD logfile
messages:
(default) No identifiers are attached to messages.
Adds identifiers to ERROR messages only.
Adds identifiers to ERROR and WARNING messages.
Adds identifiers to ERROR, WARNING, and NOTE messages.
Adds identifiers to ERROR, WARNING, NOTE, and certain other
informational messages.
Controls the 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.
See the option and the manual page 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.
provides no information to the logfile.
enables verbose logging to the log files.
enables very verbose logging to the log files.
See the option and the sd(5) manual page for more information.
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 which may be on mounted
filesystems are available to be removed.
If set to the mount operation is not attempted, and no check of the current mounts is performed.
Defines the polling interval used by the Interactive UI of the controller. It
specifies how often each target agent will be polled to obtain status information about the task being performed. When
operating across wide-area networks, the polling interval can be increased to reduce network overhead.
Controls whether a depot is removed once the last product/bundle has been
removed. If the depot is removed, the depot's and directory structure are not removed by default. If the and directory
should be removed, the option must also be set to Useful to set to false if you want to retain existing depot ACLs for
subsequent depot reuse.
Controls whether a depot's
file and directory are also removed when the depot itself is removed. The and directory will be removed if this option is
set to the option is set to and the last product/bundle has been removed from the depot.
Defines the protocol sequence(s) and endpoint(s) on which the daemon
listens and the other commands contact the daemon. If the connection fails for one protocol sequence, the next is
attempted. SD supports both the tcp and udp protocol sequence on most platforms.
See the sd(5) manual page (type for more information.
Relative length of the communications timeout. This is a value in the
range from 0 to 9 and is interpreted by the DCE RPC. Higher values mean longer times; you may need a higher value for a
slow or busy network. Lower values give faster recognition on attempts to contact hosts that are not up or not running
Each value is approximately twice as long as the preceding value. A value of 5 is about 30 seconds for the protocol
sequence. This option may not have any noticeable impact when using the protocol sequence.
This option controls SD's nonprivileged mode. This option is ignored
(treated as true) when the invoking user is super-user.
When set to the default value of true, SD operations are performed normally, with permissions for operations either
granted to a local super-user or set by SD ACLs. (See swacl(1M) for details on ACLs.)
When set to false and the invoking user is local and is not super-user, nonprivileged mode is invoked:
o Permissions for operations are based on the user's file system permissions.
o SD ACLs are ignored.
o Files created by SD have the uid and gid of the invoking user, and the mode of created files is set according to the
invoking user's umask.
SD's nonprivileged mode is intended only for managing applications that are specially designed and packaged. This mode
cannot be used to manage the HP-UX operating system or patches to it. For a full explanation of nonprivileged SD, see the
available at the web site.
See also the and options.
Controls whether or not control scripts are run during a remove session.
(See above for the list of control scripts typically run during Control scripts provide important cleanup when software is
removed. Setting this to false may result in some manual cleanup being required.
Defines the default
software_selections. There is no supplied default. If there is more than one software selection, they must be separated
by spaces.
Indicates the software view to be used by the Interactive UI of the
controller. It can be set to or a bundle category tag to indicate to show only bundles of that category.
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 removal of files from a remote (NFS) file system. When
set to files on a remote file system are not removed.
If set to and if the superuser has write permission on the remote file system, the remote files are removed.
Session File
Each invocation of defines a task session. The command automatically saves 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 interactive or command-line sessions.
Session information is saved to the file This file is overwritten by each invocation of the command. The file uses the same syntax as the
defaults files.
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.
From a command-line session, you can save session information by executing the command with the option. You can specify an absolute path
for a session file. If you do not specify a directory, the default location is
To re-execute a saved session from an interactive session, use the Recall Session option from the File menu.
To re-execute a session from a command-line, specify the session file as the argument for the option.
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
The command supports software and target selection from separate input files.
You can specify software and target selection lists with the and options. Software and targets specified in these files are selected for
operation instead of (or in addition to) files listed in the command line. (See the and options for more information.)
Additionally, the interactive user interface reads a default list of hosts on which to operate. The list is stored in:
the system-wide default list of hosts
the user-specific default list of hosts
For each interactive command, target hosts containing roots or depots are specified in separate lists respectively.) The list of hosts are
enclosed in { } braces and separated by white space (blank, tab and newline). For example:
Environment Variables
The environment variables that affect the command are:
Determines the language in which messages are displayed.
If is not specified or is set to the empty string, a default value of is used. See the lang(5) man page by typing for
more information.
NOTE: The language in which the SD agent and daemon log messages are displayed is set by the system configuration vari-
able script, For example, must be set to or to make the agent and daemon log messages display in Japanese.
Determines the locale to be used to override any values for locale
categories specified by the settings of or any environment variables beginning with
Determines the interpretation of sequences of bytes of text data as
characters (for example, single versus multibyte characters in values for vendor-defined attributes).
Determines the language in which messages should be written.
Determines the format of dates
(create_date and mod_date) when displayed by Used by all utilities when displaying dates and times in and
Determines the time zone for use when displaying dates and times.
Environment variables that affect scripts 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.
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 con-
trol_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 for are:
This variable and the
variable are exported with a value that forces "classic" behavior of instead of behavior. For HP-UX 10.30 and later
versions, this variable is set to "1".
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 value of this variables is always equal to
the value of
A value of indicates the SD command was invoked during an Operating System update. This variable is set by the command.
This variable, along with the
variable, is exported with a value that forces "classic" behavior of instead of behavior. For the 10.30 or later
release of HP-UX, this variable is cleared.
Signals
The command catches 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.
Each agent will complete the removal task (if the execution phase has already started) before it wraps up. This avoids leaving software in
a corrupt state.
Terminal Support
For in-depth information about terminal support refer to:
o The
o Start the GUI or TUI, select the menu, then select the option to access the
RETURN VALUES
An interactive session always returns 0. A non-interactive session returns:
The software_selections were successfully removed.
The remove operation failed on
all target_selections.
The remove operation failed on
some target_selections.
DIAGNOSTICS
The command writes to stdout, stderr, and to specific log files.
Standard Output
An interactive session does not write to stdout. A non-interactive session writes messages for significant events. These include:
o a begin and end session message,
o selection, analysis, and execution task messages for each target_selection.
Standard Error
An interactive session does not write to stderr. A non-interactive session writes messages for all WARNING and ERROR conditions to stderr.
Logging
Both interactive and non-interactive sessions log summary events at the host where the command was invoked. They log detailed events to
the logfile associated with each target_selection.
Command Log
A non-interactive session logs all stdout and stderr messages to the the logfile Similar messages are logged by an interactive ses-
sion. The user can specify a different logfile by modifying the option.
Target Log
A process performs the actual remove operation at each target_selection. When removing installed software, the logs messages to the
file beneath the root directory (for example,for example,for example,for example, or an alternate root directory). When removing
available software (within a depot), the logs messages to the file swagent.log beneath the depot directory (for example,
You can view command and target log files using 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
Preview the remove of the C and Pascal products installed at the local host:
Remove the C and Pascal products from several remote hosts:
Remove a particular version of HP Omniback:
Remove the entire contents of a local depot:
FILES
Contains the user-specific default values for some or all SD
options. If this file does not exist, SD looks for user-specific defaults in
Contains the user-specific default list of hosts to manage.
Contains session files automatically saved by the SD commands, or
explicitly saved by the user.
Contains the master list of current SD options with their default values.
The directory which contains all of the configurable
and non-configurable data for SD. This directory is also the default location of 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 set of date/time templates used when scheduling jobs.
The Installed Products Database (IPD), a catalog of all products
installed on a system.
The default location of a target software depot.
AUTHOR
was developed by the Hewlett-Packard Company.
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), swverify(1M), sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swremove(1M)