Support Utilities (EE)

Important

This feature is available only in OpenNebula Enterprise Edition.

OpenNebula provides customers with means to generate diagnostic bundles with all details necessary to handle the support cases. It covers:

  • Gathering the configuration state of operating system and services on the Front-end and nodes.

  • Inspecting OpenNebula configuration, the state and metadata of VMs, Hosts, Virtual Networks, etc.

  • Dumping OpenNebula database.

  • Scanning vCenter user permissions.

There are two specialized tools contained in the OpenNebula server package:

Generate Support Bundle

Important

If you have a vCenter infra, in order to gather more information about vCenter, you need to use sudo onesupport instead of onegather, for more information please check sudo onesupport --help.

If there are no special requirements, the support diagnostic bundle can be generated just by running onegather on the Front-end without any extra parameters. The command must be running under privileged user (directly by root or via sudo). For example:

sudo onegather

The command generates a diagnostic bundle archive and puts it into /tmp/. The precise file location is shown at the end of the terminal output, e.g.:

Bundle ZIP: /tmp/d20220429-22314-1382f6c.zip

Please attach this file to the support ticket.

Important

For most support issues it’s enough to provide just a limited support bundle with Front-end only specific information and without database dumps. The limited bundle can be generated by running:

sudo onegather --group fe --no-db

The tool prints all actions, based on which you can decide if you want to provide such a bundle to the support team. Here’s an example of a full output:

$ sudo onegather
Get OS distribution
Get current user
Get user "oneadmin"
Get installed packages
Get kernel version
Get security settings
Get memory/swap
Get Ruby version and Gems
Get CPU information
Get system services
Get process list
Get kernel runtime parameters (sysctl)
Get mounts
Detect web server
Get OpenNebula version
Get OpenNebula running processes
Detect changes in OpenNebula packages
Get OpenNebula database information
Get OpenNebula hosts
Get OpenNebula logs
Get system logs
Dump OpenNebula database
Get OpenNebula configuration
Get OpenNebula remotes
Dump OpenNebula objects
Dump OpenNebula instance objects
Get web server configuration
Inspecting the OpenNebula hosts
[localhost] Get OS distribution
[localhost] Get current user
[localhost] Get user "oneadmin"
[localhost] Get installed packages
[localhost] Get kernel version
[localhost] Get security settings
[localhost] Get memory/swap
[localhost] Get Ruby version and Gems
[localhost] Get CPU information
[localhost] Get system services
[localhost] Get process list
[localhost] Get kernel runtime parameters (sysctl)
[localhost] Get mounts
[localhost] Get IP/bridge runtime config.
[localhost] Get firewall config
[localhost] Get Open vSwitch runtime config.
[localhost] Detect libvirt
[localhost] Get libvirt domains list
[localhost] Get libvirt domains XML and screenshots
[localhost] Get libvirt configuration
[localhost] Get system logs

** Results **
-> Bundle: /tmp/d20220428-2468-zlxnpl
-> Bundle ZIP: /tmp/d20220428-2468-zlxnpl.zip

Advanced Usage

The purpose of the onegather tool is to gather as much information as possible about the environment so that OpenNebula’s customer care can give more accurate and faster responses. The usage is very simple and there are only a few configuration options. There are brief descriptions of all of them available via argument --help.

sudo onegather --help
Usage: onegather [options]
    -v, --vm=VM                      Get information about specific VM
    -g, --group=GROUP                Group to process
        --no-confg                   Do not get configuration files
        --no-db                      Do not get database
        --no-logs                    Do not get log files

There are two types of arguments to specify:

  • host type

  • dump type

Host Types

What data is gathered depends mainly on the type of host we are running the tool on. Each host type gets the same common data (operating system, hardware, memory, installed software packages, system services, mounts, logs etc.) and differs only in data specific to the type.

Available options are:

Option

Main Subject

fe

OpenNebula Front-end services configuration and state, database dump, various entities (e.g., VMs).

host

Hypervisor services (libvirt, KVM) and network configuration.

all

Combination of frontend mode and host mode. It starts with Front-end specific data and connects to each virtualization host to get Host-specific data. This mode is the default.

Examples

Simple run gathers all information (runs are equivalent):

sudo onegather
sudo onegather -g all

Get only Front-end specific data (must run on Front-end):

sudo onegather -g fe

Get only host-specific data (must run on hypervizor Node):

sudo onegather -g host

Dump Types

The level of detail contained in the gathered data can be adjusted by dump type parameters. The following types are supported:

Option

Description

no-db

Disable database dumps.

no-conf

Disable bundling of configuration files.

no-logs

Disable bundling of logs.

All dump types are enabled by default (db conf logs), but can be selectively disabled with negative options no-db, no-conf and/or no-logs.

Important

If negative dump types (no-db, no-conf, no-logs) are used, these types are excluded from the support bundle. All the remaining types are included.

Examples

A simple run gathers all information (these runs are equivalent):

sudo onegather

Get support bundle without any database dumps and logs:

sudo onegather --no-db --no-logs

Get support bundle with database dump, but no logs and configurations:

sudo onegather --no-conf --no-logs

Dump types and host types parameters can be combined

sudo onegather -g fe --no-db

Scan vCenter Permissions

When you are using OpenNebula cloud to manage vCenter infrastructure, it might also be necessary to know details about the permissions configuration inside vCenter. This is automatically retrieved during the support bundle preparation but can be scanned separately at any time (e.g., in case the automatic run fails).

The dedicated tool onesupport_vcenter_privs is used to gather permissions configuration.

Important

The tool connects directly to your vCenter instance and must be provided with connection parameters.

Syntax:

onesupport_vcenter_privs
Usage: onesupport_vcenter_privs [arguments]

Mandatory arguments:
  --host=name       .... vCenter hostname
  --user=name       .... vCenter login user name
  --password=text   .... vCenter password
  --check-user=name .... vCenter user for OpenNebula to check

Example run:

onesupport_vcenter_privs --host=vcenter.localdomain \
    --user=administrator@vsphere.local --password=TopSecretPassword \
    --check-user=oneadmin@vsphere.local

The result is printed on the terminal (standard output). It can be redirected to the file or just copied and pasted in the support ticket.