hpux 10.20 - swlist (1)
NAME
swlist - Display information about software products
SYNOPSIS
swlist [-d|-r] [-l level] [-v] [-a attribute] [-R] [-s source] [-x
option=value] [-X option_file]
[-f software_file] [-t target_file] [-C session_file] [-S session_file]
[software_selections] [@ target_selections]
Remarks:
SD-UX commands are included with the HP-UX Operating System and manage
software on the local host only. To install and manage software
simultaneously on multiple remote hosts (including PCs) from a central
controller, you must purchase the HP OpenView Software Distributor (HP
Prod. No. B1996AA) which provides extended software management, multi-
site software distribution capabilities and distribution to PCs. While
most of the information in this manual page applies to both SD-UX
commands and the OpenView product, some applies only to the OpenView
product. Where this is the case, you will see:
The following xxx applies only to HP OpenView Software
Distributor
DESCRIPTION
The swlist command displays information about software products
installed at or available from the specified target_selections. It
supports these features:
+ Specify bundles, products, subproducts, and/or filesets to
list.
+ Display the files contained in each fileset.
+ Display a table of contents from a software source.
+ Specify the attributes to display for each software object.
+ Display all attributes for bundles, products, subproducts,
filesets and/or files.
+ Display the structure of software selections.
+ Display the depots on a specified host.
+ Create a list of products, subproducts, and/or filesets to use
as input to the swinstall or swremove commands.
Options
When no options or operands are specified, swlist lists the software
bundles (and products which are not part of a bundle) that are
installed at the local host. swlist supports the following options:
-d List software available from a depot (instead of software
installed on a root filesystem).
-r List products installed on an alternate root filesystem
(instead of software installed on /). As of HP-UX release
10.2*, -r is optional but is allowed to maintain
compatibility with previous versions.
-l level
List all objects down to the specified level. The supported
levels are:
The machine, user and group levels apply only to HP
OpenView Software Distributor
machine Show the machines known to a PC controller.
user Show the users known to a PC controller.
group Show the groups known to a PC controller.
shroot List all registered shared roots.
prroot List all registered private roots.
root List all roots.
depot Show only the depot level (i.e. depots which exist
at the specified target hosts).
bundle Show all objects down to the bundle level.
product Show all objects down to the product level (i.e.
depots and products).
subproduct
Show all objects down to the subproduct level
(i.e. depots, products, and subproducts).
fileset Show all objects down to the fileset level (i.e.
depots, products, and filesets). If subproducts
are wanted, use "-l fileset -l subproduct".
file Show all objects down to the file level (i.e.
depots, products, filesets, and files). If
subproducts are wanted, use "-l file -l
subproduct".
Both the specified level(s) and the depth of the specified
software_selections control the depth of the swlist output.
-v If no -a options are specified, then list all the attributes
for an object, one attribute per line. The attributes are
listed in the format:
keyword value
If one or more -a options are specified, then list the
selected attributes in the above format.
-a attribute
Each object has its own set of attributes. These attributes
include such things as revision, description, vendor
information, size, and many others. The -a option selects a
specific attribute to display. You can specify multiple -a
options to display multiple attributes.
Note that the tag attribute (i.e. the identifier) is always
displayed for product, subproduct, and fileset objects. The
path attribute (i.e. the filename) is always displayed for
file objects.
The full set of attributes for a given software object can
be obtained using the -v option. See also sd(4) for details
on these attributes.
-R Shorthand for -l bundle -l subproduct -l fileset.
-s source
Specifies the software source to list. This is an alternate
way to list a source depot. Sources can also be specified
as target depots and listed using the -d option.
-x option=value
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.
-X option_file
Read the session options and behaviors from option_file.
-f software_file
Read the list of software_selections from software_file
instead of (or in addition to) the command line.
-t target_file
Read the list of target_selections from target_file instead
of (or in addition to) the command line.
-C session_file
Save the current options and operands to session_file. You
can enter a relative or absolute path with the file name.
The default directory for session files is /.sw/sessions/.
You can recall a session file with the -S option.
-S session_file
Execute swlist 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 -C option.
Operands
The swlist command supports the following syntax for each
software_selection:
bundle[.product[.subproduct][.fileset]][,version]
or
product[.subproduct][.fileset][,version]
The version component has the form:
[,r <op> revision][,a <op> arch][,v <op> vendor][,c <op>
category]
or
[instance_id]
where <op> can be: ==, >=, <=, <, >, or != which performs individual
comparisons on dot-separated fields. For example, r>=B.10.00 means
choose all revisions that are greater than or equal to B.10.00. The
system will compare each dot-separated field to find matches. Software
will only be selected when matches within each field are satisfied.
Wildcards are not allowed with these operators.
The = (equals) relational operator is also allowed. It provides the
shell pattern matching notations []*?! or wildcards to specify
selections as opposed to comparing dot-separated fields.
All version components are repeatable within a single specification
(e.g. r>=A.12, r<A.20). If multiple components are used, the
selection must match all components. No isspace(3) characters are
allowed.
No software specification or the \* software specification selects all
products.
For complete information, see the
sd(4) manual page.
The swlist command supports the following syntax for each
target_selection. The : (colon) is required if both a host and
directory are specified.
[host][:][/directory]
The following PC information applies only to HP OpenView
Software Distributor
The command also supports the syntax:
[pc_controller]
This syntax only applies to the PC controllers and PC depots on PC
controllers.
EXTERNAL INFLUENCES
Defaults File
In addition to the standard options, list formats and swlist policy
options can be changed by editing the default values found in:
/var/adm/sw/defaults - the system-wide default values,
$HOME/.sw/defaults - the user-specific default values.
Values must be specified in a defaults file using this syntax:
swlist.option=value
The default values can be overridden by specifying an options file
with the -X option, or by specifying -x option=value on the command
line. The policy options that apply to swlist are:
agent_timeout_minutes=1440
Causes a target agent to exit if it has been inactive
for the specified time. The default of 1440 (24 hours)
applies only when the interactive UI is used. Usually,
the command line controller resets this to 10 minutes.
If you change this value to anything other than 1440,
that value will be used even if the controller is using
an interactive UI. When using command line invocation
of HP OpenView Software Distributor with multiple
targets and you have not changed this value from 1440,
the value will be reset to 9 minutes plus the number of
targets.
layout_version=1.0
The object and attribute syntax of SD now conforms to
the layout_version of 1.0 from the IEEE POSIX 1387.2
Software Administration standard. This options
controls to which layout_version the SD commands write
distributions and swlist output.
Supported values are "0.8" and "1.0". The value of "1.0" should
be used for future compatibility; the SD commands still accept
the old keyword names as well as the new ones. The value of
"0.8" should only be used to create distributions readable by
older versions of SD.
level=
Defines the default level to which objects are listed. The
valid levels are:
machine, (OpenView Software Distributor only)
user, (OpenView Software Distributor only)
group, (OpenView Software Distributor only)
root,
shroot.
prroot,
depot,
bundle,
product,
subproduct,
fileset, and
file.
one_liner=revision title
Defines the attributes which will be listed for each object
when no -a or -v options are specified. Each attribute
included in the one_liner definition is separated by <tab>
or <space>. Any attributes may be included in the one_liner
definition. If a particular attribute does not exist for an
object, then that attribute is silently ignored. For
example, the description attribute is valid for products,
subproducts, and filesets, but the architecture attribute is
only valid for products.
rpc_binding_info=ncadg_ip_udp:[2121]
Defines the protocol sequence and endpoint which will be
used to contact swagentd. This value should be consistent
among all hosts that work together. See sd(5) for details
on specifying this option.
rpc_timeout=7
For HP OpenView Software Distributor 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 will give
faster recognition on attempts to contact hosts that are not
up, or are not running the swagentd. Each value is
approximately twice as long as the preceding value. A value
of 5 is about 30 seconds for ncadg_ip_udp.
select_local=true
If no target_selections are specified, select the default
root directory /, or the default target_directory (when the
-d option is specified), at the local host as the target of
the command.
software=
Defines the default software_selections. There is no
supplied default. If there is more than software selection,
they must be separated by spaces.
software_view=all_bundles
For HP OpenView Software Distributor software_view=products.
Indicates the software view to be used as the default level
for the software listing. It can be set to products,
all_bundles, or a bundle category tag (to indicate to show
only bundles of that category).
target_directory=/var/spool/sw
Defines the default location of the target depot.
targets=
Defines the default target_selections. There is no supplied
default (see select_local above). If there is more than
target selection, they must be separated by spaces.
verbose=0
Controls how attribute values are displayed. A value of 0
displays only the attribute value. A value of 1 displays
both the attribute keyword and value. (See the -v option
above.)
Session File
Each invocation of the swlist command defines a list session. The
invocation options, source information, software 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
$HOME/.sw/sessions/swinstall{swcopy}.last. This file is overwritten by
each invocation of swlist.
You can also save session information to a specific file by executing
swlist with the -C 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
/.sw/sessions/.
To re-execute a session file, specify the session file as the argument
for the -S session__file option of swlist.
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 swlist take precedence over the values in the session file.
Environment Variables
The swlist program sets the following environment variable, which is
used by the software control scripts being executed.
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 lang(5) 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.
Signals
The swlist command catches the signals SIGQUIT and SIGINT. If these
signals are received, swlist prints a message, sends a Remote
Procedure Call (RPC) to the agents to wrap up, and then exits.
Each agent will complete the list task (if the execution phase has
already started) before it wraps up.
OPERATION
The output from swlist follows this rule with all options: only the
lowest level listed (product, subproduct, fileset or file) will be
uncommented. Among other things, this allows the output from swlist
to be used as input to other commands. The one exception is the list
that contains files; file-level output is not accepted by other
commands.
The types of listings that can be selected are given below. Some of
these listings are not exclusive choices, but rather ways to view the
objects while controlling the amount of output.
+ Default Listing
+ Software Listing
+ Root Listing
+ Depot Listing
+ Multiple Targets Listing
+ Verbose Listing
+ Fanout Listing (HP OpenView Software Distributor only)
Default Listing
If swlist is invoked with no software_selections and no
target_selections, a listing of all installed products on the local
host is produced. This listing contains one line for each product.
The line includes the product tag attributes and all other attributes
selected via the one_liner option.
If target_selections (i.e. target hosts) are specified, this same
format listing is produced for the installed software at each of the
specified hosts.
Software Listing
A listing of software objects is controlled by the specified
software_selections, and also by the -l option ( swlist.level=).
For each software object specified in the software_selections, swlist
lists the contents of each. For example, if you specify product
selections, then the subproducts and/or filesets contained immediately
below each product will be listed. If you specify fileset selections,
then the files contained in each fileset will be listed.
The depth of objects listed is controlled with the -l option. This
option can expand or restrict the depth in concert with the specified
software selections. By default, the contents of a specified software
selection are always listed (as described above). The -l option can
defeat this listing by specifying a level equivalent to the level of
objects in the software_selections. For example, if you want to list
specific product selections but not their contents, use -l product.
If you want to list specific fileset selections but not their
contained files, use -l fileset. The software_selection options do
not apply if the level is:
machine, (HP OpenView Software Distributor only)
user, (HP OpenView Software Distributor only)
group, (HP OpenView Software Distributor only)
root, or
depot.
In these cases, all objects of that type are listed.
Depot Listing
Another class of objects that swlist can display are software depots.
For example, the user can list all registered depots on a given host.
A combination of the -l depot option and target_selections operands
can produce a variety of depot listings.
Multiple Targets Listing
Multiple target_selections (i.e. root filesystems, alternate roots, or
depots) are listed sequentially: list all the requested objects and
attributes from the first target_selection, followed by the second
target_selection, etc.
Verbose Listing
The -v option causes a verbose listing to be generated. A verbose
listing includes all attributes defined for an object. The swlist
command will print the keyword and value for each attribute. The
attributes are listed one per line. The user can post-process
(filter) the output with grep(1), awk(1), and/or sed(1) to get the
fields of interest.
The depot's attributes are displayed if swlist is called with the -v
and -l depot options, and a specific depot target_selection.
Attributes for a particular software level
(product/subproduct/fileset/file) are displayed based on the depth of
the specified software_selections. For example, swlist -v
product1.fileset1 will give all fileset attributes for fileset1. If
the -v option is used with the -l option, the different listing are:
+ To display attributes for all products, use swlist -v -l
product
+ To display attributes for all products and subproducts, use
swlist -vl subproduct
+ To display attributes for all products, subproducts, and
filesets, use swlist -vl fileset
+ To display attributes for all products, subproducts, and
filesets, and files, use swlist -vl file
Fanout Listing
The following applies only to HP OpenView Software
Distributor
The swlist command can also list the users, groups, or machines
associated with a PC Controller; i.e. the valid PC targets which are
available for installation through the PC Controller. To list these
PC targets, use the -l user, -l group, or -l machine options.
RETURN VALUE
The swlist command returns:
0 The software_selections and/or target_selections were
successfully listed.
1 The list operation failed on all target_selections.
2 The list operation failed on some target_selections.
DIAGNOSTICS
The swlist command writes to stdout, stderr, and to the agent logfile.
Standard Output
All listings are printed to stdout.
Standard Error
The swlist command writes messages for all WARNING and ERROR
conditions to stderr.
Logging
The swlist command does not log summary events. It logs events about
each read task to the swagent logfile associated with each
target_selection.
EXAMPLES
To list all of the products installed on the local host:
swlist
Generate a comprehensive listing that includes all filesets for the
product NETWORKING:
swlist -v -l fileset NETWORKING
List all the attributes for the ARPA-RUN fileset:
swlist -v NETWORKING.ARPA.ARPA-RUN
List the C product installed on several remote hosts:
swlist cc @ hostA hostB hostC
List the FRAME product relocated to directory /opt on host1:
swlist FRAME,1=/opt @ host1
List all the versions of the FRAME product installed on the toolserver
host:
swlist FRAME @ toolserver
List all products in a shared root:
swlist -r @/export/shared_roots/OS_700
List products in a client's private root:
swlist -r @/export/private_roots/client
List the contents of the local tape, /dev/rmt/0m:
swlist -d @ /dev/rmt/0m
or, alternatively:
swlist -s /dev/rmt/0m
List the tag and revision attributes for all products on the local
tape /dev/rmt/0m:
swlist -d -a revision @ /dev/rmt/0m
or, alternatively:
swlist -a revision -s /dev/rmt/0m
Display the README file for the FRAME product:
swlist -a readme FRAME
List the products stored in a remote depot:
swlist -d @ hostA:/depot
List all depots on a host:
swlist -l depot @ hostA
The next two examples apply only to HP OpenView Software
Distributor
List all machines known to a PC controller:
swlist -l machine @ server
List all users known to a PC controller:
swlist -l user @ server
LIMITATIONS
The following applies only to HP OpenView Software
Distributor
For PCs, the swlist command only applies to the PC controller, and the
PC depot on the PC controller.
FILES
/var/adm/sw/
The directory which contains all of the configurable (and
non-configurable) data for SD. This directory is also the
default location of logfiles.
/usr/lib/sw/sys.defaults
Contains the master list of current SD options (with their
default values).
/var/adm/sw/defaults
Contains the active system-wide default values for some or all
SD options.
$HOME/.sw/defaults
Contains the user-specific default values for some or all SD
options.
$HOME/.sw/sessions/
Contains session files automatically saved by the SD commands,
or explicitly saved by the user.
/var/adm/sw/products/
The Installed Products Database (IPD), a catalog of all
products installed on a system.
/var/spool/sw/
The default location of a source and target software depot.
/var/adm/sw/host_object
The file which stores the list of depots registered at the
local host.
AUTHOR
swlist was developed by the Hewlett-Packard Company.
SEE ALSO
sd(4), sd(5), swacl(1M), swagentd(1M), swcluster(1M), swconfig(1M),
swcopy(1M), swgettools(1M), swinstall(1M), swjob(1M), swmodify(1M),
swpackage(1M), swpackage(4), swreg(1M), swremove(1M), swverify(1M),
update(1M), and the HP OpenView Software Distributor Administrator's
Guide or Managing HP-UX Software with SD-UX manuals.