esx hcl hosts compatibility report: device hcl info

This device_hcl_info structure contains fields that describe a PCI device of a given ESXi host and its compatibility information.

If there are multiple PCI devices of the same type on the host each one will be listed in separate instance of this class.

Representation:

{
    "notes"[
        {
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "localized""string",
            "id""string",
            "params"{
                "<string>"{
                    "dt""2015-01-01T22:13:05.651Z",
                    "s""string",
                    "d"1.5,
                    "precision"1,
                    "format""SHORT_DATE",
                    "i"1,
                    "l"{
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{}
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "localized""string",
            "id""string",
            "params"{
                "<string>"{
                    "dt""2015-01-01T22:13:05.651Z",
                    "s""string",
                    "d"1.5,
                    "precision"1,
                    "format""SHORT_DATE",
                    "i"1,
                    "l"{
                        "id""string",
                        "params"{
                            "<string>"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"{}
                                }
                            }
                        }
                    }
                }
            }
        }
    ],
    "device_constraints"[
        {
            "notes"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "driver"{
                "vendor""string",
                "name""string",
                "version""string"
            },
            "firmware"{
                "vendor""string",
                "version""string"
            }
        },
        {
            "notes"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{
                                    "<string>"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"{}
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ],
            "driver"{
                "vendor""string",
                "name""string",
                "version""string"
            },
            "firmware"{
                "vendor""string",
                "version""string"
            }
        }
    ],
    "vcg_link""http://myurl.com",
    "compatibility""COMPATIBLE",
    "device"{
        "vid""string",
        "used_by_vsan"true,
        "model_name""string",
        "driver"{
            "vendor""string",
            "name""string",
            "version""string"
        },
        "pci_address""string",
        "vendor""string",
        "svid""string",
        "ssid""string",
        "sub_class_code""string",
        "firmware"{
            "vendor""string",
            "version""string"
        },
        "did""string",
        "class_code""string"
    },
    "supported_releases"[
        "string",
        "string"
    ]
}
{
    "notes"[
        {
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "localized""string",
            "id""string",
            "params"[
                {
                    "value"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    "key""string"
                }
            ]
        },
        {
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "localized""string",
            "id""string",
            "params"[
                {
                    "value"{
                        "dt""2015-01-01T22:13:05.651Z",
                        "s""string",
                        "d"1.5,
                        "precision"1,
                        "format""SHORT_DATE",
                        "i"1,
                        "l"{
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    "key""string"
                }
            ]
        }
    ],
    "device_constraints"[
        {
            "notes"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                }
            ],
            "driver"{
                "vendor""string",
                "name""string",
                "version""string"
            },
            "firmware"{
                "vendor""string",
                "version""string"
            }
        },
        {
            "notes"[
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                {
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                }
            ],
            "driver"{
                "vendor""string",
                "name""string",
                "version""string"
            },
            "firmware"{
                "vendor""string",
                "version""string"
            }
        }
    ],
    "vcg_link""http://myurl.com",
    "compatibility""COMPATIBLE",
    "device"{
        "vid""string",
        "used_by_vsan"true,
        "model_name""string",
        "driver"{
            "vendor""string",
            "name""string",
            "version""string"
        },
        "pci_address""string",
        "vendor""string",
        "svid""string",
        "ssid""string",
        "sub_class_code""string",
        "firmware"{
            "vendor""string",
            "version""string"
        },
        "did""string",
        "class_code""string"
    },
    "supported_releases"[
        "string",
        "string"
    ]
}

Attributes:

Name Type Description
Required
-.compatibility string Indicates compatibility status of the PCI device.

Defines compatibility status of a given server or PCI device against a specific release of ESXi. Value is one of:
COMPATIBLE: When given hardware is certified for the specified ESXi release but no validation of the software of this hardware is performed.
INCOMPATIBLE: When given hardware is not certified for the specified ESXi release.
UNAVAILABLE: When there is no information about specified hardware.
CERTIFIED: When given hardware is certified for the specified ESXi release. Its software is also validated and it is also certified.
NOT_CERTIFIED: When given hardware is certified for the specified ESXi release. Its software is also validated and it is not certified.

-.device PCI_device Information about the PCI device.

-.device.pci_address string The device's address in a given ESXi host.

-.device.vid string A unique number assigned to each computer hardware device that helps to identify the chipset manufacturer. For example, Dell, Broadcom, etc.

-.device.did string A unique number that identifies the specific device of the Vendor (VID).

-.device.svid string A unique number that identifies the card manufacturer.

-.device.ssid string A unique number that identifies the specific device of Subsystem Vendor (SVID).

-.device.vendor string The name of the vendor.

-.device.model_name string The name of the device model.

-.device.class_code string Register that specifies the type of function the device performs.

-.device.sub_class_code string Register that specifies the specific function the device performs.

-.device.driver driver Currently installed driver used by the device.

-.device.driver.name string The name of the driver.

-.device.driver.version string The version of the driver.

-.device.firmware.version string The version of the firmware.

-.device.used_by_vsan boolean Shows whether the device is part of VSAN cluster or not.

Optional
-.device.driver.vendor string The vendor that produced the driver.

Optional. If unset vendor is unknown.

-.device.firmware firmware Currently installed firmware used by the device.

Optional. If unset firmware is unknown.

-.device.firmware.vendor string The vendor that produced the firmware.

Optional. If unset vendor is unknown.

-.device_constraints device_constraint[] Lists the constraints the target ESXi release has for this PCI device

Optional. If unset no constraints are present as PCI device is either not compatible or compatibility information is not found.

-.supported_releases string[] Provides information about supported releases for this device.

Optional. If unset device is compatible with the given target release.

-.vcg_link URI Provides link to the VMware Compatibility Guide for further information on the compatibility.

Optional. If unset there is no VMware Compatibility link available as this is device used by VSAN.

-.notes localizable_message[] Information that needs to be taken into account when considering this device hcl.

Optional. Only set if there is any information reported.