Enrollment Campaigns Api Update Vcenter Slots
Sets the custom number of enrollment slots of one vCenter, between 1 and the ceiling (default 20), or restores the default when slots is null. The value is stored with the vCenter's other settings, survives a restart, applies to the next admission and claim (also in campaigns that already exist), and is removed when the connection is removed. A value outside the bounds answers 400 CONCURRENCY_OUT_OF_RANGE and changes nothing. A change is recorded in the audit log as ENROLLMENT_CONCURRENCY_CHANGED with the slots before and after. Raising slots raises the load on that vCenter and on the Console; the recommended value is the default. Requires the ADMIN role.
vCenter connection id, its numeric primary key with or without the db- prefix
db-1
The custom number of slots, or null to restore the default.
Show optional properties
{
"slots": 0
}
{
"slots": 8
}
The custom number of slots, from 1 to the ceiling; null restores the default
200 OK successful response envelope. The vCenter's Enrollment Performance after the change
{
"vcenterConnectionId": "db-1",
"displayName": "Primary vCenter",
"configuredSlots": 8,
"effectiveSlots": 8,
"custom": true,
"activeSlots": 5,
"queuedJobs": 120
}
Connection id in the form db-
Display name of the connection
The custom number of slots; null while the vCenter follows the default
The slots admission and claiming use now: the custom value, else the default
True when an administrator set a custom value
Slots in use now: enrollments in progress or waiting for the Agent's first heartbeat
Jobs of this vCenter waiting for a free slot
400 Bad Request: CONCURRENCY_OUT_OF_RANGE when slots is outside 1 and the ceiling; INVALID_CONNECTION_ID when the id is not a number; MALFORMED_REQUEST when the body cannot be read
{
"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.
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 when the signed-in role is not allowed to call this operation; 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)
{
"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.
404 Not Found: CONNECTION_NOT_FOUND when no connection has the id
{
"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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"slots":"integer,null"}' https://{api_host}/api/v1/hypervisors/campaigns/settings/vcenters/{id}