Vcenter Capacity Usage Config

Vcenter Capacity Usage Config
Vcenter Capacity Usage Config

The Vcenter Capacity Usage Config schema contains the validation results for a specific configuration including the current usage, Broadcom's recommendation, and information if the current usage is compliant with the set thresholds.

This schema was added in vSphere API 9.1.0.0.

JSON Example
{
    "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"
    }
}
string
id
Required

Unique identifier of the configuration.

This property was added in vSphere API 9.1.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.capacity.usage. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.capacity.usage.

name
Required

Name of the configuration.

This property was added in vSphere API 9.1.0.0.

number As double As double
threshold_percentage
Required

Threshold percentage set for the configuration, ranging from 1 to 100 (inclusive).

This property was added in vSphere API 9.1.0.0.

number As double As double
max_recommended_value
Required

Maximum recommended value of the configuration.

This property was added in vSphere API 9.1.0.0.

number As double As double
current_usage_value
Optional

The current usage/count of the configuration.

This property was added in vSphere API 9.1.0.0.

missing or null if there is an error fetching the value.

number As double As double
current_usage_percentage
Optional

The percentage of the configuration's maximum that is currently used. Calculated as (Vcenter Capacity Usage Config.current_usage_value/Vcenter Capacity Usage Config.max_recommended_value)*100

This property was added in vSphere API 9.1.0.0.

missing or null if there is an error fetching the Vcenter Capacity Usage Config.current_usage_value.

string
capacity_unit
Optional

The capacity unit of measurement for the Vcenter Capacity Usage Config.max_recommended_value and Vcenter Capacity Usage Config.current_usage_value (for example: "TB", "GB", "ms", ..).

This property was added in vSphere API 9.1.0.0.

missing or null if the values are plain integers without a capacity unit.

string
severity
Optional

Indicates the severity of the configuration's usage.

For more information see: Vcenter Capacity Usage Severity.

This property was added in vSphere API 9.1.0.0.

missing or null if there is an error fetching the Vcenter Capacity Usage Config.current_usage_value.

error
Optional

Contains the error message if an error occurs while fetching the configuration's data.

This property was added in vSphere API 9.1.0.0.

set if any issues encountered.

Property Of