Diagnostic Manager Generate Log Bundles Task

Deprecated since version 5.0 M/N it is recommended to use the CGI interface for the host bundles, use the address instead: https://<<ESX_name>>/cgi-bin/vm-support.cgi for the VC bundles, use https://<<VC_name>>/appliance/support-bundle

The caller can download the bundles using an HTTP GET operation for each returned URL. Bundles are usually available for at least 24 hours, but the caller should not assume that the returned URLs are valid indefinitely. Servers often automatically delete generated diagnostic bundles after some given period of time.

Instructs the server to generate diagnostic bundles.

A diagnostic bundle includes log files and other configuration information that can be used to investigate potential server issues. Virtual machine and guest operation system state is excluded from diagnostic bundles.

Required privileges: Global.Diagnostics

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DiagnosticManager/{moId}/GenerateLogBundles_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 DiagnosticManager/{moId}.

string

release

Required

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

Request Body

GenerateLogBundlesRequestType of type(s) application/json

Required

Show optional properties

{
    "includeDefault": false
}

{
    "includeDefault": false,
    "host": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ]
}

boolean

includeDefault

Required

Specifies if the bundle should include the default server. If called on a VirtualCenter server, then this means the VirtualCenter diagnostic files. If called directly on a host, then includeDefault must be set to true.

array of MoRefHostSystem

host

Optional

Lists hosts that are included. This is only used when called on VirtualCenter. If called directly on a host, then this parameter must be empty.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation. Upon success, the info.result property in the Task contains a list of DiagnosticManagerBundleInfo objects for each diagnostic bundle that has been generated.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

LogBundlingFailed: if generation of support bundle failed.

TaskInProgress: if there is a pending request to generate a support bundle.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_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

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Diagnostic Manager Browse Diagnostic Log