swremove(1M)

Set up the root, host, and template Access Control Lists (ACLs) on the remote machines to permit root access from the controller system. To do this, run the following command on each remote system:

/usr/lib/sw/mx/setaccess controller

NOTES:

swinstall, swcopy, and swremove have enhanced GUI interfaces for remote operations. Enable the enhanced GUIs by creating the .sdkey file on the controller. Use this command:

touch /var/adm/sw/.sdkey

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

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.

Operate on a depot rather than installed software.

Operates on an alternate root directory, which must be specified in the @ target_selections 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 Alternate Root Directory and Depot Directory heading in sd(5) for more information.)

Runs the command in interactive mode (Graphical User Interface). See the Interactive Operation and Remote Operation 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 swremove log file is not affected by this option.) Verbose output is controlled by the default verbose=x.

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.

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 /var/adm/sw/getdate.templ.

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.

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 -X option). Multiple -x options can be specified.

Read the session options and behaviors from option_file.

the system-wide default values.

the user-specific default values.

The location for SD logfiles and the default parent directory for the installed software catalog. The default value is /var/adm/sw for normal SD operations. When SD operates in nonprivileged mode (that is, when the run_as_superuser default option is set to true):

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 Software Distributor Administration Guide, available at the http://docs.hp.com web site.

See also the installed_software_catalog and run_as_superuser options.

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 value of true causes the target agent to automatically exit when appropriate. When set to false, 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 minutes 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 false, 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 true, 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 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.

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.

Controls automatic job removal. If the job is automatically removed, job information (job status or controller/agent log files) cannot be queried with swjob.

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 removal, swremove automatically selects that other software. If set to false, automatic selections are not made to resolve requisites.

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.

Determines whether SD commands create compressed INDEX and INFO catalog files when writing to target depots or roots. The default of false does not create compressed files. When set to true, SD creates compressed and uncompressed INDEX and INFO files. The compressed files are named INDEX.gz and INFO.gz, 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:

The uncompressed INDEX or INFO file is accessed by the source agent if any problem occurs when accessing, transferring, or uncompressing the INDEX.gz or INFO.gz 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 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.

Controls the handling of errors generated by scripts. If true, and a script returns an error, the swremove operation halts. An error message appears reporting that the execution phase failed. If false, all script errors are treated as warnings, and swremove 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.

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.

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 admin_directory 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 application or group of applications using a different IPD.

Caution: use a specific installed_software_catalog to manage a specific application. SD does not support multiple descriptions of the same application in multiple IPDs.

See also the admin_directory and run_as_superuser 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 Software Distributor Administration Guide, available at the http://docs.hp.com 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 swjob is invoked.

Adds numeric identification numbers at the beginning of SD logfile messages:

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.

This is the default command log file for the swremove 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 logdetail option.

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

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.

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 swagent.log and directory structure are not removed by default. If the swagent.log and directory should be removed, the remove_empty_depot_directory option must also be set to true. Useful to set to false if you want to retain existing depot ACLs for subsequent depot reuse.

Controls whether a depot's swagent.log file and directory are also removed when the depot itself is removed. The swagent.log and directory will be removed if this option is set to true, the remove_empty_depot option is set to true 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 (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.

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.

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:

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 Software Distributor Administration Guide, available at the http://docs.hp.com web site.

See also the admin_directory and installed_software_catalog options.

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 products, all_bundles, 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 select_local above). If there is more than one target selection, they must be separated by spaces.

Defines the default location of the alternate root directory.

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

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.

the system-wide default list of hosts

the user-specific default list of hosts

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.

Determines the locale to be used to override any values for locale categories specified by the settings of LANG or any environment variables beginning with LC_.

Determines the interpretation of sequences of bytes of text data as characters (e.g., 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 swlist. Used by all utilities when displaying dates and times in stdout, stderr, and logging.

Determines the time zone for use when displaying dates and times.

Holds the path to the Installed Products Database (IPD), relative to the path in the SW_ROOT_DIRECTORY environment variable. Note that you can specify a path for the IPD using the installed_software_catalog 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 (e.g. subscripts).

Holds the tag name of the control_file being executed. When packaging software, you can define a physical name and path for a control file in a depot. This lets you define the control_file with a name other than its tag and lets you use multiple control file definitions to point to the same file. A control_file can query the SW_CONTROL_TAG 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 SW_ROOT_DIRECTORY, this variable tells scripts where the product files are located.

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

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

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.

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.

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

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.

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.

A value of 1 indicates the SD command was invoked during an Operating System update. This variable is set by the update-ux command.

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.

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.

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