swjob(1M)swjob(1M)NAME
swjob, sd - display and monitor job information, create and remove
jobs; invoke graphical user interface to display and monitor job infor‐
mation and create and remove jobs, respectively
SYNOPSIS
attribute] session_file] jobid_file] session_file] target_file]
option=value] option_file] [jobid(s)] target_selections]
[XToolkit Options] option=value] option_file]
Remarks
· The command invokes an interactive interface to the same
functionality that provides. See below for more details.
· This command supports operation on remote systems. See below
for details.
· For an overview of all SD commands, see the sd(5) man page by
typing on the command line.
DESCRIPTION
The command displays job information and removes jobs. It supports
these features:
· Display the current install jobs, copy jobs, and other SD
jobs initiated by the SD commands.
· Specify a specific job to list or remove.
· Display the command logfile for a specific job.
· Display the target logfile for a specific target.
Remote Operation
You can enable Software Distributor (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 opera‐
tions 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 sys‐
tem. To do this, run the following command on each remote system:
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
· If remote system is older than 11.00 or for some other reason
does not have in place, copy script from an 11.11 or higher sys‐
tem to the remote system.
2) and have enhanced GUI interfaces for remote operations. Enable the
enhanced GUIs by creating the file on the controller. Use this
command:
NOTE: You can also set up remote access by using directly on the remote
machines to grant root or non-root access to users from the controller
system.
Interactive Operations
The command is an interactive interface for monitoring and scheduling
software jobs. It provides the same functionality as the command. You
can also use to invoke the and GUIs.
If you have enabled SD's remote operations features, and provide
enhanced GUIs to support operations on remote targets. See above for
details about enabling remote operations and the enhanced GUIs.
Options
When no options or operands are specified, lists the jobs that exist on
the local host. These jobs may be pending, active, in the background
or completed. The command supports the following options:
XToolKit Options
The command supports a subset of the standard
XToolkit options to control the appearance of the
system GUI. The supported options are: and See
the X(1) man page by typing for a definition of
these options.
Runs the command in interactive mode (invokes the GUI.)
(Using this option is an alias for the command.)
See the and headings above for details.
Applies to target lists as a shorthand for
Causes to remove the specified job(s).
Causes to list all available attributes, one per line.
The option applies only to the default list.
Each job has its own set of attributes. These attributes
include such things
as job title, schedule date, or results. The
option selects a specific attribute to display.
You can specify multiple options to display mul‐
tiple attributes. See also sd(4) for details on
these attributes. This option applies only to
the default list.
The logfiles summarizing a job or detailing tar‐
get actions can be displayed using if is speci‐
fied and no other attribute is specified (that
is, no other attribute may be specified).
Save the current options and operands only to the
session_file. You can enter a relative or abso‐
lute path with the file name. The default direc‐
tory for session files is Without this option, by
default, the session file is saved only in the
default directory
You can recall a session file with the option.
Read the list of
jobids from jobid_file instead of (or in addition
to) the command line.
Read the list of
target_selections from target_file instead of (or
in addition to) the command line.
Set the session
option to value and override the default value
(or a value in an alternate option_file specified
with the option). Multiple options can be speci‐
fied.
Execute based on the options and operands saved from a
previous session, as defined in session_file.
You can save session information to a file with
the option.
Read the session options and behaviors from
option_file.
Operands
The command supports two types of operands: followed by These operands
are separated by the "at" character. This syntax implies that the com‐
mand operates on "jobid at targets".
· The command supports the following syntax for each job id:
· target selections: The command supports the following syntax
for each target selection:
· target selections with IPv6 address: The command on HP-UX
Release 11i v3 supports IPv6 address in the target selec‐
tions. The syntax is:
If both the hostname and the path are specified, then the
first occurrence of a slash is treated as the separator.
The IPv6 address can optionally be enclosed in a pair of
square brackets and
EXTERNAL INFLUENCES
Default Options
In addition to the standard options, several SD behaviors and policy
options can be changed by editing the default values found in:
the system-wide default values.
the user-specific default values.
Values must be specified in the defaults file using this syntax:
The optional prefix denotes one of the SD commands. Using the prefix
limits the change in the default value to that command. If you leave
the prefix off, the change applies to all commands.
You can also override default values from the command line with the or
options:
The following section lists all of the keywords supported by the com‐
mand. If a default value exists, it is listed after the
The policy options that apply to are:
The location for SD logfiles and the default par‐
ent directory for the
installed software catalog. The default
value is for normal SD operations. When
SD operates in nonprivileged mode (that
is, when the default option is set to
· The default value is forced to
· The path element is replaced with the
name of the invoking user, which SD
reads from the system password file.
· If you set the value of this option
to path, SD replaces with the invok‐
ing user's home directory (from the
system password file) and resolves
path relative to that directory. For
example, resolves to the directory in
your home directory.
SD's nonprivileged mode is intended only
for managing applications that are spe‐
cially designed and packaged. This mode
cannot be used to manage the HP-UX oper‐
ating system or patches to it. For a
full explanation of nonprivileged SD,
see the available at the web site.
See also the option.
Causes a target agent to exit if it has been inac‐
tive 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 com‐
mand line invocation, a value between 10
minutes and 60 minutes is suitable. A
value of 60 minutes or more is recom‐
mended when the GUI will be used. The
default of 10000 is slightly less than 7
days.
Controls the time in minutes to cache and re-use
the results of hostname
or IP address resolution lookups. A
value of 0 disables the facility to
cache and re-use lookup results. The
maximum value allowed is 10080 minutes,
which is one week.
A value of:
disables the lookup caching mechanism.
is the maximum value allowed.
Defines the attributes which will be listed for
each job when no
option is specified. Each attribute
included in the definition is separated
by <tab> or <space>. Any attributes,
except may be included in the defini‐
tion. If a particular attribute does
not exist for an object, that attribute
is silently ignored.
This option controls the exit code returned by
SD's controller commands.
This option is applicable only for a
single target operation, and ignored
when multiple targets are used.
When set to the default value of swjob
returns:
0 If there were no errors, with or
without warnings.
1 If there were errors.
When set to swjob returns :
0 If there were no warnings and no
errors.
1 If there were errors.
2 If there were warnings but no errors.
Defines the protocol sequence(s) and endpoint(s)
on which the daemon
listens and the other commands contact
the daemon. If the connection fails for
one protocol sequence, the next is
attempted. SD supports both the tcp and
udp protocol sequence on most platforms.
See the sd(5) man page by typing for
more information.
Relative length of the communications timeout.
This is a value in the
range from 0 to 9 and is interpreted by
the DCE RPC. Higher values mean longer
times; you may need a higher value for a
slow or busy network. Lower values will
give faster recognition on attempts to
contact hosts that are not up or not
running Each value is approximately
twice as long as the preceding value. A
value of 5 is about 30 seconds for the
protocol sequence. This option may not
have any noticeable impact when using
the protocol sequence.
This option controls SD's nonprivileged mode.
This option is ignored
(treated as true) when the invoking user
is super-user.
When set to the default value of true,
SD operations are performed normally,
with permissions for operations either
granted to a local super-user or set by
SD ACLs. (See swacl(1M) for details on
ACLs.)
When set to false and the invoking user
is local and is not super-user, nonpriv‐
ileged mode is invoked:
· Permissions for operations are based
on the user's file system permis‐
sions.
· SD ACLs are ignored.
· Files created by SD have the uid and
gid of the invoking user, and the
mode of created files is set accord‐
ing to the invoking user's umask.
SD's nonprivileged mode is intended only
for managing applications that are spe‐
cially designed and packaged. This mode
cannot be used to manage the HP-UX oper‐
ating system or patches to it. For a
full explanation of nonprivileged SD,
see the available at the web site.
See also the option.
Defines the default
target_selections. There is no supplied
default. If there is more than one tar‐
get selection, they must be separated by
spaces.
Controls the verbosity of the output (stdout). A
value of:
disables output to stdout. (Error and
warning messages
are always written to stderr).
enables verbose messaging to stdout.
Session File
Each invocation of the command defines a job display ses‐
sion. The invocation options, source information, soft‐
ware selections, and target hosts are saved before the
installation or copy task actually commences. This lets
you re-execute the command even if the session ends
before proper completion.
Each session is automatically saved to the file This file
is overwritten by each invocation of
You can also save session information to a specific file
by executing with the session_file option.
A session file uses the same syntax as the defaults
files. You can specify an absolute path for the session
file. If you do not specify a directory, the default
location for a session file is
To re-execute a session file, specify the session file as
the argument for the session_file option of
Note that when you re-execute a session file, the values
in the session file take precedence over values in the
system defaults file. Likewise, any command line options
or parameters that you specify when you invoke take
precedence over the values in the session file.
Environment Variables
SD programs are affected by external environment vari‐
ables.
SD programs that execute control scripts set environment
variables for use by the control scripts. does not set
environmental variables, but it uses them.
Environment variables that affect the SD commands:
Determines the language in which messages are dis‐
played.
If is not specified or is set to the
empty string, a default value of is
used. See the lang(5) man page by
typing for more information.
NOTE: The language in which the SD
agent and daemon log messages are
displayed is set by the system con‐
figuration variable script, For exam‐
ple, must be set to or to make the
agent and daemon log messages display
in Japanese.
Determines the locale to be used to override any
values for locale
categories specified by the settings
of or any environment variables
beginning with
Determines the interpretation of sequences of
bytes of text data as
characters (for example, single ver‐
sus multibyte characters in values
for vendor-defined attributes).
Determines the language in which messages should
be written.
Determines the format of dates
(create_date and mod_date) when dis‐
played by Used by all utilities when
displaying dates and times in and
Determines the time zone for use when displaying
dates and times.
Signals
The command catches the signals SIGQUIT and SIGINT. If
these signals are received, prints a message, sends a
Remote Procedure Call (RPC) to the daemons to wrap up,
and then exits.
Each agent will complete the list task before it wraps
up.
OPERATION
Different views of the job information are available.
The types of listings that can be selected are given
below.
· Default Listing
· Target Listing
· Logfile Listing
Default Listing
If is invoked with no options or operands, it lists all
jobs that are on the local host. This listing contains
one line for each job. The line includes the job tag
attribute and all other attributes selected via the
option.
Listing jobs on a remote controller is not supported. If
a jobid is given, information for only that job is dis‐
played.
Status Listing
If a or is given, the targets for that job and their sta‐
tus are displayed. By default the status information
includes Type, State, Progress and Results.
Logfile Listing
One of the attributes "log" encompasses a variety of log‐
file types. The type of logfile returned when the is
given depends on the operands given. The types of log‐
files:
No target_selections Show the controller
logfile (default).
@ target Show the agent log‐
file.
RETURN VALUES
The command returns:
The job information was successfully listed or the
job was successfully removed.
The list /remove operation failed for all
jobids.
The list /remove operation failed for some
jobids.
DIAGNOSTICS
The command writes to stdout, stderr, and to the agent
logfile.
Standard Output
All listings are printed to stdout.
Standard Error
The command writes messages for all WARNING and ERROR
conditions to stderr.
Logging
The command does not log summary events. It logs events
about each read task to the logfile associated with each
target_selection.
swagentd Disabled
If the daemon has been disabled on the host, it can be
enabled by the host's system administrator by setting the
entry in to and executing
EXAMPLES
To list all of the jobs that exist on the local host:
To show the scheduled date for job hostA-0001:
For job hostA-0001 list the targets and their status:
or
For job hostA-0001 list the controller log:
For job hostA-0001 list the targetA agent log:
FILES
Contains the user-specific default values for some or all
SD options.
Contains the master list of current SD options (with
their default values).
The directory which contains all of the configurable
(and non-configurable) data for SD. This direc‐
tory is also the default location of logfiles.
Contains the active system-wide default values for some
or all SD options.
The directory which contains the information about all
active and complete
install jobs, copy jobs, and other jobs initiated
by the SD commands.
AUTHOR
was developed by the Hewlett-Packard Company.
SEE ALSOinstall-sd(1M), swacl(1M), swagentd(1M), swask(1M),
swconfig(1M), swcopy(1M), swinstall(1M), swlist(1M),
swmodify(1M), swpackage(1M), swreg(1M), swremove(1M),
swverify(1M), sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swjob(1M)