Host Patch Manager Scan Host Patch Task

Host Patch Manager Scan Host Patch Task

Deprecated as of VI API 4.0, use ScanHostPatchV2_Task.

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}/ScanHostPatch_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.2.0 APIs.


Request Body
ScanHostPatchRequestType of type(s) application/json
Required
{
    "repository": {
        "_typeName": "string",
        "url": "string",
        "proxy": "string"
    },
    "updateID": [
        "string"
    ]
}
repository
Required

Location of the repository that contains the bulletin depot. The depot must be organized as a flat collection of bulletins with each one being a folder named after the bulletin ID. Each folder must contain the full update metadata.

array of string
updateID
Optional

The updates to scan. Wildcards can be used to specify the update IDs. The wildcards will be expanded to include all updates whose IDs match the specified wildcard and whose metadata is available in the repository. Specifying no update is equivalent to a wildcard "*". In this case all updates available in the repository will be scanned.

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.

PatchMetadataInvalid: if query required metadata is invalid - for example, it is not found in the repository, is corrupted and so on. Typically a more specific subclass of PatchMetadataInvalid is thrown.

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.