Enrollment Campaigns Api Get Settings
Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
200 OK successful response envelope. The campaign settings
{
"automaticEnrollmentPaused": false,
"globalWorkerConcurrency": 10,
"maxConcurrentPerVcenter": 5,
"maxRetries": 3,
"initialBackoffSeconds": 10,
"maxBackoffSeconds": 300
}
Null on update leaves the pause untouched
Number of campaign jobs the engine takes per cycle, also the size of the worker pool shared by all campaigns (default 10, property vtp.campaign.global-worker-concurrency). The worker pool is resized at runtime, without a restart, and the stored value survives a restart. At most the ceiling (default 32). An update keeps the current value unless the new value is above 0
The default number of enrollment slots per vCenter (default 5, recommended): the limit used for a vCenter that has no custom value of its own (see GET /api/v1/hypervisors/campaigns/settings/vcenters) and for a campaign without its own concurrencyLimit. At most the ceiling (default 20). An update keeps the current value unless the new value is above 0
Number of failed attempts after which a job fails permanently (default 3, applied to jobs when they are created); a terminal error fails it at once, and an update accepts 0 or more
Base delay in seconds before a failed job is retried (default 10): the delay is this value times 2 to the power of the retry number, capped at maxBackoffSeconds, plus a random 0 to 4 seconds; an update keeps the current value unless the new value is above 0
Cap in seconds on the retry delay before the random 0 to 4 seconds are added (default 300); an update is applied only when it is not below initialBackoffSeconds
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/campaigns/settings