option_info
structure describes information about a specific input option of a command.
{
"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> |
Name | Type | Required | Description |
---|---|---|---|
long_option* |
string | Yes | The long option name of the parameter as used by the user. |
short_option | string | No. If not present, there's no single character option for the parameter. | The single character value option name. |
field_name* |
string | Yes | The fully qualified name of the option referred to by the operation element in com.vmware.vapi.metadata.cli.command.info.operation_id. |
description* |
string | Yes | The description of the option to be displayed to the user when they request usage information for a CLI command. |
type* |
string | Yes | 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* |
com.vmware.vapi.metadata.cli.command.generic_type | Yes | This is used to tell the user whether the option is required or optional, or whether they can specify the option multiple times. The generic_type enumerated type defines generic types supported by command service. See com.vmware.vapi.metadata.cli.command.option_info.generic.Values one of NONE: Default case. OPTIONAL: Input parameter is an optional. LIST: Input parameter is a list. |
Copyright © 2014. All Rights Reserved.