CommandInfo
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
| Required | Property Name | Type | Description |
|---|---|---|---|
| required | description | string |
The text description displayed to the user in help output. |
| optional | formatter | CommandFormatterType Enum |
The formatter to use when displaying the output of this command. If not present, client can choose a default output formatter. |
| required | identity | CommandIdentity |
Basic command identity. |
| required | 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. |
| required | options | array of CommandOptionInfo |
The input for this command. |
| required | output_field_list | array of CommandOutputInfo |
List of output structure name and output field info. |
| required | 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. |
