Cluster Compute Resource Get Hci Config

This is applicable to clusters which are configured using the HCI workflow and contains data related to the workflow and specification.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/hciConfig

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ClusterComputeResource/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns ClusterComputeResourceHCIConfigInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "workflowState": "string",
    "dvsSetting": [
        {
            "_typeName": "string",
            "dvSwitch": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "pnicDevices": [
                "string"
            ],
            "dvPortgroupSetting": [
                {
                    "_typeName": "string",
                    "dvPortgroup": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "service": "string"
                }
            ]
        }
    ],
    "configuredHosts": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "hostConfigProfile": {
        "_typeName": "string",
        "dateTimeConfig": {
            "_typeName": "string",
            "timeZone": "string",
            "ntpConfig": {
                "_typeName": "string",
                "server": [
                    "string"
                ],
                "configFile": [
                    "string"
                ]
            },
            "ptpConfig": {
                "_typeName": "string",
                "domain": 0,
                "port": [
                    {
                        "_typeName": "string",
                        "index": 0,
                        "deviceType": "string",
                        "device": "string",
                        "ipConfig": {
                            "_typeName": "string",
                            "dhcp": false,
                            "ipAddress": "string",
                            "subnetMask": "string",
                            "ipV6Config": {
                                "_typeName": "string",
                                "ipV6Address": [
                                    {
                                        "_typeName": "string",
                                        "ipAddress": "string",
                                        "prefixLength": 0,
                                        "origin": "string",
                                        "dadState": "string",
                                        "lifetime": "string",
                                        "operation": "string"
                                    }
                                ],
                                "autoConfigurationEnabled": false,
                                "dhcpV6Enabled": false
                            }
                        }
                    }
                ]
            },
            "protocol": "string",
            "enabled": false,
            "disableEvents": false,
            "disableFallback": false,
            "resetToFactoryDefaults": false
        },
        "lockdownMode": "string"
    }
}

string

workflowState

Required

Configuration pertinent to state of the HCI workflow.

Valid values are enumerated by the HCIWorkflowState type.

array of ClusterComputeResourceDVSSetting

dvsSetting

Optional

Contains DVS related information captured while configuring the cluster.

array of MoRefHostSystem

configuredHosts

Optional

Contains a list of hosts that are currently configured using ClusterComputeResource.ConfigureHCI_Task and ClusterComputeResource.ExtendHCI_Task method.

A failed host will not be part of this list.

ClusterComputeResourceHostConfigurationProfile

hostConfigProfile

Optional

HostConfigurationProfile describes the configuration of services and settings which gets applied on every host in the HCI cluster.

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body