Metadata_Cli_Command_Info

The Command.Info structure contains information about a command. It includes the identity of the command, a description, information about the service and operation that implement the command, and CLI-specific information for the command.

JSON Example

{
    "identity": {
        "path": "string",
        "name": "string"
    },
    "description": "string",
    "service_id": "string",
    "operation_id": "string",
    "options": [
        {
            "long_option": "string",
            "short_option": "string",
            "field_name": "string",
            "description": "string",
            "type": "string",
            "generic": "string"
        }
    ],
    "formatter": "string",
    "output_field_list": [
        {
            "structure_id": "string",
            "output_fields": [
                {
                    "field_name": "string",
                    "display_name": "string"
                }
            ]
        }
    ]
}

Metadata_Cli_Command_Identity

identity

Required

The Command.Identity structure uniquely identifies a command in the CLI commands tree.

string

description

Required

The text description displayed to the user in help output.

string

service_id

Required

The service identifier that contains the operations for this CLI command. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service.

string

operation_id

Required

The operation identifier corresponding to this CLI command. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation.

array of Metadata_Cli_Command_OptionInfo

options

Required

The input for this command.

Metadata_Cli_Command_FormatterType

formatter

Optional

The Command.FormatterType enumerated type defines supported CLI output formatter types. See Command.Info.formatter.
SIMPLE : Displays command output as it is.
TABLE : Displays command output in table format.
JSON : Displays command output in JSON format.
XML : Displays command output in XML format.
CSV : Displays command output in CSV format.
HTML : Displays command output in HTML format.

array of Metadata_Cli_Command_OutputInfo

output_field_list

Required

List of output structure name and output field info.