swinstall(1M)

The swinstall and swcopy commands support 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 by typing man X for a definition of these options.

Runs the command in interactive mode by invoking the Graphical User Interface (GUI). [Note: The GUI is only supported on HP-UX]. The SD-UX swinstall, swcopy, and swremove commands also support an interactive terminal user interface (text based) in which screen navigation is done with the keyboard (no mouse).

(Applies only to HP-UX 10.X.) Runs the command in linkinstall mode which makes software installed under a server's shared root available to a diskless client's private root (HP-UX only).

When run in the linkinstall mode, swinstall:

Mounts are created by examining the share_link product attribute. Not all products support linkinstall. Some products may be visible without creating a new mount if they reside under an old one.

Previews an install task by running the session through the analysis phase only.

(Optional) Causes the command to operate on target_selections that are alternate root directories (root filesystems other than /).

Note that you cannot use this option to relocate software during installation. You must use the l=location syntax in the software selection component.

Turns on verbose output to stdout. (The swinstall or swcopy logfile is not affected by this option.) Verbose output is enabled by default; see the verbose option below.

Specifies the pathname of an exported catalog which stores copies of the response file or files created by a request script (if -x ask=true or -x ask=as_needed). The response files are also stored in the Installed Products Database after the installation process is complete.

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.

(Applies only to HP OpenView Software Distributor.)

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

(Applies only to HP OpenView Software Distributor.)

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

Specifies the source depot (or tape) from which software is installed or copied. The default source type is directory. The syntax is:

[host][:][/directory] A host may be specified by its host name, domain name, or internet address. A directory must be specified by an absolute path.

Execute swinstall or swcopy based on the options and operands saved from a previous session, as defined in session_file. You can save session information from a command-line session with the -C session_file option.

(Applies only to HP OpenView Software Distributor.)

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.

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 automatically exits when appropriate. If 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 is used. The default of 10000 is slightly less than 7 days.

(Applies only to swinstall.) Prevents the installation of an older revision of fileset that already exists at the target(s). (Many software products do not support "downdating".) If set to true, the older revision can be installed.

(Applies only to swinstall.) Requires that the software products which are being installed 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.

(Applies only to swinstall.) Prevents the installation of another, independent version of a product when a version already is already installed at the target.

If set to true, another version of an existing product can be installed into a new location. Multiple versions can only be installed if a product is locatable. Multiple configured versions will not work unless the product supports it.

(Applies only to swinstall.) When ask=true, executes a request script which asks for a user response. If ask=as_needed, the swinstall command first determines if a response file already exists in the catalog specified in the -c option or source depot and executes the request script only when a response file is absent.

If set to ask=true, or ask=as_needed, you can use the -c catalog option to specify the pathname of an exported catalog to store copies of the response file or files created by the request script.

See swask(1M) for more information on request scripts.

(Applies only to swinstall.) Prevents the installation of software requiring a reboot from the non-interactive interface. If set to true, this software can be installed and the target system(s) will be automatically rebooted.

An interactive session always asks for confirmation before software requiring a reboot is installed.

(Applies only to swinstall.) Causes swinstall to remove the original files as they are updated. If an error occurs during the installation (e.g. network failure), then the original files are lost, and the installation must be re-tried.

If set to true, all files are saved as backup copies until all filesets in the current product loading are complete; then they are removed. At the cost of a temporary increase in disk space and slower performance, this allows for automatic recovery of the original filesets in that product if the load fails.

Controls automatic job removal of completed jobs. If the job is automatically removed, job information (job status or target logfiles) cannot be queried with swjob.

Install jobs to PCs cannot be automatically removed. They should not be removed until the job completes on all PC targets.

Automatically select dependencies when software is being selected. When set to true, and any software which has dependencies is selected for install, swinstall or swcopy makes sure that the dependencies are met. If they are not already met, they are automatically selected for you. If set to false, automatic selections are not made to resolve requisites.

Automatically selects the latest patches (based on superseding and ancestor attributes) for a software object that a user selects for a swinstall or swcopy operation. When set to false, the patches corresponding to the selected object are not automatically selected.

The patch_filter= option can be used in conjunction with autoselect_patches.

If true, bundles that are sticky are automatically installed or copied, along with the software it is made up of. If false, the software can be installed, or copied, without automatically including sticky bundles that contain it.

Provides the "codeword" needed to unlock protected HP CD-ROM software.

Some HP software products are shipped on CD-ROM as "protected" products. That is, they cannot be installed or copied unless a "codeword" and "customer ID" are provided. The codeword is found on the CD-ROM certificate which you received from HP. You may use this default specification on the command line or the SD-UX Interactive User Interface to enter the codeword.

This default stores the codeword for future reference, and you need to enter the codeword only once. If you purchase a new HP product and a previous codeword has already been entered for that CD-ROM, just enter the new codeword as usual and the codewords will be merged internally.

NOTE: For HP-UX B.10.10 and later systems, SD searches the .codewords file on the server that is providing protected software to other hosts. It looks for valid customer_id/codeword pairs. In doing so, SD eliminates the need to enter codewords and customer_ids on every host that is "pulling" the software.

To properly store the customer_id/codeword for a CD-ROM, run swinstall -p or swcopy -p on the host serving the CD-ROM. After the codeword has been stored, clients installing or copying software using that host and CD-ROM as a source will no longer need a codeword or customer_id.

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][:][/directory]

The controller_source_option supports the same syntax as the -s source option. This option has no effect on which sources the target uses and is ignored when used with the Interactive User Interface.

Causes the agent to create the target directory if it does not already exist. If set to false, a new target directory is not created. This option can prevent the erroneous creation of new target depots or new alternate root directories.

(Applies only to swcopy.) If set to true, files not already compressed are compressed before transfer from a source. This enhances performance on slower networks for swinstall and swcopy, and results in smaller depots for swcopy, unless uncompress_files is also set to true.

This number, also printed on the Software Certificate, is used to "unlock" protected software and restrict its installation to a specific site or owner. It is entered using the -x customer_id= option or by using the Interactive User Interface. The customer_id can be used on any HP-UX 10.0X compatible HP9000 system.

(Applies only to swinstall.) Causes swinstall to automatically configure the software_selections after they are installed. When an alternate root directory is specified, swinstall never performs the configuration task, since only hosts using the software should be configured. If set to true, this option allows configuration to be deferred even when the root directory is /.

An additional version of a product will not be configured if another version is already configured. The swconfig command must be run separately.

Defines the default location of the source depot. This syntax can be host:path. The -s option overrides this value.

(Applies only to swcopy.) Defines the default location of the target depot.

Requires that all dependencies specified by the software_selections be resolved either in the specified source, or at the target_selections themselves.

The swinstall and swcopy commands will not proceed unless the dependencies have also been selected or already exist at the target in the correct state (INSTALLED or AVAILABLE). This prevents unusable software from being installed on the system. It also ensures that depots contain usable sets of software.

If set to false, dependencies are still 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 installation or configuration to fail.

Prevents the command from proceeding past the analysis phase if the disk space required is beyond the available free space of the impacted filesystem(s). If set to false, the install or copy operation uses the filesystems' minfree space and may fail because it reaches the filesystem's absolute limit.

(Applies only to swinstall.) Prevents swinstall from proceeding past the kernel build phase if the kernel build processes fail. If set to false, the install operation continues (without suspension if in the interactive mode) despite failure or warnings from either the system preparation process or the kernel build process.

(Applies only to swinstall.) By default, if a fileset checkinstall script fails (i.e. returns with an exit code 1), that fileset is not installed. If a product checkinstall script fails, no filesets in that product are installed. If set to false, the install proceeds even if a checkinstall script fails.

(Applies only to swinstall.) Defines the polling interval, in minutes, used by the daemon. It specifies how often a PC install job is polled to cache the progress of remote targets on the controller.

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. The default value is to have no title. If a title is specified, it should be enclosed in quotes.

(Applies only to swcopy.) Specifies the POSIX layout_version to which the SD commands conform when writing distributions and swlist output. Supported values are "1.0" (default) and "0.8".

SD object and attribute syntax conforms to the layout_version 1.0 specification of the IEEE POSIX 1387.2 Software Administration standard. SD commands still accept the keyword names associated with the older layout version, but you should use layout_version=0.8 only to create distributions readable by older versions of SD.

See the description of the layout_version option in sd(5) for more information.

Controls the amount of detail written to the logfile. When set to true, this option adds detailed task information (such as options specified, progress statements and additional summary information) to the logfile. This information is in addition to log information controlled by the loglevel option.

See loglevel=1 and the sd(5) manual page by typing man 5 sd for more information.

This is the default command log file for the swinstall 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 logdetail=false and the sd(5) manual page for more information.) A value of:

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

(Applies only to swinstall.) If set to true, software selection is done by locating filesets on the source that match the target system's installed filesets. If multiple targets are specified, the first in the list is used as the basis for selections.

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

(Applies only to swinstall.) This option can be used in conjunction with os_release to specify the desired OS name during an HP-UX update. The os_name option should only be specified from the command line. Refer to the SD readme file for correct syntax. You can display the readme file by entering:

swlist -a readme -l product SW-DIST

(Applies only to swinstall.) This option can be used in conjunction with os_name to specify the desired OS release during an HP-UX update. The os_release option should only be specified from the command line. Refer to the SD readme file for correct syntax. You can display the readme file by entering:

swlist -a readme -l product SW-DIST

This option can be used in conjunction with the autoselect_patches or patch_match_target options to filter the selected patches to meet the criteria specified by software_specification. The default value of this option is *.*.

If set to true, this option selects the latest patches (software identified by the is_patch=true attribute) that correspond to software on the target root or depot.

The patch_filter= option can be used in conjunction with patch_match_target.

(Applies only to swinstall) Saves the original versions of files modified by patches, which permits the future rollback of a patch. Patched files are saved to /var/adm/sw/save. When set to false, patches cannot be rolled back (removed) unless the base software modified by the patch is removed at the same time.

To commit a patch by removing the corresponding saved files, use the swmodify command's patch_commit option.

Defines the polling interval, in seconds, used by the interactive GUI or TUI of the controller. It specifies how often each target agent is 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.

(Applies only to swcopy.) Do not copy a fileset that is already available on the target at the same version. If recopy=true, copy the fileset in any case.

(Applies only to swcopy.) Causes swcopy to register a newly created depot with the local swagentd. This action allows other SD commands to automatically "see" this depot. If set to false, a new depot is not automatically registered. It can be registered later with the swreg command.

(Applies only to swinstall.) Causes alternate roots to be registered during swinstall. These can be listed with swlist.

When re-installing or re-copying an existing revision of a fileset, this option causes that fileset to be skipped, i.e. not re-installed. If set to true, the fileset is re-installed or re-copied.

Causes all the files in a fileset to always be reinstalled or recopied, even when the file already exists at the target and is identical to the new file. If set to false, files that have the same checksum (see next option), size and timestamp are not re-installed. This check enhances performance on slow networks or slow disks.

This option affects the operation when the reinstall_files option is set to false. It causes the checksums of the new and old file to be computed and compared to determine if the new file should replace the old one. (The checksum is slower, but is a more robust way to check for files being equivalent.) If set to false, the checksums are not computed, and files are reinstalled or not based only on their size and timestamp.

(Applies to swcopyonly) Controls whether swcopy automatically removes obsolete filesets from target products in the target depot. If set to true, swcopy removes obsolete filesets from the target products that were written to during the copy process. Removal occurs after the copy is complete. Filesets are defined as obsolete if they were not part of the most recent packaging of the product residing on the source depot.

Defines the number of times a lost source connection is retried during file transfers in swinstall or swcopy. A lost connection is one that has timed out. When used in conjunction with the rpc_timeout option, the success of installing over slow or busy networks can be increased. If set to zero, any rpc_timeout to the source causes the task to abort. If set from 1 to 9, the install of each fileset is attempted that number of times. The reinstall_files option should also be set to false to avoid installing files within the fileset that were successfully installed.

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) man page by typing 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.

If no target_selections are specified, select the default root directory / (swinstall), or the default target_directory (swcopy), at the local host as the target of the command.

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 as the default level for the software listing in the GUI. It can be set to all_bundles, products, or a bundle category tag (to indicate to show only bundles of that category). For HP OpenView Software Distributor the default value is products.

Defines the default location of the source CD-ROM. This syntax can be host:path.

Defines the default location of the source tape, usually the character-special file of a local tape device. If the host:path syntax is used, the host must match the local host. The -s option overrides this value.

Defines the default source type: cdrom, directory, or tape. The source type derived from the -s option overrides this value.

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.

(Applies only to swcopy.) If set to true, files being transferred from a source are uncompressed before swcopy store them on the target depot.

Empowers each target agent to use its own, configured alternate source, instead of the one specified by the user. If false, each target agent uses the same source (the source specified by the user and validated by the command). If true, each target agent uses its own configured value for the source.

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

Prevents the installation or copying of files to a target which exists on a remote filesystem. All files destined for a remote filesystem are skipped.

If set to true and if the superuser has write permission on the remote filesystem, the remote files are installed or copied.

the system-wide default list of hosts

the user-specific default list of hosts

the system-wide default list of patch filters.

the user-specific default list of patch filters.

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.

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

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 to 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 is normally unset. If it is set, the actions necessary for preparing the system file /stand/system cannot be accomplished from within the postinstall scripts, but instead must be accomplished by the configurescripts. This occurs whenever software is installed to a directory other than /, such as for a cluster client system. This variable should be read only by the configure and postinstall scripts of a kernel fileset. The swinstall command sets these environment variables for use by the kernel preparation and build scripts.

This variable is normally unset. If it is set, the swinstall session is being run as the back end of an initial system software installation ("cold" install).

The path to the kernel. The default value is /stand/vmunix, defined by the swagent option or kernel_path.

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 values of this variables is always equal to the value of SW_SESSION_IS_KERNEL.

The path to the kernel's system file. The default value is /stand/system.

The swinstall and swcopy commands log all stdout and stderr messages to the the logfile /var/adm/sw/swinstall.log (/var/adm/sw/swcopy.log). Similar messages are logged by an interactive swinstall and swcopy session. The user can specify a different logfile by modifying the logfile option.

A swagent process performs the actual install or copy operation at each target_selection. For install tasks, the swagent logs messages to the file var/adm/sw/swagent.log beneath the root directory (e.g. / or an alternate root directory). For copy tasks, the swagent logs messages to the file swagent.log beneath the depot directory (e.g. /var/spool/sw).

If both source and target machine are updated to HP-UX version 10.30 or later, the system administrator at the source depot machine can track which user pulls which software from a depot on the source machine and when the software is pulled. (Note that a user running swinstall/swcopy from a target machine cannot set this option; only the administrator of the source depot machine can set it. See the source_depot_audit option in the swagent(1M) man page.)