summaryrefslogtreecommitdiff
path: root/doc/manual/en_US/dita/topics/ts_vboxbugreport.dita
blob: 25592ce16a658ef6558266cfb60cda4b3e47528c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic xml:lang="en-us" id="ts_vboxbugreport">
  <title>Using the VBoxBugReport Command to Collect Debug Information
        Automatically</title>
  
  <body>
    <p>
        The <userinput>VBoxBugReport</userinput> command is used to collect
        debug information automatically for an Oracle VM VirtualBox
        installation. This command can be useful when you need to gather
        information to send to Oracle Support.
      </p>
    <p>
        The following examples show how to use
        <userinput>VBoxBugReport</userinput>.
      </p>
    <p>
        By default, the command collects <userinput>VBoxSVC</userinput>
        process logs, device settings, and global configuration data for
        an Oracle VM VirtualBox host.
      </p>
    <pre xml:space="preserve">$ VBoxBugReport
  ...
  0% - collecting VBoxSVC.log.10...
  7% - collecting VBoxSVC.log.9...
  ...
 64% - collecting VBoxSVC.log.1...
 71% - collecting VBoxSVC.log...
 78% - collecting VirtualBox.xml...
 85% - collecting HostUsbDevices...
 92% - collecting HostUsbFilters...
100% - compressing...

Report was written to '2019-03-26-13-32-02-bugreport.tgz'</pre>
    <p>
        The results are saved as a compressed tar file archive in the
        same directory where the command is run.
      </p>
    <p>
        To specify a different output file location:
      </p>
    <pre xml:space="preserve">$ VBoxBugReport --output ~/debug/bug004.tgz</pre>
    <p>
        To output all debug information to a single text file, rather
        than a <filepath>tgz</filepath> file:
      </p>
    <pre xml:space="preserve">$ VBoxBugReport --text</pre>
    <p>
        To collect information for a specific VM, called
        <codeph>Windows_10</codeph>:
      </p>
    <pre xml:space="preserve">$ VBoxBugReport Windows_10</pre>
    <p>
        This command collects machine settings, guest properties, and
        log files for the specified VM. Global configuration information
        for the host is also included.
      </p>
    <p>
        To collect information for several VMs, called
        <codeph>Windows_7</codeph>, <codeph>Windows_8</codeph>, and
        <codeph>Windows_10</codeph>:
      </p>
    <pre xml:space="preserve">$ VBoxBugReport Windows_7 Windows_8 Windows_10</pre>
    <p>
        To collect information for all VMs:
      </p>
    <pre xml:space="preserve">$ VBoxBugReport --all</pre>
    <p>
        To show a full list of the available command options, run
        <userinput>VBoxBugReport --help</userinput>.
      </p>
  </body>
  
</topic>