Task Manager Create Collector For Tasks

Task Manager Create Collector For Tasks

Creates a TaskHistoryCollector, a specialized HistoryCollector that gathers TaskInfo data objects.

A TaskHistoryCollector does not persist beyond the current client session.

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/TaskManager/{moId}/CreateCollectorForTasks
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 TaskManager/{moId}.

string
release
Required

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

Request Body
CreateCollectorForTasksRequestType of type(s) application/json
Required 
"CreateCollectorForTasksRequestType Object"
filter
Required

The specification for the task query filter.

Authentication
This operation uses the following authentication methods.
Responses
200

The task collector based on the filter.

Returns MoRefTaskHistoryCollector of type(s) application/json 
"MoRefTaskHistoryCollector Object"

500

InvalidArgument: if the filter is null or unknown.

InvalidState: if there are more than the maximum number of task collectors.

NotSupported: if called directly on a host.

Returns InvalidState of type(s) application/json 
"InvalidState Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/TaskManager/{moId}/CreateCollectorForTasks
On This Page
Virtual Infrastructure Operations
POST
Task Manager Read Next Tasks By View Spec
POST
Task Manager Create Collector For Tasks
POST
Task Manager Create Collector With Info Filter For Tasks
POST
Task Manager Create Task
GET
Task Manager Get Description
GET
Task Manager Get Max Collector
GET
Task Manager Get Recent Task