Host Patch Manager Scan Host Patch V2 Task

Host Patch Manager Scan Host Patch V2 Task

Deprecated as of vSphere 8.0u3, and there is no replacement available.

Scan the host for the patch status.

The operation is cancelable through the returned Task object. Integrity checks are performed on the metadata only during the scan operation.

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostPatchManager/{moId}/ScanHostPatchV2_Task
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 HostPatchManager/{moId}.

string
release
Required

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


Request Body
ScanHostPatchV2RequestType of type(s) application/json
Required
{
    "metaUrls": [
        "string"
    ],
    "bundleUrls": [
        "string"
    ],
    "spec": {
        "_typeName": "string",
        "proxy": "string",
        "port": 0,
        "userName": "string",
        "password": "string",
        "cmdOption": "string"
    }
}
array of string
metaUrls
Optional

a list of urls pointing to metadata.zip.

array of string
bundleUrls
Optional

a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.

spec
Optional

Optional parameters for hostd to pass to exupdate.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the HostPatchManagerStatus upon success.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

RequestCanceled: if the operation is canceled.

InvalidState: if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.

TaskInProgress: if there is already a patch installation in progress.

PlatformConfigFault: if there is any error in the repository access, metadata download, repository level integrity check, or reading the metadata. See text for specific details.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: Any
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}
faultCause
Optional

The base data object type for all the object model faults that an application might handle.

faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.