swa-clean(1M)swa-clean(1M)NAME
- remove files created by
SYNOPSISDESCRIPTION
The command allows the user to remove software and files cached by
Software Assistant (SWA). As SWA is used to report on systems and
download software, objects will be cached on disk for later use. There
are two caches, the first for catalog, inventory, and analysis informa‐
tion, and the second for software downloaded from HP. The command
allows the recapture of this disk space.
Remove files containing software downloaded by
into the swcache. The swcache directory is specified by the
extended option. This is often gigabytes in size.
Remove cached files that were created by
These files are stored in the subdirectory of the directory
specified by the extended option. Generally, this includes the
inventories of systems and depots, the catalog of issues and
recommended resolutions, and the results of the analysis. This
is often a dozen or more megabytes in size.
Clean the
and the recognizes the following options:
Run this command in preview mode.
The verbosity level is decreased by one for each instance
is specified. (See also the option.)
The verbosity level is increased by one for each instance
is specified. (See also the option.)
Displays general usage.
Describes the legal values for this option. If <option> is
all possible extended options are listed for the speci‐
fied major mode. If no mode is given, all extended
options are listed.
Sets the extended option to a value. See Extended Options defi‐
nitions below.
Describe the legal values for this option.
Gets the extended options from
option_file. (See the file for a description and exam‐
ples of syntax for this file).
The extended options may be specified in different ways: on the command
line using the option, in an option file specified using the option, or
in one of the configuration files (system wide) or (user-specific).
The file provides example syntax for a configuration or file. If the
same option is given in multiple locations, the following order is pri‐
oritized from highest to lowest:
1. Options specified on the command line
2. Options specified within an option file
3. Proxy environment variables (See Environment Variable
section.)
4. Options specified within the $HOME/.swa.conf file
5. Options specified within the /etc/opt/swa/swa.conf file
6. Default value, specified in the descriptions of each
option below in format
Note: If the same option or extended option is given multiple times in
the same location, the last takes effect. If the option has a single
letter equivalent (e.g., and ) and both are used on the command line,
the single letter option generally takes precedence. If the single
letter option affects an extended option that takes a list of argu‐
ments, specifying the single letter option multiple times will append
to the list.
recognizes the following (extended) options, which are shown with their
default values:
Usage: Basic
Applicable caches: swcache usercache all
This is the path to the log file for this command. Each time
SWA is run, this file will grow larger. This can be changed,
for example, to a month-specific location for easier archiving,
off-host backup, and rotation.
Usage: Basic
Applicable caches: swcache usercache all
Specifies the level of message verbosity in the log file (See
also -x verbosity). Legal values are:
Only ERROR messages and the startingending BANNER messages.
Adds WARNING messages.
Adds NOTE messages.
Adds INFO messages (informational messages preceded by the '*'
character).
Adds verbose INFO messages.
Adds very-verbose INFO messages.
Usage: Basic
Applicable caches: swcache usercache all
If true, run this command in preview mode only (i.e., complete
the analysis phase and exit; no changes are committed to disk).
Setting this option to true has the same effect as specifying -p
on the command line.
Usage: Basic
Applicable caches: swcache all
This is the directory where SWA stores downloaded patches before
putting them into a depot. The default location is only
writable by root, so this value needs to be changed for a non-
root user to be able to download software. Opening up permis‐
sions on the default location is not recommended.
Usage: Basic
Applicable caches: usercache all
The directory where swa stores catalog, inventory, analysis,
ignore, and report files. The default location is a subdirec‐
tory (.swa) of the user's home directory. This can be changed,
for example, to allow archival of previous interim artifacts in
a date-specific directory or off-host. Several other options
default to a directory relative to this directory, so changing
this option allows all of those locations to stay in synch rela‐
tive to a common root.
Usage: Basic
Applicable caches: swcache usercache all
Specifies the level of stderr verboseness:
Only ERROR messages and the startingending BANNER messages.
Adds WARNING messages.
Adds NOTE messages.
Adds INFO messages (informational messages preceded by the '*'
character).
Adds verbose INFO messages.
Adds very-verbose INFO messages.
Note: The '-v' option is equivalent to increasing ver‐
bosity by 1 (e.g., from 3 to 4) and the '-q' option is
equivalent to decreasing verbosity by 1. The '-v' and
'-q' options can be used more than once.
Return Values
returns the following values:
Success
Error
Warning
Examples
To display usage information:
To display usage and list all extended options:
To run using the options specified in the file "./myconfig":
To remove all cached inventory, catalog, and analysis information in
the default location:
To remove all cached downloaded software in the default location:
To preview the removal of all cached downloaded software in the default
location:
To remove all cached inventory, catalog, analysis, and downloaded soft‐
ware in specified locations:
AUTHOR
was developed by Hewlett-Packard Development Company, L.P.
FILES
The per-user Software Assistant configuration file. This file takes
precedence over the system-wide SWA configuration file.
An HP-supplied catalog file from the ITRC website that
contains known security issues and other defects along with
their solutions. This file is downloaded with the command swa
report or swa step catalog.
The analysis of the inventory file and the catalog file
created with swa report or swa step analyze.
The inventory of installed software created by swa
inventory or swa step inventory.
Use this file to specify issues for analyzers to ignore. It is
possible to use more than one ignore file by using the extended
option ignore_file.
The comprehensive report written by swa report and
swa step report.
Default alternative log file if you don't have permissions
to write to /var/opt/swa/swa.log.
The system-wide SWA configuration file.
An example configuration file outlining the usage of each
extended option.
Script to configure HP SIM 5.2 and later for SWA. Only
required if SWA is installed when HP SIM is installed but not
running. HP SIM must be running when configHPSIM is run.
Manpages.
The default directory for downloading software before it
is packaged in a depot. This directory can be set with the
extended option swcache. Note that this directory can consume a
significant amount of disk space.
Directory that holds all clients' files generated from SWA
within HP SIM. Files are kept in user and job-specific subdirec‐
tories. This directory might require significant space to sup‐
port clients' analysis, catalog, inventory, and report files.
User-specific directory used by SWA when running under
HP SIM.
Default log file.
Lists all files downloaded from HP to the swcache. It is
located in the swcache directory.
Lists special installation instructions and dependencies
for the patches in the depot. It is located in the depot direc‐
tory.
SEE ALSO
swa(1M), swa-report(1M), swa-get(1M), swa-step(1M), and secu‐
rity_patch_check(1M).
swa-clean(1M)
