com.vmware.esx.hcl package¶
Submodules¶
com.vmware.esx.hcl.hosts_client module¶
-
class
com.vmware.esx.hcl.hosts_client.
CompatibilityReleases
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
This class provides methods to list available releases for generating compatibility report for a specific ESXi host.
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
EsxiCompatibilityReleases
(current_compatibility_release=None, newer_compatibility_releases=None, notifications=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReleases.EsxiCompatibilityReleases
class contains attributes that describe available releases for generating compatibility report for a specific ESXi host.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
current_compatibility_release (
str
) –The current release of the ESXi, which also can be checked for compatibility.
The information for the release does not include patch information.
newer_compatibility_releases (
list
ofstr
) – The available ESXi releases, greater than the current one, than can be checked for compatibility.notifications (
com.vmware.esx.hcl_client.Notifications
) – Notifications returned by the operation.
-
list
(host)¶ Lists the locally available ESXi releases for a given host that can be used to generate a compatiblity report. Each host has its own list of supported releases depending on its current release.
- Parameters
host (
str
) – Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type:HostSystem
.- Return type
- Returns
Available releases for compatibility for a specified host.
- Raise
com.vmware.vapi.std.errors_client.InternalServerError
If there is some internal error. The accompanying error message will give more details about the failure.- Raise
com.vmware.vapi.std.errors_client.NotAllowedInCurrentState
if there is no compatibility data on the vCenter executing the operation.- Raise
com.vmware.vapi.std.errors_client.NotFound
if no host with the given MoID can be found.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the caller is not authenticated.- Raise
com.vmware.vapi.std.errors_client.Unsupported
if the provided host is not supported.- Raise
com.vmware.vapi.std.errors_client.ResourceInaccessible
if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).- Raise
com.vmware.vapi.std.errors_client.Error
If there is some unknown error. The accompanying error message will give more details about the failure.- Raise
com.vmware.vapi.std.errors_client.Unauthorized
if you do not have all of the privileges described as follows:Method execution requires
VcIntegrity.HardwareCompatibility.Read
.
-
class
com.vmware.esx.hcl.hosts_client.
CompatibilityReport
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
This class provides methods to generate hardware compatibility report for a given ESXi host against a specific ESXi release.
- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
BiosConstraint
(bios=None, notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.BiosConstraint
class contains attributes that describe the BIOS that is supported for the given server and ESXi release.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
bios (
com.vmware.esx.hcl_client.Firmware
) – The BIOS information about the constraint.notes (
list
ofcom.vmware.vapi.std_client.LocalizableMessage
) – Any information that should be taken into account when reviewing the BIOS constraint.
-
class
DeviceConstraint
(driver=None, firmware=None, notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.DeviceConstraint
class contains attributes that describe pair of driver and firmware that are supported for a given PCI device and ESXi release.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
driver (
com.vmware.esx.hcl_client.Driver
) – The driver information about the constraint.firmware (
com.vmware.esx.hcl_client.Firmware
orNone
) – The firmware information about the constraint. If None there is no firmware restriction on the driver to work with that release.notes (
list
ofcom.vmware.vapi.std_client.LocalizableMessage
) – Any information that should be taken into account when reviewing the device constraint.
-
class
DeviceHclInfo
(compatibility=None, device=None, device_constraints=None, supported_releases=None, vcg_link=None, notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.DeviceHclInfo
class contains attributes 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.
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
compatibility (
com.vmware.esx.hcl_client.CompatibilityStatus
) – Indicates compatibility status of the PCI device.device (
com.vmware.esx.hcl_client.PCIDevice
) – Information about the PCI device.device_constraints (
list
ofCompatibilityReport.DeviceConstraint
orNone
) – Lists the constraints the target ESXi release has for this PCI device If None no constraints are present as PCI device is either not compatible or compatibility information is not found.supported_releases (
list
ofstr
orNone
) – Provides information about supported releases for this device. If None device is compatible with the given target release.vcg_link (
str
orNone
) – Provides link to the VMware Compatibility Guide for further information on the compatibility. If None there is no VMware Compatibility link available as this is device used by VSAN.notes (
list
ofcom.vmware.vapi.std_client.LocalizableMessage
orNone
) – Information that needs to be taken into account when considering this device hcl. Onlyset
if there is any information reported.
-
class
HclReport
(host=None, target_release=None, server_hcl=None, devices_hcl=None, generated_at=None, notifications=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.HclReport
represents the hardware compatibility report generated for a specific host and target ESXi release.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
host (
str
) – FQDN identifying the ESXi host that the report refers to.target_release (
str
) – Indicates for which ESXi release the report is generated.server_hcl (
CompatibilityReport.ServerHclInfo
) – Lists compatibility information for the ESXi’s server part.devices_hcl (
list
ofCompatibilityReport.DeviceHclInfo
orNone
) – Lists compatibility information for discoverable PCI devices of the host. If None the server is not compatible with the requested release and the PCI devices cannot be checked.generated_at (
datetime.datetime
) – Specifies the time the report was generated.notifications (
com.vmware.esx.hcl_client.Notifications
) – Notifications returned by the operation.
-
class
Result
(report=None, identifier=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
CompatibilityReport.Result
class contains the result of hardware compatibility report creation operation.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
report (
CompatibilityReport.HclReport
) – The hardware compatibility report.identifier (
str
orNone
) –The identifier of the compatibility report.
com.vmware.esx.hcl_client.Reports.get()
provides location where a file based report based on theCompatibilityReport.HclReport
can be downloaded using this identifier. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.esx.hcl.resources.CompatibilityReport
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:com.vmware.esx.hcl.resources.CompatibilityReport
. None in case of error reported inCompatibilityReport.HclReport.notifications
.
-
class
ServerCompatibility
(bios_constraints=None, cpu_series=None, supported_releases=None, vcg_link=None, notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.ServerCompatibility
class contains attributes that provide the compatibility information for a server model, cpu and BIOS.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
bios_constraints (
list
ofCompatibilityReport.BiosConstraint
orNone
) – Lists the BIOS constraints that the target ESXi release has for this server. If None no constraints are present as server is either not compatible or compatibility information is not found.cpu_series (
str
) – The CPU series name.supported_releases (
list
ofstr
orNone
) – Provides information about supported releases for this entry. If None server is compatible with the given target release.vcg_link (
str
) – Provides link to the VMware Compatibility Guide for further information on the compatibility.notes (
list
ofcom.vmware.vapi.std_client.LocalizableMessage
orNone
) – Information that needs to be taken into account when considering this server hardware compatibility. Onlyset
if there is any information reported.
-
class
ServerHclInfo
(server=None, matches=None, model_compatibility=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
This
CompatibilityReport.ServerHclInfo
class contains attributes that describe the server of a ESXi host and its compatibility information.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
server (
com.vmware.esx.hcl_client.Server
) – Information about the server.matches (
list
ofCompatibilityReport.ServerCompatibility
) –Provides information about possible compatibility matches for the given server.
There could be multiple matches returned as there are several possible matches in the Compatibility data.
model_compatibility (
com.vmware.esx.hcl_client.CompatibilityStatus
) – Shows if the server model is compatible with given target ESXi release.
-
class
Spec
(release=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
CompatibilityReport.Spec
class contains attributes to describe the input configuration for an ESXi’s compatibility report generation.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
release (
str
) – A target ESXi release which will be used to generate a compatibility report. Releases that can be used to generate report can be found usingCompatibilityReleases.list()
-
create_task
(host, spec=None)¶ Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
- Parameters
host (
str
) – Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type:HostSystem
.spec (
CompatibilityReport.Spec
orNone
) – Specifies the input parameters for generating compatibility report. If None host compatibility will be checked against the current release of the ESXi.
- Return type
- class
vmware.vapi.stdlib.client.task.Task
- Returns
Task instance
- Raise
com.vmware.vapi.std.errors_client.NotFound
if no host with the given MoID can be found.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the caller is not authenticated.- Raise
com.vmware.vapi.std.errors_client.Unsupported
if the provided host is not supported.- Raise
com.vmware.vapi.std.errors_client.ResourceInaccessible
if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).- Raise
com.vmware.vapi.std.errors_client.NotAllowedInCurrentState
if there is no compatibility data on the vCenter executing the operation.- Raise
com.vmware.vapi.std.errors_client.Error
If there is some unknown error. The accompanying error message will give more details about the failure.
-
get
(host)¶ Returns the last generated hardware compatibility report for the given host.
- Parameters
host (
str
) – The parameter must be an identifier for the resource type:HostSystem
.- Return type
- Returns
- Raise
com.vmware.vapi.std.errors_client.NotFound
if there is no report generated for the given host. This operation does not check if the host id is valid or it exists.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the caller is not authenticated.- Raise
com.vmware.vapi.std.errors_client.ResourceInaccessible
if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).- Raise
com.vmware.vapi.std.errors_client.Error
If there is some unknown error. The accompanying error message will give more details about the failure.
-
class
com.vmware.esx.hcl.hosts_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance