Hypervisors Api Sync Vib Inventory
Refreshes the agent VIB inventory, for one vCenter connection or for all. status is SERVICE_NOT_AVAILABLE when the inventory service is not configured. Requires the ADMIN role.
Refresh only this vCenter connection
db-1
200 OK successful response envelope. The outcome of the sync, which is SYNC_COMPLETED, or SERVICE_NOT_AVAILABLE when the inventory service is not available
{
"status": "SYNC_COMPLETED"
}
Outcome of the sync: SYNC_COMPLETED (HTTP 200), SERVICE_NOT_AVAILABLE when the vCenter software inventory service is not available (HTTP 200), SKIPPED when the host is not discoverable (HTTP 409) or NOT_FOUND when the hypervisor does not exist (HTTP 404)
State of the agent VIB on a hypervisor host.
INSTALLED: The vCenter software inventory lists the VTP Agent VIB component on the hostNOT_INSTALLED: The software inventory succeeded and the VIB is absent; the Agent of such a host is reported OFFLINEUNKNOWN: The software inventory is unavailable, for example it was not queried or the host does not support it (the initial value); previously stored VIB facts are keptQUERY_FAILED: The vCenter query returned an error, timed out or could not connect; previously stored VIB facts are kept
Single-host refresh only
Single-host refresh only
Reason the VIB query reported as failed; present only when status is SYNC_COMPLETED and the query reported one
Explanation of the outcome; present only when status is SKIPPED or NOT_FOUND
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 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)
{
"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 POST -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/sync-vib