Vcenter Capacity Usage Info

Vcenter Capacity Usage Info

The Vcenter Capacity Usage Info schema contains information about the current configuration usage and its compliance with the configuration recommendation by Broadcom. Additionally, it provides an URI where the CSV report can be downloaded from.

This schema was added in vSphere API 9.1.0.0.

JSON Example

{
    "created_at": "string",
    "deployment_size": "string",
    "version": "string",
    "created_by": "string",
    "configurations": [
        {
            "id": "string",
            "name": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            },
            "threshold_percentage": "number",
            "max_recommended_value": "number",
            "current_usage_value": "number",
            "current_usage_percentage": "number",
            "capacity_unit": "string",
            "severity": "string",
            "error": {
                "messages": [
                    {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    }
                ],
                "data": {},
                "error_type": "string"
            }
        }
    ],
    "csv_report_location": {
        "uri": "string",
        "auth_token": {
            "uuid": "string",
            "expiry": "string"
        }
    },
    "error": {
        "messages": [
            {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        ],
        "data": {},
        "error_type": "string"
    }
}

string As date-time As date-time

created_at

Required

The timestamp when the result was generated.

This property was added in vSphere API 9.1.0.0.

string

deployment_size

Required

The current deployment size of the vCenter server (for example: tiny,small,medium,large,x-large).

This property was added in vSphere API 9.1.0.0.

string

version

Required

The current vCenter server version.

This property was added in vSphere API 9.1.0.0.

string

created_by

Required

The user who initiated the request.

This property was added in vSphere API 9.1.0.0.

array of Vcenter Capacity Usage Config

configurations

Required

List of configuration objects containing the current usage and Broadcom's recommendation.

This property was added in vSphere API 9.1.0.0.

csv_report_location

Optional

Contains the URI to access the CSV Report and the authentication token required to access it.

This property was added in vSphere API 9.1.0.0.

missing or null in case of any Vcenter Capacity Usage Info.error reported.

error

Optional

Contains error message generated during the validation.

This property was added in vSphere API 9.1.0.0.

set if any errors encountered before calling the downstream APIs or when Vcenter Capacity Usage Config.error is set or any errors reported during CSV generation.

Returned By

Vcenter Capacity Usage get