Extension Manager Update Extension

If the key specified in the extension exists, the existing record is updated.

If the "subjectName" property of the Extension object has a value, and it is different from the existing value, this method will unset any public key or certificate associated with the extension.

Required privileges: Extension.Update

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ExtensionManager/{moId}/UpdateExtension

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ExtensionManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

UpdateExtensionRequestType of type(s) application/json

Required

Show optional properties

{
    "extension": {
        "description": {
            "label": "string",
            "summary": "string"
        },
        "key": "string",
        "version": "string",
        "lastHeartbeatTime": "string"
    }
}

{
    "extension": {
        "_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"
        }
    }
}

Extension

extension

Required

This data object type contains all information about an extension.

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

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

NotFound: if the specified extension key is not registered.

InvalidArgument: if the Extension description is incomplete or invalid, or if the extension is an OVF extension and its section types overlap with other registered OVF extensions.

Returns NotFound of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Extension Manager Find Extension