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

Submodules¶

com.vmware.esx.settings.hosts.software.drafts.software_client module¶

The com.vmware.esx.settings.hosts.software.drafts.software_client module provides classes to manage specifications in a software draft for an ESX host.

class com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The AddOn class provides methods to manage the OEM add-on specification in a software draft. 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.

RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'¶: Resource type for add-on resource. This class attribute was added in vSphere API 8.0.0.1.

delete(host, draft)¶

Deletes the desired OEM add-on specification in the software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

get(host, draft)¶

Returns the OEM add-on specification in a software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

com.vmware.esx.settings_client.AddOnInfo

Returns

OEM add-on specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft in the system or no add-on specification is set.

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.lifecycleSoftwareSpecification.Read.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

set(host, draft, spec)¶

Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
spec (com.vmware.esx.settings_client.AddOnSpec) – AddOn specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

class com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The BaseImage class provides methods to manage the base-image specification in a software draft. 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.

RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'¶: Resource type for base-image resource. This class attribute was added in vSphere API 8.0.0.1.

get(host, draft)¶

Returns the base-image specification in a software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

com.vmware.esx.settings_client.BaseImageInfo

Returns

Base-image specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Read.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

set(host, draft, spec)¶

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
spec (com.vmware.esx.settings_client.BaseImageSpec) – Base-image specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

class com.vmware.esx.settings.hosts.software.drafts.software_client.Components(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Components class provides methods to manage component specification in a software draft. 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.

RESOURCE_TYPE = 'com.vmware.esx.settings.component'¶: Resource type for component resource. This class attribute was added in vSphere API 8.0.0.1.

class UpdateSpec(components_to_set=None, components_to_delete=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Components.UpdateSpec class contains attributes that are specified to update list of components in the draft. 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

components_to_set ((dict of str and (str or None)) or None) – List of components to be updated. If the component already exists in the draft, the version is updated, else it is added. If a component is provided without version, then its version will be chosen based on constraints in the system. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.esx.settings.component. If None, no components will be added or updated.
components_to_delete (set of str or None) – List of components to be removed. 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 contain identifiers for the resource type: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.esx.settings.component. If None, no components will be removed.

delete(host, draft, component)¶

Deletes the given component from the software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
component (str) – Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft or no component associated with component 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

get(host, draft, component)¶

Returns the component version for the given component in the software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
component (str) – Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.

Return type

com.vmware.esx.settings_client.ComponentInfo or None

Returns

Information about component version. If None then version will be chosen based on the constraints in the system.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft or no component associated with component 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.lifecycleSoftwareSpecification.Read.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list(host, draft)¶

Returns the components that comprise the software draft. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

dict of str and com.vmware.esx.settings_client.ComponentInfo

Returns

Map of component version information keyed by the component identifier. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.component.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Read.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

set(host, draft, component, version=None)¶

Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
component (str) – Identifier of the component. The parameter must be an identifier for the resource type: com.vmware.esx.settings.component.
version (str or None) – Component version. This attribute is currently required. In the future,if this attribute is None then version is chosen based on the constraints in the system.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

update(host, draft, spec)¶

Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.
spec (Components.UpdateSpec) – Update specification containing list of components to add and/or delete.

Raise

com.vmware.vapi.std.errors_client.Error If there is some 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Write.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

class com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The EffectiveComponents class provides methods to manage effective list of components. 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.

list(host, draft)¶

Returns the components that comprise the desired software state of the host. This method was added in vSphere API 8.0.0.1.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
draft (str) – Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Return type

dict of str and com.vmware.esx.settings_client.EffectiveComponentInfo

Returns

Map of effective components keyed by their identifier. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.component.

Raise

com.vmware.vapi.std.errors_client.Error If there is 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 or no draft associated with draft 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.lifecycleSoftwareSpecification.Read.
The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.settings.hosts.software.drafts.software_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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