com.vmware.esx.settings.depots package

Submodules

com.vmware.esx.settings.depots.offline_client module

The com.vmware.esx.settings.depots.offline_client module provides classes to manage vLCM offline depots.

class com.vmware.esx.settings.depots.offline_client.Content(config)

Bases: VapiInterface

The Content class provides methods to manage offline software depots used during ESX lifecycle management. This class was added in vSphere API 7.0.3.0.

Parameters:

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

class Info(metadata_bundles=None)

Bases: VapiStruct

The Content.Info class contains fields that describe the information of metadata bundles of an offline depot. This class was added in vSphere API 7.0.3.0.

Tip

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

Parameters:

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is vendor of metadata bundle. This attribute was added in vSphere API 7.0.3.0. 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.depots.vendor. 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.depots.vendor.

get(depot)

Gets the information of content of an imported offline software depot. This method was added in vSphere API 7.0.3.0.

Parameters:

depot (str) – Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Return type:

Content.Info

Returns:

Information of content of the imported offline software depot.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.NotFound If there is no depot with given identifier depot in the system.

Raise:

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

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.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depots.offline_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.esx.settings.depots.online_client module

The com.vmware.esx.settings.depots.online_client module provides classes to manage vLCM online depots.

class com.vmware.esx.settings.depots.online_client.Content(config)

Bases: VapiInterface

The Content class provides methods to manage online software depots used during ESX lifecycle management. This class was added in vSphere API 7.0.3.0.

Parameters:

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

class Info(metadata_bundles=None)

Bases: VapiStruct

The Content.Info class contains fields that describe the information of metadata bundles of an online depot. This class was added in vSphere API 7.0.3.0.

Tip

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

Parameters:

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is vendor of metadata bundle. This attribute was added in vSphere API 7.0.3.0. 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.depots.vendor. 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.depots.vendor.

get(depot)

Gets the information of content of an imported online software depot. This method was added in vSphere API 7.0.3.0.

Parameters:

depot (str) – Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Return type:

Content.Info

Returns:

Information of content of the imported online software depot.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.NotFound If there is no depot with given identifier depot in the system.

Raise:

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

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.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depots.online_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.esx.settings.depots.umds_client module

The com.vmware.esx.settings.depots.umds_client module provides classes to manage vLCM UMDS depot.

class com.vmware.esx.settings.depots.umds_client.Content(config)

Bases: VapiInterface

The Content class provides methods to manage the UMDS depot used during ESX lifecycle management. This class was added in vSphere API 7.0.3.0.

Parameters:

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

class Info(metadata_bundles=None)

Bases: VapiStruct

The Content.Info class contains fields that describe the information of matadata bundles of the UMDS depot. This class was added in vSphere API 7.0.3.0.

Tip

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

Parameters:

metadata_bundles (dict of str and list of com.vmware.esx.settings.depots_client.MetadataInfo) – A list of metadata bundles contained in the depot. The key is vendor of metadata bundle. This attribute was added in vSphere API 7.0.3.0. 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.depots.vendor. 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.depots.vendor.

get()

Gets the information of content about the UMDS depot. This method was added in vSphere API 7.0.3.0.

Return type:

Content.Info

Returns:

Information of content of the imported UMDS depot.

Raise:

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

Raise:

com.vmware.vapi.std.errors_client.NotFound If there is no UMDS depot configured in the system.

Raise:

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

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.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depots.umds_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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