com.vmware.esx.settings.hosts.software package

Submodules

com.vmware.esx.settings.hosts.software.drafts_client module

The com.vmware.esx.settings.hosts.software.drafts_client module provides classes to manage software drafts for ESX host.

class com.vmware.esx.settings.hosts.software.drafts_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.esx.settings.hosts.software.reports_client module

The com.vmware.esx.settings.hosts.software.reports_client module provides classes to manage reports pertaining to the desired state software for standalone ESXi hosts.

class com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The ApplyImpact class provides methods to get the impact of an apply method on a standalone ESXi host. This class was added in vSphere API 8.0.0.1.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class HostImpact(impact=None, commit=None, host_info=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplyImpact.HostImpact class contains attributes that describe the summary of how the standalone ESXi host will be impacted during an apply method. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • impact (list of ApplyImpact.Impact) – Impact of steps performed during the apply method. This attribute was added in vSphere API 8.0.0.1.

  • commit (str) – Identifier of the commit on which the impact is generated. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. 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.settings.commit.

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host. This attribute was added in vSphere API 8.0.0.1.

class Impact(message=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplyImpact.Impact class contains attributes that describe what the impact is of a particular step during the apply method. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

message (com.vmware.vapi.std_client.LocalizableMessage) – Description of the impact. This attribute was added in vSphere API 8.0.0.1.

get(host)

Returns a summary of how a standalone ESXi host will be impacted during an apply method. The impact is generated from the compliance information obtained from com.vmware.esx.settings.hosts.software_client.Compliance.get(). This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – The host identifier. The parameter must be an identifier for the resource type: HostSystem.

Return type

ApplyImpact.HostImpact

Returns

Summary of how hosts will be impacted during an apply method

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no host associated with host in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unsupported If the host is not a vLCM managed standlone host.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.

  • The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The LastApplyResult class provides methods to get the most recent available result of applying the desired software document to a standalone ESXi host. This class was added in vSphere API 8.0.0.1.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class ApplyResult(status=None, commit=None, host_info=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastApplyResult.ApplyResult class contains attributes that describe the result of an apply method. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • status (LastApplyResult.ApplyStatus or None) – Specifies the status of the apply method. This attribute was added in vSphere API 8.0.0.1. None if the apply method is in progress.

  • commit (str) – The identifier of the commit used to fetch the desired software document to be applied to the standalone host. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. 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.settings.commit.

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information of the host to which the desired software document specified by the LastApplyResult.ApplyResult.commit needs to be applied to. This attribute was added in vSphere API 8.0.0.1.

  • notifications (com.vmware.esx.settings_client.Notifications or None) – Notifications providing additional information for com.vmware.esx.settings.hosts_client.Software.apply() method. These notifications are mutually exclusive with the notifications in LastApplyResult.ApplyStatus. This attribute was added in vSphere API 8.0.0.1.

class ApplyStatus(status=None, start_time=None, end_time=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastApplyResult.ApplyStatus class contains attributes that describe the status of an apply method. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • status (LastApplyResult.ApplyStatus.Status) – The status of the method. This attribute was added in vSphere API 8.0.0.1.

  • start_time (datetime.datetime) – Time when the method started. This attribute was added in vSphere API 8.0.0.1.

  • end_time (datetime.datetime) – Time when the method completed. This attribute was added in vSphere API 8.0.0.1.

  • notifications (com.vmware.esx.settings_client.Notifications) – Notifications providing additional information about the status of the method. This attribute was added in vSphere API 8.0.0.1.

class Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The LastApplyResult.ApplyStatus.Status class contains the possible different status codes that can be returned while trying to apply the desired software specification to a standalone host. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Status instance.

ERROR = Status(string='ERROR')

The method encountered an unspecified error. This class attribute was added in vSphere API 8.0.0.1.

OK = Status(string='OK')

The method completed successfully. This class attribute was added in vSphere API 8.0.0.1.

SKIPPED = Status(string='SKIPPED')

The method was skipped. This class attribute was added in vSphere API 8.0.0.1.

TIMED_OUT = Status(string='TIMED_OUT')

The method timed out. This class attribute was added in vSphere API 8.0.0.1.

get(host)

Returns the most recent available result of applying the desired software document to the standalone ESXi host. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – the host identifier. The parameter must be an identifier for the resource type: HostSystem.

Return type

LastApplyResult.ApplyResult

Returns

Most recent available result of applying the desired software document to the standalone ESXi host.

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no standalone host associated with host in the system or if there is no result associated with the host host

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unsupported If the host is not a vLCM managed standlone host.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.

  • The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The LastCheckResult class provides methods to get the most recent available result of the checks that have been run on the standalone host before the application of the desired software document to the host. This class was added in vSphere API 8.0.0.1.

Parameters

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class CheckInfo(check=None, name=None, description=None, originator=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckInfo class contains attributes that describe a particular check. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • check (str) – The check identifier. This attribute was added in vSphere API 8.0.0.1.

  • name (com.vmware.vapi.std_client.LocalizableMessage) – The check name. This attribute was added in vSphere API 8.0.0.1.

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Human-readable check description. This attribute was added in vSphere API 8.0.0.1.

  • originator (str or None) – The service that performed the check. This attribute was added in vSphere API 8.0.0.1. Only set if there is an originator available for this check.

class CheckIssue(description=None, resolution=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

The arguments are used to initialize data attributes with the same names.

Parameters
class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_result=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckResult class contains attributes that describe aggregated status of all checks performed. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • status (LastCheckResult.Status) – Aggregated status from all checks performed. This attribute was added in vSphere API 8.0.0.1.

  • start_time (datetime.datetime) – Time when the operation started. This attribute was added in vSphere API 8.0.0.1.

  • end_time (datetime.datetime) – Time when the operation completed. This attribute was added in vSphere API 8.0.0.1.

  • commit (str) – The identifier of the commit on which checks have been run. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. 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.settings.commit.

  • host_info (com.vmware.esx.settings_client.HostInfo) – Information about the host for which checks have been requested to be run. This attribute was added in vSphere API 8.0.0.1.

  • entity_result (LastCheckResult.EntityCheckResult) – List of LastCheckResult.EntityCheckResult for all entities for which checks have been run. This attribute was added in vSphere API 8.0.0.1.

class CheckStatus(check=None, status=None, check_issues=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.CheckStatus class contains attributes that describe a check result. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • check (LastCheckResult.CheckInfo) – Information about this check. This attribute was added in vSphere API 8.0.0.1.

  • status (LastCheckResult.Status) – The status of this check. This attribute was added in vSphere API 8.0.0.1.

  • check_issues (list of LastCheckResult.CheckIssue or None) – The issues encountered while running this check. This attribute was added in vSphere API 8.0.0.1.

class EntityCheckResult(type=None, host=None, status=None, check_statuses=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The LastCheckResult.EntityCheckResult class contains attributes that describe aggregated status of all checks performed on a specific entity. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

  • type (LastCheckResult.EntityCheckResult.EntityType) – The entity type for which these checks are being run. This attribute was added in vSphere API 8.0.0.1.

  • host (str) – If the entity type is HOST then the host identifier for which the checks have been run. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. This attribute is optional and it is only relevant when the value of type is LastCheckResult.EntityCheckResult.EntityType.HOST.

  • status (LastCheckResult.Status) – Aggregated status from all checks performed on this entity. This attribute was added in vSphere API 8.0.0.1.

  • check_statuses (list of LastCheckResult.CheckStatus) – List of LastCheckResult.CheckStatus for all checks performed. This attribute was added in vSphere API 8.0.0.1.

class EntityType(string)

Bases: vmware.vapi.bindings.enum.Enum

The LastCheckResult.EntityCheckResult.EntityType class contains the entities on which checks can be performed. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the EntityType instance.

HOST = EntityType(string='HOST')

Entity type Host. This class attribute was added in vSphere API 8.0.0.1.

class Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The LastCheckResult.Status class defines the status result for a particular check. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters

string (str) – String value for the Status instance.

ERROR = Status(string='ERROR')

The check indicates an error. This class attribute was added in vSphere API 8.0.0.1.

OK = Status(string='OK')

The check indicates a success. This class attribute was added in vSphere API 8.0.0.1.

TIMEOUT = Status(string='TIMEOUT')

The check did not return in a timely manner. This class attribute was added in vSphere API 8.0.0.1.

WARNING = Status(string='WARNING')

The check indicates a warning. This class attribute was added in vSphere API 8.0.0.1.

get(host)

Returns the most recent available result of checks run on the standalone host before the application of the desired software document to the host. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – The host identifier. The parameter must be an identifier for the resource type: HostSystem.

Return type

LastCheckResult.CheckResult

Returns

Most recent available result of the checks run on the host.

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no standalone host associated with host in the system or if there is no result associated with the host host.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unsupported If the host is not a vLCM managed standlone host.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.

  • The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Read.

class com.vmware.esx.settings.hosts.software.reports_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance