MetadataCliCommandInfo
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.
Properties
The text description displayed to the user in help output.
The formatter to use when displaying the output of this command. If not present, client can choose a default output formatter.
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.
List of output structure name and output field info.
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.
JSON Example
{
"description": "string",
"identity": {
"name": "string",
"path": "string"
},
"operation_id": "string",
"options": [
{
"description": "string",
"field_name": "string",
"generic": "enum",
"long_option": "string",
"type": "string"
}
],
"output_field_list": [
{
"output_fields": [
{
"display_name": "string",
"field_name": "string"
}
],
"structure_id": "string"
}
],
"service_id": "string"
}
