19.5. The Log Collector Tool

General options

--version

Displays the version number of the command in use and returns to prompt.

-h, --help

Displays command usage information and returns to prompt.

--conf-file=PATH

Sets PATH as the configuration file the tool is to use.

--local-tmp=PATH

Sets PATH as the directory in which logs are saved. The default directory is /tmp/logcollector.

--ticket-number=TICKET

Sets TICKET as the ticket, or case number, to associate with the SOS report.

--upload=FTP_SERVER

Sets FTP_SERVER as the destination for retrieved logs to be sent using FTP. Do not use this option unless advised to by a Red Hat support representative.

--log-file=PATH

Sets PATH as the specific file name the command should use for the log output.

--quiet

Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.

-v, --verbose

Sets verbose mode, providing more console output. Verbose mode is off by default.

--time-only

Displays only information about time differences between hosts, without generating a full SOS report.

Red Hat Virtualization Manager Options

--no-hypervisors

Omits virtualization hosts from the log collection.

--one-hypervisor-per-cluster

Collects the logs of one host (the SPM, if there is one) from each cluster.

-u USER, --user=USER

Sets the user name for login. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Virtualization Manager.

-r FQDN, --rhevm=FQDN

Sets the fully qualified domain name of the Red Hat Virtualization Manager server from which to collect logs, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the log collector is being run on the same local host as the Red Hat Virtualization Manager; the default value is localhost.

-c CLUSTER, --cluster=CLUSTER

Collects logs from the virtualization hosts in the nominated CLUSTER in addition to logs from the Red Hat Virtualization Manager. The cluster(s) for inclusion must be specified in a comma-separated list of cluster names or match patterns.

-d DATACENTER, --data-center=DATACENTER

Collects logs from the virtualization hosts in the nominated DATACENTER in addition to logs from the Red Hat Virtualization Manager. The data center(s) for inclusion must be specified in a comma-separated list of data center names or match patterns.

-H HOSTS_LIST, --hosts=HOSTS_LIST

Collects logs from the virtualization hosts in the nominated HOSTS_LIST in addition to logs from the Red Hat Virtualization Manager. The hosts for inclusion must be specified in a comma-separated list of host names, fully qualified domain names, or IP addresses. Match patterns are also valid.

SSH Configuration

--ssh-port=PORT

Sets PORT as the port to use for SSH connections with virtualization hosts.

-k KEYFILE, --key-file=KEYFILE

Sets KEYFILE as the public SSH key to be used for accessing the virtualization hosts.

--max-connections=MAX_CONNECTIONS

Sets MAX_CONNECTIONS as the maximum concurrent SSH connections for logs from virtualization hosts. The default is 10.

PostgreSQL Database Options

--no-postgresql

Disables collection of database. The log collector will connect to the Red Hat Virtualization Manager PostgreSQL database and include the data in the log report unless the --no-postgresql parameter is specified.

--pg-user=USER

Sets USER as the user name to use for connections with the database server. The default is postgres.

--pg-dbname=DBNAME

Sets DBNAME as the database name to use for connections with the database server. The default is rhevm.

--pg-dbhost=DBHOST

Sets DBHOST as the host name for the database server. The default is localhost.

--pg-host-key=KEYFILE

Sets KEYFILE as the public identity file (private key) for the database server. This value is not set by default; it is required only where the database does not exist on the local host.