REST API - list

vcenter cluster modules: list

Returns information about the modules available in this vCenter server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/vcenter/cluster/modules
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "summaries"[
            {
                "cluster""obj-103",
                "module""obj-103"
            },
            {
                "cluster""obj-103",
                "module""obj-103"
            }
        ]
    }
}

Response Type:

Name Type Description
bold = required
value list_result The list of modules available on this vCenter server.
value.summaries summary[] List of commonly used information for each module in this vCenter server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value.summaries[].cluster string Identifier of the cluster in which this module resides. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

value.summaries[].module string Identifier of the module. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.cluster.modules. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.cluster.modules.

Errors:

None