LinuxCommandLibrary

openstack-help

Display OpenStack command-line help information

TLDR

Display a description of a particular command

$ openstack help [command_name]
copy

Get help for Identity v3
$ openstack --os-identity-api-version 3 --help
copy

Display help
$ openstack --help
copy

SYNOPSIS

openstack help [command]

PARAMETERS

command
    The specific OpenStack command or service for which help is needed. If omitted, openstack-help displays general help about the OpenStack CLI.

DESCRIPTION

The openstack-help command provides access to help information for the OpenStack command-line interface (CLI). It displays help messages related to various OpenStack services and their associated commands. This is a crucial tool for both novice and experienced OpenStack users, helping them discover the available commands, their syntax, and options.

The help system typically extracts information directly from the installed OpenStack client packages, meaning the available help accurately reflects the installed versions and supported features. It simplifies command discovery, allowing users to quickly find information about specific tasks and services.

It is an essential tool to master, it allows you to search the available functions of openstack from the linux command line. The usage of this command varies based on the installed OpenStack clients and the depth of the information provided by their respective help systems.

EXAMPLES

To get help about the 'server create' command:
openstack help server create

To get general help about the OpenStack CLI:
openstack help

SEE ALSO

openstack(1)

Copied to clipboard