Getting Started¶

Installation¶

hvmcli is pre-installed on all HPE HVM hosts. No manual installation is required.

To verify the installed version:

sudo hvmcli version

hvmcli 1.0.0 (build 20260719)

Usage¶

The general syntax for hvmcli commands is:

sudo hvmcli <namespace> <command> [options]

For example:

sudo hvmcli vm list
sudo hvmcli node list
sudo hvmcli virtswitch list

To get help on any namespace:

sudo hvmcli <namespace> help

Global Options¶

The following options are available for all commands:

JSON Output¶

All commands support --json output for automation and integration with other tools. JSON responses follow a standard envelope format:

{
  "errorCode": 0,
  "messages": "",
  "data": { ... }
}

• errorCode: 0 indicates success, non-zero indicates an error.

• messages: Empty on success, contains error description on failure.

• data: The command-specific response payload.

Namespace Availability¶

Not all namespaces are available on every HVM version:

All other namespaces are available on both versions.

Namespaces¶

hvmcli is organized into the following namespaces: