com.vmware.esx.settings.depot_content package¶
Submodules¶
com.vmware.esx.settings.depot_content.add_ons_client module¶
The com.vmware.esx.settings.depot_content.add_ons_client
module provides
classes to retrieve OEM specific add-on versions from the depot.
-
class
com.vmware.esx.settings.depot_content.add_ons_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
-
class
com.vmware.esx.settings.depot_content.add_ons_client.
Versions
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Versions
class provides methods to get OEM add-on versions from the sync’ed and imported depots.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CategoryType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Versions.CategoryType
class defines possible values of categories for a OEM add-on.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 theCategoryType
instance.
-
BUGFIX
= CategoryType(string='BUGFIX')¶ Bugfix
-
ENHANCEMENT
= CategoryType(string='ENHANCEMENT')¶ Enhancement
-
SECURITY
= CategoryType(string='SECURITY')¶ Security
-
class
ComponentInfo
(name=None, display_name=None, version=None, display_version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.ComponentInfo
class defines the information regarding a component present in OEM add-on.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
name (
str
) – Identifier of the component. 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.component
. 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.component
.display_name (
str
) – Display name of the component.version (
str
) – Version of the component.display_version (
str
) – Human readable version of the OEM add-on.
-
class
Info
(display_name=None, vendor=None, display_version=None, summary=None, description=None, category=None, kb=None, release_date=None, components=None, removed_components=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.Info
class defines the information regarding a OEM add-on version.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
display_name (
str
) – Display name of the OEM add-on.vendor (
str
) – Vendor of the OEM add-on.display_version (
str
) – Human readable version of the OEM add-on.summary (
str
) – Summary of the OEM add-on.description (
str
) – Discription of the OEM add-on.category (
Versions.CategoryType
) – Category of the OEM add-on.kb (
str
) – Link to kb article related to this the OEM add-on.release_date (
datetime.datetime
) – Release date of the OEM add-on.components (
list
ofVersions.ComponentInfo
) – List of components in this OEM add-on.removed_components (
list
ofVersions.RemovedComponentInfo
) – List of components removed by this OEM add-on.
-
class
RemovedComponentInfo
(name=None, display_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.RemovedComponentInfo
class defines the information regarding a component removed by the OEM add-on.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
name (
str
) – Identifier of the component. 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.component
. 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.component
.display_name (
str
) – Display name of the component.
-
get
(name, version)¶ Returns information about a given OEM add-on version in the depot.
- Parameters
name (
str
) – Name of the OEM add-on The parameter must be an identifier for the resource type:com.vmware.esx.settings.add_on
.version (
str
) – Version of the OEM add-on
- Return type
- Returns
Information about the given OEM add-on
- 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 OEM add-on with given version is not found.- 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.Unauthorized
if you do not have all of the privileges described as follows:Method execution requires
VcIntegrity.lifecycleSettings.Read
.
com.vmware.esx.settings.depot_content.base_images_client module¶
The com.vmware.esx.settings.depot_content.base_images_client
module
provides classes to retrieve base_images from the depot.
-
class
com.vmware.esx.settings.depot_content.base_images_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
-
class
com.vmware.esx.settings.depot_content.base_images_client.
Versions
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Versions
class provides methods to get versions of base-images from the sync’ed and imported depots.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CategoryType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Versions.CategoryType
class defines possible values of categories for a base-image.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 theCategoryType
instance.
-
BUGFIX
= CategoryType(string='BUGFIX')¶ Bugfix
-
ENHANCEMENT
= CategoryType(string='ENHANCEMENT')¶ Enhancement
-
SECURITY
= CategoryType(string='SECURITY')¶ Security
-
class
ComponentVersionInfo
(name=None, display_name=None, version=None, display_version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.ComponentVersionInfo
class defines the information regarding a component present inbase-image.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
name (
str
) – Identifier of the component. 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.component
. 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.component
.display_name (
str
) – Display name of the component.version (
str
) – Version of the component.display_version (
str
) – Human readable version of the base-image.
-
class
Info
(display_name=None, version=None, display_version=None, summary=None, description=None, category=None, kb=None, release_date=None, components=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.Info
class defines the information regarding a base-image.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
display_name (
str
) – Display name of the base-image.version (
str
) – Version of the base-image. 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.base_image
. 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.base_image
.display_version (
str
) – Human readable version of the base-image.summary (
str
) – Summary of the base-image.description (
str
) – Discription of the base-image.category (
Versions.CategoryType
) – Category of the base-image.kb (
str
) – Link to kb article related to this the base-image.release_date (
datetime.datetime
) – Release date of the base-image.components (
list
ofVersions.ComponentVersionInfo
) – List of components in this base-image.
-
get
(version)¶ Returns information about a given base-image version in the depot.
- Parameters
version (
str
) – Version of the base-image- Return type
- Returns
Information about the given base-image
- 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 base-image with given version is not found.- 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.Unauthorized
if you do not have all of the privileges described as follows:Method execution requires
VcIntegrity.lifecycleSettings.Read
.
com.vmware.esx.settings.depot_content.components_client module¶
The com.vmware.esx.settings.depot_content.components_client
module provides
classes to retrieve component versions from the depot.
-
class
com.vmware.esx.settings.depot_content.components_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
-
class
com.vmware.esx.settings.depot_content.components_client.
Versions
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Versions
class provides methods to get component versions from the sync’ed and imported depots.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CategoryType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Versions.CategoryType
class defines possible values of categories for a component.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 theCategoryType
instance.
-
BUGFIX
= CategoryType(string='BUGFIX')¶ Bugfix
-
ENHANCEMENT
= CategoryType(string='ENHANCEMENT')¶ Enhancement
-
GENERAL
= CategoryType(string='GENERAL')¶ General
-
INFO
= CategoryType(string='INFO')¶ Info
-
MISC
= CategoryType(string='MISC')¶ Misc
-
RECALL
= CategoryType(string='RECALL')¶ Recall
-
RECALL_FIX
= CategoryType(string='RECALL_FIX')¶ Recall-fix
-
SECURITY
= CategoryType(string='SECURITY')¶ Security
-
class
Info
(display_name=None, vendor=None, display_version=None, summary=None, description=None, category=None, urgency=None, kb=None, contact=None, release_date=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Versions.Info
class defines the information regarding a component version.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
display_name (
str
) – Display name of the component.vendor (
str
) – Vendor of the component.display_version (
str
) – Human readable version of the component.summary (
str
) – Summary of the component version.description (
str
) – Discription of the component version.category (
Versions.CategoryType
) – Category of the component version.urgency (
Versions.UrgencyType
) – Urgency of the component version.kb (
str
) – Link to kb article related to this the component version.contact (
str
) – Contact email for the component version.release_date (
datetime.datetime
) – Release date of the component version.
-
class
UrgencyType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Versions.UrgencyType
class defines possible values of urgencies for a component.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 theUrgencyType
instance.
-
CRITICAL
= UrgencyType(string='CRITICAL')¶ Critical
-
GENERAL
= UrgencyType(string='GENERAL')¶ General
-
IMPORTANT
= UrgencyType(string='IMPORTANT')¶ Important
-
LOW
= UrgencyType(string='LOW')¶ Low
-
MODERATE
= UrgencyType(string='MODERATE')¶ Moderate
-
get
(name, version)¶ Returns information about a given component version in the depot.
- Parameters
name (
str
) – Name of the component The parameter must be an identifier for the resource type:com.vmware.esx.settings.component
.version (
str
) – Version of the component
- Return type
- Returns
Information about the given 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 component with given version is not found.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the caller is not authenticated.- Raise
com.vmware.vapi.std.errors_client.ServiceUnavailable
If the service is not available.- 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
.