com.vmware.vcenter.lcm package¶
Submodules¶
com.vmware.vcenter.lcm.discovery_client module¶
The com.vmware.vcenter.lcm.discovery_client
module provides classes for
discovering products registered with vCenter Server and interoperability
between those products and vCenter Server.
-
class
com.vmware.vcenter.lcm.discovery_client.
AssociatedProducts
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
AssociatedProducts
class provides options to list, add, modify, and delete VMware products associated with vCenter Server. Some products can be auto-detected by the system while others can be added manually.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
CreateSpec
(product_name=None, version=None, deployments=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
AssociatedProducts.CreateSpec
class is the specification used for the product creation.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
product_name (
str
) – The name of the product.version (
str
) – Current product version.deployments (
list
ofstr
orNone
) – The list of hostname/IPs of the instances of the VMware products deployed in the environment.
-
RESOURCE_TYPE
= 'com.vmware.vcenter.lcm.product'¶ The resource type for the products interface.
-
class
UpdateSpec
(deployments=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
AssociatedProducts.UpdateSpec
class is the specification for the product update.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
deployments (
list
ofstr
orNone
) – The list of hostname/IPs of the instances of the VMware products deployed in the environment.
-
create
(spec)¶ Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.
- Parameters
spec (
AssociatedProducts.CreateSpec
) – Info creation specification.- Return type
str
- Returns
Identifier of the newly-added product. The return value will be an identifier for the resource type:
com.vmware.vcenter.lcm.product
.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.AlreadyExists
if this version is already added- Raise
com.vmware.vapi.std.errors_client.InvalidArgument
if the spec argument is not allowed- 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.
-
delete
(product)¶ Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.
- Parameters
product (
str
) – An id of the product to be removed. The parameter must be an identifier for the resource type:com.vmware.vcenter.lcm.product
.- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no record associated withproduct
in the system database.- 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.
-
get
(product)¶ Returns the detailed information of a product associated with vCenter Server.
- Parameters
product (
str
) – An identifier of the product to be modified. The parameter must be an identifier for the resource type:com.vmware.vcenter.lcm.product
.- Return type
- Returns
Product details.
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no record associated withproduct
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.
-
list
()¶ Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.
- Return type
- Returns
List of all the registered products with vCenter.
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- 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.
-
update
(product, spec)¶ Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.
- Parameters
product (
str
) – An id of the product to be modified. The parameter must be an identifier for the resource type:com.vmware.vcenter.lcm.product
.spec (
AssociatedProducts.UpdateSpec
) –
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.InvalidArgument
if the spec argument is not allowed- Raise
com.vmware.vapi.std.errors_client.NotFound
If there is no record associated withproduct
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.
-
class
com.vmware.vcenter.lcm.discovery_client.
InteropReport
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
InteropReport
interface provides methods to report the interoperability between a vCenter Server release version and the other installed VMware products registered in the vCenter Server instance.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
ReleaseInfo
(version=None, note=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
InteropReport.ReleaseInfo
class contains a product release information.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
version (
str
) – The version of the release.note (
str
orNone
) – A link to the release notes of the release. None if the release notes are not available.
-
class
Report
(date_created=None, target_product=None, products=None, issues=None, summary=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
InteropReport.Report
class contains the interoperability report between the target product and the other registered products in the vCenter Server instance.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
date_created (
datetime.datetime
) – Time when the report is created.target_product (
Product
) – A product against the other products are compared to. Only vCenter Server is supported.products (
list
ofInteropReport.ReportRow
) – Interoperability matrix for the supplied target product and the other registered products.issues (
com.vmware.vcenter.lcm_client.Notifications
orNone
) – Lists of issues encountered during report creation.set
if any issues encountered.summary (
InteropReport.ReportSummary
) – A summary of the interoperability matrix.
-
class
ReportRow
(product=None, compatible=None, compatible_releases=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
InteropReport.ReportRow
class contains the interoperability between a given product and the target product.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
product (
Product
) – The product to compare to the target product.compatible (
bool
) – Defines whether the product is compatible against the target product.compatible_releases (
list
ofInteropReport.ReleaseInfo
) – A list of compatible releases of the product with the target product.
-
class
ReportSummary
(compatible_count=None, incompatible_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
InteropReport.ReportSummary
class contains a summary of theInteropReport.Report.products
. It consists of the count of compatible and incompatible products to the target product.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
compatible_count (
long
) – Number of compatible products.incompatible_count (
long
) – Number of incompatible products.
-
class
Result
(report=None, csv_report=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
InteropReport.Result
class contains the result of interoperability report creation operation.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
report (
InteropReport.Report
) – The interoperability report.csv_report (
str
orNone
) –The identifier of CSV formatted interopability report.
com.vmware.vcenter.lcm.report.Report#get provides location where the CSV report can be downloaded from based on the
csvReport
. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.vcenter.lcm.report
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:com.vmware.vcenter.lcm.report
. None in case oferrors
reported inInteropReport.Report.issues
.
-
class
Spec
(target_version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
Configuration of report generation.
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
target_version (
str
) –The vCenter Server version.
It is used for checking against the other products registered with that instance of vCenter Server.
-
create_task
(spec=None)¶ Creates interoperability report between a vCenter Server release version and all registered products with the vCenter Server instance.
The result of this operation can be queried by calling the com.vmware.cis.Tasks#get method where
task
is the response of this operation.- Parameters
spec (
InteropReport.Spec
orNone
) – Specifies the target version against this interoperability check report will be generated. If None the report will be generated for the currently installed version of the vCenter server.- Return type
- class
vmware.vapi.stdlib.client.task.Task
- Returns
Task instance
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- 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.
-
class
com.vmware.vcenter.lcm.discovery_client.
Product
(installed_product=None, name=None, version=None, target_version=None, deployments=None, auto=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Info
class contains information about a VMware product which is present in the customer Environemnt. The following information about the products are present:Name
Version
Deployments
Automatically Discovered or Manually Added
Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
installed_product (
str
) –Identifies a product and a version uniquely.
The identifier consists of product internal name and version. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:
PRODUCT
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:PRODUCT
.name (
str
) – A public official product name.version (
str
) – Current product version.target_version (
str
orNone
) – Future version of the product after upgrade.targetVersion
may not be applicable.deployments (
list
ofstr
orNone
) – The list of hostname/IPs of the instances of the VMware products deployed in the environment. This field would be empty for manually added products.auto (
bool
) – Indicates if the product is auto-detected by the system or manually added. If it is set to true it means it is auto-detected.
-
class
com.vmware.vcenter.lcm.discovery_client.
ProductCatalog
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
ProductCatalog
class provides information which VMware products can be associated with vCenter Server.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
Summary
(name=None, versions=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
ProductCatalog.Summary
class contains information about each VMware product and its corresponding versions that can be associated with vCenter Server.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
name (
str
) – A product name that the customer is aware of.versions (
list
ofstr
) – List of versions the customer can select from.
-
list
()¶ Retrieves a list of all VMware products that can be associated with vCenter Server.
- Return type
- Returns
List of all the VMware products which can be associated with vCenter Server
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- 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.
-
class
com.vmware.vcenter.lcm.discovery_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.vcenter.lcm.update_client module¶
The com.vmware.vcenter.lcm.update_client
module provides classes for
updating vCenter Server to a newer version.
-
class
com.vmware.vcenter.lcm.update_client.
Pending
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
Pending
class provides method for listing pending minor or major updates of vCenter Server.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
class
Category
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Pending.Category
class defines the type of payload this release has on top of previous releaseNote
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 theCategory
instance.
-
FIX
= Category(string='FIX')¶ Fixes bugs/vulnerabilities, doesn’t change functionality
-
SECURITY
= Category(string='SECURITY')¶ Fixes vulnerabilities, doesn’t change functionality
-
UPDATE
= Category(string='UPDATE')¶ Changes product functionality
-
UPGRADE
= Category(string='UPGRADE')¶ Introduces new features, significantly changes product functionality
-
class
Info
(description=None, pending_update=None, version=None, release_date=None, severity=None, build=None, update_type=None, category=None, reboot_required=None, execute_url=None, release_notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Pending.Info
class contains detailed information about the vCenter patch/update.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
description (
str
) – Description of the vSphere updatepending_update (
str
) – Identifier of the given vSphere update When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
.version (
str
) – Version of the vSphere update or patchrelease_date (
datetime.datetime
) – Release date of the vSphere update or patchseverity (
Pending.SeverityType
) – Severity of the issues fixed in the vSphere update or patchbuild (
str
) – Build number of the vCenter Releaseupdate_type (
Pending.UpdateType
) – Type of the Release based on the current vCenter versioncategory (
Pending.Category
) – Category of the release based on features bundled on top of previous releasereboot_required (
bool
) – Flag to suggest a reboot after the release is appliedexecute_url (
str
) – VAMI or ISO URL for update or upgrade execute phase redirectionrelease_notes (
list
ofstr
) – List of URI pointing to patch or update release notes
-
class
ListResult
(last_check_time=None, update_count=None, upgrade_count=None, updates=None, issues=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Pending.ListResult
class contains information about the pending patch/updates for the given vCenter server.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
last_check_time (
datetime.datetime
) – Time when the software depo was last checked.update_count (
long
orNone
) – Number of pending updates Onlyset
if there are available updatesupgrade_count (
long
orNone
) – Number of pending upgrades Onlyset
if there are available upgradesupdates (
list
ofPending.Summary
) – List of pending update detailsissues (
com.vmware.vcenter.lcm_client.Notifications
orNone
) – Lists of issues encountered during pending updates retrieval.set
if any issues encountered.
-
RESOURCE_TYPE
= 'com.vmware.vcenter.lcm.update.pending'¶ Resource type for pending update
-
class
SeverityType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
Level of severity for applying a given patch or update.
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 theSeverityType
instance.
-
CRITICAL
= SeverityType(string='CRITICAL')¶ Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation.
-
IMPORTANT
= SeverityType(string='IMPORTANT')¶ Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers.
-
LOW
= SeverityType(string='LOW')¶ All other issues that may or maynot have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact.
-
MODERATE
= SeverityType(string='MODERATE')¶ Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources.
-
class
Summary
(pending_update=None, version=None, release_date=None, severity=None, build=None, update_type=None, category=None, reboot_required=None, execute_url=None, release_notes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Pending.Summary
class contains basic information about the vCenter patch/update/upgradeTip
The arguments are used to initialize data attributes with the same names.
- Parameters
pending_update (
str
) – Identifier of the given vSphere update When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
.version (
str
) – Version of the vSphere update or patchrelease_date (
datetime.datetime
) – Release date of the vSphere update or patchseverity (
Pending.SeverityType
) – Severity of the issues fixed in the vSphere update or patchbuild (
str
) – Build number of the vCenter Releaseupdate_type (
Pending.UpdateType
) – Type of the Release based on the current vCenter versioncategory (
Pending.Category
) – Category of the release based on features bundled on top of previous releasereboot_required (
bool
) – Flag to suggest a reboot after the release is appliedexecute_url (
str
) – VAMI or ISO URL for update or upgrade execute phase redirectionrelease_notes (
list
ofstr
) – List of URI pointing to patch or update release notes
-
class
UpdateType
(string)¶ Bases:
vmware.vapi.bindings.enum.Enum
The
Pending.UpdateType
class defines update typeNote
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 theUpdateType
instance.
-
PATCH
= UpdateType(string='PATCH')¶ Fixes bugs/vulnerabilities, doesn’t change functionality
-
UPDATE
= UpdateType(string='UPDATE')¶ Changes product functionality
-
UPGRADE
= UpdateType(string='UPGRADE')¶ Introduces new features, significantly changes product functionality
-
get
(version)¶ Gets detailed update information.
- Parameters
version (
str
) – A version identified the update The parameter must be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
.- Return type
- Returns
A detailed information about the particular vCenter patch/update
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.NotFound
if there is no pending update assosiated with theversion
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 error.
-
list
()¶ Lists all available minor and major updates.
- Return type
- Returns
Information about the pending patch/updates for the given vCenter server
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- 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 error.
-
class
com.vmware.vcenter.lcm.update_client.
PrecheckReport
(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterface
The
PrecheckReport
class generates precheck report for a vCenter Server instance against a target update version.- Parameters
config (
vmware.vapi.bindings.stub.StubConfiguration
) – Configuration to be used for creating the stub.
-
RESOURCE_TYPE
= 'com.vmware.vcenter.lcm.report'¶ Resource type for precheck report
-
class
Report
(date_created=None, estimated_time_to_update=None, issues=None, summary=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
PrecheckReport.Report
class contains estimates of how long it will take an update as well as a list of possible warnings and errors with applying the update.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
date_created (
datetime.datetime
) – Time when this precheck report was generatedestimated_time_to_update (
long
orNone
) – Rough estimate of time to update vCenter Server in minutes. This attribute will be None if the precheck failed.issues (
com.vmware.vcenter.lcm_client.Notifications
orNone
) – Lists of the issues and warnings This attribute will be None if the precehck is successful.summary (
PrecheckReport.ReportSummary
) – A summary of the report consist of count of warnings and errors returned by running the precheck.
-
class
ReportSummary
(error_count=None, warning_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
Summary
Class contains the summary of precheck report.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
error_count (
long
) – Number of errors detected by precheck processwarning_count (
long
) – Number of warnings detected by precheck process
-
class
Result
(report=None, csv_report=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
The
PrecheckReport.Result
class contains the precheck report and a link to download the CSV report.Tip
The arguments are used to initialize data attributes with the same names.
- Parameters
report (
PrecheckReport.Report
) – The report generated by running the precheck.csv_report (
str
orNone
) – The identifier of CSV formatted precheck report. com.vmware.vcenter.lcm.report#get provides location where the CSV report can be downloaded from based on thecsvReport
. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type:com.vmware.vcenter.lcm.report
. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type:com.vmware.vcenter.lcm.report
. None in case oferrors
reported inPrecheckReport.Report.issues
.
-
create_task
(version)¶ Creates a vCenter Server pre-update compatibility check report for the pending update version. The report can be exported and downloaded in CSV format.
The result of this operation can be queried by calling the com.vmware.cis.Tasks#get method where
task
is the response of this operation.- Parameters
version (
str
) – Pending update version for which pre-update compatibility check will be executed. The parameter must be an identifier for the resource type:com.vmware.vcenter.lcm.update.pending
.- Return type
- class
vmware.vapi.stdlib.client.task.Task
- Returns
Task instance
- Raise
com.vmware.vapi.std.errors_client.Unauthenticated
if the user can not be authenticated.- Raise
com.vmware.vapi.std.errors_client.NotFound
if there is no pending update assosiated with theversion
in the system.- Raise
com.vmware.vapi.std.errors_client.NotAllowedInCurrentState
if a precheck is already in progress.- 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 error.
-
class
com.vmware.vcenter.lcm.update_client.
StubFactory
(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
- Parameters
stub_config (
vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance