Extension

Extension
Extension

This data object type contains all information about an extension.

An extension may contain zero or more server interfaces and zero or more clients.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "description": {
        "_typeName": "string",
        "label": "string",
        "summary": "string"
    },
    "key": "string",
    "company": "string",
    "type": "string",
    "version": "string",
    "subjectName": "string",
    "server": [
        {
            "_typeName": "string",
            "url": "string",
            "description": {
                "_typeName": "string",
                "label": "string",
                "summary": "string"
            },
            "company": "string",
            "type": "string",
            "adminEmail": [
                "string"
            ],
            "serverThumbprint": "string",
            "serverCertificate": "string"
        }
    ],
    "client": [
        {
            "_typeName": "string",
            "version": "string",
            "description": {
                "_typeName": "string",
                "label": "string",
                "summary": "string"
            },
            "company": "string",
            "type": "string",
            "url": "string"
        }
    ],
    "taskList": [
        {
            "_typeName": "string",
            "taskID": "string"
        }
    ],
    "eventList": [
        {
            "_typeName": "string",
            "eventID": "string",
            "eventTypeSchema": "string"
        }
    ],
    "faultList": [
        {
            "_typeName": "string",
            "faultID": "string"
        }
    ],
    "privilegeList": [
        {
            "_typeName": "string",
            "privID": "string",
            "privGroupName": "string"
        }
    ],
    "resourceList": [
        {
            "_typeName": "string",
            "locale": "string",
            "module": "string",
            "data": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ],
    "lastHeartbeatTime": "string",
    "healthInfo": {
        "_typeName": "string",
        "url": "string"
    },
    "ovfConsumerInfo": {
        "_typeName": "string",
        "callbackUrl": "string",
        "sectionType": [
            "string"
        ]
    },
    "extendedProductInfo": {
        "_typeName": "string",
        "companyUrl": "string",
        "productUrl": "string",
        "managementUrl": "string",
        "self": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    },
    "managedEntityInfo": [
        {
            "_typeName": "string",
            "type": "string",
            "smallIconUrl": "string",
            "iconUrl": "string",
            "description": "string"
        }
    ],
    "shownInSolutionManager": false,
    "solutionManagerInfo": {
        "_typeName": "string",
        "tab": [
            {
                "_typeName": "string",
                "label": "string",
                "url": "string"
            }
        ],
        "smallIconUrl": "string"
    }
}
Description
description
Required

Static strings used for describing an object or property.

string
key
Required

Extension key.

Should follow java package naming conventions for uniqueness (e.g. "com.example.management").

Extension names can only contain characters belonging to the lower ASCII character set (UTF-7) with the exception of the following characters:

  1. All whitespace characters ("space" - ascii character 0x20 is allowed)
  2. Control characters
  3. Comma (ascii 0x2c), Forward slash (ascii 0x2f), Backward slash (ascii 0x5c), Hash/Pound (ascii 0x23), Plus (ascii 0x2b), Greater (ascii 0x3e), Lesser (ascii 0x3c), Equals (ascii 0x3d), Semi-colon (ascii 0x3b) and Double quote (ascii 0x22).
string
company
Optional

Company information.

string
type
Optional

Type of extension (example may include CP-DVS, NUOVA-DVS, etc.).

string
version
Required

Extension version number as a dot-separated string.

For example, "1.0.0"

string
subjectName
Optional

Subject name from client certificate.

array of ExtensionServerInfo
server
Optional

Servers for this extension.

array of ExtensionClientInfo
client
Optional

Clients for this extension.

array of ExtensionTaskTypeInfo
taskList
Optional

Definitions of tasks defined by this extension.

array of ExtensionEventTypeInfo
eventList
Optional

Definitions of events defined by this extension.

array of ExtensionFaultTypeInfo
faultList
Optional

Definitions of faults defined by this extension.

array of ExtensionPrivilegeInfo
privilegeList
Optional

Definitions privileges defined by this extension.

array of ExtensionResourceInfo
resourceList
Optional

Resource data for all locales

string As date-time As date-time
lastHeartbeatTime
Required

Last extension heartbeat time.

ExtensionHealthInfo
healthInfo
Optional

This data object encapsulates the health specification for the extension.

ExtensionOvfConsumerInfo
ovfConsumerInfo
Optional

This data object contains configuration for extensions that also extend the OVF functionality of vCenter server.

Note: This feature is for internal use only.

ExtExtendedProductInfo
extendedProductInfo
Optional

This data object encapsulates extended product information for an extension.

array of ExtManagedEntityInfo
managedEntityInfo
Optional

Information about entities managed by this extension.

An extension can register virtual machines as managed by itself, by setting the managedBy property of the virtual machine.

boolean
shownInSolutionManager
Optional

Opt-in to the Solution Manager.

If set to true, this extension will be shown in the Solution Manager. If not set, or set to false, this extension is not shown in the Solution Manager.

ExtSolutionManagerInfo
solutionManagerInfo
Optional

This data object encapsulates the Solution Manager configuration for this extension.

Property Of
Returned By