HostQueryResponse

HostQueryResponse
HostQueryResponse

Represents a host query response

JSON Example
{
    "queryInfo": {
        "status": "string",
        "queryId": "string",
        "errorResponse": {
            "errorCode": "string",
            "errorType": "string",
            "arguments": [
                "string"
            ],
            "context": {
                "context": "string"
            },
            "message": "string",
            "remediationMessage": "string",
            "causes": [
                {
                    "type": "string",
                    "message": "string"
                }
            ],
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "label": "string",
            "remediationUrl": "string"
        },
        "completed": false,
        "processing": false,
        "failure": false
    },
    "result": {
        "elements": [
            {
                "id": "string",
                "serialNumber": "string",
                "esxiVersion": "string",
                "sshThumbprint": "string",
                "sslThumbprint": "string",
                "fqdn": "string",
                "hardwareVendor": "string",
                "hardwareModel": "string",
                "ipAddresses": [
                    {
                        "ipAddress": "string",
                        "type": "One among: MANAGEMENT, VSAN, VMOTION, NFS, VSAN_EXTERNAL"
                    }
                ],
                "cpu": {
                    "frequencyMHz": "number",
                    "usedFrequencyMHz": "number",
                    "cores": 0,
                    "cpuCores": [
                        {
                            "frequencyMHz": "number",
                            "model": "string",
                            "manufacturer": "string"
                        }
                    ]
                },
                "memory": {
                    "totalCapacityMB": "number",
                    "usedCapacityMB": "number"
                },
                "storage": {
                    "totalCapacityMB": "number",
                    "usedCapacityMB": "number",
                    "disks": [
                        {
                            "capacityMB": "number",
                            "diskType": "One among: HDD, FLASH",
                            "manufacturer": "string",
                            "model": "string"
                        }
                    ]
                },
                "physicalNics": [
                    {
                        "deviceName": "string",
                        "macAddress": "string",
                        "speed": 0,
                        "unit": "string",
                        "smartNicInfo": {
                            "vendorName": "string",
                            "dpuId": "string"
                        },
                        "state": "One among: INACTIVE, ACTIVE_IN_USE, ACTIVE_NOT_IN_USE"
                    }
                ],
                "networks": [
                    {
                        "id": "string",
                        "type": "VSAN, VMOTION, VXLAN, NFS, ISCSI, VSAN_EXTERNAL",
                        "vlanId": 0,
                        "mtu": 0,
                        "subnet": "string",
                        "mask": "string",
                        "gateway": "string",
                        "ipPools": [
                            {
                                "start": "string",
                                "end": "string"
                            }
                        ],
                        "freeIps": [
                            "string"
                        ],
                        "usedIps": [
                            "string"
                        ]
                    }
                ],
                "hostNetworks": [
                    {
                        "type": "string",
                        "vlanId": 0,
                        "mtu": 0
                    }
                ],
                "gpus": [
                    {
                        "deviceName": "string",
                        "vendorName": "string",
                        "vgpuState": "One among: READY, DRIVER_MISSING, NOT_SUPPORTED, NO_NVIDIA_GPU"
                    }
                ],
                "domain": {
                    "id": "string",
                    "name": "string",
                    "type": "string"
                },
                "networkpool": {
                    "id": "string",
                    "name": "string"
                },
                "cluster": {
                    "id": "string",
                    "name": "string"
                },
                "status": "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
                "compatibleStorageType": "string",
                "bundleRepoDatastore": "string",
                "hybrid": false,
                "softwareInfo": {
                    "baseImage": {
                        "version": "7.0.0-0.0.30340198",
                        "details": {
                            "displayName": "7.0.0-0.0.30340198",
                            "displayVersion": "string",
                            "releaseDate": "string",
                            "releaseTimestamp": "string",
                            "quickPatchCompatibleVersions": [
                                {
                                    "version": "8.0.3-0.0.23174786",
                                    "displayVersion": "8.0 Update 3 - 23174786"
                                }
                            ]
                        }
                    },
                    "addOn": {
                        "version": "2.0-1",
                        "name": "DELL-sample-Addon",
                        "vendor": "Dell",
                        "displayName": "string",
                        "displayVersion": "string"
                    },
                    "components": {
                        "components": {
                            "version": "1.3.2.8-1OEM.650.0.0.4598673",
                            "details": {
                                "vendor": "intel",
                                "displayName": "string",
                                "displayVersion": "string"
                            }
                        }
                    },
                    "removedComponents": {
                        "removedComponents": {
                            "version": "1.3.2.8-1OEM.650.0.0.4598673",
                            "details": {
                                "vendor": "intel",
                                "displayName": "string",
                                "displayVersion": "string"
                            }
                        }
                    },
                    "hardwareSupport": {
                        "packages": {
                            "packages": {
                                "pkg": "string",
                                "version": "string"
                            }
                        }
                    },
                    "alternativeImages": {
                        "alternativeImages": {
                            "baseImage": {
                                "version": "7.0.0-0.0.30340198",
                                "details": {
                                    "displayName": "7.0.0-0.0.30340198",
                                    "displayVersion": "string",
                                    "releaseDate": "string",
                                    "releaseTimestamp": "string",
                                    "quickPatchCompatibleVersions": [
                                        {
                                            "version": "8.0.3-0.0.23174786",
                                            "displayVersion": "8.0 Update 3 - 23174786"
                                        }
                                    ]
                                }
                            },
                            "addOn": {
                                "version": "2.0-1",
                                "name": "DELL-sample-Addon",
                                "vendor": "Dell",
                                "displayName": "string",
                                "displayVersion": "string"
                            },
                            "components": {
                                "components": {
                                    "version": "1.3.2.8-1OEM.650.0.0.4598673",
                                    "details": {
                                        "vendor": "intel",
                                        "displayName": "string",
                                        "displayVersion": "string"
                                    }
                                }
                            },
                            "removedComponents": {
                                "removedComponents": {
                                    "version": "1.3.2.8-1OEM.650.0.0.4598673",
                                    "details": {
                                        "vendor": "intel",
                                        "displayName": "string",
                                        "displayVersion": "string"
                                    }
                                }
                            },
                            "hardwareSupport": {
                                "packages": {
                                    "packages": {
                                        "pkg": "string",
                                        "version": "string"
                                    }
                                }
                            },
                            "selectionCriteria": {
                                "selectionType": "One among: HOST_UUID, HOST_HARDWARE_SPEC",
                                "hostBiosIds": [
                                    "string"
                                ],
                                "hostHardware": {
                                    "vendor": "string",
                                    "models": [
                                        "string"
                                    ],
                                    "families": [
                                        "string"
                                    ],
                                    "oemStrings": [
                                        "string"
                                    ]
                                }
                            },
                            "displayName": "string"
                        }
                    }
                },
                "tags": [
                    {
                        "id": "string",
                        "name": "string",
                        "categoryId": "string",
                        "categoryName": "string"
                    }
                ],
                "configurationStatus": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
                "datastoreType": "One among: VSAN, VSAN_ESA, VSAN_MAX, NFS, FC, VVOL, VSAN_REMOTE, VMFS",
                "vvolStorageProtocolType": "One among: ISCSI, NFS, FC"
            }
        ],
        "pageMetadata": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}
queryInfo
Optional

Represents the query info.

result
Optional

Represents a page of elements of a single type