.\" -*- nroff -*-
.so lib/ovs.tmac
.TH ovs\-bugtool 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
.\" This program's name:
.ds PN ovs\-bugtool
.
.SH NAME
ovs\-bugtool \- Open vSwitch bug reporting utility
.
.SH SYNOPSIS
.B ovs\-bugtool
.
.SH DESCRIPTION
Generates a debug bundle with useful information about Open vSwitch on this
system and places it in \fB/var/log/ovs-bugtool\fR.
.
.SH "COLLECTION OPTIONS"
.PP
These options influence what categories of data \fBovs\-bugtool\fR
collects.
.
.IP "\fB\-\-entries=\fIlist\fR"
Collect the capabilities specified in the comma-separated \fIlist\fR.
.IP "\fB\-\-all\fR"
Collect all available capabilities.
.IP "\fB\-\-ovs\fR"
In addition to Open vSwitch configuration and status,
\fBovs\-bugtool\fR can collect a variety of relevant system
information.  This option limits collection to Open vSwitch-specific
categories.
.IP "\fB\-\-log\-days=\fIdays\fR"
Include the logs with last modification time in the previous \fIdays\fR days
in the debug bundle. The number of log files included has a big impact on the
eventual bundle size. The default value is 20 days.
.IP "\fB\-y\fR"
.IQ "\fB\-\-yestoall\fR"
Answer yes to all prompts.
.IP "\fB\-\-capabilities\fR"
Writes the categories that \fBovs\-bugtool\fR can collect on stdout in
XML, then exits.
.
.SH "OUTPUT OPTIONS"
.PP
These options influence the format and destination of
\fBovs\-bugtool\fR output.
.
.IP "\fB\-\-output=\fIfiletype\fR"
Generates a debug bundle with the specified file type.  Options include
\fBtar\fR, \fBtar.gz\fR, \fBtar.bz2\fR, and \fBzip\fR.
.IP "\fB\-\-outfile=\fIfile\fR"
Write output to \fIfile\fR.  Mutually exclusive with \fB\-\-outfd\fR.
.IP "\fB\-\-outfd=\fIfd\fR"
Write output to file descriptor \fIfd\fR.  This option must be used
with \fB\-\-output=tar\fR.
.IP "\fB\-\-unlimited\fR"
Do not exclude files which are too large. Also skip checking free disk space.
By default up to 90 percent of the free disk space can be used.
.IP "\fB\-\-debug\fR"
Print verbose debugging output.
.
.SH "OTHER OPTIONS"
.
.IP "\fB\-s\fR"
.IQ "\fB\-\-silent\fR"
Suppress most output to stdout.
.IP "\fB\-\-help\fR"
Print a summary of \fBovs\-bugtool\fR usage to stdout, then exit.
.
.SH EXAMPLES
.PP
Here's a collection of some commonly useful options:
.PP
\fBovs\-bugtool \-y \-s \-\-output=tar.gz \-\-outfile=/var/log/bugtool-report.tgz\fR
.
.SH BUGS
\fBovs\-bugtool\fR makes many assumptions about file locations and the
availability of system utilities.  It has been tested on Debian and
Red Hat and derived distributions.  On other distributions it is
likely to be less useful.