com.vmware.vcenter.lcm package¶

Submodules¶

com.vmware.vcenter.lcm.common_client module¶

The com.vmware.vcenter.lcm.upgrade module provides classes for upgrading vCenter Server to a newer version.

class com.vmware.vcenter.lcm.common_client.ApplianceDeployment(name=None, size=None, thin_disk_mode=None, disk_size=None, root_password=None, ova_info=None, ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplianceDeployment class describes the new appliance deployment configuration.

Tip

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

Parameters

name (str) – The name of the appliance to deploy.
size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If #ApplianceSize is not provided, will use the size of the source VCSA
thin_disk_mode (bool) – Whether to deploy the appliance with thin mode virtual disks.
disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If #StorageSize is not provided, will use the diskSize of the source VCSA.
root_password (str) – Password must conform to the following requirements: 1. At least 8 characters. 2. No more than 20 characters. 3. At least 1 uppercase character. 4. At least 1 lowercase character. 5. At least 1 number. 6. At least 1 special character (e.g., ‘!’, ‘(‘, ‘\@’, etc.). 7. Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)
ova_info (OvaInfo or None) – Location of custom OVA for deployment. If None use the OVA file for the desired version in the configured repository.
ceip_enabled (bool or None) – This key describes the enabling option for the VMware’s Customer Experience Improvement Program (CEIP). If None, defaults to True

class com.vmware.vcenter.lcm.common_client.ApplianceDeploymentConfig(appliance=None, location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ApplianceDeploymentConfig class contains the new appliance deployment configuration.

Tip

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

Parameters

appliance (ApplianceDeployment) – Description of the new appliance configuration.
location (Location) – ESX or VC on which to deploy the appliance.

class com.vmware.vcenter.lcm.common_client.ApplianceSize(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ApplianceSize class defines the size of the appliance (CPU and memory) to be deployed.

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 ApplianceSize instance.

LARGE = ApplianceSize(string='LARGE')¶: Appliance size of ‘large’,

MEDIUM = ApplianceSize(string='MEDIUM')¶: Appliance size of ‘medium’.

SMALL = ApplianceSize(string='SMALL')¶: Appliance size of ‘small’.

TINY = ApplianceSize(string='TINY')¶: Appliance size of ‘tiny’.

XLARGE = ApplianceSize(string='XLARGE')¶: Appliance size of ‘extra large’.

class com.vmware.vcenter.lcm.common_client.Connection(hostname=None, username=None, password=None, https_port=None, ssl_verify=None, ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Connection class contains information for deployment location

Tip

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

Parameters

hostname (str) – The IP address or DNS resolvable name of the ESX/VC host. If a DNS resolvable name is provided, it must be resolvable from the source appliance.
username (str) – A username with administrative privileges on the ESX/VC host.
password (str) – The password of the Connection.username on the ESX/VC host.
https_port (long or None) – The port number for the ESX/VC. If None, defaults to 443
ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If sslThumbprint is provided, this field can be omitted If None, defaults to True
ssl_thumbprint (str or None) – Thumbprint for SSL verification. If sslVerify if false, this field is not required

class com.vmware.vcenter.lcm.common_client.Esx(connection=None, placement_config=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Esx class contains ESX configuration.

Tip

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

Parameters

connection (Connection) – The configuration to connect to an ESX/VC.
placement_config (EsxPlacementConfig) – The location of the new version of the vCSA on the desired ESX.

class com.vmware.vcenter.lcm.common_client.EsxPlacementConfig(datastore_name=None, network_name=None, resource_pool_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The EsxPlacementConfig class contains configuration of ESX placement of the target appliance.

Tip

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

Parameters

datastore_name (str) – The datastore on which to store the files of the appliance. This value has to be either a specific datastore name, or a specific datastore in a datastore cluster. The datastore must be accessible from the ESX host.
network_name (str or None) – The network of the ESX host to which the new appliance should connect. Omit this parameter if the ESX host has one network. If None and there is only one network configured, it will be used.
resource_pool_path (str or None) – The path to the resource pool on the ESX host in which the appliance will be deployed. Not applicable when not in resource pool

class com.vmware.vcenter.lcm.common_client.HashAlgorithm(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The HashAlgorithm class defines the valid hash algorithms.

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 HashAlgorithm instance.

SHA256 = HashAlgorithm(string='SHA256')¶: Hash algorithm: SHA-256

SHA512 = HashAlgorithm(string='SHA512')¶: Hash algorithm: SHA-512

class com.vmware.vcenter.lcm.common_client.Location(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Location class contains configuration of appliance location.

Tip

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

Parameters

esx (Esx or None) – This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host. Mutual exclusive between esx and vcenter
vcenter (VCenter or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class com.vmware.vcenter.lcm.common_client.OvaInfo(location=None, ssl_verify=None, ssl_hash=None, hash_algorithm=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvaInfo class defines the OVA file location info.

Tip

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

Parameters

location (str) – The location of the OVA file for installation. It can be web URL or absolute filepath i.e https://server.com/appliance.ova or file://storage/appliance.ova
ssl_verify (bool or None) – A flag to indicate whether SSL verification is required for the ova location. If None defaults to True
ssl_hash (str or None) – Hash to verify the SSL OVA location. If sslVerify is false this filed can be omitted. If sslVerify is true and this field is ommited a CA based validation will be used. If sslVerify is true and this field is provided will be used for SSL validation. If set will be used for SSL validation.
hash_algorithm (HashAlgorithm or None) – The hash algorithm (SHA256, SHA512) used to calculate the checksum. If not specified the default checksum algorithm is HashAlgorithm.SHA256.

class com.vmware.vcenter.lcm.common_client.Question(data_item=None, text=None, description=None, type=None, allowed_values=None, default_answer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Question class describes a item of information that must be provided by the user in order to perform the update.

Tip

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

Parameters

data_item (str) – ID of the data item 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.common.dataitem. 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.common.dataitem.
text (com.vmware.vapi.std_client.LocalizableMessage) – Label for the item
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the item
type (Question.InputType) – The type of the field.
allowed_values (list of str or None) – List of allowed values allowedValues If None any value is valid.
default_answer (str or None) – Default answer defaultAnswer If None then there is no default answer, so an explicit answer must be provided

class InputType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Question.InputType class defines the supported field types for questions.

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 InputType instance.

BOOLEAN = InputType(string='BOOLEAN')¶: Yes/No,On/Off,Checkbox answer.

PASSWORD = InputType(string='PASSWORD')¶: Password (masked) answer.

PLAIN_TEXT = InputType(string='PLAIN_TEXT')¶: Plain text answer.

class com.vmware.vcenter.lcm.common_client.StorageSize(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The StorageSize class defines the storage size of the appliance to be deployed.

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 StorageSize instance.

LARGE = StorageSize(string='LARGE')¶: Large storage

REGULAR = StorageSize(string='REGULAR')¶: Regular storage

XLARGE = StorageSize(string='XLARGE')¶: Extra large storage

class com.vmware.vcenter.lcm.common_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.vcenter.lcm.common_client.VCenter(connection=None, placement_config=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The VCenter class contains configuration of the VC that hosts/will host an appliance.

Tip

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

Parameters

connection (Connection) – The configuration to connect to an ESX/VC.
placement_config (VcPlacementConfig) –
The location of the new version of the vCSA on the desired vCenter.

All names are case-sensitive. you can install the appliance to one of the following destinations: 1. A resource pool in a cluster, use ‘cluster_path’. 2. A specific ESX host in a cluster, use ‘host_path’. 3. A resource pool in a specific ESX host being managed by the current vCenter, use ‘resource_pool_path’. 4. To install a new appliance to a specific ESX host in a cluster, provide the ‘host_path’ key, and the ‘datastore_name’, e.g. ‘host_path’: ‘/MyDataCenter/host/MyCluster/10.20.30.40’, ‘datastore_name’: ‘Your Datastore’. 5. To install a new appliance to a specific resource pool, provide the ‘resource_pool_path’, and the ‘datastore_name’, e.g. ‘resource_pool_path’: ‘/Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool’, ‘datastore_name’: ‘Your Datastore’. 6. To place a new appliance to a virtual machine Folder, provide the ‘vm_folder_path’, e.g. vm_folder_path’: ‘VM Folder 0/VM Folder1’.

class com.vmware.vcenter.lcm.common_client.VcPlacementConfig(vm_folder_path=None, resource_pool_path=None, cluster_path=None, host_path=None, datastore_name=None, datastore_cluster_name=None, network_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The VcPlacementConfig class contains configuration of VC placement of the target appliance.

Tip

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

Parameters

vm_folder_path (str or None) – Aboslute path of the VM folder. VM folder must be visible by the Data Center of the compute resourceFormat:/{dc}/{vm_folder1}/{vm_folder2}e.g.:’/DCenter/VM Folder 0/VM Folder1’. Mutually exclusive between {\@vm_folder_path}, #resource_pool_path, #cluster_path, and #host_path
resource_pool_path (str or None) – Absolute path to resource pool. Format: /{datacenter folder}/{datacenter name}/host/{host name}/{cluster_name}/Resources/{resource pool}. e.g: Your Datacenter Folder/Your Datacenter/host/Your Cluster/Resources/Your Resource Pool Mutually exclusive between {\@vm_folder_path}, #resource_pool_path, #cluster_path, and #host_path
cluster_path (str or None) – Absolute path to the cluster. Format: /{datacenter folder}/{datacenter name}/host/{cluster_name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Cluster Mutually exclusive between {\@vm_folder_path}, #resource_pool_path, #cluster_path, and #host_path
host_path (str or None) – Absolute path of the ESX host (FQDN/IP) in the vCenter inventory tree. Mutually exclusive between {\@vm_folder_path}, #resource_pool_path, #cluster_path, and #host_path
datastore_name (str or None) – The datastore on which to store the files of the appliance. This value has to be either a specific datastore name, or a specific datastore in a datastore cluster. The datastore must have the space defined as appliance storage size. Mutually exclusive between #datastore_name and #datastore_cluster_name
datastore_cluster_name (str or None) – The datastore cluster on which to store the files of the appliance. The datastore cluster must have the space defined as appliance storage size. Mutually exclusive between #datastore_name and #datastore_cluster_name
network_name (str) – Name of the network. e.g. VM Network

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 of str or None) – 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 of str or None) – 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 with product 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: Product
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 with product 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: list of Product
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 with product 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 or None) – 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 of InteropReport.ReportRow) – Interoperability matrix for the supplied target product and the other registered products.
issues (com.vmware.vcenter.lcm_client.Notifications or None) – 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 of InteropReport.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 the InteropReport.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 or None) –
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 of errors reported in InteropReport.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 or None) – 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 or None) – Future version of the product after upgrade. targetVersion may not be applicable.
deployments (list of str or None) – 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 of str) – 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: list of ProductCatalog.Summary
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 release

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 Category 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 update
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 patch
release_date (datetime.datetime) – Release date of the vSphere update or patch
severity (Pending.SeverityType) – Severity of the issues fixed in the vSphere update or patch
build (str) – Build number of the vCenter Release
update_type (Pending.UpdateType) – Type of the Release based on the current vCenter version
category (Pending.Category) – Category of the release based on features bundled on top of previous release
reboot_required (bool) – Flag to suggest a reboot after the release is applied
execute_url (str) – VAMI or ISO URL for update or upgrade execute phase redirection
release_notes (list of str) – 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 or None) – Number of pending updates Only set if there are available updates
upgrade_count (long or None) – Number of pending upgrades Only set if there are available upgrades
updates (list of Pending.Summary) – List of pending update details
issues (com.vmware.vcenter.lcm_client.Notifications or None) – 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 the SeverityType 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/upgrade

Tip

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 patch
release_date (datetime.datetime) – Release date of the vSphere update or patch
severity (Pending.SeverityType) – Severity of the issues fixed in the vSphere update or patch
build (str) – Build number of the vCenter Release
update_type (Pending.UpdateType) – Type of the Release based on the current vCenter version
category (Pending.Category) – Category of the release based on features bundled on top of previous release
reboot_required (bool) – Flag to suggest a reboot after the release is applied
execute_url (str) – VAMI or ISO URL for update or upgrade execute phase redirection
release_notes (list of str) – 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 type

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 UpdateType 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: Pending.Info
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 the version 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: Pending.ListResult
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 generated
estimated_time_to_update (long or None) – 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 or None) – 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 process
warning_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 or None) – 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 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 of errors reported in PrecheckReport.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 the version 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