swagentd(1M)

NAME

swagent, swagentd — serve local or remote SD software management tasks; daemon that invokes swagent

SYNOPSIS

swagent executed by swagentd only.

swagentd [-k] [-n] [-r] [-x option=value] [-X option_file]

Remarks

This command supports operation on remote systems. See Remote Operation below.
For an overview of all SD commands, see the sd(5) man page by typing man 5 sd on the command line.

DESCRIPTION

The roles of UNIX target and source systems require two processes known as the daemon and agent. For most purposes, the distinction between these two processes is invisible to the user and they can be viewed as a single process.

Each SD command interacts with the daemon and agent to perform its requested tasks.

The swagentd daemon process must be scheduled before a UNIX system is available as a target or source system. This can be done either manually or in the system start-up script. The swagent agent process is executed by swagentd to perform specific software management tasks. The swagent agent is never invoked by the user.

Remote Operation

You can enable SD to manage software on remote systems. To let the root user from a central SD controller (also called the central management server or manager node) perform operations on a remote target (also called the host or agent):

1)

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

/usr/lib/sw/mx/setaccess controller

NOTES:

controller is the name of the central management server.
If remote system is 11.00, make sure SD patch PHCO_22526 or a superseding patch is installed on remote system before running setaccess.
If remote system is older than 11.00 or for some other reason does not have setaccess in place, copy setaccess script from an 11.11 or higher system to the remote system.

2)

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

touch /var/adm/sw/.sdkey

See sd(5), swinstall(1M), swcopy(1M), swjob(1M), swlist(1M) or swremove(1M) for more information on interactive operations.

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

Disable and Enable

The swagentd daemon can be disabled by the system administrator by setting the SW_ENABLE_SWAGENTD entry in /etc/rc.config.d/swconfig to 0 and executing /usr/sbin/swagentd -k.

The swagentd daemon can be enabled by the system administrator by setting the SW_ENABLE_SWAGENTD entry in /etc/rc.config.d/swconfig to 1 and executing /usr/sbin/swagentd -r.

Options

The swagentd command supports the following options to control its behavior. (These options do not apply to swagent, which you cannot start from the command line.)

-k: The kill option stops the currently running daemon. Stopping the daemon will not stop any agent processes currently performing management tasks (such as installing or removing software), but will cause any subsequent management requests to this host to be refused. This option is equivalent to sending a SIGTERM to the daemon that is running.
-n: The no fork option runs the daemon as a synchronous process rather than the default behavior of forking to run it asynchronously. This is intended for running the daemon from other utilities that schedule processes, such as init.
-r: The restart option stops the currently running daemon and restarts a new daemon. Because the swagentd daemon processes options only at startup, you must restart the daemon after you have modified any daemon options. Otherwise, the modified options have no effect.
-x option=value: Set the option to value and override the default value (or a value in an option_file specified with the -X option). Multiple -x options can be specified.
-X option_file: Read the session options and behaviors from options_file.

EXTERNAL INFLUENCES

Default Options

In addition to the standard options, you can change SD behaviors and policy options by editing the system-wide default values found in the /var/adm/sw/defaults file. (Note that the user-specific default values in $HOME/.swdefaults do not apply to the agent or daemon.)

To specify values in the defaults file, you must use the following:

[command_name.]option=value 

The optional command_name prefix denotes one of the SD commands. Using the prefix limits the value change to that command. If you leave the prefix off, the change applies to all commands that use the option.

You can also override swagentd default values from the command line with the -x or -X options:

command -x option=value

command -X option_file

NOTE: the only way to change default values for the agent is to modify the system-wide defaults file. You cannot change agent defaults from the command line.

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

Daemon Options

These options apply only to the daemon, swagentd. After changing daemon options, you must restart the daemon for these options to take effect (see the -r command-line option above).

agent=/usr/lbin/swagent: The location of the agent program invoked by the daemon.
logfile=/var/adm/sw/swagentd.log: This is the default log file for the swagentd daemon.
max_agents=-1: The maximum number of agents that are permitted to run simultaneously. The value of -1 means that there is no limit.
minimum_job_polling_interval=1: Defines in minutes how often the daemon wakes up to scan the job queue to determine if any scheduled jobs must be started. When set to 0, no scheduled jobs will be initiated.
rpc_binding_info=ncacn_ip_tcp:[2121] ncadg_ip_udp:[2121]: Defines the protocol sequence(s) and endpoint(s) on which the daemon listens and which the other commands use to 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.

Agent Options

These options apply only to the agent, swagent. You cannot set these options directly from the command line. To set agent options, you must edit the system-wide defaults file. See the Default Options heading above for instructions.

alternate_source=

If the swinstall or swcopy controller has set use_alternate_source=true, the target agent will consult and use the configured value of its own alternate_source option to determine the source that it will use in the install or copy.

The agent's value for alternate_source is specified using the host:path syntax. If the host portion is not specified, the local host is used. If the path portion is not specified, the path sent by the command is used. If there is no configured value at all for alternate_source, the agent will apply the controller-supplied path to its own local host.

compress_cmd=/usr/contrib/bin/gzip

Defines the command called by the source agent to compress files before transmission. If the compression_type is set to other than gzip or compress, this path must be changed.

compression_type=gzip

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). The only supported compression types are compress and gzip.

config_cleanup_cmd=/usr/lbin/sw/config_clean

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

Please Note: Transition links do not exist on 11.31 and newer releases so there are no configure cleanup steps to perform therefore the config_cleanup_cmd is never executed for these releases.

install_cleanup_cmd=/usr/lbin/sw/install_clean

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.

Please Note: Transition links do not exist on 11.31 and newer releases so there are no install cleanup steps to perform; therefore, the install_cleanup_cmd is never executed for these releases.

install_setup_cmd=/usr/lbin/sw/install_setup

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.

Please Note: Transition links do not exist on 11.31 and newer releases so there are no install setup steps to perform; therefore, the install_setup_cmd is never executed for these releases.

kernel_build_cmd=/usr/sbin/mk_kernel

Defines the script called by the agent for kernel building after kernel filesets have been loaded.

kernel_path=/stand/vmunix

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.

mount_cmd=/sbin/mount

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

reboot_cmd=/sbin/reboot

Defines the command called by the agent to reboot the system after all filesets have been loaded, if any of the filesets required reboot.

remove_setup_cmd=/usr/lbin/sw/remove_setup

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

Please Note: Transition links do not exist on 11.31 and newer releases so there are no remove preparation steps to perform; therefore, the remove_setup_cmd is never executed for these releases.

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 supports both the udp (ncadg_ip_udp:[2121]) and tcp (ncacn_ip_tcp:[2121]) protocol sequence/endpoint.

source_depot_audit=true

If both source and target machine are updated to SD 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/swcopy from a target machine cannot set this option; only the administrator of the source depot machine can set it.)

When swagent.source_depot_audit is set to 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).

Users can invoke the swlist interactive user interface (using swlist -i -d) to view, print, or save the audit information on a remote or local depot. Users can view audit information based on language preference, as long as the system has the corresponding SD message catalog files on it. For example, a user can view the source audit information in Japanese during one invocation of swlist, then view the same information in English at the next invocation.

system_file_path=/stand/system

Defines the path to the kernel's template file. This path is passed to the system_prep_cmd via the SW_SYSTEM_FILE_PATH environment variable.

system_prep_cmd=/usr/lbin/sysadm/system_prep

Defines 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 about to be built. This script is called before any kernel filesets have been loaded.

uncompress_cmd=

Defines the command called by the target agent to uncompress files after transmission. This command processes files which were stored on the media in a compressed format. If the compression_type stored with the file is gzip, the internal uncompression (funzip) is used instead of the external uncompress_cmd. The default value for HP-UX is undefined.

Session File

swagentd and swagent do not use a session file.

Environment Variables

The environment variables that affect the swagentd and swagent commands are:

LANG

Determines the language in which messages are displayed. If LANG is not specified or is set to the empty string, a default value of C is used. See the lang(5) man page by typing man 5 sd for more information.

Note: The language in which the SD agent and daemon log messages are displayed is set by the system configuration variable script, /etc/rc.config.d/LANG. For example, /etc/rc.config.d/LANG, must be set to LANG=ja_JP.SJIS or LANG=ja_JP.eucJP to make the agent and daemon log messages display in Japanese.

LC_ALL

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

LC_CTYPE

Determines the interpretation of sequences of bytes of text data as characters (e.g., single-versus multibyte characters in values for vendor-defined attributes).

LC_MESSAGES

Determines the language in which messages should be written.

LC_TIME

Determines the format of dates (create_date and mod_date) when displayed by swlist. Used by all utilities when displaying dates and times in stdout, stderr, and logging.

TZ

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

Signals

The daemon ignores SIGHUP, SIGINT and SIGQUIT. It immediately exits gracefully after receiving SIGTERM and SIGUSR2. After receiving SIGUSR1, it waits for completion of a copy or remove from a depot session before exiting, so that it can register or unregister depots. Requests to start new sessions are refused during this wait.

The agent ignores SIGHUP, SIGINT, and SIGQUIT. It immediately exits gracefully after receiving SIGTERM, SIGUSR1, or SIGUSR2. Killing the agent may leave corrupt software on the system, and thus should only be done if absolutely necessary. Note that when an SD command is killed, the agent does not terminate until completing the task in progress.

Locking

The swagentd ensures that only one copy of itself is running on the system.

Each copy of swagent that is invoked uses appropriate access control for the operation it is performing and the object it is operating on.

RETURN VALUES

When the -n option is not specified, the swagentd returns:

0: When the daemon is successfully initialized and is now running in the background.
non-zero: When initialization failed and the daemon terminated.

When the -n option is specified, the swagentd returns:

0: When the daemon successfully initialized and then successfully shutdown.
non-zero: When initialization failed or the daemon unsuccessfully terminated.

DIAGNOSTICS

The swagentd and swagent commands log events to their specific logfiles.

The swagent (target) log files cannot be relocated. They always exist relative to the root or depot target path (e.g. /var/adm/sw/swagent.log for the root / and /var/spool/sw/swagent.log for the depot /var/spool/sw).

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

Daemon Log: The daemon logs all events to /var/adm/sw/swagentd.log. (The user can specify a different logfile by modifying the logfile option.)
Agent Log: When operating on (alternate) root file systems, the swagent logs messages to the file var/adm/sw/swagent.log beneath the root directory (e.g. / or an alternate root directory).
Source Depot Audit Log: 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. Refer to the swagent.source_depot_audit option for more information.

When operating on software depots, the swagent logs messages to the file swagent.log beneath the depot directory (e.g. /var/spool/sw). When accessing a read-only software depot (for example, as a source), the swagent logs messages to the file /tmp/swagent.log.

EXAMPLES

To start the daemon:

/usr/sbin/swagentd 

To restart the daemon:

/usr/sbin/swagentd -r  

To stop the daemon:

/usr/sbin/swagentd -k  

FILES

/usr/lib/sw/sys.defaults: Contains the master list of current SD options (with their default values).
/var/adm/sw/: The directory which contains all configurable and non-configurable data for SD. This directory is also the default location of logfiles.
/var/adm/sw/defaults: Contains the active system-wide default values for some or all SD options.
/var/adm/sw/host_object: The file which stores the list of depots registered at the local host.

AUTHOR

swagentd was developed by the Hewlett-Packard Company. swagent was developed by the Hewlett-Packard Company and Mark H. Colburn (see pax(1)).