Command Line Interface on

Overview

Mon, 17 Feb 2025 00:00:00 +0000

Here you will find information about the core command-line interfaces and support utilities available to manage and diagnose an OpenNebula installation.

How Should I Read This Chapter

Command Line Interface (CLI): provides a comprehensive reference for the suite of one* commands (e.g., onevm, onehost, onedatastore) used for full lifecycle management of cloud resources.

Command Line Interface Configuration: details the configuration of the shell environment using variables like ONE_XMLRPC´ and ONE_AUTH´, and explains how to customize CLI output formats.

Command Line Interface

Mon, 17 Feb 2025 00:00:00 +0000

OpenNebula provides a set of commands to interact with the system:

CLI

oneacct: gets accounting data from OpenNebula.
oneacl: manages OpenNebula ACLs.
onecfg: manages OpenNebula configuration files upgrade.
onecluster: manages OpenNebula clusters.
onedatastore: manages OpenNebula datastores.
onedb: OpenNebula database migration tool.
onegroup: manages OpenNebula groups.
onehook: manages OpenNebula hooks.
onehost: manages OpenNebula Hosts.
oneimage: manages OpenNebula images.
onemarket: manages internal and external Marketplaces.
onemarketapp: manages appliances from Marketplaces.
onesecgroup: manages OpenNebula security groups.
oneshowback: OpenNebula Showback tool.
onetemplate: manages OpenNebula templates.
oneuser: manages OpenNebula users.
onevdc: manages OpenNebula Virtual Data centers.
onevm: manages OpenNebula Virtual Machines.
onevmgroup: manages OpenNebula VMGroups.
onevnet: manages OpenNebula networks.
onevntemplate: manages OpenNebula networks templates.
onevrouter: manages OpenNebula Virtual Routers.
onezone: manages OpenNebula Zones.
oneirb: opens an irb session.
onelog: access to OpenNebula services log files.
oneswap: convert Virtual Machines from vCenter to OpenNebula.

The output of these commands can be customized by modifying the configuration files found in /etc/one/cli/. They also can be customized on a per-user basis, in this case the configuration files should be placed in $HOME/.one/cli.

Command Line Interface Configuration

Mon, 17 Feb 2025 00:00:00 +0000

There are necessary environment variables and command-line arguments for OpenNebula users to authenticate and communicate with the core services, ensuring proper function of the one* CLI tools. You will also find about the use of command-line parameters (–user, –password, –endpoint) as an alternative to environment variables and notes configuration for OneFlow and OneGate services.

Shell Environment

OpenNebula users should have the following environment variables set, you may want to place them in the .bashrc of the user’s Unix account for convenience:

Support Utilities (EE)

Mon, 17 Feb 2025 00:00:00 +0000

OpenNebula provides customers with the means to generate diagnostic bundles with all details necessary to handle support cases. The OpenNebula server package contains OneGather, a specialized tool that generates an archive bundle with information about the OpenNebula instance, such as configuration, database, and Hosts’ state.

Important

This feature is available only in OpenNebula Enterprise Edition.

Generate Support Bundle

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: