NAME
hpvmcollect — Collects crash dumps, logs, system status,
and configuration on the VM Host and guests for post-mortem analysis.
SYNOPSIS
On the VM Host:
hpvmcollect { -P vm-name -p vm-number } [-f] [-g] [-h] [-b bug-report-number] [-d directory] [-c [-n crash-dump-number]] [-l|-s hostname [-r directory] ]
On the Guest:
hpvmcollect [-f] [-h] [-b bug-report-number] [-d directory] [-c [-n crash-dump-number]] [-l|-s hostname [-r directory] ]
DESCRIPTION
The hpvmcollect command collects
log files, system status, device information, system and Integrity
Virtual Machines configuration, guest information, and crash dumps.
When run on a VM Host, this command collects systemwide
information as well as information for a specified guest. In this
case, you can specify a guest using the virtual machine name or the
virtual machine number.
When run in a guest, the hpvmcollect command collects information associated only with the guest.
The hpvmcollect command creates
a directory and produces a tar archive or a compressed tar archive containing the collected information and places
it in your current directory. By default, the archive name is constructed
by appending a timestamp to the guest name.
Only superusers can execute the hpvmcollect command.
Options
The following options can be specified only once.
The hpvmcollect command recognizes
the following command-line options and arguments:
- -b bug-report-number
Overrides the default
archive name with bug-report-number plus the
specified label. If an archive with the same name exists, it is renamed
by appending a timestamp to the original name before the new archive
is created. Valid on both the VM Host and the guest.
- -c
Includes the latest crash
dump directory in the archive. This option is used if the guest or
the VM Host crashes or hangs. Valid on both the VM Host and the guest.
- -d directory
Specifies a target directory
in which to create the hpvmcollect_archive directory.
Valid on both the VM Host and the guest.
- -f
Forces an archive to be
overwritten, if it exists, rather than renamed with an appended timestamp.
Valid on both the VM Host and the guest.
- -g
Cleans up a guest debug
memory dump directory after a memory dump has been collected into
the hpvmcollect archive. Valid on the VM Host only.
- -n crash-dump-number
Specifies the number of
crash dumps to copy to the archive. Valid on both the VM Host and
the guest. By default, the hpvmcollect command
copies the latest crash dump directory (based on the bounds file).
This option can be used only with the -c option.
- -l
Leaves the collected information
in the directory rather than an archiving it. Valid on both the VM
Host and the guest. The -l option and the -s option are mutually exclusive.
- -s hostname
Specifies a host name
to receive the archive, which is copied using scp. Verify that you can login to the host without a password. Valid
on both the VM Host and the guest. Note that the -l option and the -s option are mutually exclusive.
- -h
Displays the help message.
Valid on both the VM Host and the guest.
- -P vm_name
Specifies the unique name
of the virtual machine to be archived. Valid on the VM Host only.
The -P and -p options are mutually exclusive.
- -p vm_number
Specifies the unique number
of the virtual machine to be archived. The vm_number is displayed by the hpvmstatus command. Valid
on the VM Host only.
The -P and -p options are mutually exclusive.
- -r directory
Specifies a remote target
directory in which to store the collected archive, overriding the
default of /crashes. Valid on both the VM Host and the guest. The -r option is valid only with the -s option.
RETURN VALUES
The hpvmcollect command exits
with one of the following values:
0: Successful completion.
1: One or more error conditions occurred.
DIAGNOSTICS
The hpvmcollect command displays
the status of each collection line by line:
OK: The item collection
was successful.
NO: The option was not used
to collect the item.
N/A: hpvmcollect was supposed
to collect the item but failed. Possible reasons include:
The command is not available (for example, it
may not be in $PATH).
The command exited with an error; thus, there
was no collection.
The condition that triggers the log file generation
did not occur.
AUTHORS
The hpvmcollect command was
developed by HP.
SEE ALSO
On the VM Host:
hpvm(5), hpvmclone(1M), hpvmconsole(1M), hpvmcreate(1M), hpvmdevmgmt(1M), hpvmdevtranslate(1M), hpvmhostrdev(1M), hpvminfo(1M), hpvmmigrate(1M), hpvmmodify(1M), hpvmnet(1M), hpvmpubapi(3), hpvmremove(1M), hpvmresources(5), hpvmsar(1M), hpvmstart(1M), hpvmstatus(1M), hpvmstop(1M), hpvmupgrade(1M), p2vassist(1M)
On the Integrity VM guest:
hpvmmgmt(1M), hpvminfo(1M), hpvmpubapi(3)