1. Types
  2. vapi
  3. metadata
  4. cli

vapi metadata cli: component info

The component_info is an aggregated structure for CLI commands and namespaces information. This structure was added in vSphere API 6.7.

Representation:

{
    "commands" : [
        {
            "formatter" : "SIMPLE",
            "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"
                }
            ],
            "identity" : {
                "path" : "string",
                "name" : "string"
            },
            "service_id" : "obj-103",
            "options" : [
                {
                    "short_option" : "string",
                    "long_option" : "string",
                    "description" : "string",
                    "type" : "string",
                    "generic" : "NONE",
                    "field_name" : "string"
                },
                {
                    "short_option" : "string",
                    "long_option" : "string",
                    "description" : "string",
                    "type" : "string",
                    "generic" : "NONE",
                    "field_name" : "string"
                }
            ],
            "description" : "string",
            "operation_id" : "obj-103"
        },
        {
            "formatter" : "SIMPLE",
            "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"
                }
            ],
            "identity" : {
                "path" : "string",
                "name" : "string"
            },
            "service_id" : "obj-103",
            "options" : [
                {
                    "short_option" : "string",
                    "long_option" : "string",
                    "description" : "string",
                    "type" : "string",
                    "generic" : "NONE",
                    "field_name" : "string"
                },
                {
                    "short_option" : "string",
                    "long_option" : "string",
                    "description" : "string",
                    "type" : "string",
                    "generic" : "NONE",
                    "field_name" : "string"
                }
            ],
            "description" : "string",
            "operation_id" : "obj-103"
        }
    ],
    "namespaces" : [
        {
            "children" : [
                {
                    "path" : "string",
                    "name" : "string"
                },
                {
                    "path" : "string",
                    "name" : "string"
                }
            ],
            "identity" : {
                "path" : "string",
                "name" : "string"
            },
            "description" : "string"
        },
        {
            "children" : [
                {
                    "path" : "string",
                    "name" : "string"
                },
                {
                    "path" : "string",
                    "name" : "string"
                }
            ],
            "identity" : {
                "path" : "string",
                "name" : "string"
            },
            "description" : "string"
        }
    ]
}

Attributes:

Name Type Description
Required
namespaces info[] Information for all CLI namespaces of a component. This attribute was added in vSphere API 6.7.
namespaces[].identity identity Basic namespace identity.
namespaces[].identity.path string The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.
namespaces[].identity.name string The name displayed to the user for this namespace.
namespaces[].description string The text description displayed to the user in help output.
namespaces[].children identity[] The children of this namespace in the tree of CLI namespaces.
namespaces[].children[].path string The dot-separated path of the namespace containing the namespace in the CLI node tree. For top-level namespace this will be empty.
namespaces[].children[].name string The name displayed to the user for this namespace.
commands info[] Information for all CLI commands of a component. This attribute was added in vSphere API 6.7.
commands[].identity identity Basic command identity.
commands[].identity.path string The dot-separated path of the namespace containing the command in the CLI command tree.
commands[].identity.name string Name of the command.
commands[].description string The text description displayed to the user in help output.
commands[].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.
commands[].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.
commands[].options option_info[] The input for this command.
commands[].options[].long_option string The long option name of the parameter as used by the user.
Optional
commands[].options[].short_option string The single character value option name.

Optional. If not present, there's no single character option for the parameter.