Enrollment Campaigns Api Get Enrollment Performance

Enrollment Campaigns Api Get Enrollment Performance
Get the Enrollment Performance of every vCenter

Per vCenter: the slots in effect now, whether they are the default or a custom value, how many are in use and how many jobs wait for one, plus the default, the ceiling and the global worker count. Slots are logical per-vCenter enrollment slots held from the start of an enrollment until the Agent's first heartbeat is reconciled; they are not simultaneous calls to vCenter and ESX hosts (bounded by the global workers) and not VIB verification workers. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/hypervisors/campaigns/settings/vcenters
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The Enrollment Performance of every vCenter

Returns EnrollmentPerformanceDto of type(s) application/json
{
    "defaultSlots": 5,
    "slotsCeiling": 20,
    "globalWorkerConcurrency": 10,
    "vcenters": [
        {
            "vcenterConnectionId": "db-1",
            "displayName": "Primary vCenter",
            "configuredSlots": null,
            "effectiveSlots": 5,
            "custom": false,
            "activeSlots": 5,
            "queuedJobs": 120
        }
    ]
}
integer As int32 As int32
defaultSlots
Required  

Slots a vCenter without a custom value gets (default 5, the recommended value)

integer As int32 As int32
slotsCeiling
Required  

The highest custom number of slots accepted for one vCenter (default 20)

integer As int32 As int32
globalWorkerConcurrency
Required  

Size of the worker pool shared by every vCenter; it bounds how many enrollments run at the same moment on the Console

array of object
vcenters
Required  

One entry per connected vCenter, ordered by connection


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 when the signed-in role is not allowed to call this operation; 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 ForbiddenRead 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 -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/campaigns/settings/vcenters