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.Representations:
{
"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"
}
"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"
}
<?xml version="1.0" ?>
<ns0:Info xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<formatter>SIMPLE</formatter>
<service_id>obj-103</service_id>
<operation_id>obj-103</operation_id>
<identity>
<name>string</name>
<path>string</path>
</identity>
<output_field_list-array>
<array-item>
<output_fields-array>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
</output_fields-array>
<structure_id>obj-103</structure_id>
</array-item>
<array-item>
<output_fields-array>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
</output_fields-array>
<structure_id>obj-103</structure_id>
</array-item>
</output_field_list-array>
<description>string</description>
<options-array>
<array-item>
<generic>NONE</generic>
<field_name>string</field_name>
<description>string</description>
<type>string</type>
<long_option>string</long_option>
<short_option>string</short_option>
</array-item>
<array-item>
<generic>NONE</generic>
<field_name>string</field_name>
<description>string</description>
<type>string</type>
<long_option>string</long_option>
<short_option>string</short_option>
</array-item>
</options-array>
</ns0:Info>
<ns0:Info xmlns:ns0="http://vmware.com/vapi/metadata/cli/command" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<formatter>SIMPLE</formatter>
<service_id>obj-103</service_id>
<operation_id>obj-103</operation_id>
<identity>
<name>string</name>
<path>string</path>
</identity>
<output_field_list-array>
<array-item>
<output_fields-array>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
</output_fields-array>
<structure_id>obj-103</structure_id>
</array-item>
<array-item>
<output_fields-array>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
<array-item>
<field_name>string</field_name>
<display_name>string</display_name>
</array-item>
</output_fields-array>
<structure_id>obj-103</structure_id>
</array-item>
</output_field_list-array>
<description>string</description>
<options-array>
<array-item>
<generic>NONE</generic>
<field_name>string</field_name>
<description>string</description>
<type>string</type>
<long_option>string</long_option>
<short_option>string</short_option>
</array-item>
<array-item>
<generic>NONE</generic>
<field_name>string</field_name>
<description>string</description>
<type>string</type>
<long_option>string</long_option>
<short_option>string</short_option>
</array-item>
</options-array>
</ns0:Info>
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. |