com.vmware.vcenter.lcm.deployment package

Submodules

com.vmware.vcenter.lcm.deployment.common_client module

The com.vmware.vcenter.lcm.deployment.common_client module provides common classes for install/upgrade of a vCenter Server.

class com.vmware.vcenter.lcm.deployment.common_client.AllocateResource(string)

Bases: Enum

The AllocateResource class defines when to allocate resource to the target VM. See ResourceAllocationInfo. This enumeration was added in vSphere API 8.0.3.0.

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

ON_DEPLOYMENT = AllocateResource(string='ON_DEPLOYMENT'): On deployment of a new VM allocate the resource. This class attribute was added in vSphere API 8.0.3.0.

ON_SUCCESSFUL_UPGRADE = AllocateResource(string='ON_SUCCESSFUL_UPGRADE'): On successful upgrade of the VC allocate the resource to the VM deployed as part of the upgrade. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.common_client.ApplianceDeployment(name=None, size=None, thin_disk_mode=None, disk_size=None, root_password=None, network_settings=None, ova_info=None, ceip_enabled=None, cpu_allocation=None, memory_allocation=None)

Bases: VapiStruct

The ApplianceDeployment class describes the new appliance deployment configuration. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

name (str) – The VM name of the appliance to deploy. This attribute was added in vSphere API 8.0.3.0.
size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. This attribute was added in vSphere API 8.0.3.0. If size 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. This attribute was added in vSphere API 8.0.3.0.
disk_size (StorageSize or None) – The disk size of the new vCenter appliance. This attribute was added in vSphere API 8.0.3.0. If diskSize is not provided, will use the diskSize of the source VCSA.
root_password (str) –
A root password to be used for that appliance. During migration upgrade it is only temporary passwords. It must conform to the following requirements:
- At least 8 characters.
- No more than 20 characters.
- At least 1 uppercase character.
- At least 1 lowercase character.
- At least 1 number.
- At least 1 special character (e.g., ‘!’, ‘(’, ‘\@’, etc.).
- Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed)
. This attribute was added in vSphere API 8.0.3.0.
network_settings (Network or None) – The network settings of the appliance to be deployed. This attribute was added in vSphere API 8.0.3.0. If None the appliance will be deployed with an automatically selected link-local address.
ova_info (OvaInfo or None) – Custom location of the OVA for deployment. This attribute was added in vSphere API 8.0.3.0. 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). This attribute was added in vSphere API 8.0.3.0. If None, defaults to True
cpu_allocation (ResourceAllocationInfo or None) – Resource allocation information of CPU. This attribute was added in vSphere API 8.0.3.0. If None will deploy the appliance with no cpu reservation.
memory_allocation (ResourceAllocationInfo or None) – Resource allocation information of Memory. This attribute was added in vSphere API 8.0.3.0. If None will deploy the appliance with no memory reservation.

class com.vmware.vcenter.lcm.deployment.common_client.ApplianceDeploymentConfig(source_container=None, appliance=None, location=None)

Bases: VapiStruct

The ApplianceDeploymentConfig class contains the new appliance deployment configuration. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

source_container (Connection or None) – A connection to container, which hosts the source appliance. This connection information is required for automatically extracting and preserving VM configuration during deployment, e.g. Virtual Ethernet Cards. If either the current vCenter is self managed or the VM configuration is not necessary to be preserved during deployment this field might be omitted. This attribute was added in vSphere API 8.0.3.0. Not required if the current VCenter is self managed. Otherwise if not set VM configuration won’t be preserved.
appliance (ApplianceDeployment) – Description of the new appliance configuration. This attribute was added in vSphere API 8.0.3.0.
location (Location or None) – ESX or VC on which to deploy the appliance. This attribute was added in vSphere API 8.0.3.0. If None the target appliance will be deployed on the same location as current vCenter. If current vCenter is not self managed and source container is not specified, upgrade initialization will fail.

class com.vmware.vcenter.lcm.deployment.common_client.ApplianceSize(string)

Bases: Enum

The ApplianceSize class defines the size of the appliance (CPU and memory) to be deployed. This enumeration was added in vSphere API 8.0.3.0.

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’,. This class attribute was added in vSphere API 8.0.3.0.

MEDIUM = ApplianceSize(string='MEDIUM'): Appliance size of ‘medium’. This class attribute was added in vSphere API 8.0.3.0.

SMALL = ApplianceSize(string='SMALL'): Appliance size of ‘small’. This class attribute was added in vSphere API 8.0.3.0.

TINY = ApplianceSize(string='TINY'): Appliance size of ‘tiny’. This class attribute was added in vSphere API 8.0.3.0.

XLARGE = ApplianceSize(string='XLARGE'): Appliance size of ‘extra large’. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.common_client.Connection(hostname=None, username=None, password=None, https_port=None, ssl_verify=None, certificate=None)

Bases: VapiStruct

The Connection class contains information used to connect to a vCenter or ESXi. This class was added in vSphere API 8.0.3.0.

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. This attribute was added in vSphere API 8.0.3.0.
username (str) – A username with administrative privileges on the ESX/VC host. This attribute was added in vSphere API 8.0.3.0.
password (str) – The password of the Connection.username on the ESX/VC host. This attribute was added in vSphere API 8.0.3.0.
https_port (long or None) – The port number for the ESX/VC. This attribute was added in vSphere API 8.0.3.0. If None, defaults to 443
ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. This attribute was added in vSphere API 8.0.3.0. If None, defaults to True
certificate (str or None) – Certificate to verify the target host location. The value should be a single x509 certificate encoded in PEM format. Only if sslVerify is true and this field is provided will be used for SSL validation. This attribute was added in vSphere API 8.0.3.0. If set will be used for SSL validation.

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

Bases: VapiStruct

The Esx class contains ESX configuration that should be used for deployment. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

connection (Connection) – The configuration to connect to an ESX/VC. This attribute was added in vSphere API 8.0.3.0.
placement_config (EsxPlacementConfig) – The location of the new version of the vCSA on the desired ESX. This attribute was added in vSphere API 8.0.3.0.

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

Bases: VapiStruct

The EsxPlacementConfig class contains configuration of ESX placement of the target appliance. This class was added in vSphere API 8.0.3.0.

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. This attribute was added in vSphere API 8.0.3.0.
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. This attribute was added in vSphere API 8.0.3.0. 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. This attribute was added in vSphere API 8.0.3.0. Not applicable when not in resource pool

class com.vmware.vcenter.lcm.deployment.common_client.HashAlgorithm(string)

Bases: Enum

The HashAlgorithm class defines the valid hash algorithms. This enumeration was added in vSphere API 8.0.3.0.

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. This class attribute was added in vSphere API 8.0.3.0.

SHA512 = HashAlgorithm(string='SHA512'): Hash algorithm: SHA-512. This class attribute was added in vSphere API 8.0.3.0.

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

Bases: VapiStruct

The Location class contains configuration of appliance location. This class was added in vSphere API 8.0.3.0.

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. This attribute was added in vSphere API 8.0.3.0. Mutual exclusive between esx and vcenter
vcenter (VCenter or None) – This subsection describes the vCenter on which to deploy the appliance. This attribute was added in vSphere API 8.0.3.0. Mutual exclusive between esx and vcenter

class com.vmware.vcenter.lcm.deployment.common_client.Network(ip_family=None, mode=None, ip=None, dns_servers=None, prefix=None, gateway=None, hostname=None)

Bases: VapiStruct

The Network class defines the network configuration. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

ip_family (Network.IpType or None) – Network IP address family. This attribute was added in vSphere API 8.0.3.0. If None defaults to IPv4
mode (Network.NetworkMode) – Network mode. This attribute was added in vSphere API 8.0.3.0.
ip (str) – Network IP address. Required for static mode only. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of mode is Network.NetworkMode.STATIC.
dns_servers (list of str) – A comma-separated list of IP addresses of DNS servers.Required for static mode only. A JSON array such as [“1.2.3.4”, “127.0.0.1”]. The DNS servers must be reachable from the source appliance and only the first two will be used. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of mode is Network.NetworkMode.STATIC.
prefix (long) – Network prefix length. Required for static mode only. This is the number of bits set in the subnet mask; for instance, if the subnet mask is 255.255.255.0, there are 24 bits in the binary version of the subnet mask, so the prefix length is 24. If used, the values must be in the inclusive range of 0 to 32 for IPv4 and 0 to 128 for IPv6. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of mode is Network.NetworkMode.STATIC.
gateway (str) – Gateway of the network. Required for static mode only. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of mode is Network.NetworkMode.STATIC.
hostname (str or None) – Primary network identity. Can be either an IP address or a fully qualified domain name(FQDN). This attribute was added in vSphere API 8.0.3.0. hostname may not be applicable

class IpType(string)

Bases: Enum

Network IP address family. This enumeration was added in vSphere API 8.0.3.0.

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

IPV4 = IpType(string='IPV4'): IPv4 Type of IP address. This class attribute was added in vSphere API 8.0.3.0.

IPV6 = IpType(string='IPV6'): IPv6 Type of IP address. This class attribute was added in vSphere API 8.0.3.0.

class NetworkMode(string)

Bases: Enum

Network mode. This enumeration was added in vSphere API 8.0.3.0.

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

DHCP = NetworkMode(string='DHCP'): DHCP mode. This class attribute was added in vSphere API 8.0.3.0.

STATIC = NetworkMode(string='STATIC'): Static IP mode. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.common_client.OvaInfo(location=None, ssl_verify=None, ova_checksum=None, ova_checksum_algorithm=None, certificate=None)

Bases: VapiStruct

The OvaInfo class defines the OVA file location info to be used by the lifecycle service. This class was added in vSphere API 8.0.3.0.

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. This attribute was added in vSphere API 8.0.3.0.
ssl_verify (bool or None) – A flag to indicate whether SSL verification is required for the ova location. This attribute was added in vSphere API 8.0.3.0. If None defaults to True
ova_checksum (str or None) – Checksum to validate the OVA file. This attribute was added in vSphere API 8.0.3.0. If set will be used for checksum validation of the ova file on the vCenter.
ova_checksum_algorithm (HashAlgorithm or None) – The hash algorithm (SHA256, SHA512) used to calculate the checksum. This attribute was added in vSphere API 8.0.3.0. If not specified the default checksum algorithm is HashAlgorithm.SHA256.
certificate (str or None) –
Certificate to verify the SSL OVA location. The value should be a single x509 certificate encoded in PEM format.
- If sslVerify is true and this field is omitted. a CA based validation will be used.
- If sslVerify is true and this field is provided will be used for SSL validation.
. This attribute was added in vSphere API 8.0.3.0. If set will be used for SSL validation.

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

Bases: VapiStruct

The Question class describes a item of additional information that must be provided in order to perform the upgrade. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

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

class InputType(string)

Bases: Enum

The Question.InputType class defines the supported field types for questions. This enumeration was added in vSphere API 8.0.3.0.

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. This class attribute was added in vSphere API 8.0.3.0.

PASSWORD = InputType(string='PASSWORD'): Password (masked) answer. This class attribute was added in vSphere API 8.0.3.0.

PLAIN_TEXT = InputType(string='PLAIN_TEXT'): Plain text answer. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.common_client.ResourceAllocationInfo(reservation=None, allocate=None)

Bases: VapiStruct

The ResourceAllocationInfo class contains resource allocation information for a VM. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

reservation (long) – Amount of resource that is guaranteed available to the virtual machine. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, and MHz for CPU. This attribute was added in vSphere API 8.0.3.0.
allocate (AllocateResource or None) – This attribute was added in vSphere API 8.0.3.0. If None will allocate resource at VM deployment.

class com.vmware.vcenter.lcm.deployment.common_client.StoragePolicySpec(policy=None)

Bases: VapiStruct

The StoragePolicySpec class contains information about the storage policy to be associated with a virtual machine object. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:: policy (str) – Identifier of the storage policy which should be associated with the virtual machine. This attribute was added in vSphere API 8.0.3.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. 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.StoragePolicy.

class com.vmware.vcenter.lcm.deployment.common_client.StorageSize(string)

Bases: Enum

The StorageSize class defines the storage size of the appliance to be deployed. This enumeration was added in vSphere API 8.0.3.0.

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. This class attribute was added in vSphere API 8.0.3.0.

REGULAR = StorageSize(string='REGULAR'): Regular storage. This class attribute was added in vSphere API 8.0.3.0.

XLARGE = StorageSize(string='XLARGE'): Extra large storage. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.common_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

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

class com.vmware.vcenter.lcm.deployment.common_client.VCenter(connection=None, placement_config=None)

Bases: VapiStruct

The VCenter class contains VC configuration that should be used for deployment. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

connection (Connection or None) – The configuration to connect to a VCenter. This attribute was added in vSphere API 8.0.3.0. If None the target appliance will be deployed on the location specified in VCenter.placement_config on the current vCenter.
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’.. This attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.lcm.deployment.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: VapiStruct

The VcPlacementConfig class contains configuration of VC placement of the target appliance. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

vm_folder_path (str or None) – Absolute 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’. This attribute was added in vSphere API 8.0.3.0. If None the default VM folder of the Datacenter will be used.
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. This attribute was added in vSphere API 8.0.3.0. Mutually exclusive between resourcePoolPath, clusterPath, and hostPath
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. This attribute was added in vSphere API 8.0.3.0. Mutually exclusive between resourcePoolPath, clusterPath, and hostPath
host_path (str or None) – Absolute path of the ESX host (FQDN/IP) in the vCenter inventory tree. This attribute was added in vSphere API 8.0.3.0. Mutually exclusive between resourcePoolPath, clusterPath, and hostPath
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. This attribute was added in vSphere API 8.0.3.0. Mutually exclusive between datastoreName and datastoreClusterName
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. This attribute was added in vSphere API 8.0.3.0. Mutually exclusive between datastoreName and datastoreClusterName
network_name (str or None) – Name of the network. e.g. VM Network. This attribute was added in vSphere API 8.0.3.0. If None the target appliance will be deployed on the same network as current vCenter. If current vCenter is not self managed and source container is not specified, upgrade initialization will fail.

com.vmware.vcenter.lcm.deployment.migration_upgrade_client module

The com.vmware.vcenter.lcm.deployment.migration_upgrade_client module provides classes for executing migration-based operations.

class com.vmware.vcenter.lcm.deployment.migration_upgrade_client.Status(config)

Bases: VapiInterface

The Status class provides methods to retrieve the status information about the vCenter Appliance upgrade. This class was added in vSphere API 8.0.3.0.

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

class Info(subtasks=None, subtask_order=None, progress=None, notifications=None, upgrade_info=None, last_update_time=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)

Bases: VapiStruct

The Status.Info class contains attributes to describe the state of the appliance. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

subtasks (dict of str and Status.Task) – The map of the deployment subtasks and their status information. This attribute was added in vSphere API 8.0.3.0.
subtask_order (list of str) – The ordered list of subtasks for this deployment operation. This attribute was added in vSphere API 8.0.3.0.
progress (com.vmware.cis.task_client.Progress) – The progress info of the current appliance status. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
notifications (com.vmware.vcenter.lcm_client.Notifications or None) – Notifications containing upgrade info, errors and warnings. This attribute was added in vSphere API 8.0.3.0. Only set if an infos, errors or warnings have been reported by the upgrade process.
upgrade_info (Status.UpgradeInfo) – The metadata of the upgrade process. This attribute was added in vSphere API 8.0.3.0.
last_update_time (datetime.datetime) – The time when the status has been updated. This attribute was added in vSphere API 8.0.3.0.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.
service (str) – Identifier of the service containing the operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.service.
operation (str) – Identifier of the operation associated with the task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.operation.
parent (str or None) – Parent of the current task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task. This attribute will be None if the task has no parent.
target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing one the operation performed on. This attribute will be None if the operation has no target or multiple targets.
status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.
cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
error (Exception or None) – Description of the error if the operation status is “FAILED”. If None the description of why the operation failed will be included in the result of the operation (see com.vmware.cis.task_client.Info.result).
start_time (datetime.datetime) – Time when the operation is started. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
end_time (datetime.datetime) – Time when the operation is completed. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.SUCCEEDED or com.vmware.cis.task_client.Status.FAILED.
user (str or None) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.

class State(string)

Bases: Enum

The Status.State class defines the various states of the migration upgrade process. This enumeration was added in vSphere API 8.0.3.0.

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

CANCELED = State(string='CANCELED'): The upgrade has been canceled. This class attribute was added in vSphere API 8.0.3.0.

CANCELING = State(string='CANCELING'): The upgrade process is canceling. In this state the source appliance will reverted to the state as it was before the start of the upgrade process. This class attribute was added in vSphere API 8.0.3.0.

INITIALIZED = State(string='INITIALIZED'): The upgrade process is successfully initialized with the defined migration configuration. This class attribute was added in vSphere API 8.0.3.0.

INITIALIZING = State(string='INITIALIZING'): The upgrade process is initializing with the defined migration configuration. This class attribute was added in vSphere API 8.0.3.0.

PREPARED = State(string='PREPARED'): The upgrade process have prepared the source in ready state for switchover i.e it has replicated most of the data and there will be only some small delta of the data for replication during switchover. This class attribute was added in vSphere API 8.0.3.0.

PREPARING = State(string='PREPARING'): The upgrade process is replicating the source data to the newly deployed target appliance. This class attribute was added in vSphere API 8.0.3.0.

STAGED = State(string='STAGED'): The upgrade process deployed the new version and is ready for the next step of the process. This class attribute was added in vSphere API 8.0.3.0.

STAGING = State(string='STAGING'): The upgrade process is downloading or deploying the new target appliance version. This class attribute was added in vSphere API 8.0.3.0.

SWITCHOVER = State(string='SWITCHOVER'): The upgrade process is promoting the target appliance as an active one. This includes powering off the current active appliance, migrating the network identity, and activating the current standby appliance. This class attribute was added in vSphere API 8.0.3.0.

UPGRADED = State(string='UPGRADED'): The upgrade process promoted the target appliance successfully. This class attribute was added in vSphere API 8.0.3.0.

class Task(progress=None, notifications=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)

Bases: VapiStruct

The Status.Task class contains attributes to describe a particular deployment task. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

progress (com.vmware.cis.task_client.Progress) – The progress info of this deployment task. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
notifications (com.vmware.vcenter.lcm_client.Notifications or None) – Result of the task. This attribute was added in vSphere API 8.0.3.0. This attribute will be None if result is not available at the current step of the task.
description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.
service (str) – Identifier of the service containing the operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.service.
operation (str) – Identifier of the operation associated with the task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.operation.
parent (str or None) – Parent of the current task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task. This attribute will be None if the task has no parent.
target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing one the operation performed on. This attribute will be None if the operation has no target or multiple targets.
status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.
cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
error (Exception or None) – Description of the error if the operation status is “FAILED”. If None the description of why the operation failed will be included in the result of the operation (see com.vmware.cis.task_client.Info.result).
start_time (datetime.datetime) – Time when the operation is started. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.
end_time (datetime.datetime) – Time when the operation is completed. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.SUCCEEDED or com.vmware.cis.task_client.Status.FAILED.
user (str or None) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.

class UpgradeInfo(upgrade_state=None, desired_state=None, scheduled_downtime=None, remaining_replication_data=None)

Bases: VapiStruct

The Status.UpgradeInfo class contains attributes to describe important parameters and state of the upgrade process. This class was added in vSphere API 8.0.3.0.

Tip

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

Parameters:

upgrade_state (Status.State) – The current state of migration upgrade process. This attribute was added in vSphere API 8.0.3.0.
desired_state (Status.State or None) – Desired state of the migration upgrade process. This attribute was added in vSphere API 8.0.3.0. If None there is no upgrade in the environment.
scheduled_downtime (datetime.datetime or None) – The time when the switchover i.e the downtime will happen. This attribute was added in vSphere API 8.0.3.0. If None will mean that the upgrade action called will be executed right after the prepare step.
remaining_replication_data (long) – The size of the data (in MB) that is left to be replicated from the source machine to the target machine. This attribute was added in vSphere API 8.0.3.0.

get()

Returns the current status of the appliance migration upgrade. This method was added in vSphere API 8.0.3.0.

Return type:

Status.Info

Returns:

Info structure containing the status information about the appliance.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not 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.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

Method execution requires VcLifecycle.View.

class com.vmware.vcenter.lcm.deployment.migration_upgrade_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

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