HPlogo HP-UX Reference Volume 2 of 5 > s

swremove(1M)

Hewlett-Packard Company
» 

Technical documentation

Complete book in PDF

 » Table of Contents

 » Index

NAME

swremove — unconfigure and remove software products

SYNOPSIS

swremove [XToolkit Options] [-d|-r] [-i] [-p] [-v] [-C session_file] [-f software_file] [-J jobid] [-Q date] [-S session_file] [-t target_file] [-x option=value] [-X option_file] [software_selections] [@ target_selections]

Remarks

  • swremove has an interactive user interface. You can invoke it by typing swremove or by including the -i option on the command line.

  • 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 HP-UX, other UNIX® platforms, Windows NT®, and PCs) from a central controller, you must purchase the HP OpenView Software Distributor which provides extended software management capabilities. Information specific only to the OpenView product is marked with a heading similar to the following:

    • The following information applies to HP OpenView Software Distributor only.

DESCRIPTION

The swremove command removes software_selections from target_selections (e.g. root file systems). When removing installed software, swremove 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), swremove 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 Pascal and FORTRAN both use the fileset Debugger.Run and you try to remove FORTRAN, the fileset Debugger.Run will not be removed because it is also used by the bundle Pascal. This prevents the removal of one bundle from inadvertently causing the removal of filesets needed by another bundle.

Removing Patches or Patch Rollback Files

To remove patch software, rollback files corresponding to the patch must 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 swmodify command's patch_commit option to remove the files saved for patch rollback, or use the swinstall command's save_patch_files option to not save them initially. See swmodify(1M) and swinstall(1M) for more information.

PC Software Removal

  • The following paragraph applies only to HP OpenView Software Distributor.

For PC software removal, the swremove command can remove software_selections from one or more target PC depots.

Control Scripts

When removing installed software, the swremove command executes several vendor-supplied scripts (if they exist) during the removal of the software_selections. The swremove command supports the following scripts:

checkremove

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.

preremove

a script executed immediately before the software files are removed.

postremove

a script executed immediately after the software files are removed.

unconfigure

a script executed during the unconfiguration of each target_selection, it unconfigures the host for the software (and the software for the host). The preremove and postremove scripts are not intended for unconfiguration tasks. They are to be used for simple file management needs such as restoring files moved during install. The unconfigure script allows the swremove command to unconfigure the hosts on which it has been running before removing the software specified.

Options

The swremove supports the following options:

XToolKit Options

The swremove command supports a subset of the standard X Toolkit options to control the appearance of the GUI. The supported options are: -bg, -background, -fg, -foreground, -display, -name, -xrm, and -synchronous. See the X(1) manual page for a definition of these options.

-d

Operate on a depot rather than installed software.

-r

(optional) Operate on an alternate root rather than /. Unconfigure scripts are not run when removing software from an alternate root directory.

-i

Runs swremove in interactive mode (invokes the Graphical User Interface). The swremove command also supports an interactive terminal user interface (TUI) in which screen navigation is done with the keyboard (no mouse).

-p

Previews a remove task by running the session through the analysis phase only.

-v

Turns on verbose output to stdout. (The swremove log file is not affected by this option.) Verbose output is controlled by the default verbose=x.

-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 $HOME/.sw/sessions/. You can recall a session file with the -S option.

-f software_file

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

-J jobid

(HP OpenView Software Distributor only)

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

-Q date

(HP OpenView Software Distributor only)

Schedules the job for the specified date. The date format can be changed by modifying the file /var/adm/sw/getdate.templ.

-S session_file

Execute swremove 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.

-t target_file

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

-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.

Operands

swremove supports two types of operands: software selections followed by target selections. 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.

swremove supports the following syntax for each software_selection:

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

The version component has the form:

[,r <op> revision][,a <op> arch][,v <op> vendor] [,c <op> category][,l=location][,fr <op> revision] [,fa <op> arch]

  • location applies only to installed software and refers to software installed to a location other than the default product directory.

  • fr and fa apply only to filesets.

  • The <op> (relational operator) component can be of the form:

    • ==, >=, <=, <, >, or !=

    which performs individual comparisons on dot-separated fields.

    For example, r>=B.10.00 chooses all revisions greater than or equal to B.10.00. The system compares each dot-separated field to find matches. Shell patterns are not allowed with these operators.

  • The = (equals) relational operator lets you specify selections with the shell wildcard and pattern-matching notations:

    • [ ], *, ?, !

    For example, the expression r=1[01].* returns any revision in version 10 or version 11.

  • 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.

  • Fully qualified software specs include the r=, a=, and v= version components even if they contain empty strings.

  • No space or tab characters are allowed in a software selection.

  • The software instance_id can take the place of the version component. It has the form:

    • [instance_id]

    within the context of an exported catalog, where instance_id is an integer that distinguishes versions of products and bundles with the same tag.

The \* software specification selects all products. It is not allowed when removing software from the root directory /.

Target Selections

swremove supports the following syntax for each target_selection:

[host][:][/directory]

The : (colon) is required if both a host and directory are specified.

  • The following PC information applies only to HP OpenView Software Distributor.

To remove software from a PC depot, the swremove command also supports the following syntax:

  • [pc_controller]

EXTERNAL INFLUENCES

Defaults File

In addition to the standard options, you can change swremove behavior and policy options by editing the default values found in:

/var/adm/sw/defaults

the system-wide default values.

$HOME/.swdefaults

the user-specific default values.

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

[command_name.]option=value

The optional command_name 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 -x or -X options:

command -x option=value command -X option_file

The following section lists all of the keywords supported by swremove. If a default value exists, it is listed after the "=".

The policy options that apply to swremove 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 user interface, 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=10000

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 minutes or more is recommended when the GUI will be used. The default of 10000 is slightly less than 7 days.

auto_kernel_build=true

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 auto_kernel_build option is set to true, the autoreboot option must also be set to true. If the auto_kernel_build option is set to false, the value of the autoreboot option does not matter.

autoreboot=false

Prevents the removal of software requiring a reboot from the non-interactive interface. If set to true, 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 auto_kernel_build option is set to true, the autoreboot option must also be set to true. If the auto_kernel_build option is set to false, the value of the autoreboot option does not matter.

autoremove_job=false

Applies only to the HP OpenView Software Distributor product. Controls automatic job removal. If the job is automatically removed, job information (job status or controller/agent log files) cannot be queried with swjob.

autoselect_dependents=false

Automatically selects all software that depends on the specified software. When set to true, and any software that other software depends on is selected for remove, swremove automatically selects that other software. If set to false, automatic selections are not made to resolve requisites.

autoselect_reference_bundles=true

If true, bundles that have the is_sticky attribute set to true will be automatically removed when the last of its contents is removed. If false, the sticky bundles will not be automatically removed.

controller_source=

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:

  • [host][:][path]

This option has no effect on which sources the target uses and is ignored when used with the Interactive User Interface.

distribution_target_directory=/var/spool/sw

Defines the default location of the target depot.

enforce_dependencies=true

Requires that all dependencies specified by the software_selections be resolved at the target_selections. For swremove, if a selected fileset has dependents (i.e. other software depends on the fileset) and they are not selected, do not remove the selected filesets. If set to false, dependencies will still be checked, but not enforced.

enforce_scripts=true

By default, if a fileset checkremove script fails (i.e. returns with exit code 1), that fileset will not be removed. If a product checkremove script fails, none of the filesets in that product will be removed . If set to false, the remove operation will proceed even when a check script fails.

force_single_target=false

This option applies only to the Interactive User Interface when no SD-OV license is in effect on a system that is a diskless server. It causes swremove to run in a single target mode, even though a diskless server normally causes swremove to run in multi-target mode.

job_title=
  • This option applies to HP OpenView Software Distributor only.

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

log_msgid=0

Controls whether numeric identification numbers are prepended to log file messages produced by SD:

0

(default) No 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 log file messages.

logdetail=false

Controls the amount of detail written to the log file. When set to true, 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 loglevel option.

See the loglevel option and the sd(5) manual page for more information.

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

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

loglevel=1

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 logdetail option.

0

provides no information to the logfile.

1

enables verbose logging to the log files.

2

enables very verbose logging to the log files.

See the logdetail option and the sd(5) manual page for more information.

mount_all_filesystems=true

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

polling_interval=2

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.

remove_empty_depot=true

Controls whether a depot is removed once the last product/bundle has been removed. Useful to set to false if you want to retain existing depot ACLs for subsequent depot reuse.

rpc_binding_info=ncacn_ip_tcp:[2121] ncadg_ip_udp:[2121]

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 (ncacn_ip_tcp:[2121]) and udp (ncadg_ip_udp:[2121]) protocol sequence on most platforms.

See the sd(5) manual page (type man 5 sd) for more information.

rpc_timeout=5

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 swagentd. Each value is approximately twice as long as the preceding value. A value of 5 is about 30 seconds for the ncadg_ip_udp protocol sequence. This option may not have any noticeable impact when using the ncacn_ip_tcp protocol sequence.

software=

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_view=products

Indicates the software view to be used by the Interactive UI of the controller. It can be set to products, all_bundles, or a bundle category tag to indicate to show only bundles of that category.

targets=

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

target_shared_root=
  • This option applies to HP-UX 10.* only.

Defines the default location of the alternate root directory.

verbose=1

Controls the verbosity of the output (stdout). A value of

0

disables output to stdout. (Error and warning messages are always written to stderr).

1

enables verbose messaging to stdout.

write_remote_files=false

Prevents the removal of files from a remote (NFS) file system. When set to false, files on a remote file system are not removed.

If set to true and if the superuser has write permission on the remote file system, the remote files are removed.

Session File

Each invocation of swremove 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 $HOME/.sw/sessions/swremove.last. 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 -C session__file option. You can specify an absolute path for a session file. If you do not specify a directory, the default location is $HOME/.sw/sessions/.

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 -S 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 swremove command supports software and target selection from separate input files.

You can specify software and target selection lists with the -f and -t 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 -f and -t options for more information.)

Additionally, the swremove interactive user interface reads a default list of hosts on which to operate. The list is stored in:

/var/adm/sw/defaults.hosts

the system-wide default list of hosts

$HOME/.swdefaults.hosts

the user-specific default list of hosts

For each interactive command, target hosts containing roots or depots are specified in separate lists (hosts and hosts_with_depots respectively.) The list of hosts are enclosed in { } braces and separated by white space (blank, tab and newline). For example:

swremove.hosts={hostA hostB hostC hostD hostE hostF} swremove.hosts_with_depots={hostS}

Environment Variables

The environment variable that affects the swremove command is:

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 the lang(5) man page by typing man 5 sd 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.

Environment variables that affect scripts are:

SW_CONTROL_DIRECTORY

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 (e.g. subscripts).

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_PATH

A PATH variable which defines a minimum set of commands available for use in a control script (e.g. /sbin:/usr/bin).

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_SESSION_OPTIONS

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 SW_SESSIONS_OPTIONS is made available to a request script, the targets option contains a list of software_collection_specs for all targets specified for the command. When the file pointed to by SW_SESSIONS_OPTIONS 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.

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.

Additional environment variables that affect scripts for swremove are:

PRE_UNIX95

This variable and the UNIX95 variable are exported with a value that forces "classic" behavior of swremove instead of UNIX95 behavior. For HP-UX 10.30 and later versions, this variable is set to "1".

SW_SESSION_IS_KERNEL

Indicates whether a kernel build is scheduled for the current install/remove session. A TRUE value indicates that the selected kernel fileset is scheduled for a kernel build and that changes to /stand/system are required. A null value indicates that a kernel build is not scheduled and that changes to /stand/system are not required.

The value of this variable is always equal to the value of SW_SESSION_IS_REBOOT.

SW_SESSION_IS_REBOOT

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 SW_SESSION_IS_KERNEL.

UNIX95

This variable, along with the PRE_U95 variable, is exported with a value that forces "classic" behavior of swremove instead of UNIX95 behavior. For the 10.30 or later release of HP-UX, this variable is cleared.

Signals

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

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:

  • The Managing HP-UX Software with SD-UX manual

  • Start the GUI or TUI, select the Help menu, then select the Keyboard... option to access the Keyboard Reference Guide.

RETURN VALUES

An interactive swremove session always returns 0. A non-interactive swremove session returns:

0

The software_selections were successfully removed.

1

The remove operation failed on all target_selections.

2

The remove operation failed on some target_selections.

DIAGNOSTICS

The swremove command writes to stdout, stderr, and to specific log files.

Standard Output

An interactive swremove session does not write to stdout. A non-interactive swremove session 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

An interactive swremove session does not write to stderr. A non-interactive swremove session writes messages for all WARNING and ERROR conditions to stderr.

Logging

Both interactive and non-interactive swremove sessions log summary events at the host where the command was invoked. They log detailed events to the swagent logfile associated with each target_selection.

Command Log

A non-interactive swremove session logs all stdout and stderr messages to the the logfile /var/adm/sw/swremove.log. Similar messages are logged by an interactive swremove session. The user can specify a different logfile by modifying the logfile option.

Target Log

A swagent process performs the actual remove operation at each target_selection. When removing installed software, the swagent logs messages to the file var/adm/sw/swagent.log beneath the root directory (e.g. / or an alternate root directory). When removing available software (within a depot), the swagent logs messages to the file swagent.log beneath the depot directory (e.g. /var/spool/sw).

  • The following paragraph applies only to HP OpenView Software Distributor.

You can view command and target log files using the sd or swjob command.

EXAMPLES

Preview the remove of the C and Pascal products installed at the local host:

swremove -p cc pascal

  • The following example applies only to HP OpenView Software Distributor.

Remove the C and Pascal products from several remote hosts:

swremove cc pascal @ hostA hostB hostC

Remove a particular version of HP Omniback:

swremove Omniback,l/opt/Omniback_v2.0

Remove the entire contents of a local depot:

swremove -d * @ /var/spool/sw

LIMITATIONS

  • The SD-UX version of swremove does not support the unconfiguration and removal of software products on remote targets.

  • Only the HP-UX version of swremove provides a GUI.

  • The swremove TUI is supported only on SD-UX.

    • The following PC information applies only to HP OpenView Software Distributor.

  • When removing software from a PC controller, swremove operates only on the available software stored in the PC depot (configured on the PC controller). Software installed on PC targets can be removed by packaging a remove action (using the PC console) and distributing that package to PC targets.

FILES

$HOME/.swdefaults

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 $HOME/.sw/defaults.

$HOME/.sw/defaults.hosts

Contains the user-specific default list of hosts to manage.

$HOME/.sw/sessions/

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

/usr/lib/sw/sys.defaults

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

/var/adm/sw/

The directory which contains all of the configurable and non-configurable data for SD. This directory is also the default location of log files.

/var/adm/sw/defaults

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

/var/adm/sw/defaults.hosts

Contains the system-wide default list of hosts to manage.

/var/adm/sw/getdate.templ

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

/var/adm/sw/products/

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

/var/spool/sw/

The default location of a target software depot.

PC FILES

  • The following applies only to HP OpenView Software Distributor.

...\SD\DATA\

The directory which contains all of the configurable and non-configurable data for SD.

...\SD\DATA\DEPOT\

The default location of a source and target PC depot.

AUTHOR

swremove was developed by the Hewlett-Packard Company.

SEE ALSO

sd(4), sd(5), swacl(1M), swagentd(1M), swask(1M), swconfig(1M), swgettools(1M), swinstall(1M), swjob(1M), swlist(1M), swmodify(1M), swpackage(1M), swpackage(4), swreg(1M), swverify(1M), the Managing HP-UX Software with SD-UX manual, the HP OpenView Software Distributor Administrator's Guide.

© Hewlett-Packard Development Company, L.P.