Options Listed Alphabetically

admin_directory=/var/adm/sw (for normal mode) admin_directory=/var/home/LOGNAME/sw (for nonprivileged mode)

The location for logfiles and the default parent directory for the installed software catalog. The default value is /var/adm/sw for normal operations.

For nonprivileged mode (that is, when the run_as_superuser default option is set to true):

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-UX, see Chapter 12: “Nonprivileged SD ”.

See also the installed_software_catalog and run_as_superuser options.

Applies to all commands except swagent, swagentd, and install-sd.

agent=/usr/lbin/swagent

This is the default location of the executable invoked to perform agent tasks.

Applies to swagentd.

agent_auto_exit=true

Causes the target agent to automatically exit after execute phase, or after a failed analysis phase. This is forced to false when the controller is using an interactive UI, or when -p (preview) is used.

Enhances network reliability and performance.

The default is true. The target agent automatically exits when appropriate.

If set to false, the target agent does not exit until the controller explicitly ends the session.

Applies to swconfig, swcopy, swinstall, swremove, and swverify.

agent_timeout_minutes=10000

Causes a target agent to exit if it has been inactive for the specified time.

You can use this default value to make target agents more quickly detect lost network connections. RPC typically detects lost connections very quickly, but it can take as long 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 and 60 minutes is suitable. More than 60 minutes is recommended when you use the GUI.

The default is 10,000 minutes, slightly less than seven days.

Applies to swcopy, swinstall, swlist, swremove, and swverify.

allow_downdate=false

Normally set to false, so installing an older version of software than already exists is disallowed. This keeps you from installing older versions by mistake. Additionally, many software products do not support this “downdating.”

If set to true, a previous version can be installed but SD-UX issues a warning message.

Applies to swinstall.

allow_incompatible=false

Normally set to false, only software compatible with the local host is allowed to be installed or configured.

If set to true, no compatibility checks are made.

Applies to swconfig, swinstall, and swverify.

allow_large_files=false

Specifies if a file with size greater than or equal to 2 gigabytes can be packaged/modified.

If false (default), prohibit the packaging/modifying of a file with size greater than or equal to 2 gigabytes.

If true, permit the packaging/modifying of a file with size greater than or equal to 2 gigabytes. If the file is packaged or modified in a depot, then the depot can only be used by HP-UX 11i v1 (B.11.11) December 2005 SD, 11i v2 (B.11.23) December 2005 SD, 11i v3 (B.11.31) SD, and newer releases of SD. Those releases of SD support packaging and installing a large file up to 2 terabytes (2048 gigabytes).

Applies to swpackage and swmodify.

allow_large_serial_depot=false

Specifies if swpackage is allowed to create a serial depot greater than 2 gigabytes.

If false (default), prohibit the creation of a serial depot greater than 2 gigabytes.

If true, permit the creation of a serial depot greater than 2 gigabytes. The depot is only usable by HP-UX 11i v1 (B.11.11) December 2004 SD, 11i v2 (B.11.23) March 2005 SD, 11i v3 (B.11.31) SD, and newer releases of SD.

Applies to swpackage.

allow_multiple_versions=false

Normally set to false, so installed or configured multiple versions (for example, the same product, but a different revision, installed into a different location) are disallowed. Even though multiple installed versions of software are supported if the software is locatable, multiple configured versions do not work unless the product supports it.

If set to true, you can install and manage multiple versions of the same software.

Applies to swconfig, swinstall, and swverify.

allow_partial_bundles=true

Determines whether to process partial bundles without issuing warnings or notes to log files.

If true (default), swpackage packages what is available in the source PSF, ignoring missing or ambiguous bundle contents. Bundles are wrappers around products, so you must make sure the bundle contents are placed in the resulting depot, if they are not in the PSF. Otherwise, the missing/ambiguous contents will not affect the system after installation.

If false, swpackage expects all the bundle contents to be present in the source PSF and to be unique. Every content that is ambiguous or missing gets a NOTE and every bundle that has a missing or ambiguous content gets a WARNING.

Applies only to swpackage.

allow_split_patches=false

Controls the ability to install or copy part of a patch. Use this option only to resolve critical problems with the assistance of your HP support representative.

When set to the default value of false, installation or copy of a single fileset from a multi-fileset patch automatically includes other, “sibling” filesets that are appropriate, based on the target’s ancestor attributes. This behavior applies to any filesets you select directly and to filesets automatically selected to meet dependencies for a patch filesets. Likewise, removing a fileset when this option is false causes sibling filesets to be removed at the same time.

When set to true, this option allows a single patch fileset to be installed, copied, or removed to or from a target without dragging along sibling filesets (that is, filesets that have an ancestor on the target that would usually be loaded if this option was set to false). This allows a target to contain a patch that has been “split” into component filesets. This can create harmful results if one fileset in a sibling group is updated while others remain at an earlier release. Running a swlist on the target after using this option may show more than one active patch at a time. This makes your system more difficult to maintain and troubleshoot.

Applies to swcopy, swinstall, and swremove.

alternate_source=

Syntax is host:path, used when use_alternate_source default is set to true.

By default, this option is not defined. If the host portion is not specified, the local host is used. If the path is not specified, the path sent by the command is used. See the use_alternate_source option.

The protocol sequence and endpoint given by the option rpc_binding_info_alt_source are used when the agent attempts to contact an alternate source depot.

Applies only to swagent.

ask=true

Executes a request script, which asks for a user response.

The ask option has three possible values;

See “Requesting User Responses (swask)” for more information on the swask command and writing request scripts.

Applies to swask, swconfig, and swinstall.

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.

Applies only to swremove.

autoreboot=false

Normally set to false, indicating that installation of software requiring a reboot is not allowed from the command line.

If set to true, this option allows installation or removal of the software and automatically reboots the local host.

If the auto_kernel_build option is set to true, this option must also be set to true.

Applies to swinstall and swremove.

autorecover=false

This option permits automatic recovery of original filesets if an installation error occurs. The cost is a temporary increase in disk space and slower performance. The default value of false causes swinstall to overwrite original files as a fileset is updated. If an error occurs during the installation (e.g. network failure), then the original files are lost, and you must reinstall the fileset.

If set to true, all files are saved as backup copies until the current fileset finishes loading. If an error occurs during installation, the fileset’s original files are restored, and swinstall continues to the next fileset in the product or the product postinstall script.

When set to true, this option also affects scripts. For example, if a preinstall script fails, this option causes the corresponding unpreinstall script to execute.

Applies only to swinstall.

autorecover_product=false

By default, swinstall overwrites old files. If a load error occurs, the product is marked “corrupt” and you must retry the install.

When this option is true, swinstall saves all product files as backups until the product finishes loading successfully, then removes the backups. This lets swinstall automatically recover files if the load fails. The trade-off is a temporary increase in disk space use and slower performance

Note: The autorecover operation does not work properly if any software has pre-install scripts that move or remove files. This includes HP-UX operating system files.

Applies only to swinstall.

autoremove_job=false

SD-UX stores small amounts of information (such as job status or controller or agent logfiles) about each job. You can display this information from the Job Browser or with swjob. Running very large numbers of jobs may take up significant disk space.

Setting this option to true prevents SD-UX from storing the job information. The trade-off is that you can no longer display the job information.

This option is automatically set to true when run_as_superuser is set to true.

Applies to swconfig, swcopy, swinstall, swremove and swverify.

autoselect_dependencies=true

Causes SD-UX to automatically select requisites when software is being selected. At the default value of true, dependent software is automatically selected when you select software with requisites. If set to false, automatic selections are not made to resolve requisites.

The autoselect_minimum_dependencies option is ignored when this option is set to false.

Applies to swconfig, swcopy, swinstall and swverify.

autoselect_dependents=false

Causes swconfig and swremove to automatically select dependents when software is being selected. When set to true, and any software on which other software depends is selected, SD-UX makes sure that the dependents are also selected. If they are not already selected, they are automatically selected for you. If set to false, dependents are not automatically selected.

A dependent fileset has established either a prerequisite, corequisite, or exrequisite on the selected fileset. The default value of false prevents automatic selection of dependent software. Specifying true causes SD-UX to automatically select dependent software.

Applies to swconfig and swremove.

autoselect_minimum_dependencies=false

Controls the automatic selection (marked for ask/config/copy/install/verify) of the first left-most dependency in a list of OR dependencies that satisfies a requisite, when another dependency in the list that also satisfies the requisite is explicitly selected by the user.

This option is ignored when the autoselect_dependencies option is set to false.

If false (default), the first left-most dependency in a list of OR dependencies that satisfies a requisite is automatically selected, even when another dependency in the list that also satisfies the requisite is explicitly selected.

If true, the first left-most dependency in a list of OR dependencies that satisfies a requisite is not automatically selected when another dependency in the list that also satisfies the requisite is explicitly selected.

Applies to swask, swconfig, swcopy, swinstall, and swverify.

autoselect_patches=true

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.

You can use the patch_filter= option in conjunction with autoselect_patches.

Applies to swask, swinstall and swcopy.

autoselect_reference_bundles=true

If true, a bundle that is referenced is installed, copied, or removed along with the software from which the reference is made.

Applies to swcopy, swinstall and swremove.

check_contents=true

Normally set to true, verify mtime, size and cksum of files.

If false, the software can be installed without the bundle that contains it.

Applies only to swverify.

check_contents_uncompressed=false

When a file is compressed, SD-UX uses it with check_contents and check_contents_use_cksum to determine whether or not to compute and verify the uncompressed checksum and size of a compressed file. (This option is ignored if the file is not compressed.)

Since the timestamp of uncompressed contents is meaningless, this option verifies only the timestamp of the file, whether it is compressed or not.

If set to true and the file is compressed, SD-UX uncompresses the file into memory and computes the checksum and size of the uncompressed contents. Then, the checksum and size of the compressed file and the checksum and size of the uncompressed contents are verified.

If check_contents_use_cksum=false, only the compressed and uncompressed sizes are verified, not the checksums.

Applies only to swverify.

check_contents_use_cksum=true

Normally true, calculates the checksum of the file being verified, checking the timestamp, size, and checksum.

If false, turns off the checksum calculation. If check_contents is set to true, timestamp and size checking is still performed.

Applies only to swverify.

check_permissions=true

Normally set to true, verify owner, uid, group, gid and mode attributes of files.

Applies only to swverify.

check_requisites=true

Normally set to true, verify that the prerequisites and corequisites of filesets are being met.

Applies only to swverify.

check_scripts=true

Normally set to true, run the vendor-supplied verify scripts when verifying software.

Applies only to swverify.

check_volatile=false

When set to true, swverify verifies installed files that have the is_volatile attribute set. By default, installed volatile files do not have their attributes verified because they are intended to be modified by the customer.

Applies only to swverify.

codeword=

Lets you to enter a codeword for the HP-UX licensing procedure. Once entered you need not re-enter the codeword. See “Working with Protected Software ” for more information.

Applies to swcopy, swinstall and swlist.

compress_cmd=/usr/contrib/bin/gzip

Specifies the command called by the source agent to compress files before installing, copying, or packaging.

If you set the compression_type option to a value other than gzip or compress, you must change this path.

Applies to swagent and swpackage.

compress_files=false

Controls file compression during transfer. When set to false, files are not compressed before transfer from a remote source.

If set to true, SD-UX compresses files before network transfer if they’re not already compressed. For swinstall, the files are uncompressed after network transfer.

If set to true during swcopy or swpackage, the resulting depots are smaller, unless you also set uncompress_files to true.

Applies to swcopy, swinstall and swpackage.

compress_index=false

Enhances performance on slower networks, although it may increase disk space usage due to a larger Installed Products Database and depot catalog. The default of false does not compress INDEX and INFO files. When set to true, INDEX and INFO files are compressed.

Applies to swinstall, swcopy, swpackage, swmodify, swconfig, and swremove.

compression_type=gzip

Defines the default compression type used by the agent (or set by swpackage) when it compresses files during or after transmission.

If uncompress_files is set to false, the compression type is recorded for each file compressed so that the correct uncompression can later be applied during a swinstall, or a swcopy with uncompress_files set to true.

The compress_cmd specified must produce files with the compression_type specified.

The uncompress_cmd must be able to process files of the compression_type specified unless the format is gzip which is uncompressed by the internal uncompressor (funzip). To use gzip you must load the SW-DIST.GZIP fileset (which is optional freeware). If the SW-DIST.GZIP fileset is loaded, then you may set the compression options as follows:

compress_cmd=/usr/contrib/bin/gzip

uncompress_cmd=/usr/contrib/bin/gunzip

compression_type=gzip

Applies to swpackage and swagent.

config_cleanup_cmd=/usr/lbin/sw/config_clean

Defines the script called by the agent to perform release-specific configure cleanup steps.

Applies only to swagent.

control_files=

When adding or deleting control file objects, this option lists the tags of those control files. There is no supplied default. (Control file objects being added can also be specified in the given product specification file.)

If there is more than one tag, they must be separated by white space and surrounded by quotes.

Applies only to swmodify.

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 an Interactive User Interface.

Applies to swconfig, swcopy, swinstall, swremove and swverify.

create_target_acls=true

Normally set to true, this default determines whether swpackage creates Access Control Lists (ACLs) in the depot.

If you set this option to false as superuser, ACLs for each new product being packaged (and for the depot, if it is new) are not created.

When another user invokes swpackage, it always creates ACLs in the distribution depot. This default has no impact on the ACLs that already exist in the depot. The swpackage command never creates ACLs when software is packaged onto a distribution tape.

Applies only to swpackage.

create_target_path=true

Normally set to true, creates the target directory if it does not already exist.

If false, target directory is not created. This option can be used to avoid creating new depots by mistake.

Applies to swcopy and swinstall.

create_time_filter=0

Controls time settings for cumulative source depots. The default of zero includes all bundles, products, subproducts, and filesets in the source depot as candidates for selection (and autoselection of dependencies and patches), based on the software selections and other options. When set to a time (specified as seconds from epoch), only bundles, products, and filesets (and the subproducts in the product) with a create_time less than or equal to the specified value are available for selection (or autoselection).

To list the create_time of bundles, products and filesets, use:

swlist -a create_time -a create_date

Applies to swlist, swcopy, and swinstall.

customer_id=

This number, printed on the Software Certificate, “unlocks” protected software and restricts installation to a specific site or owner. You can enter the number with the -x customer_id=option or by using the Interactive User Interface. See thecodeword option for more information.

Applies to swinstall, swcopy, swlist.

defer_configure=false

Controls the automatic running of configure scripts after swinstall software selections are installed. The default value of false allows swinstall to automatically run configure scripts. When set to true, swinstall does not run configure scripts. To configure the software later, you must run the swconfig command.

Applies only to swinstall

distribution_source_directory=/var/spool/sw

Defines the default source depot when the value for the source_type option is directory. You can also use the host:path syntax. The -s option overrides this default.

Applies to swcopy, swinstall, and swpackage.

distribution_target_directory=/var/spool/sw

Defines the default distribution directory of the target depot. The target_selection operand overrides this default.

Applies to swacl, swcopy, swlist, swmodify, swpackage, swreg, swremove and swverify.

distribution_target_serial=/dev/rmt/0m

Defines the default location of the target tape device file. The target_selection operand overrides this default.

Applies only to swpackage.

enforce_dependencies=true

When set to true, SD-UX enforces dependencies. swinstall, swcopy, and swconfig do not proceed unless necessary dependencies can be selected, or already exist in the proper state (installed, configured, or available). This prevents SD-UX from installing or copying unusable software. This option also prevents swremove from removing dependent software.

When set to false, SD-UX checks dependencies but does not enforce them. Corequisite dependencies, if not enforced, may keep the software from working properly. Prerequisite dependencies, if not enforced, may cause the installation or configuration to fail.

Applies to swconfig, swcopy, swinstall, swremove and swverify.

enforce_dsa=true

When set to the default value of true, SD-UX does not proceed if the disk space required for a software operation is more than the available free space. You can use this option to allow installation into minfree space, or to attempt an install, copy, or package operation even though it may fail because the disk reaches its absolute limit.

If set to false, space checks are still performed but a warning is issued that the system may not be usable if the disk fills past the minfree threshold. An installation will fail if you run out of disk space.

Applies to swcopy, swinstall and swpackage.

enforce_kernbld_failure = true

Controls whether or not a failure in either of the kernel build steps (system_prep and mk_kernel) is fatal to the install session. A failure to build a kernel causes the install process to exit if in non-interactive mode, or to suspend if in an interactive mode.

If set to false, a failure return from a kernel build process is ignored, and the install session proceeds. The currently running kernel remains in place.

Applies only to swinstall.

enforce_locatable=true

When set to the default value of true, this option generates an error if a command tries to relocate a non-relocatable fileset. (Relocatable filesets are packaged with the is_relocatable attribute set to true.) When set to false, the usual error handling process is overridden, and SD-UX permits the command to relocate the fileset.

Note that although this option is defined for swverify, there is no swverify behavior associated with the option.

Applies to swinstall and swverify.

enforce_scripts=true

Controls the handling of errors generated by scripts. If true, and a script returns an error, the command halts, and an error message appears reporting that the execution failed. If false, script-generated errors are treated as warnings, and the command attempts to continue. A warning message appears and reports that the command was successful. Where appropriate, the message identifies the phase in which the error occurred (configure/unconfigure, preinstall/postinstall, preremove/postremove, etc.).

Applies to swask, swconfig, swinstall and swremove.

files=

When adding or deleting file objects, this option can list the path names of those files. There is no supplied default. File objects being added can also be specified in the given product specification file.

If there is more than one path name, they must be separated by white space and surrounded by double-quotes.

Applies only to swmodify.

fix=false

Controls whether or not to run vendor-specific scripts to correct and report problems on installed software. Fix scripts can create missing directories, correct file modifications (mode, owner, group, major, minor), and recreate symbolic links.

If false (default), fix scripts are not run.

If true, fix scripts are run.

Applies to swverify.

follow_symlinks=false

Do not follow symbolic links that exist in the packaging source; instead, package them as symlinks.

Applies only to swpackage.

include_file_revisions=false

Normally set to false, controls whether swpackage includes each source file’s revision attribute in the product(s) being packaged. Because this operation is very time consuming, the revision attributes are not included by default.

A value of true for this keyword causes swpackage to execute the what and possibly the ident commands (in that order) to try to determine a file’s revision.

Applies only to swpackage.

install_cleanup_cmd= /usr/lbin/sw/install_clean

The script called by the agent to perform release-specific install cleanup steps immediately after the last postinstall script has been run. For an OS update, this script should at least remove commands that were saved by the install_setup script.

Applies only to swagent.

install_setup_cmd=/usr/lbin/sw/install_setup

Defines a script called by the agent to perform release-specific install preparation. For an OS update, this script should copy commands needed for the checkinstall, preinstall, and postinstall scripts to an accessible location while the OS updates the system commands.

This script is executed before any kernel filesets are loaded.

Applies only to swagent.

installed_software_catalog=products

Defines the directory path where the Installed Products Database (IPD, information describing the installed software) is stored. When set to an absolute path, this option defines the location of the IPD. When this option contains a relative path, the controller appends the path to the path 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-UX does not support multiple descriptions of the same application in multiple IPDs.

See also the admin_directory option.

Applies to swacl, swask, swconfig, swinstall, swlist, swmodify, swremove, and swverify.

job_title=

When running large numbers of jobs, you may want to add more information to help you identify a specific job. Providing a value for this lets you add an ASCII string that will be displayed along with the ID and other job attributes when you invoke swjob or the job browser.

Applies to swconfig, swcopy, swinstall, swremove, and swverify.

kernel_build_cmd=/usr/sbin/mk_kernel

This is the script called by the agent for kernel building.

Applies only to swagent.

kernel_path=/stand/vmunix

The path to the system’s bootable kernel. It is passed to the kernel_build_cmd via the SW_KERNEL_PATH environment variable.

Applies only to swagent.

layout_version=1.0

Specifies the POSIX layout version to which the SD-UX commands conform when writing distributions and swlist output. Supported values are 1.0 (default) and 0.8. SD-UX for HP-UX version 11.10 and later can read or write either version.

SD-UX object and attribute syntax conforms to layout version 1.0 of the IEEE Standard 1387.2, Software Administration (POSIX). SD-UX still accepts the keyword names associated with the older layout version, but you should only use layout version 0.8 to create distributions readable by older versions of SD-UX.

Layout version 1.0 adds significant functionality not recognized by systems supporting only version 0.8, including:

In addition to adding new attributes and objects, layout version 1.0 changes the following preexisting 0.8 objects and attributes:

Applies to swcopy, swlist, swmodify and swpackage.

level=

Specifies a software level for swacl, swlist and swreg.

For swlist, this option lists all objects down to the specified level. Both the specified levels and the depth of the specified software_selections control the depth of the swlist output. The supported software levels are:

The supported depot and root levels are:

For swacl, this option specifies the level of ACLs to view or modify:

For swreg, this option defines the level of object to register or unregister.

Applies to swacl, swlist, and swreg.

log_msgid=0

Adds numeric identification numbers to the beginning of SD-UX log file messages:

Applies to swconfig, swcopy, swinstall, swmodify, swpackage, swreg, swremove, and swverify.

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.

Table A-2 shows the possible combinations of loglevel and logdetail options.

Applies to swconfig, swcopy, swinstall, swreg, swremove and swverify.

logfile=/var/adm/sw/<command>.log

This is the default controller log file for each command. The agent log files are always located relative to the target depot or target root: /var/spool/sw/swagent.log and /var/adm/sw/swagent.log, respectively.

Applies to all commands except swacl, swlist and swjob.

loglevel=1

This option controls the log level for events logged to the command log file, the target agent log file and the source agent log file by prepending identification numbers to SD-UX log file messages. This information is in addition to the detail controlled by the logdetail option. A value of:

Applies to swconfig, swcopy, swinstall, swmodify, swpackage, swremove and swverify.

match_target=false

If set to true, forces selection of filesets from the source that match filesets already installed on the target system.

Filesets on the source which specify an installed fileset as an “ancestor” will be selected.

This option overrides any other software selections.

Selections cannot be ambiguous.

Applies only to swinstall.

max_agents=-1

The maximum number of agents that are permitted to run simultaneously. The value of -1 means there is no limit.

Applies only to swagentd.

max_targets=25

When set to a positive integer, this option limits the number of concurrent install or copy operations to the number specified. As each copy or install operation completes, another target is selected and started until all targets are completed.

Server and network performance determines the optimal setting; a recommended starting point is 25 (the default value). If you set this option to a value of less than one, SD-UX attempts to install or copy to all targets at once.

Applies to swcopy and swinstall.

media_capacity=1330

If creating a distribution tape or multiple-directory media such as a CD-ROM, this keyword specifies the capacity of the tape in one million byte units (not Mbytes). This option is required if the media is not a DDS tape or a disk file. Without this option, swpackage sets the size to the default of 1,330 million bytes for tape or to the amount of free space on the disk up to minfree for a disk file.

SD-UX uses the same format across multiple directory media as it does for multiple serial media, including calculations of the correct size based partitioning of filesets and setting of the media_sequence_number attributes.

Applies only to swpackage.

media_type=directory

Defines the type of distribution to create. The recognized types are directory and tape. Without this option, swpackage creates a distribution directory (depot) by default.

Applies only to swpackage.

minimum_job_polling_interval=1

Defines how often, in minutes, the daemon will “wake up” and scan the job queue to determine if any scheduled jobs need to be initiated or if any active jobs need their remote target status cached locally.

If set to 0, no scheduled jobs will be initiated, and no caching of active jobs will occur.

Applies only to swagentd.

mount_all_filesystems=true

Normally set to true, the commands automatically try to mount all file systems in the file system table (/etc/fstab) at the beginning of the analysis phase and make sure that all those file systems are mounted before proceeding.

When set to false, no additional file systems are mounted.

Applies to swconfig, swcopy,swinstall, swremove, swverify.

mount_cmd=/sbin/mount

Specifies the command called by the agent to mount all file systems.

Applies only to swagent.

objects_to_register=

Defines the default objects to register or unregister. If there is more than one object, they must be separated by spaces.

There is no supplied default. See also select_local.

Applies only to swreg.

one_liner=<attributes>

Defines the attributes listed in the non-verbose listing.

If there is more than one attribute, they must be separated by a space and surrounded by quotes.

one_liner="revision size title"

You must choose which attributes (that is, revision, size, title, etc.) a default listing of software should use. Note: the tag attribute is always displayed for bundles, products, subproducts and filesets; the path is always displayed for files.

Any attributes may be chosen but a particular attribute may not exist for all applicable software classes (bundle, product, subproduct, fileset). For example, the software attribute, title is available for bundles, products, subproducts and filesets, but the attribute architecture is only available for products and filesets.

In the absence of the -v or -a option, swlist displays one_liner information for each software object (bundles, products, subproducts and filesets).

Applies only to swlist.

os_name

Specifies fileset selection for an HP-UX update. (This option should always be used with the os_release option.) You must specify this option from the command line or when invoking the swinstall GUI.

This options has the following syntax:

os_name=operating_system:width

Applies only to swinstall.

os_release

Specifies fileset selection for an HP-UX update. (This option should always be used with the os_name option.) You must specify this option from the command line or when invoking the swinstall GUI.

This options has the following syntax:

os_release=release

release specifies the HP-UX release. Values include:

Applies only to swinstall.

package_in_place=no

Setting this option to yes causes swpackage to build the products such that the depot does not actually contain the files that make up a product. Instead, the depot references the original source files used to build a product. This lets you package products in a development or test environment without consuming the extra disk space required to create a distribution depot.

Applies only to swpackage.

patch_commit=false

Commits a patch by removing files saved for patch rollback. The default value is false. When set to true, this option removes the saved files for the patches specified in the software selections for the command. Once you have run this option on a patch, you cannot remove the patch unless you remove the associated base software that the patch modified.

Applies only to swmodify.

patch_filter=*.*

Specifies a software_specification for a patch filter.

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

Note that patch filtering is overridden if you specify software with a command or if you use the \* wildcard to select software.

If multiple targets are specified, the first target in the list is used as the basis for patch selections.

Applies to swask, swcopy and swinstall.

patch_match_target=false

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

The patch_filter= option can be used with the patch_match_target option.

If multiple targets are specified, the first target in the list is used as the basis for patch selections.

Applies to swcopy and swinstall.

patch_one_liner=title patch_state

Use this command to specify the attributes displayed for each object listed when the -l patch option is invoked and when no -a or -v option is specified. The default display attributes are title and patch_state.

Applies to swlist and swjob.

patch_save_files=true

Saves patched files, which permits future rollback of patches. When set to false, patches cannot be rolled back (removed) unless the base software modified by the patch is removed at the same time.

Applies to swinstall.

polling_interval=2

Applies only to interactive sessions. Specifies how often, in seconds, SD-UX polls each target for status information during the analysis and execution phases. When you must operate across wide-area networks, you can increase the polling interval to reduce network overhead. Specifying a high numbers for this option creates longer intervals between polls.

Applies to swcopy, swinstall and swremove.

preserve_create_time=false

Preserves the original create time when you copy depots, which produces consistent results when you use the copies. The default of false sets the create_time of software bundles, products, and filesets equal to the time swcopy created the new depot. When set to true, the create_time is set to that specified in the source depot from which the current selections were copied. Note that using this option when copying to a master depot can change the objects that are visible when you use the create_time_filter option.

Applies to swcopy.

preview=false

If true, run this command in preview mode only (complete the analysis phase and exit). This option has the same effect as specifying -p on the command line.

Applies to swcopy, swinstall, swremove, and swconfig.

reboot_cmd=/sbin/reboot

This is the command called by the agent to reboot the system.

Applies to swagent.

reconfigure=false

This option prevents software that is already in the configured state from being reconfigured. If set to true, configured software can be reconfigured.

Applies to swconfig.

recopy=false

Prevents SD from recopying (overwriting) an existing revision of a fileset. If set to true, the fileset is recopied.

The reinstall and recopy options are synonymous.

Applies to swcopy and swinstall.

register_new_depot=true

Normally set to true, a newly created depot is registered on its host. This allows other commands to automatically see this depot.

If set to false, new depots are not registered. This could allow you to create a private depot on which to test, then later register it with swreg.

Applies only to swcopy.

register_new_root=true

Causes swinstall to register a newly-created alternate root with the local swagentd, which lets other SD-UX commands see this root.

If set to false, a new root is not automatically registered. (You can use the swreg command to register the depot later.)

Applies only to swinstall.

reinstall=false

Prevents SD from reinstalling (overwriting) an existing revision of a fileset. If set to true, the fileset is reinstalled.

The reinstall and recopy options are synonymous.

Applies to swcopy and swinstall.

reinstall_files=false

Controls the overwriting of files, which may enhance performance on slow networks or disks. At the default value of false, SD-UX compares each file in a source fileset to corresponding files on the target system. SD-UX compares the files based on size, timestamp, and (optionally) the checksum. If the files are identical the files on the target system are not overwritten.When set to true, SD-UX does not compare files and overwrites any identical files on the target.

See also the reinstall and reinstall_files_use_cksum options.

Applies to swcopy, swinstall and swpackage.

reinstall_files_use_cksum=true, reinstall_files_use_cksum=false (swpackage only)

Controls the use of checksum comparisons when the reinstall_files option is set to false. The default value of true causes SD-UX to compute and compare checksums to determine if a new file should overwrite an old file. Use of checksums slows the comparison but is a more robust check for equivalency than size and time stamp.If set to false, SD-UX does not compute checksums and compares files only by size and timestamp.

Applies to swcopy, swinstall and swpackage.

remove_empty_depot=true

When the last product or bundle in a depot is removed, the depot itself is removed.

The depot's swagent.log file and directory structure are not removed by default. If the swagent.log file and directory should be removed, the remove_empty_depot_directory option must also be set to “true”.

If set to false, the depot is not removed when the last product (or bundle) in it is removed. This preserves that depot’s ACL.

Applies only to swremove.

remove_empty_depot_directory=false

If false (default), the depot's swagent.log file and directory are not removed when the last product (or bundle) in the depot is removed.

If the remove_empty_depot_directory and the remove_empty_depot options are set to true, and the last product (or bundle) in a depot is removed, the depot's swagent.log file and directory are also removed.

Applies to swremove.

remove_obsolete_filesets=false

This command controls whether swcopy and swpackage automatically remove obsolete filesets from target products in the target depot.

If set to true, swcopy and swpackage remove obsolete filesets from the target products that were written during the copy or package process. Removal occurs after the copy or package 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 or during the current packaging of the product defined in the source PSF.

Applies to swcopy and swpackage.

remove_setup_cmd=/usr/lbin/sw/remove_setup

Defines the script called by the agent to perform release-specific removal preparation. For an OS update, this script invokes the tlink command when a fileset is removed.

Applies only to swagentd.

retry_rpc=1

This command defines the number of times a lost source connection is retried during file transfers. 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 that were successfully installed within the fileset.

This option also applies to the controller contacting the agent. If the agent session fails to start for any reason, the controller tries to recontact that agent for the number of times specified in retry_rpc, using the values from the retry_rpc_intervaloption to determine how long to wait between each attempt to recontact the agent.

Applies to swcopy and swinstall.

retry_rpc_interval={0}

Specifies in minutes the length of the interval for repeated attempts to make a connection to a target after an initial failure. Used in conjunction with the retry_rpc option.

If the number of values in this option equals the value of retry_rpc, SD-UX tries to reestablish a source connection for the number of times specified in retry_rpc. If the number of values in retry_rpc_interval is less than the value in retry_rpc, SD-UX repeats the final interval value until the number of retries matches retry_rpc.

For example, if an agent session failed to start and retry_rpc was set to 9 and retry_rpc_interval was set to {1 2 4 8 15} to allow long waits to handle transient network failures, the controller would attempt to recontact the agent after 1 minute for the first retry, then 2 minutes for the second retry, 4 for the third retry, then 8, then 15 for all additional retries until nine retries were attempted. With these values, a file load failure could cause the operation to pause for 90 minutes (1+2+4+8+15+15+15+15+15). If both options were set to 5, the controller would try to contact the target five times over a 30-minute period.

Applies to swcopy and swinstall.

reuse_short_job_numbers=true

When assigning job ID numbers, SD-UX uses numbers less than 10,000. Typically, old jobs are removed long before job number 9,999 is reached, so the job number quickly rolls over from 9999 back to 1. When you execute a large numbers of jobs that are not removed before the ID numbers reach 9,999, SD-UX may have performance delays while it searches for unused job numbers.

Setting reuse_short_job_numbers to false causes SD-UX to begin using numbers above 10,000. This avoids possible searching delays and lets the job ID numbers increase to 8 digits (99,999,999) if necessary. (This prevents roll-over from 9999 back to 1, so is usually not desirable.)

See also the autoremove_job option.

Applies to swconfig, swcopy, swinstall, swremove, and swverify.

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

Determines on what protocol sequence(s) and endpoint(s) the swagentd daemon listens. If the connection fails for one protocol sequence, the next is attempted. SD-UX supports both the tcp and udp protocols on most platforms.

The value can have the following form:

Applies to all commands except swask, swmodify, and swpackage.

rpc_binding_info_alt_source=ncadg_ip_udp:[2121]

Defines the protocol sequence(s) and endpoint(s) used when the agent attempts to contact an alternate source depot specified by the alternate_source option. SD-UX supports both the udp(ncadg_ip_udp:[2121]) and tcp(ncacn_ip_tcp:[2121])protocol sequence/endpoint.

Applies to swagent.

rpc_binding_info_source=

Defines the protocol sequences and endpoints used to contact a source depot. If rpc_binding_info_source is not specified, rpc_binding_info is used. If both are specified, rpc_binding_info_source is used.

Applies to swinstall and swcopy.

rpc_binding_info_target=

Defines the protocol sequences and endpoints used to contact targets. If rpc_binding_info_target is not specified, rpc_binding_info is used. If both are specified, rpc_binding_info_target is used.

Applies to swinstall and swcopy.

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 of attempts to contact hosts that are not up or are not running swagentd.

Each value is approximately twice as long as the lower one. A value of 5 is about 30 seconds for the ncadg_ip_udp protocol sequence. This option may be ignored when using the ncacn_ip_tcp protocol sequence.

Applies to all commands except swmodify and swpackage.

run_as_superuser=true

This option controls SD-UX’s nonprivileged mode. This option is ignored (treated as true) when the invoking user is super-user.

At the default value of true, SD-UX operations are performed normally, with permissions for operations either granted to a local super-user or set by ACLs. (See Chapter 9: “SD-UX Security ” for details on ACLs.)

When set to false and the invoking user is local and is not super-user, nonprivileged mode is invoked:

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. This option is not compatible with remote operations. Setting this option to true forces the autoremove_job option to true. For a full explanation of nonprivileged SD-UX, see Chapter 12: “Nonprivileged SD ”.

See also the admin_directory option.

Applies to all commands except swagent, swagentd, and install-sd.

run_scripts=true

Controls whether or not control scripts (such as preinstall, preremove, postremove, configure, etc.) are run during an install or remove session. Control scripts are an important part of software packages, and setting this to false might keep software from being installed correctly. Control scripts also provide important cleanup when software is removed. Setting this to false during swremove might result in some manual cleanup being required.

Applies to swinstall and swremove.

select_local=true

Normally set to true, selects the default depot or installation directory of the local host as the target of the command.

Applies to swacl, swconfig, swcopy, swinstall, swlist, swreg, swremove, swverify.

show_superseded_patches=false

If false, swlist will not display superseded patches. To see them, you must set this option to true. Even if you explicitly swlist the superseded patch, it will not display unless this option is true.

Applies only to swlist.

software=

Defines the default software_selections.

There is no supplied default. If there is more than one software_selection, they must be surrounded by brackets { } or quotes. Software is usually specified in a software_selections input file, as options on the command line or in the GUI or TUI.

Applies to all commands except swreg.

software_view=products

Indicates which software view is to be used in the GUI. It can be set to products, all_bundles, or a bundle category tag (shows only bundles of that category). The default view is all_bundles plus products that are not part of a bundle.

Applies to swcopy, swinstall, swlist and swremove.

source=

Specify a source to automatically bypass the GUI and CLI source selection dialog box. This has the same effect as the -s source command line option. Specify the source using the following syntax:

[path]

Applies to swcopy and swinstall.

source_cdrom=/SD_CDROM

Defines the default location of the source CD-ROM. The syntax is:

[host][:][path]

Applies only to swinstall.

source_depot_audit=true

If both source and target machine are updated to SD-UX revision B.11.00 or later, the system administrator at the source depot machine can set this option to track which user pulls which software from a depot on the source machine and when the software is pulled.

A user running swinstall or swcopy from a target machine cannot set this option; only the administrator of the source depot machine can set it.

When source_depot_audit is set to its default value of true, a swaudit.log file is created on the source depot (for writable directory depots) or in /var/tmp (for tar images, CD-ROMs, or other nonwritable depots).

To view, print, or save the audit information, invoke the swlist interactive user interface by typing:

swlist -i -d

You can view audit information based on language preference, as long as the system has the corresponding SD-UX message catalog files on it. For example, you can view the source audit information in Japanese during one invocation of swlist, then view the same information in English at the next invocation.

Applies to swagent.

source_directory

See distribution_source_directory.

source_file=psf

This keyword defines the default product_specification_file to read as input to the packaging or swmodify session. It may be a relative or absolute path.

Applies to swpackage and swmodify.

source_tape=/dev/rmt/0m

Defines the default tape location, usually the character-special file of a local tape device. You can also use the host:path syntax, but the host must match the local host. The -s option overrides this value.

Applies to swcopy and swinstall.

source_type=directory

The default source type (choices are cdrom, file, directory, or tape) that points to one of the next three options. The source type derived from the -s source file option overrides this default.

The cdrom and tape values apply to swcopy and swinstall. The file value applies only to swpackage.

system_file_path=/stand/system

The path to the kernel’s template file. The path is passed to the system_prep_command via the SW_SYSTEM_FILE_PATH environment variable.

Applies only to swagent.

system_prep_cmd=/usr/lbin/sysadm/system_prep

The kernel build preparation script called by the agent. This script must do any necessary preparation so that control scripts can correctly configure the kernel that is about to be built.

Applies only to swagent.

targets=

There is no supplied default (see also select_local). If there is more than one target, they must be separated by spaces. Targets are usually specified in a target input file, as options on the command line or in the GUI.

Applies to all commands.

target_directory

See distribution_target_directory.

target_tape

See distribution_target_serial.

target_type

See media_type.

uncompress_cmd=

This is the command called by the source agent to uncompress files when installing, copying or packaging.

This command processes files that were stored on the media in compressed format. If the compression_type of the file is gzip, the internal compression (funzip) is used instead of the external uncompress command.

Applies to swagent and swpackage.

uncompress_files=false

When set to true, files are uncompressed using the current uncompress_cmd before storing them on the target depot.

Only one of the uncompress_files and compress_files options may be set to true during a swpackage session.

The uncompress_files option may not be set to true if package_in_place is set to true or if the media_type is set to tape.

Applies to swcopy and swpackage.

use_alternate_source=false

At the default value of false, swinstall or swcopy begins an analysis or task with a request that includes information describing the source binding and depot path for the local host to use as the software source.

If true, the local host uses its own configured value. On the local host, the agent’s configured value for alternate_source is specified in host:/path format. If this value contains only a path component (for example, alternate_source=:/path), the agent applies this path to the file system of its own local host.

If only the host component exists (for example, alternate_source=host), the agent applies the controller-supplied path to this host. If there is no configured value at all for the alternate_source, the agent applies the controller-supplied path to its own local host.

Applies to swcopy and swinstall.

verbose=

By default, the command sends output to stdout for task summary messages. Alternatively, the verbose option can be set to 0 for session level messages (no output to stdout) or (for swpackage and swmodify) to 2 for file level messages.

Error and warning messages are always written to stderr.

For the swlist command, a verbose listing includes all attributes that have been defined for the appropriate level of each software_selection operand. The attributes are listed one per line, prefaced by the attribute keyword.

The -v option overrides this default, if it is set to 0.

Applies to all commands.

write_remote_files=false

Prevents file operations on remote (NFS) file systems. All files destined for installation, copy, removal, or packaging on targets on a remote (NFS) file systems are skipped.

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

Applies to swconfig, swcopy, swinstall, swpackage, and swremove.