Enrollment Campaigns Api Update Settings

Enrollment Campaigns Api Update Settings
Update the enrollment campaign settings

A numeric field of zero or less is left unchanged; a null automaticEnrollmentPaused leaves the pause untouched. A globalWorkerConcurrency above its ceiling (default 32, property vtp.campaign.global-worker-concurrency-ceiling) or a maxConcurrentPerVcenter above its ceiling (default 20, property vtp.campaign.max-concurrent-per-vcenter-ceiling) answers 400 CONCURRENCY_OUT_OF_RANGE and changes nothing. A change to either concurrency value is recorded in the audit log as ENROLLMENT_CONCURRENCY_CHANGED. Requires the ADMIN role.

Request
URI
PUT
https://{api_host}/api/v1/hypervisors/campaigns/settings
COPY
Request Body

The campaign settings to apply: the automatic-enrollment pause flag and the worker, concurrency, retry and backoff limits.

CampaignSettingsDto of type(s) application/json
Required  

Show optional properties

{
    "globalWorkerConcurrency": 0,
    "maxConcurrentPerVcenter": 0,
    "maxRetries": 0,
    "initialBackoffSeconds": 0,
    "maxBackoffSeconds": 0
}
{
    "automaticEnrollmentPaused": false,
    "globalWorkerConcurrency": 10,
    "maxConcurrentPerVcenter": 8,
    "maxRetries": 3,
    "initialBackoffSeconds": 10,
    "maxBackoffSeconds": 300
}
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

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The campaign settings now in effect

Returns CampaignSettingsDto of type(s) application/json
{
    "automaticEnrollmentPaused": false,
    "globalWorkerConcurrency": 10,
    "maxConcurrentPerVcenter": 8,
    "maxRetries": 3,
    "initialBackoffSeconds": 10,
    "maxBackoffSeconds": 300
}
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


400

400 Bad Request: MALFORMED_REQUEST

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

403 Forbidden: FORBIDDEN or CSRF_ERROR. CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"globalWorkerConcurrency":"integer","maxConcurrentPerVcenter":"integer","maxRetries":"integer","initialBackoffSeconds":"integer","maxBackoffSeconds":"integer"}' https://{api_host}/api/v1/hypervisors/campaigns/settings