sd(5)

Install a special HP ServiceControl Manager fileset on the remote systems. This permits root access from the controller system by automatically setting up the root, host, and template Access Control Lists (ACLs) on the remote machines. To install the fileset, run this command on each remote system:

swinstall -s controller:/var/opt/mx/depot11 AgentConfig.SD-CONFIG

NOTES:

(Optional) Enable the GUI interfaces for remote operations by creating the .sdkey file on the controller. Use this command:

touch /var/adm/sw/.sdkey

(This step is not required when you use SD from within the HP ServiceControl Manager.)

NOTE: You can also set up remote access by using the swacl(1M) command directly on the remote machines to grant root or non-root access to users from the controller system.

The interactive 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 for a definition of these options.

Causes the command to operate on target_selections which are software depots rather than root directories.

Causes SD commands to operate on alternate root directories, which must be specified the @ target_selections option. (This option is not required for alternate root operations but is maintained for backward compatibility. See the Alternate Root Directory and Depot Directory heading above for more information.)

Runs the command in interactive mode (Graphical User Interface). See the Interactive Operation and Remote Operation headings above for additional details.

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

When run in 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 existing one.

Previews the task by executing the session through the analysis phase and exiting before the command begins to perform the actual task.

For swlist, recursively includes all objects to the fileset level.

For swjob: recursively includes all objects to the end_target level.

Undo variation of the operation, unconfiguring software using swconfig, unregistering the specified objects using swreg, or removing the specified jobs using the swjob command.

Turns on verbose output to stdout. (The command log file is not affected by this option.) By default, verbose output is enabled for all the SD commands.

List the supported data model revisions.

Specifies particular attributes to display or modify using swlist, swmodify, or the swjob command.

Specifies the pathname of the directory containing an exported catalog. For swask, this catalog stores copies of the response files created by request scripts. For swlist and swmodify, this catalog stores output or input for these commands.

Saves the current options and operands to session_file. (You can recall a session file with the -S session_file option.) See the Session File heading in this manpage for more information.

Deletes an existing entry from the ACL associated with the specified objects using swacl.

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

Assigns the ACL contained in acl_file to the specified object using swacl.

Executes the previously scheduled job. This option is used by the swagentd to initiate scheduled jobs.

List all objects at the specified level when using swlist, or define the level of the objects when using swacl, or swreg.

Adds a new ACL entry or changes the permissions of an existing entry using swacl.

Schedules the command for the specified date and time.

Specifies source depot, PSF file, or tape from which software will be installed, copied, listed, or packaged. (SD can read both tar and cpio tape depots.)

Executes the command based on the options and operands saved from a previous session in session_file. (You can save session information to a file with the -C session_file option.) See the Session File heading in this manpage for more information.

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

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. These values defined in this file override the default values.

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.

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

The location of the agent program invoked by the daemon.

Applies to swagentd.

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 value of true means the target agent automatically exits when appropriate. When set to false, the target agent will not exit until the controller ends the session.

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

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.

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

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

Applies 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 to swconfig, swinstall, and swverify.

Prevents the installation or configuration of another, independent version of a product when a version already is already installed or configured at the target.

If set to true, another version of an existing product can be installed into a new location, or can be configured in its 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 to swconfig, swinstall, and swverify.

Permits the use of single patch filesets without "sibling" filesets. In the default state of false, installation, copy, or 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 installed, copied, or 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 updated or removed by a patch, while the other filesets would remain at an earlier release or fail to be removed.

Applies to swinstall, swcopy, and swremove.

Defines the alternate source which the agent will use when the use_alternate_source option is set to true. The alternate source is specified using the syntax:

If the host portion is not specified, then the local host is used. If the path portion is not specified, then the path sent by the command is used. The protocol sequence and endpoint given by the option swagent.rpc_binding_info are used when the agent attempts to contact an alternate source depot.

Applies to swagent.

Executes a request script, which asks for a user response. If ask=as_needed, swinstall executes the request script only if a response file does not already exist in the control directory. See swask(1M) for more information on request scripts.

Applies to swask, swconfig, and swinstall.

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 to swremove only.

Prevents the installation or removal of software requiring a reboot from the non-interactive interface. If set to true, then software can be installed or removed, after which the target system(s) will automatically reboot.

An interactive session always asks for confirmation before software requiring a reboot is installed or 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.

Applies to swinstall and swremove.

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 remove the 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 replaced, 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. See the Software Distributor Administration Guide for complete information.

Applies only to swinstall.

This option permits automatic recovery of original product files 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 remove any existing product files as a product is updated. If an error occurs during installation (e.g. network failure), then the original files are lost, and you must reinstall the product.

If set to true, all files for a product are saved as backup copies until the entire product finishes loading. Then the files are removed. If an error occurs during installation, the original product files are replaced, and swinstall exits.

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. See Software Distributor Administration Guide for complete information.

Applies only to swinstall.

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

Controls the automatic selection of prerequisite, corequisite, and exrequisite software that SD automatically selects. When set to true, the requisite software is automatically selected for configuration. When set to false, requisite software which is not explicitly selected is not automatically selected for configuration. When set to as_needed, autoselected dependencies are operated only if the dependency is not already met on the target.

Applies to swconfig, swcopy, swinstall, and swverify.

Controls whether or not SD automatically selects dependent software. A dependent fileset has established either a prerequisite, corequisite, or exrequisite on the selected fileset. Specifying true causes SD to automatically select dependent software. The default value of false prevents SD from automatically selecting dependent software.

Applies to swconfig and swremove.

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 will not be automatically selected.

The patch_filter option can be used in conjunction with autoselect_patches.

Applies to swask, swinstall, and swcopy.

If true, bundles that are sticky will be 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.

For swremove, if set to true, any bundle with the is_sticky attribute set to true is removed automatically when the last of its contents is removed. If set to false, the sticky bundles will not be automatically removed.

Applies to swcopy, swinstall, and swremove.

Causes swverify to verify the time stamp, size, and checksum attributes of files. If set to false, these attributes are not verified.

Applies to swverify.

(This option is ignored if check_contents is set to false.) Controls whether or not swverify validates the size and checksum for compressed files. In the default state of false, swverify checks only the mtime, size and cksum attributes of the compressed file. If set to true, swverify uncompresses the file in memory and verifies the size and cksum attributes of the uncompressed contents.

Only files compressed with SD's internal compressor can be uncompressed during a swverify operation. See the compress_files option of the swpackage(1M) command for more information.

Applies to swverify.

(This option is ignored if check_contents is set to false.) Controls whether or not swverify computes a checksum on the contents of the file. In the default state of true, swverify checks all file attributes including the checksum. If set to false, swverify checks only the file timestamp and size.

Applies to swverify.

Causes swverify to verify the mode, owner, UID, group, and GID attributes of installed files. If set to false, these attributes are not verified.

Applies to swverify.

Causes swverify to verify that the prerequisite, corequisite, and exrequisite dependencies of the software selections are being met. If set to false, these checks are not performed.

Applies to swverify.

Causes swverify to run the fileset/product verify scripts for installed software. If set to false, these scripts are not executed.

Applies to swverify.

Causes swverify to not verify those files marked as volatile (i.e. can be changed). If set to true, volatile files are also checked (for installed software).

Applies to swverify.

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. This option stores the codeword for future reference; you needs to enter the codeword only once.

Defines the command called to compress files before installing, copying or packaging. If the compression_type option is set to other than gzip or compress, this path must be changed.

Applies to swpackage and swagent.

If set to true, uncompressed files are compressed before transfer from a source. This enhances performance on slower networks for swcopy and swinstall, and results in smaller depots for swcopy and swpackage, unless the uncompress_files option is also set to true.

Applies to swcopy, swinstall, and swpackage.

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.

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

Defines the default compression type used by the agent 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).

Applies to swagent.

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

Applies to swagent.

When adding or deleting control file objects, this option lists the tags of those control files. There is no supplied default. If there is more than one tag, they must be separated by whitespace and surrounded by quotes.

Applies to swmodify.

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

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

If creating a target depot, swpackage will create Access Control Lists (ACLs) for the depot (if it is new) and all products being packaged into it. If set to false, and if the user is the superuser, swpackage will not create ACLs. (The swpackage command never creates ACLs when software is packaged on to a distribution tape.)

Applies to swpackage.

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

Applies to swcopy and swinstall.

For cumulative source depots, this option allows consistent software selections over time by swlist, swcopy, and swinstall. 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 those 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.

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. The customer_id can be used on any HP-UX 10.X or later system.

Applies to swinstall,swcopy,swlist.

Causes swinstall to automatically run configure scripts for the software_selections after they are installed. (Alternate root directories are not configured.)

When set to true, swinstall does not run configure scripts. If you want to configure the software later, you must run the swconfig command.

NOTES:

Applies to swinstall.

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

Applies to swcopy, swinstall, and swpackage.

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.

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

Applies to swpackage.

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

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

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 are checked, but not enforced. Corequisite dependencies, if not enforced, may keep the selected software from working properly. Prerequisite or exrequisite dependencies, if not enforced, may cause the installation or configuration to fail.

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

Prevents a command from proceeding past the analysis phase if the disk space required is beyond the available free space of the impacted file systems. If set to false, then the install, copy, or package operation will use the file systems' minfree space and may fail because it reaches the file system's absolute limit.

Applies to swcopy, swinstall, and swpackage.

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 permits the command to relocate the fileset.

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

Applies to swinstall and swverify.

The default value of true prevents swinstall from proceeding past the kernel build phase if the kernel build processes fail. If set to false, the install operation continues despite failures or warnings in the system preparation process or the kernel build process.

Applies to swinstall.

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.

When adding or deleting file objects, this option lists the pathnames of those file objects. There is no supplied default. If there is more than one pathname, they must be separated by whitespace.

Applies to swmodify.

Controls the swinstall response to explicitly packaged software (software packaged with explicit file specifications). The default value of false causes swinstall to set permissions (as specified in the product specification file) on new directories but never on pre-existing directories. When set to true, swinstall also sets the permissions on pre-existing directories.

Applies to swinstall.

Do not follow symbolic links in the package source files, but include the symbolic links in the packaged products. A value of true for this keyword causes swpackage to follow symbolic links in the package source files and include the files they reference in the packaged products.

Applies to swpackage.

This option applies only to the Interactive User Interface 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.

Applies to swremove.

Do not include each source file's revision attribute in the products being packaged. Because this operation is time consuming, by default the revision attributes are not included. If set to true, swpackage will execute what(1) and possibly ident(1) (in that order) to try to determine a file's revision attribute.

Applies to swpackage.

Defines 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. This script is executed after all filesets have been installed, just before the reboot to the new operating system.

Applies to swagent.

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

Applies to all SD commands except swacl, swask, swconfig, swinstall, swlist, swmodify, swremove, and swverify.

Defines the script called by the agent to perform release-specific install preparation. For an OS update, this script should at least copy commands needed for the checkinstall, preinstall, and postinstall scripts to a path where they can be accessed while the real commands are being updated. This script is executed before any kernel filesets are loaded.

Applies to swagent.

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.

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

Defines the script called by the agent for kernel building.

Applies to swagent.

Defines the path to the system's bootable kernel. This path is passed to the kernel_build_cmd via the SW_KERNEL_PATH environment variable.

Applies to swagent.

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 for HP-UX version 10.10 and later can read or write either layout version.

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.

The version used by swpackage can be controlled by specifying the layout_version attribute in the product specification file (PSF). However, if the layout_version attribute in the PSF is 1.0, the is_locatable attribute defaults to true in all cases, and must be explicitly set to false. (See swpackage(4) for more information on PSFs.)

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

In addition to adding new attributes and objects, layout_version 1.0 changes the following preexisting 0.8 objects and attributes as follows:

Applies to swpackage, swcopy, swmodify, and swlist.

Specifies a software level for swlist, swacl, or swreg.

For swlist:

Lists all objects down to the specified level. Both the specified level(s) 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:

The level option defines the level of ACLs to view or modify:

For swreg:

The level option defines the level of object to register or unregister:

Applies to swacl, swlist, and swreg.

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

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

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

Here are the possible combinations of loglevel and logdetail options:

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

Defines the default log file for each SD command. (The agent log files are always located relative to the target depot or target root, e.g. /var/spool/sw/swagent.log and /var/adm/sw/swagent.log.)

Applies to all commands except swacl, swlist, and swjob.

Controls the log level for the events logged to the command logfile, the target agent logfile, and the source agent logfile by prepending identification numbers to SD logfile messages. This information is in addition to the detail controlled by the logdetail option. See logdetail for more information.

A value of

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

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.

Applies to swinstall.

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

Applies to swagentd.

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 attempts to install or copy to all targets at once.

Applies to swcopy and swinstall.

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 Mbytes for tape or to the amount of free space on the disk up to minfree for a disk file. SD 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 to swpackage.

Defines the type of distribution to create. The recognized types are directory and tape.

Applies to swpackage.

Defines in minutes how often the daemon wakes up to scan the job queue for scheduled jobs that must start. If set to 0, no scheduled jobs are initiated.

Applies to