REST API - info

vapi metadata cli command: info

The 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.

Representation:

JSON

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

Attributes:

Name	Type	Description
Required
identity	identity	Basic command identity.
description	string	The text description displayed to the user in help output.
service_id	string	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`.
operation_id	string	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`.
options	option_info[]	The input for this command.
output_field_list	output_info[]	List of output structure name and output field info.
Optional
formatter	string	The formatter to use when displaying the output of this command. Optional. If not present, client can choose a default output formatter.