REST API - get
  1. Operations
  2. esx
  3. settings
  4. internal
  5. summary

esx settings internal summary: get

Summarize the compliance result of the clusters. The API will return the cluster summary with an empty compliance result and/or desired software specification if the service failed get this information from the database due to unexpected scenarios.

Request:

HTTP request

GET https://{server}/api/esx/settings/internal/summary

?folder={obj-103}
&datacenter={obj-103}

Query Parameters:

Name Type Description
bold = required
folder string Identifier of the folder entity. Exactly one of folder or datacenter must be specified.

Optional. either folder or datacenter are unset, the default root entity will be vcenter.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.
datacenter string Identifier of the datacenter entity Exactly one of folder or datacenter must be specified.

Optional. either folder or datacenter are unset, the default root entity will be vcenter.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datacenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "obj-103" : {
        "summary" : {
            "incompatible_hosts" : [
                "obj-103",
                "obj-103"
            ],
            "non_compliant_hosts" : [
                "obj-103",
                "obj-103"
            ],
            "compliant_hosts" : [
                "obj-103",
                "obj-103"
            ],
            "scan_time" : "2015-01-01T22:13:05.651Z",
            "unavailable_hosts" : [
                "obj-103",
                "obj-103"
            ],
            "status" : "COMPLIANT"
        },
        "cluster" : {
            "name" : "string"
        },
        "software" : {
            "hardware_support" : {
                "packages" : {
                    "obj-103" : {
                        "pkg" : "obj-103",
                        "version" : "string"
                    }
                }
            },
            "components" : {
                "obj-103" : {
                    "details" : {
                        "vendor" : "string",
                        "display_version" : "string",
                        "display_name" : "string"
                    },
                    "version" : "string"
                }
            },
            "base_image" : {
                "details" : {
                    "release_date" : "2015-01-01T22:13:05.651Z",
                    "display_version" : "string",
                    "display_name" : "string"
                },
                "version" : "string"
            },
            "solutions" : {
                "obj-103" : {
                    "components" : [
                        {
                            "component" : "obj-103"
                        },
                        {
                            "component" : "obj-103"
                        }
                    ],
                    "details" : {
                        "components" : [
                            {
                                "component" : "obj-103",
                                "display_version" : "string",
                                "vendor" : "string",
                                "display_name" : "string"
                            },
                            {
                                "component" : "obj-103",
                                "display_version" : "string",
                                "vendor" : "string",
                                "display_name" : "string"
                            }
                        ],
                        "display_version" : "string",
                        "display_name" : "string"
                    },
                    "version" : "string"
                }
            },
            "add_on" : {
                "name" : "string",
                "details" : {
                    "vendor" : "string",
                    "display_version" : "string",
                    "display_name" : "string"
                },
                "version" : "string"
            }
        }
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- object Complaince summary of all the clusters.Object with element values of type cluster_summary.
-.* cluster_summary
-.*.cluster cluster_info Information of the cluster.
-.*.cluster.name string Name of the host.
-.*.summary compliance_result Summary of the cluster.

Optional. unset if the cluster compliance result is unavailable.
-.*.summary.status string Overall compliance state of the host.

Contains the possible different status of compliance with respect to target version. Value is one of:
COMPLIANT: Target version is same as current version.
NON_COMPLIANT: Target version is greater than current version.
INCOMPATIBLE: Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.
UNAVAILABLE: Drift check failed due to unknown error or check hasn't happened yet and results are not available.
-.*.summary.scan_time date_time Scan completion time.
-.*.summary.compliant_hosts string[] Identifiers of compliant hosts.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
-.*.summary.non_compliant_hosts string[] Identifiers of non-compliant hosts.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
-.*.summary.incompatible_hosts string[] Identifiers of incompatible hosts.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
-.*.summary.unavailable_hosts string[] Identifiers of unavailable hosts.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
-.*.software software_info Desired software specification of the cluster.

Optional. unset if the desired software specification of the cluster is unavailable.
-.*.software.base_image base_image_info Base image of the ESX.
-.*.software.base_image.details base_image_details Details about the base-image.

Optional. unset if base-image is not present in the depot.
-.*.software.base_image.details.display_name string Display name of the base-image.
-.*.software.base_image.details.display_version string Human readable version of the base-image.
-.*.software.base_image.details.release_date date_time Release date of the base-image.
-.*.software.base_image.version string Version of the base-image
-.*.software.add_on add_on_info OEM customization on top of given base-image. The components in this customization override the components in the base base-image.

Optional. If unset, no OEM customization will be applied.
-.*.software.add_on.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.
-.*.software.add_on.details.display_name string Display name of the OEM add-on.
-.*.software.add_on.details.vendor string Vendor of the OEM add-on.
-.*.software.add_on.details.display_version string Human readable version of the OEM add-on.
-.*.software.add_on.name string Name of the add-on
-.*.software.add_on.version string Version of the add-on
-.*.software.components object Information about the components in the software specification.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info.
-.*.software.components.* component_info
-.*.software.components.*.version string Version of the component.

Optional. unset if version is not specified.

Errors:

HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no entity found in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.