REST API - option

vapi metadata cli command: option info

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

Representations:

JSON
XML

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

<?xml version="1.0" ?>
<ns0:OptionInfo xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <generic>NONE</generic>
  <field_name>string</field_name>
  <description>string</description>
  <type>string</type>
  <long_option>string</long_option>
  <short_option>string</short_option>
</ns0:OptionInfo>

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. New in vSphere 6.5. LIST_OPTIONAL: Input parameter is a list of optionals. New in vSphere 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.