1. Types
  2. vapi
  3. metadata
  4. cli
  5. command

vapi metadata cli command: option info

The option_info structure describes information about a specific input option of a command.

Representation:

{
    "short_option" : "string",
    "long_option" : "string",
    "description" : "string",
    "type" : "string",
    "generic" : "NONE",
    "field_name" : "string"
}

Attributes:

Name Type Description
Required
long_option string The long option name of the parameter as used by the user.
field_name string The fully qualified name of the option referred to by the operation element in vapi.metadata.cli.command.info.operation_id.
description string The description of the option to be displayed to the user when they request usage information for a CLI command.
type string The type of option. This is used to display information about what kind of data is expected (string, number, boolean, etc.) for the option when they request usage information for a CLI command. For enumerated type this stores the fully qualified enumerated type id.
generic string This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times.

Defines generic types supported by command service. See vapi.metadata.cli.command.option_info.generic. Value is one of:
NONE: Default case.
OPTIONAL: Input parameter is an optional.
LIST: Input parameter is a list.
OPTIONAL_LIST: Input parameter is an optional of type list. This constant was added in vSphere API 6.5.
LIST_OPTIONAL: Input parameter is a list of optionals. This constant was added in vSphere API 6.5.
Optional
short_option string The single character value option name.

Optional. If not present, there's no single character option for the parameter.