CampaignSettingsDto

CampaignSettingsDto
CampaignSettingsDto

Campaign engine settings.

JSON Example
{
    "automaticEnrollmentPaused": false,
    "globalWorkerConcurrency": 0,
    "maxConcurrentPerVcenter": 0,
    "maxRetries": 0,
    "initialBackoffSeconds": 0,
    "maxBackoffSeconds": 0
}
boolean
automaticEnrollmentPaused
Optional

Null on update leaves the pause untouched

integer As int32 As int32
globalWorkerConcurrency
Required  

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

integer As int32 As int32
maxConcurrentPerVcenter
Required  

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

integer As int32 As int32
maxRetries
Required  

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

integer As int32 As int32
initialBackoffSeconds
Required  

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

integer As int32 As int32
maxBackoffSeconds
Required  

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