com.vmware.vcenter package¶

Subpackages¶

Submodules¶

com.vmware.vcenter.certificate_management_client module¶

The com.vmware.vcenter.certificate_management_client module provides classes to manage certificates.

class com.vmware.vcenter.certificate_management_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.certificate_management_client.X509CertChain(cert_chain=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The X509CertChain class contains x509 certificate chain. This class was added in vSphere API 6.7.2.

Tip

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

Parameters: cert_chain (list of str) – Certificate chain in base64 format. This attribute was added in vSphere API 6.7.2.

com.vmware.vcenter.compute_client module¶

The com.vmware.vcenter.compute_client module provides classes for managing compute policies.

class com.vmware.vcenter.compute_client.Policies(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Policies class provides methods to manage compute policies. A compute policy defines the intended behavior for a collection of vSphere objects identified by a tag. A compute policy is an instance of a capability. It is created by providing a value for the creation type specified by the capability. See com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type. Warning: This class is available as technical preview. It may be changed in a future release.

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

RESOURCE_TYPE = 'com.vmware.vcenter.compute.Policy'¶: The resource type for the compute policy. Warning: This class attribute is available as technical preview. It may be changed in a future release.

class Summary(policy=None, name=None, description=None, capability=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policies.Summary class contains commonly used information about a compute policy. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

policy (str) – Identifier of the policy. Warning: This attribute is available as technical preview. It may be changed in a future release. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.Policy. 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.compute.Policy.
name (str) – Name of the policy. Warning: This attribute is available as technical preview. It may be changed in a future release.
description (str) – Description of the policy. Warning: This attribute is available as technical preview. It may be changed in a future release.
capability (str) – Identifier of the capability this policy is based on. Warning: This attribute is available as technical preview. It may be changed in a future release. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. 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.compute.policies.Capability.

create(spec)¶

Creates a new compute policy. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters

spec (vmware.vapi.struct.VapiStruct) – Specification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see com.vmware.vcenter.compute.policies_client.Capabilities.Info.create_spec_type) equal to the type of the specified value (see spec). The parameter must contain all the attributes defined in com.vmware.vcenter.compute.policies_client.CreateSpec.

Return type

str

Returns

The identifier of the newly created policy. Use this identifier to get or destroy the policy. The return value will be an identifier for the resource type: com.vmware.vcenter.compute.Policy.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists if a policy with the same name is already present on this vCenter server.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if a parameter passed in the spec is invalid.

Raise

com.vmware.vapi.std.errors_client.UnableToAllocateResource if more than 100 policies are created.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise

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

Method execution requires ComputePolicy.Manage.

delete(policy)¶

Deletes a specific compute policy. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters

policy (str) – Identifier of the policy to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy.

Raise

com.vmware.vapi.std.errors_client.NotFound if a policy with this identifier does not exist.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise

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

Method execution requires ComputePolicy.Manage.

get(policy)¶

Returns information about a specific compute policy. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters

policy (str) – Identifier of the policy for which information should be retrieved. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Policy.

Return type

vmware.vapi.struct.VapiStruct

Returns

Detailed information about the specified compute policy. The returned value can be converted to the information type of the capability that this policy is based on. See com.vmware.vcenter.compute.policies_client.Capabilities.Info.info_type. The return value will contain all the attributes defined in com.vmware.vcenter.compute.policies_client.Info.

Raise

com.vmware.vapi.std.errors_client.NotFound if a policy with this identifier does not exist.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise

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

Method execution requires System.Read.

list()¶

Returns information about the compute policies available in this vCenter server. Warning: This method is available as technical preview. It may be changed in a future release.

Return type

list of Policies.Summary

Returns

The list of compute policies available on this vCenter server.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise

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

Method execution requires System.Read.

class com.vmware.vcenter.compute_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.datastore_client module¶

class com.vmware.vcenter.datastore_client.DefaultPolicy(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The DefaultPolicy class provides methods related to storage policies associated with datastore object. The DefaultPolicy.get() method provides information about the default storage policy associated with the specific datastore. This class was added in vSphere API 6.7.

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

get(datastore)¶

Returns the identifier of the current default storage policy associated with the specified datastore. This method was added in vSphere API 6.7.

Parameters: datastore (str) – Identifier of the datastore for which the default policy is requested. The parameter must be an identifier for the resource type: Datastore.
Return type: str or None
Returns: Identifier of the default storage policy associated with the specified datastore. The return value will be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. this field is None if there is no default storage policy associated with the datastore.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the specified datastore does not exist.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user does not have the required priveleges.

class com.vmware.vcenter.datastore_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.deployment_client module¶

class com.vmware.vcenter.deployment_client.ApplianceState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ApplianceState class defines the various states the vCenter Appliance can be in. This enumeration was added in vSphere API 6.7.

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

CONFIGURED = ApplianceState(string='CONFIGURED')¶: The appliance has been configured. This class attribute was added in vSphere API 6.7.

CONFIG_IN_PROGRESS = ApplianceState(string='CONFIG_IN_PROGRESS')¶: The appliance is in the process of being configured. This class attribute was added in vSphere API 6.7.

FAILED = ApplianceState(string='FAILED')¶: The appliance configuration has failed. This class attribute was added in vSphere API 6.7.

INITIALIZED = ApplianceState(string='INITIALIZED')¶: The appliance is initialized and ready to be configured. This class attribute was added in vSphere API 6.7.

NOT_INITIALIZED = ApplianceState(string='NOT_INITIALIZED')¶: The appliance is in the process of being initialized and not ready for configuration. This class attribute was added in vSphere API 6.7.

QUESTION_RAISED = ApplianceState(string='QUESTION_RAISED')¶: The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.ApplianceType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ApplianceType class defines the vCenter appliance types. This enumeration was added in vSphere API 6.7.

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

PSC_EXTERNAL = ApplianceType(string='PSC_EXTERNAL')¶: An external Platform Services Controller. This class attribute was added in vSphere API 6.7.

VCSA_EMBEDDED = ApplianceType(string='VCSA_EMBEDDED')¶: vCenter Server Appliance with an embedded Platform Services Controller. This class attribute was added in vSphere API 6.7.

VCSA_EXTERNAL = ApplianceType(string='VCSA_EXTERNAL')¶: vCenter Server Appliance with an external Platform Services Controller. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.CheckInfo(status=None, result=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CheckInfo class describes the result of the appliance deployment check. This class was added in vSphere API 6.7.

Tip

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

Parameters

status (CheckStatus) – Status of the check. This attribute was added in vSphere API 6.7.
result (Notifications or None) – Result of the check. This attribute was added in vSphere API 6.7. This attribute will be None if result is not available at the current step of the task.

class com.vmware.vcenter.deployment_client.CheckStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The CheckStatus class defines the status of the checks. This enumeration was added in vSphere API 6.7.

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

FAILED = CheckStatus(string='FAILED')¶: A fatal error was encountered when running the sanity checks. This class attribute was added in vSphere API 6.7.

SUCCESS = CheckStatus(string='SUCCESS')¶: All checks have completed successfully. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.HistoryMigrationOption(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The HistoryMigrationOption class defines the vCenter history migration option choices. This enumeration was added in vSphere API 6.7.

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

ALL = HistoryMigrationOption(string='ALL')¶: All history data will be migrated along with the core data. This class attribute was added in vSphere API 6.7.

EVENTS_TASKS = HistoryMigrationOption(string='EVENTS_TASKS')¶: Only event data and task data will be migrated along with the core data. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.HistoryMigrationSpec(data_set=None, defer_import=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The HistoryMigrationSpec class defines how vCenter history data will be migrated. vCenter History data includes

Statistics
Events
Tasks

. This class was added in vSphere API 6.7.

Tip

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

Parameters

data_set (HistoryMigrationOption) – Defines what part of vCenter historical data will be migrated along with core data. This attribute was added in vSphere API 6.7.
defer_import (bool or None) – Defines how vCenter history will be migrated. If set to true, vCenter history will be migrated separately after successful upgrade or migration, otherwise it will be migrated along with core data during the upgrade or migration process. This attribute was added in vSphere API 6.7. If None, vCenter historical data won’t be deferred and will be migrated along with core data.

class com.vmware.vcenter.deployment_client.ImportHistory(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ImportHistory class provides methods for managing the import of vCenter historical data, e.g. Tasks, Events and Statistics, when is is imported separately from the upgrade or migration process. This class was added in vSphere API 6.7.

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

class CreateSpec(name=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ImportHistory.CreateSpec class contains information to create and start vCenter historical data lazy-import. This class was added in vSphere API 6.7.

Tip

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

Parameters

name (str) – Name of the vCenter history import task. This attribute was added in vSphere API 6.7.
description (str) – Description of the vCenter history import task. This attribute was added in vSphere API 6.7.

class Info(progress=None, result=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: vmware.vapi.bindings.struct.VapiStruct

The ImportHistory.Info class contains attributes to describe the state of vCenter history import task. This class was added in vSphere API 6.7.

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 task. This attribute was added in vSphere API 6.7. 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.FAILED, com.vmware.cis.task_client.Status.BLOCKED, or com.vmware.cis.task_client.Status.SUCCEEDED.
result (Notifications or None) – Result of the operation. If an operation reports partial results before it completes, this attribute could be set before the null has the value com.vmware.cis.task_client.Status.SUCCEEDED. The value could change as the operation progresses. This attribute was added in vSphere API 6.7. This attribute will be None if result is not available at the current step of the operation.
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.

cancel()¶

Cancels the task for importing vCenter historical data. This method was added in vSphere API 6.7.

Raise

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

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if vCenter historical data import task cannot be canceled at this state. This can happen in the following cases:

If historical data import has not been started yet because a not running task cannot be canceled
If historical data import has already been completed because a completed task cannot be canceled

Raise

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if vCenter historical data import task is already canceled.

Raise

com.vmware.vapi.std.errors_client.Error Generic error.

get()¶

Get the current status of the vCenter historical data import. This method was added in vSphere API 6.7.

Return type: ImportHistory.Info
Returns: Info structure containing the status information about the historical data import status.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized to perform the method.
Raise: com.vmware.vapi.std.errors_client.Error Generic error

pause()¶

Pauses the task for importing vCenter historical data. This method was added in vSphere API 6.7.

Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized to perform the method.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if vCenter historical data import task cannot be paused at this time. Pause can be accepted only in com.vmware.cis.task_client.Status.RUNNING state.
Raise: com.vmware.vapi.std.errors_client.AlreadyInDesiredState if vCenter historical data import task is already paused
Raise: com.vmware.vapi.std.errors_client.Error Generic error

resume()¶

Resumes the task for importing vCenter historical data. This method was added in vSphere API 6.7.

Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized to perform the method.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if vCenter historical data import task cannot be resumed at this state. Resume can be accepted only in com.vmware.cis.task_client.Status.BLOCKED state
Raise: com.vmware.vapi.std.errors_client.AlreadyInDesiredState if vCenter historical data import task is already resumed.
Raise: com.vmware.vapi.std.errors_client.Error Generic error.

start(spec=None)¶

Creates and starts task for importing vCenter historical data. This method was added in vSphere API 6.7.

Parameters

spec (ImportHistory.CreateSpec or None) –

An optional ImportHistory.CreateSpec info that can be passed for creating a new historical data import task and starts it. If None, default value will be:

name : vcenter.deployment.history.import
description : vCenter Server history import

Raise

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

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if vCenter historical data import task cannot be started at this time. This can happen in the following cases:

If historical data import has already been canceled because a canceled task cannot be re-started
If historical data import has already been completed because a completed task cannot be re-started
If historical data import has already been paused because a paused task can only be resumed or canceled

Raise

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if vCenter historical data import task has already being started.

Raise

com.vmware.vapi.std.errors_client.Error Generic error

class com.vmware.vcenter.deployment_client.Install(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Install class provides methods to configure the installation of the appliance. This class was added in vSphere API 6.7.

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

class InstallSpec(vcsa_embedded=None, auto_answer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Install.InstallSpec class contains information used to configure the appliance installation. This class was added in vSphere API 6.7.

Tip

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

Parameters

vcsa_embedded (Install.VcsaEmbeddedSpec) – Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7.
auto_answer (bool or None) – Use the default option for any questions that may come up during appliance configuration. This attribute was added in vSphere API 6.7. If None, will default to false.

class VcsaEmbeddedSpec(standalone=None, replicated=None, ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Install.VcsaEmbeddedSpec class contains information used to configure an embedded standalone or replicated vCenter Server. This class was added in vSphere API 6.7.

Tip

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

Parameters

standalone (StandaloneSpec or None) – Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7. If None, will default to None.
replicated (ReplicatedSpec or None) – Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7. If None, will default to None.
ceip_enabled (bool) – Whether CEIP should be enabled or disabled. This attribute was added in vSphere API 6.7.

cancel()¶

Cancel the appliance installation that is in progress. This method was added in vSphere API 6.7.

Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

check(spec)¶

Run sanity checks using the InstallSpec parameters passed. This method was added in vSphere API 6.7.

Parameters: spec (Install.InstallSpec) – InstallSpec parameters to run sanity check with.
Return type: CheckInfo
Returns: CheckInfo containing the check results.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in INITIALIZED state.

get()¶

Get the parameters used to configure the ongoing appliance installation. This method was added in vSphere API 6.7.

Return type: Install.InstallSpec
Returns: InstallSpec parameters being used to configure appliance install.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if appliance is not in INSTALL_PROGRESS state.

start(spec)¶

Start the appliance installation. This method was added in vSphere API 6.7.

Parameters: spec (Install.InstallSpec) – InstallSpec parameters to configure the appliance install.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in INITIALIZED state.

class com.vmware.vcenter.deployment_client.LocationSpec(hostname=None, https_port=None, ssl_thumbprint=None, ssl_verify=None, username=None, password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LocationSpec class is used to pass the container ESXi or vCenter server of the VM to patch the size of this appliance. This class was added in vSphere API 6.7.

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 container. This attribute was added in vSphere API 6.7.
https_port (long or None) – The HTTPS port of the container. This attribute was added in vSphere API 6.7. If None, port 443 will be used.
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. This attribute is only relevant if sslVerify is None or has the value true.
ssl_verify (bool or None) – SSL verification should be enabled or disabled. If sslVerify is true and and sslThumbprint is None, the CA certificate will be used for verification. If sslVerify is true and sslThumbprint is set then the thumbprint will be used for verification. No verification will be performed if sslVerify value is set to false. This attribute was added in vSphere API 6.7. If None, ssl_verify true will be used.
username (str) – The administrator account on the host. This attribute was added in vSphere API 6.7.
password (str) – The administrator account password. This attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.Notification(id=None, time=None, message=None, resolution=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notification class contains attributes to describe any info/warning/error messages that Tasks can raise. This class was added in vSphere API 6.7.

Tip

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

Parameters

id (str) – The notification id. This attribute was added in vSphere API 6.7.
time (datetime.datetime or None) – The time the notification was raised/found. This attribute was added in vSphere API 6.7. Only set if the time information is available.
message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. This attribute was added in vSphere API 6.7.
resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. This attribute was added in vSphere API 6.7. Only set for warnings and errors.

class com.vmware.vcenter.deployment_client.Notifications(info=None, warnings=None, errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notifications class contains info/warning/error messages that can be reported be the task. This class was added in vSphere API 6.7.

Tip

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

Parameters

info (list of Notification or None) – Info notification messages reported. This attribute was added in vSphere API 6.7. Only set if an info was reported by the task.
warnings (list of Notification or None) – Warning notification messages reported. This attribute was added in vSphere API 6.7. Only set if an warning was reported by the task.
errors (list of Notification or None) – Error notification messages reported. This attribute was added in vSphere API 6.7. Only set if an error was reported by the task.

class com.vmware.vcenter.deployment_client.Operation(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Operation class defines the supported vCenter appliance deployment operations. This enumeration was added in vSphere API 6.7.

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

INSTALL = Operation(string='INSTALL')¶: The appliance installation is in progress. This class attribute was added in vSphere API 6.7.

MIGRATE = Operation(string='MIGRATE')¶: The appliance migration is in progress. This class attribute was added in vSphere API 6.7.

RESTORE = Operation(string='RESTORE')¶: The appliance restoration is in progress. This class attribute was added in vSphere API 6.7.

ROLLBACK = Operation(string='ROLLBACK')¶: The appliance is being rolled back to an unconfigured state. This class attribute was added in vSphere API 6.7.

UPGRADE = Operation(string='UPGRADE')¶: The appliance upgrade is in progress. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.deployment_client.Question(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Question class provides methods to get the question raised during deployment and to answer them. This class was added in vSphere API 6.7.

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

class AnswerSpec(question_id=None, answer_val=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Question.AnswerSpec class contains attributes to describe the answer to a raised question. This class was added in vSphere API 6.7.

Tip

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

Parameters

question_id (str) – Id of the question being answered. This attribute was added in vSphere API 6.7.
answer_val (str) – The answer value. This attribute was added in vSphere API 6.7.

class Info(questions=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Question.Info class contains attributes to describe questions raised during the deployment process. This class was added in vSphere API 6.7.

Tip

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

Parameters: questions (list of Question.Question) – One or more questions raised during the deployment. This attribute was added in vSphere API 6.7.

class Question(id=None, question=None, type=None, default_answer=None, possible_answers=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Question.Question class contains attributes to describe a deployment question. This class was added in vSphere API 6.7.

Tip

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

Parameters

id (str) – Id of the question raised. This attribute was added in vSphere API 6.7.
question (com.vmware.vapi.std_client.LocalizableMessage) – Message describing the question. This attribute was added in vSphere API 6.7.
type (Question.QuestionType) – Type of the question raised. This attribute was added in vSphere API 6.7.
default_answer (str) – Default answer value. This attribute was added in vSphere API 6.7.
possible_answers (list of str) – Possible answers values. This attribute was added in vSphere API 6.7.

class QuestionType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Question.QuestionType class defines the type of the question raised. This enumeration was added in vSphere API 6.7.

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

ABORT_RETRY_IGNORE = QuestionType(string='ABORT_RETRY_IGNORE')¶: Question with answer values Abort/Retry/Ignore. This class attribute was added in vSphere API 6.7.

OK_CANCEL = QuestionType(string='OK_CANCEL')¶: Question with answer values Ok/Cancel. This class attribute was added in vSphere API 6.7.

YES_NO = QuestionType(string='YES_NO')¶: Question with answer values Yes/No. This class attribute was added in vSphere API 6.7.

answer(spec)¶

Supply answer to the raised question. This method was added in vSphere API 6.7.

Parameters: spec (Question.AnswerSpec) – AnswerSpec with the answer to the raised question.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is NOT in QUESTION_RAISED state.
Raise: com.vmware.vapi.std.errors_client.InternalServerError if answer file could not be created.

get()¶

Get the question that was raised during the configuration. This method was added in vSphere API 6.7.

Return type: Question.Info
Returns: Info structure containing the question.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in QUESTION_RAISED state.
Raise: com.vmware.vapi.std.errors_client.InternalServerError if questions could not be retrieved although the appliance is in QUESTION_RAISED state.

class com.vmware.vcenter.deployment_client.RemotePscSpec(psc_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The RemotePscSpec class contains information used to configure an external vCenter Server that registers with a remote PSC. This class was added in vSphere API 6.7.

Tip

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

Parameters

psc_hostname (str) – The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered to. This attribute was added in vSphere API 6.7.
https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7. If None, port 443 will be used.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for verification when ssl_verify field is set to true. This attribute was added in vSphere API 6.7. This attribute is only relevant if sslVerify is None or has the value true.
ssl_verify (bool or None) – SSL verification should be enabled or disabled. If sslVerify is true and and sslThumbprint is None, the CA certificate will be used for verification. If sslVerify is true and sslThumbprint is set then the thumbprint will be used for verification. No verification will be performed if sslVerify value is set to false. This attribute was added in vSphere API 6.7. If None, sslVerify true will be used.

class com.vmware.vcenter.deployment_client.ReplicatedPscSpec(sso_site_name=None, partner_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ReplicatedPscSpec class contains information used to check if the configuring PSC can be replicated to the remote PSC. This class was added in vSphere API 6.7.

Tip

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

Parameters

sso_site_name (str or None) – The SSO sitename that will be used in PSC replication. This attribute was added in vSphere API 6.7. If None, default-first-site will be used.
partner_hostname (str) – The IP address or DNS resolvable name of the partner PSC appliance. This attribute was added in vSphere API 6.7.
https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7. If None, port 443 will be used.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. This attribute is only relevant if sslVerify is None or has the value true.
ssl_verify (bool or None) – SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7. If None, ssl_verify true will be used.

class com.vmware.vcenter.deployment_client.ReplicatedSpec(partner_hostname=None, https_port=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ReplicatedSpec class contains information used to check if the configuring vCenter Server can be replicated to the remote PSC. This class was added in vSphere API 6.7.

Tip

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

Parameters

partner_hostname (str) – The IP address or DNS resolvable name of the partner PSC appliance. This attribute was added in vSphere API 6.7.
https_port (long or None) – The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7. If None, port 443 will be used.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. This attribute is only relevant if sslVerify is None or has the value true.
ssl_verify (bool or None) – SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7. If None, ssl_verify true will be used.

class com.vmware.vcenter.deployment_client.StandalonePscSpec(sso_site_name=None, sso_admin_password=None, sso_domain_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StandalonePscSpec class contains information used to configure a standalone PSC appliance. This class was added in vSphere API 6.7.

Tip

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

Parameters

sso_site_name (str or None) – The SSO site name used for this PSC. This attribute was added in vSphere API 6.7. If None, default-first-site will be used.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
sso_domain_name (str or None) – The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7. If None, vsphere.local will be used.

class com.vmware.vcenter.deployment_client.StandaloneSpec(sso_admin_password=None, sso_domain_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The StandaloneSpec class contains information used to configure a standalone embedded vCenter Server appliance. This class was added in vSphere API 6.7.

Tip

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

Parameters

sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
sso_domain_name (str or None) – The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7. If None, vsphere.local will be used.

class com.vmware.vcenter.deployment_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.deployment_client.Upgrade(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Upgrade class provides methods to configure the upgrade of this appliance from an existing vCenter appliance. This class was added in vSphere API 6.7.

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

class PscSpec(ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Upgrade.PscSpec class contains information used to upgrade a Platform Service Controller appliance. This class was added in vSphere API 6.7.

Tip

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

Parameters: ceip_enabled (bool) – Customer experience improvement program should be enabled or disabled for this Platform Services Controller upgrade. This attribute was added in vSphere API 6.7.

class SourceApplianceSpec(hostname=None, https_port=None, ssl_thumbprint=None, ssl_verify=None, sso_admin_username=None, sso_admin_password=None, root_password=None, ssh_verify=None, ssh_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Upgrade.SourceApplianceSpec class contains information used to connect to the appliance used as the source for an upgrade. This class was added in vSphere API 6.7.

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 source appliance. This attribute was added in vSphere API 6.7.
https_port (long or None) – The HTTPS port of the source appliance. This attribute was added in vSphere API 6.7. If None, port 443 will be used.
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. This attribute is only relevant if sslVerify is None or has the value true.
ssl_verify (bool or None) – SSL verification should be enabled or disabled for the source appliance validations. By default it is enabled and will use SSL certificate for verification. If thumbprint is provided, will use thumbprint for the verification. This attribute was added in vSphere API 6.7. If None, ssl_verify true will be used.
sso_admin_username (str) – The SSO administrator account on the source appliance. This attribute was added in vSphere API 6.7.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.
root_password (str) – The password of the root user on the source appliance. This attribute was added in vSphere API 6.7.
ssh_verify (bool or None) – Appliance SSH verification should be enabled or disabled. By default it is disabled and will not use any verification. If thumbprint is provided, thumbprint verification will be performed. This attribute was added in vSphere API 6.7. If None, ssh_verify true will be used.
ssh_thumbprint (str or None) – MD5 thumbprint of the server SSH key will be used for verification. This attribute was added in vSphere API 6.7. This attribute is only relevant if sshVerify is None or has the value true.

class UpgradeSpec(source_appliance=None, source_location=None, history=None, vcsa_embedded=None, psc=None, auto_answer=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Upgrade.UpgradeSpec class contains information used to configure the appliance upgrade. This class was added in vSphere API 6.7.

Tip

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

Parameters

source_appliance (Upgrade.SourceApplianceSpec) – Source appliance spec. This attribute was added in vSphere API 6.7.
source_location (LocationSpec) – Source location spec. This attribute was added in vSphere API 6.7.
history (HistoryMigrationSpec or None) –
Determines how vCenter history will be migrated during the upgrade process. vCenter history consists of:
- Statistics
- Events
- Tasks
By default only core data will be migrated. Use this spec to define which part of vCenter history data will be migrated and when. This attribute was added in vSphere API 6.7. If None, only core database content will be migrated.
vcsa_embedded (Upgrade.VcsaEmbeddedSpec or None) – Information that are specific to this embedded vCenter Server. This attribute was added in vSphere API 6.7. If None, ceip_enabled for embedded vcenter server upgrade will default to enabled.
psc (Upgrade.PscSpec or None) – Information that are specific to this Platform Services Controller. This attribute was added in vSphere API 6.7. If None, ceip_enabled for psc upgrade will default to enabled.
auto_answer (bool or None) – Use the default option for any questions that may come up during appliance configuration. This attribute was added in vSphere API 6.7. If None, will default to false.

class VcsaEmbeddedSpec(ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Upgrade.VcsaEmbeddedSpec class contains information used to upgrade a Embedded vCenter Server appliance. This class was added in vSphere API 6.7.

Tip

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

Parameters: ceip_enabled (bool) – Customer experience improvement program should be enabled or disabled for this embedded vCenter Server upgrade. This attribute was added in vSphere API 6.7.

cancel()¶

Cancel the appliance upgrade that is in progress. This method was added in vSphere API 6.7.

Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

check(spec)¶

Run sanity checks using the UpgradeSpec parameters passed. This method was added in vSphere API 6.7.

Parameters: spec (Upgrade.UpgradeSpec) – UpgradeSpec parameters to run sanity check on.
Return type: CheckInfo
Returns: CheckInfo containing the check results.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if source credentials are not valid.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if source container credentials are not valid.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in INITIALIZED state.

get()¶

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This method was added in vSphere API 6.7.

Return type: Upgrade.UpgradeSpec
Returns: UpgradeSpec parameters being used to configure appliance upgrade.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if appliance is not in UPGRADE_PROGRESS state.

start(spec)¶

Start the appliance installation. This method was added in vSphere API 6.7.

Parameters: spec (Upgrade.UpgradeSpec) – UpgradeSpec parameters to configure the appliance upgrade.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if source credentials are not valid.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if source container credentials are not valid.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in INITIALIZED state.

class com.vmware.vcenter.deployment_client.VerificationMode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The VerificationMode class defines the verification modes for SSL certificates or SSH connections. This enumeration was added in vSphere API 6.7.

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

NONE = VerificationMode(string='NONE')¶: No verification will be performed. This class attribute was added in vSphere API 6.7.

THUMBPRINT = VerificationMode(string='THUMBPRINT')¶: Passed thumbprint will be used for verification. This class attribute was added in vSphere API 6.7.

com.vmware.vcenter.guest_client module¶

The com.vmware.vcenter.guest_client module provides classes for managing guest customization specifications in the vCenter Server.

class com.vmware.vcenter.guest_client.CustomizationSpecs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The CustomizationSpecs class provides methods to manage guest customization specifications in the vCenter Server. This class was added in vSphere API 6.7.1.

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

class FilterSpec(names=None, os_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CustomizationSpecs.FilterSpec class contains attributes used to filter the results when listing guest customization specifications (see CustomizationSpecs.list()). If multiple attributes are specified, only guest customization specifications matching all of the attributes match the filter. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

names (set of str or None) – Names that guest customization specifications must have to match the filter (see CustomizationSpecs.Summary.name). This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.guest.CustomizationSpec. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.guest.CustomizationSpec. If None or empty, guest customization specifications with any name match the filter.
os_type (CustomizationSpecs.OsType or None) – Guest operating system type that guest customization specifications must have to match the filter (see CustomizationSpecs.Summary.os_type). This attribute was added in vSphere API 6.7.1. If None, guest customization specifications with any guest operating system type match the filter.

class OsType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The CustomizationSpecs.OsType class defines the types of guest operating systems for which guest customization is supported. This enumeration was added in vSphere API 6.7.1.

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

LINUX = OsType(string='LINUX')¶: A customization specification for a Linux guest operating system. This class attribute was added in vSphere API 6.7.1.

WINDOWS = OsType(string='WINDOWS')¶: A customization specification for a Windows guest operating system. This class attribute was added in vSphere API 6.7.1.

RESOURCE_TYPE = 'com.vmware.vcenter.guest.CustomizationSpec'¶: The resource type for a vCenter guest customization specification. This class attribute was added in vSphere API 6.7.1.

class Summary(name=None, description=None, os_type=None, last_modified=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CustomizationSpecs.Summary class contains commonly used information about a guest customization specification. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

name (str) – Name of the guest customization specification. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec. 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.guest.CustomizationSpec.
description (str) – Description of the guest customization specification. This attribute was added in vSphere API 6.7.1.
os_type (CustomizationSpecs.OsType) – Guest operating system type for which that this guest customization specification applies. This attribute was added in vSphere API 6.7.1.
last_modified (datetime.datetime) – Date and tme when this guest customization specification was last modified. This attribute was added in vSphere API 6.7.1.

list(filter=None)¶

Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the CustomizationSpecs.FilterSpec. This method was added in vSphere API 6.7.1.

Parameters: filter (CustomizationSpecs.FilterSpec or None) – Specification of matching guest customization specifications for which information should be returned. If None, the behavior is equivalent to a CustomizationSpecs.FilterSpec with all attributes None which means all guest customization specifications match the filter.
Return type: list of CustomizationSpecs.Summary
Returns: Commonly used information about the guest customization specifications matching the CustomizationSpecs.FilterSpec.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if the CustomizationSpecs.FilterSpec.os_type attribute contains a value that is not supported by the server.
Raise: com.vmware.vapi.std.errors_client.UnableToAllocateResource if more than 1000 guest customization specifications match the CustomizationSpecs.FilterSpec.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.guest_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.hvc_client module¶

The com.vmware.vcenter.hvc_client module provides classes to manage hybrid links between a local and remote Platform Service Controller.

class com.vmware.vcenter.hvc_client.Links(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Links class provides methods to create, delete, get information, and list hybrid links between the local and foreign Platform Service Controller (PSC). Warning: This class is available as technical preview. It may be changed in a future release.

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

class CertificateInfo(ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.CertificateInfo class contains information about the SSL certificate for a destination PSC endpoint. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters: ssl_thumbprint (str) – The SHA-256 thumbprint of the SSL certificate for the destination PSC endpoint. Warning: This attribute is available as technical preview. It may be changed in a future release.

class CreateSpec(psc_hostname=None, port=None, domain_name=None, username=None, password=None, ssl_thumbprint=None, admin_groups=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.CreateSpec class is the specification used for the hybrid link creation. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

psc_hostname (str) – The PSC hostname for the domain to be linked. Warning: This attribute is available as technical preview. It may be changed in a future release.
port (str or None) – The HTTPS port of the PSC to be linked. Warning: This attribute is available as technical preview. It may be changed in a future release. If None 443 will be used as default.
domain_name (str) – The domain to which the PSC belongs. Warning: This attribute is available as technical preview. It may be changed in a future release.
username (str) – The administrator username of the PSC. Warning: This attribute is available as technical preview. It may be changed in a future release.
password (str) – The administrator password of the PSC. Warning: This attribute is available as technical preview. It may be changed in a future release.
ssl_thumbprint (str or None) – The ssl thumbprint of the server. Warning: This attribute is available as technical preview. It may be changed in a future release. if None no thumbprint is passed.
admin_groups (set of str or None) – List of groups to be added to enable administrator access to. Warning: This attribute is available as technical preview. It may be changed in a future release. if None administrator access will not be set.

class Credentials(user_name=None, password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.Credentials class specifies user credentials to make a successful connection to remote endpoint. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

user_name (str) – Name of the user to authenticate. Warning: This attribute is available as technical preview. It may be changed in a future release.
password (str) – Password for the user. Warning: This attribute is available as technical preview. It may be changed in a future release.

class Summary(link=None, display_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Links.Summary class contains information about the hybrid link. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

link (str) – Unique identifier for the link. Warning: This attribute is available as technical preview. It may be changed in a future release. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.hvc.Links. 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.hvc.Links.
display_name (str) – The display name is set to the domain name which was set during create. Warning: This attribute is available as technical preview. It may be changed in a future release.

create(spec)¶

Creates a new hybrid link between the local and foreign PSC. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: spec (Links.CreateSpec) – Specification for the new link to be created.
Return type: str
Returns: The identifier of the newly linked domain. The return value will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
Raise: com.vmware.vapi.std.errors_client.AlreadyExists If the link already exists.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the values of any of the attributes of the spec parameter are not valid.
Raise: com.vmware.vapi.std.errors_client.Unsupported If the PSC or the VC version is not supported.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized.
Raise: com.vmware.vapi.std.errors_client.UnverifiedPeer If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in Links.CreateSpec.ssl_thumbprint or if Links.CreateSpec.ssl_thumbprint is None. The value of the {\@link UnverifiedPeer#data) attribute will be a class that contains all the attributes defined in Links.CertificateInfo.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

delete(link)¶

Deletes an existing hybrid link. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: link (str) – Identifier of the hybrid link. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
Raise: com.vmware.vapi.std.errors_client.NotFound If the hybrid link associated with link does not exist.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

list()¶

Enumerates the list of registered hybrid links. Warning: This method is available as technical preview. It may be changed in a future release.

Return type: list of Links.Summary
Returns: The list of hybrid link information.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

class com.vmware.vcenter.hvc_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.identity_client module¶

The com.vmware.vcenter.identity_client module provides classes to manage VcIdentity.

class com.vmware.vcenter.identity_client.Providers(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Providers interface provides methods to list, read and modify vCenter Server identity providers. Warning: This class is available as technical preview. It may be changed in a future release.

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

class ConfigType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.ConfigType class contains the possible types of vCenter Server identity providers. Warning: This enumeration is available as technical preview. It may be changed in a future 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 ConfigType instance.

Oauth2 = ConfigType(string='Oauth2')¶: Config for OAuth2. Warning: This class attribute is available as technical preview. It may be changed in a future release.

Oidc = ConfigType(string='Oidc')¶: Config for OIDC. Warning: This class attribute is available as technical preview. It may be changed in a future release.

class CreateSpec(config_tag=None, oauth2=None, oidc=None, org_ids=None, is_default=None, name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.CreateSpec class contains the information used to create an identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

config_tag (Providers.ConfigType) – The config type of the identity provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
oauth2 (Providers.Oauth2CreateSpec) – OAuth2 CreateSpec. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oauth2.
oidc (Providers.OidcCreateSpec) – OIDC CreateSpec. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oidc.
org_ids (set of str or None) – The set of orgIds as part of SDDC creation which provides the basis for tenancy. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, the set will be empty.
is_default (bool or None) – Specifies whether the provider is the default provider. Setting isDefault of current provider to True makes all other providers non-default. If no other providers created in this vCenter Server before, this parameter will be disregarded, and the provider will always be set to the default. Warning: This attribute is available as technical preview. It may be changed in a future release. If None the provider will be the default provider if it is the first provider that is created, and will not be the default provider otherwise.
name (str or None) – Friendly name for the provider. This must be unique, otherwise calling create will throw com.vmware.vapi.std.errors_client.InvalidArgument. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, the server will use a UUID.

class IdentityManagementEndpoint(usage_hint=None, endpoint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.IdentityManagementEndpoint class is an provider endpoint that the client can manage users and groups with. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

usage_hint (str or None) – This is a client specified hint on how to use this endpoint. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, the hint will be empty.
endpoint (str) – Identity management endpoint URL. Warning: This attribute is available as technical preview. It may be changed in a future release.

class Info(org_ids=None, config_tag=None, oauth2=None, oidc=None, is_default=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Info class contains the information about an identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

org_ids (set of str) – The set of orgIds as part of SDDC creation which provides the basis for tenancy. Warning: This attribute is available as technical preview. It may be changed in a future release.
config_tag (Providers.ConfigType) – The config type of the identity provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
oauth2 (Providers.Oauth2Info) – OAuth2 Info. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oauth2.
oidc (Providers.OidcInfo) – OIDC Info. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oidc.
is_default (bool) – Specifies whether the provider is the default provider. Warning: This attribute is available as technical preview. It may be changed in a future release.

class Oauth2AuthenticationMethod(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.Oauth2AuthenticationMethod class contains the possible types of OAuth2 authentication methods. Warning: This enumeration is available as technical preview. It may be changed in a future 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 Oauth2AuthenticationMethod instance.

CLIENT_SECRET_BASIC = Oauth2AuthenticationMethod(string='CLIENT_SECRET_BASIC')¶: Clients that have received a client_secret value from the Authorization Server, authenticate with the Authorization Server in accordance with Section 3.2.1 of OAuth 2.0 [RFC6749] using the HTTP Basic authentication scheme. Warning: This class attribute is available as technical preview. It may be changed in a future release.

CLIENT_SECRET_JWT = Oauth2AuthenticationMethod(string='CLIENT_SECRET_JWT')¶: Clients that have received a client_secret value from the Authorization Server, create a JWT using an HMAC SHA algorithm, such as HMAC SHA-256. The HMAC (Hash-based Message Authentication Code) is calculated using the octets of the UTF-8 representation of the client_secret as the shared key. Warning: This class attribute is available as technical preview. It may be changed in a future release.

CLIENT_SECRET_POST = Oauth2AuthenticationMethod(string='CLIENT_SECRET_POST')¶: Clients that have received a client_secret value from the Authorization Server, authenticate with the Authorization Server in accordance with Section 3.2.1 of OAuth 2.0 [RFC6749] by including the Client Credentials in the request body. Warning: This class attribute is available as technical preview. It may be changed in a future release.

PRIVATE_KEY_JWT = Oauth2AuthenticationMethod(string='PRIVATE_KEY_JWT')¶: Clients that have registered a public key sign a JWT using that key. The client authenticates in accordance with JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants [OAuth.JWT] and Assertion Framework for OAuth 2.0 Client Authentication and Authorization Grants [OAuth.Assertions]. Warning: This class attribute is available as technical preview. It may be changed in a future release.

class Oauth2CreateSpec(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None, idm_endpoints=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Oauth2CreateSpec class contains the information used to create an OAuth2 identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

auth_endpoint (str) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_endpoint (str) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
public_key_uri (str) – Endpoint to retrieve the provider public key for validation. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_secret (str) – The secret shared between the client and the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release.
issuer (str) – The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. Warning: This attribute is available as technical preview. It may be changed in a future release.
authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_query_params ((dict of str and list of str) or None) –
k/v pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details:
- If the value contains only one string, then the key is added with “k=v”.
- If the value is an empty list, then the key is added without a “=v”.
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, the map will be empty.
idm_endpoints (list of Providers.IdentityManagementEndpoint or None) – Identity management endpoints provided by the provider. The list can be empty if the provider has no management capability. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, default to empty list.

class Oauth2Info(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None, idm_endpoints=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Oauth2Info class contains the information about an OAuth2 identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

auth_endpoint (str) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_endpoint (str) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
public_key_uri (str) – Endpoint to retrieve the provider public key for validation. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_secret (str) – The secret shared between the client and the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release.
issuer (str) – The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. Warning: This attribute is available as technical preview. It may be changed in a future release.
authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_query_params (dict of str and list of str) –
k/v pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details:
- If the value contains only one string, then the key is added with “k=v”.
- If the value is an empty list, then the key is added without a “=v”.
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
. Warning: This attribute is available as technical preview. It may be changed in a future release.
idm_endpoints (list of Providers.IdentityManagementEndpoint) – Identity management endpoints provided by the provider. The list can be empty if the provider has no management capability. Warning: This attribute is available as technical preview. It may be changed in a future release.

class Oauth2Summary(auth_endpoint=None, token_endpoint=None, client_id=None, authentication_header=None, auth_query_params=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Oauth2Summary class contains commonly used information about an OAuth2 identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

auth_endpoint (str) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_endpoint (str) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
authentication_header (str) – The authentication data used as part of request header to acquire or refresh an OAuth2 token. The data format depends on the authentication method used. Example of basic authentication format: Authorization: Basic [base64Encode(clientId + “:” + secret)]. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_query_params (dict of str and list of str) –
k/v pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details:
- If the value contains only one string, then the key is added with “k=v”.
- If the value is an empty list, then the key is added without a “=v”.
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
. Warning: This attribute is available as technical preview. It may be changed in a future release.

class Oauth2UpdateSpec(auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None, idm_endpoints=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Oauth2UpdateSpec class contains the information used to update the OAuth2 identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

auth_endpoint (str or None) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
token_endpoint (str or None) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
public_key_uri (str or None) – Endpoint to retrieve the provider public key for validation. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
client_id (str or None) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
client_secret (str or None) – Shared secret between identity provider and client. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
claim_map ((dict of str and (dict of str and list of str)) or None) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
issuer (str or None) – The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
authentication_method (Providers.Oauth2AuthenticationMethod or None) – Authentication method used by the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
auth_query_params ((dict of str and list of str) or None) – k/v pairs that are to be appended to the authEndpoint request. How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details: If the value contains only one string, then the key is added with “k=v”. If the value is an empty list, then the key is added without a “=v”. If the value contains multiple strings, then the key is repeated in the query-string for each string in the value. If the map is empty, deletes all params. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
idm_endpoints (list of Providers.IdentityManagementEndpoint or None) – Identity management endpoints provided by the provider. The list can be empty if the provider has no management capability. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.

class OidcCreateSpec(discovery_endpoint=None, client_id=None, client_secret=None, claim_map=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.OidcCreateSpec class contains the information used to create an OIDC identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

discovery_endpoint (str) – Endpoint to retrieve the provider metadata. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_secret (str) – The secret shared between the client and the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release.

class OidcInfo(discovery_endpoint=None, auth_endpoint=None, token_endpoint=None, public_key_uri=None, client_id=None, client_secret=None, claim_map=None, issuer=None, authentication_method=None, auth_query_params=None, idm_endpoints=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.OidcInfo class contains information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so Providers.OidcInfo contains additional discovered OAuth2 metadata. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

discovery_endpoint (str) – Endpoint to retrieve the provider metadata. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_endpoint (str) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_endpoint (str) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
public_key_uri (str) – Endpoint to retrieve the provider public key for validation. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_secret (str) – The secret shared between the client and the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
claim_map (dict of str and (dict of str and list of str)) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release.
issuer (str) – The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. Warning: This attribute is available as technical preview. It may be changed in a future release.
authentication_method (Providers.Oauth2AuthenticationMethod) – Authentication method used by the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_query_params (dict of str and list of str) –
k/v pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details:
- If the value contains only one string, then the key is added with “k=v”.
- If the value is an empty list, then the key is added without a “=v”.
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
. Warning: This attribute is available as technical preview. It may be changed in a future release.
idm_endpoints (list of Providers.IdentityManagementEndpoint) – Identity management endpoints provided by the provider. The list can be empty if the provider has no management capability. Warning: This attribute is available as technical preview. It may be changed in a future release.

class OidcSummary(auth_endpoint=None, token_endpoint=None, client_id=None, authentication_header=None, auth_query_params=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.OidcSummary class contains commonly used information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so Providers.OidcSummary contains discovered OAuth2 metadata. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

auth_endpoint (str) – Authentication/authorization endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_endpoint (str) – Token endpoint of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
client_id (str) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
authentication_header (str) – The authentication data used as part of request header to acquire or refresh an OAuth2 token. The data format depends on the authentication method used. Example of basic authentication format: Authorization: Basic [base64Encode(clientId + “:” + secret)]. Warning: This attribute is available as technical preview. It may be changed in a future release.
auth_query_params (dict of str and list of str) –
k/v pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details:
- If the value contains only one string, then the key is added with “k=v”.
- If the value is an empty list, then the key is added without a “=v”.
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
. Warning: This attribute is available as technical preview. It may be changed in a future release.

class OidcUpdateSpec(discovery_endpoint=None, client_id=None, client_secret=None, claim_map=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.OidcUpdateSpec class contains the information used to update the OIDC identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

discovery_endpoint (str or None) – Endpoint to retrieve the provider metadata. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
client_id (str or None) – Client identifier to connect to the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
client_secret (str or None) – The secret shared between the client and the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
claim_map ((dict of str and (dict of str and list of str)) or None) – The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.

class Summary(provider=None, config_tag=None, oauth2=None, oidc=None, is_default=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Summary class contains commonly used information about an identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

provider (str) – The identifier of the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.identity.Providers. 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.identity.Providers.
config_tag (Providers.ConfigType) – The config type of the identity provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
oauth2 (Providers.Oauth2Summary) – OAuth2 Summary. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oauth2.
oidc (Providers.OidcSummary) – OIDC Summary. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oidc.
is_default (bool) – Specifies whether the provider is the default provider. Warning: This attribute is available as technical preview. It may be changed in a future release.

class UpdateSpec(config_tag=None, oauth2=None, oidc=None, org_ids=None, is_default=None, name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.UpdateSpec class contains the information used to update the identity provider. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

config_tag (Providers.ConfigType) – The config type of the identity provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
oauth2 (Providers.Oauth2UpdateSpec) – OAuth2 UpdateSpec. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oauth2.
oidc (Providers.OidcUpdateSpec) – OIDC UpdateSpec. Warning: This attribute is available as technical preview. It may be changed in a future release. This attribute is optional and it is only relevant when the value of configTag is Providers.ConfigType.Oidc.
org_ids (set of str or None) – The set orgIds as part of SDDC creation which provides the basis for tenancy. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
is_default (bool or None) – Specifies whether the provider is the default provider. Setting isDefault of current provider to True makes all other providers non-default. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.
name (str or None) – Friendly name for this provider. This must be unique, otherwise calling update will throw com.vmware.vapi.std.errors_client.InvalidArgument. Warning: This attribute is available as technical preview. It may be changed in a future release. If None, leaves value unchanged.

create(spec)¶

Create a vCenter Server identity provider. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: spec (Providers.CreateSpec) – the CreateSpec contains the information used to create the provider
Return type: str
Returns: The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to caller.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if invalid arguments are provided in createSpec.

delete(provider)¶

Delete a vCenter Server identity provider. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: provider (str) – the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to caller.
Raise: com.vmware.vapi.std.errors_client.NotFound if no provider found with the given provider identifier.

get(provider)¶

Retrieve detailed information of the specified identity provider. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: provider (str) – the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.
Return type: Providers.Info
Returns: Detailed information of the specified identity provider.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to caller.
Raise: com.vmware.vapi.std.errors_client.NotFound if no provider found with the given provider identifier.

list()¶

Retrieve all identity providers. Warning: This method is available as technical preview. It may be changed in a future release.

Return type: list of Providers.Summary
Returns: Commonly used information about the identity providers.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to caller.

update(provider, spec)¶

Update a vCenter Server identity provider. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters

provider (str) – the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.
spec (Providers.UpdateSpec) – the UpdateSpec contains the information used to update the provider

Raise

com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to caller.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if invalid arguments are provided in updateSpec.

Raise

com.vmware.vapi.std.errors_client.NotFound if no provider found with the given provider identifier.

class com.vmware.vcenter.identity_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.inventory_client module¶

The com.vmware.vcenter.inventory_client component provides methods and classes for retrieving vCenter datastore and network information for a given list of identifiers.

class com.vmware.vcenter.inventory_client.Datastore(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Datastore class provides methods to retrieve information about datastores.

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

class Info(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Datastore.Info class contains information about a datastore.

Tip

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

Parameters: type (str) – Type of the datastore. When clients pass a value of this class as a parameter, the attribute must be one of Datastore or StoragePod. When methods return a value of this class as a return value, the attribute will be one of Datastore or StoragePod.

find(datastores)¶

Returns datastore information for the specified datastores. The key in the return value dict is the datastore identifier and the value in the dict is the datastore information.

Parameters

datastores (list of str) – Identifiers of the datastores for which information will be returned. The parameter must contain identifiers for the resource type: Datastore.

Return type

dict of str and (Datastore.Info or None)

Returns

Datastore information for the specified datastores. The key in the return value dict is the datastore identifier and the value in the dict is the datastore information. The key in the return value dict will be an identifier for the resource type: Datastore.

Raise

com.vmware.vapi.std.errors_client.NotFound if no datastore can be found for one or more of the datastore identifiers in datastores

Raise

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

Method execution requires System.Read.
The resource Datastore referenced by the parameter datastores requires System.Read.

class com.vmware.vcenter.inventory_client.Network(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Network class provides methods to retrieve information about vCenter Server networks.

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

class Info(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Network.Info class contains information about a vCenter Server network.

Tip

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

Parameters: type (str) – Type of the vCenter Server network. When clients pass a value of this class as a parameter, the attribute must be one of Network, DistributedVirtualPortgroup, or OpaqueNetwork. When methods return a value of this class as a return value, the attribute will be one of Network, DistributedVirtualPortgroup, or OpaqueNetwork.

find(networks)¶

Returns network information for the specified vCenter Server networks. The key in the return value dict is the network identifier and the value in the dict is the network information.

Parameters

networks (list of str) – Identifiers of the vCenter Server networks for which information will be returned. The parameter must contain identifiers for the resource type: Network.

Return type

dict of str and (Network.Info or None)

Returns

Network information for the specified vCenter Server networks. The key in the return value dict is the network identifier and the value in the dict is the network information. The key in the return value dict will be an identifier for the resource type: Network.

Raise

com.vmware.vapi.std.errors_client.NotFound if no datastore can be found for one or more of the vCenter Server network identifiers in networks

Raise

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

Method execution requires System.Read.
The resource Network referenced by the parameter networks requires System.Read.

class com.vmware.vcenter.inventory_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.iso_client module¶

The com.vmware.vcenter.iso_client module provides classes and classes that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

class com.vmware.vcenter.iso_client.Image(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

Provides an interface to mount and unmount an ISO image on a virtual machine.

This is an API that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

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

mount(library_item, vm)¶

Mounts an ISO image from a content library on a virtual machine.

Parameters

library_item (str) – The identifier of the library item having the ISO image to mount on the virtual machine. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
vm (str) – The identifier of the virtual machine where the specified ISO image will be mounted. The parameter must be an identifier for the resource type: VirtualMachine.

Return type

str

Returns

The identifier of the newly created virtual CD-ROM backed by the specified ISO image. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise

com.vmware.vapi.std.errors_client.NotFound If either vm or the library_item is not found.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If no .iso file is present on the library item.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState When the operation is not allowed on the virtual machine in its current state.

Raise

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

Method execution requires System.Read.
The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice.
The resource com.vmware.content.library.Item referenced by the parameter library_item requires ContentLibrary.DownloadSession.

unmount(vm, cdrom)¶

Unmounts a previously mounted CD-ROM using an ISO image as a backing.

Parameters

vm (str) – The identifier of the virtual machine from which to unmount the virtual CD-ROM. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom (str) – The device identifier of the CD-ROM. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Raise

com.vmware.vapi.std.errors_client.NotFound If the virtual machine identified by vm is not found or the cdrom does not identify a virtual CD-ROM in the virtual machine.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState When the operation is not allowed on the virtual machine in its current state.

Raise

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

Method execution requires System.Read.
The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice.
The resource com.vmware.vcenter.vm.hardware.Cdrom referenced by the parameter cdrom requires System.Read.

class com.vmware.vcenter.iso_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_client module¶

class com.vmware.vcenter.lcm_client.ApplianceSize(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The size of 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 ApplianceSize instance.

LARGE = ApplianceSize(string='LARGE')¶: Appliance size of ‘large’, Default vCPUs: 16, Memory: 32GB, VM: 10000, Hosts: 1000

MEDIUM = ApplianceSize(string='MEDIUM')¶: Appliance size of ‘medium’, Default vCPUs: 8, Memory: 24GB, VM: 4000, Hosts: 400

SMALL = ApplianceSize(string='SMALL')¶: Appliance size of ‘small’, Default vCPUs: 4, Memory: 16GB, VM: 1000, Hosts: 100

TINY = ApplianceSize(string='TINY')¶: Appliance size of ‘tiny’, Default vCPUs: 2, Memory: 8GB, VM: 100, Hosts: 10

XLARGE = ApplianceSize(string='XLARGE')¶: Appliance size of ‘extra large’, Default vCPUs: 24, Memory: 48GB, VM: 35000, Hosts: 2000

class com.vmware.vcenter.lcm_client.ApplianceType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The type of 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 ApplianceType instance.

PSC = ApplianceType(string='PSC')¶: Infrastructure node.

VCSA_EMBEDDED = ApplianceType(string='VCSA_EMBEDDED')¶: Embedded node.

VCSA_EXTERNAL = ApplianceType(string='VCSA_EXTERNAL')¶: Management node.

VMC = ApplianceType(string='VMC')¶: VMC node.

class com.vmware.vcenter.lcm_client.CeipOnlySso(ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The SSO definition that only contains CEIP setting.

Tip

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

Parameters: ceip_enabled (bool or None) – This key describes the enabling option for the VMware’s Customer Experience Improvement Program (CEIP). By default we have ceipEnabled: true, which indicates that you are joining CEIP. If you prefer not to participate in the VMware’s CEIP for this product, you must disable CEIP by setting ceipEnabled: false. You may join or leave VMware’s CEIP for this product at any time. If None, defaults to True

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

Bases: vmware.vapi.bindings.struct.VapiStruct

Connection information for source/destination 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 machine that is running the installer.
username (str) – A username with administrative privileges on the ESX/VC host.
password (str) – The password of the ‘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_client.DeploymentInfo(appliance_name=None, appliance_fqdn=None, appliance_ips=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Information about the appliance deployed.

Tip

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

Parameters

appliance_name (str) – The name of the appliance.
appliance_fqdn (str or None) – The FQDN of the appliance. Not applicable before firstboot.
appliance_ips (list of str or None) – The ip addresses of the appliance. Not applicable before firstboot.

class com.vmware.vcenter.lcm_client.DeploymentOption(skip_options=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Container to control deployment.

Tip

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

Parameters: skip_options (dict of DeploymentOption.SkipOptions and bool) – The options control if a task should be skipped.

class SkipOptions(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Skippable tasks.

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

SKIP_SSO_CHECK = SkipOptions(string='SKIP_SSO_CHECK')¶: Skips the sso check. This should only be used when performing precheck for install/upgrade of management node before infrastructure node is deployed.

class com.vmware.vcenter.lcm_client.DestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of destination 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 (Vc or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class com.vmware.vcenter.lcm_client.EmbeddedReplicatedVcsa(sso_admin_password=None, sso_domain_name=None, partner_hostname=None, ssl_verify=None, ssl_thumbprint=None, https_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the replicated Single Sign-On for Embedded type deployment.

Tip

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

Parameters

sso_admin_password (str) – Administrator password of the existing Single Sign-On to be replicated.
sso_domain_name (str) – Domain name for the remote appliance which is being replicated. For example, ‘vsphere.local’
partner_hostname (str) – The IP address or DNS resolvable name for the remote appliance.
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) – SHA1 thumbprint of the server SSL certificate which will be used for verification. If sslVerify is set to False, this field can be omitted
https_port (long or None) – The HTTPS port of the external PSC appliance. If None, defaults to 443

class com.vmware.vcenter.lcm_client.EmbeddedStandaloneVcsa(sso_admin_password=None, sso_domain_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the standalone Single Sign-On for Embedded type deployment.

Tip

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

Parameters

sso_admin_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)
sso_domain_name (str) – The Single Sign-On domain name to be used to configure this vCenter Server Appliance. For example, ‘vsphere.local’

class com.vmware.vcenter.lcm_client.Esx(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of ESX.

Tip

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

Parameters

connection (Connection) – The configuration to connect to an ESX/VC.
inventory (EsxInventory) – The configuration of ESX inventory.

class com.vmware.vcenter.lcm_client.EsxInventory(datastore_name=None, network_name=None, resource_pool_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of ESX’s inventory.

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 and must have at least 25 GB of free space. Otherwise, the new appliance might not power on.
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, defaults to VM Network
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_client.ExistingMigrationAssistant(ssl_thumbprint=None, https_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the migration assistant that is already running on the source Windows VC.

Tip

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

Parameters

ssl_thumbprint (str) – The SSL thumbprint of Migration Assistant. The SSL thumbprint can be retrieved from the Migration Assistant console and log file.
https_port (long or None) – Migration Assistant port number shown in the Migration Assistant console and log file. The default port is 9123. If None, defaults to 9123

class com.vmware.vcenter.lcm_client.ExternalTool(name=None, hostname=None, location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the external tools used.

Tip

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

Parameters

name (str) – The name of the external tool
hostname (str or None) – The host name of the external tool. Can be absent when external tool does not have a host name.
location (str) – The location of the external tool.

class com.vmware.vcenter.lcm_client.ExternalVcsa(sso_admin_password=None, sso_domain_name=None, psc_hostname=None, ssl_verify=None, ssl_thumbprint=None, https_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the Single Sign-On for Management type deployment.

Tip

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

Parameters

sso_admin_password (str) – Administrator password of the external PSC to register with.
sso_domain_name (str) – Domain name of the external PSC. For example, ‘vsphere.local’
psc_hostname (str) – The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered.
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 False
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate which will be used for verification. If sslVerify is set to False, this field can be omitted.
https_port (long or None) – The HTTPS port of the external PSC appliance. If None, defaults to 443

class com.vmware.vcenter.lcm_client.GuestCredential(os_username=None, os_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the guest credential.

Tip

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

Parameters

os_username (str) – Administrator username for the source Windows operating system.
os_password (str) – Administrator user password for the source Windows operating system.

class com.vmware.vcenter.lcm_client.History(defer_import=None, data_set=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the data to be exported during upgrade/migrate.

Tip

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

Parameters

defer_import (bool or None) – A flag to indicate whether the import of historical data should be deferred until after upgrade/migrate. If None, defaults to False
data_set (History.DataSetType or None) – The type of data to be upgraded/migrated. If None, defaults to ALL

class DataSetType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The type of data to be upgraded/migrated.

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

ALL = DataSetType(string='ALL')¶: core, event and task data.

EVENTS_TASKS = DataSetType(string='EVENTS_TASKS')¶: event data and task data.

NONE = DataSetType(string='NONE')¶: core only.

class com.vmware.vcenter.lcm_client.Install(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service to install Embedded VCSA, PSC, Management VCSA, VMC gateway.

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

class DestinationAppliance(appliance_name=None, appliance_type=None, appliance_size=None, appliance_disk_size=None, root_password=None, thin_disk_mode=None, ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None, ovftool_location=None, ovftool_location_ssl_verify=None, ovftool_location_ssl_thumbprint=None, services=None, network=None, time=None, ovftool_arguments=None, vcsa_embedded=None, psc=None, vcsa_external=None, vmc=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters

appliance_name (str) – The name of the appliance to deploy.
appliance_type (ApplianceType) – The type of appliance to deploy.
appliance_size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If None, defaults to SMALL
appliance_disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If None, defaults to REGULAR
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)
thin_disk_mode (bool) – Whether to deploy the appliance with thin mode virtual disks.
ova_location (str) – The location of the OVA file.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted
ovftool_location (str) – The location of the OVF Tool.
ovftool_location_ssl_verify (bool or None) – Flag to indicate whether or not to verify the SSL thumbprint of OVF Tool location. if None, Default to be True.
ovftool_location_ssl_thumbprint (str or None) – SSL thumbprint of OVF Tool location to be verified. When ovftoolLocationSslVerify is set to False, this field can be omitted.
services (Install.DestinationApplianceService) – The configuration of vCenter services.
network (Network) – The network settings of the appliance to be deployed.
time (Time) – Configuration of the vCSA time synchronization.
ovftool_arguments ((dict of str and str) or None) – The OVF Tool arguments to be included. Not required when no OVF Tool argument to pass through
vcsa_embedded (Install.VcsaEmbedded) – Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.VCSA_EMBEDDED.
psc (Install.Psc) – Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either vcsaEmbedded or vcsaExternal must be provided. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.PSC.
vcsa_external (ExternalVcsa) – Spec used to configure a vCenter Server registered with an external PSC. If unset, either vcsa_embedded or psc must be provided. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.VCSA_EXTERNAL.
vmc (ExternalVcsa) – Spec used to configure a vCenter Server registered with an external PSC. If unset, either vcsa_embedded or psc must be provided. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.VMC.

class DestinationApplianceService(rhttpproxy=None, ssh=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The configuration of vCenter services.

Tip

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

Parameters

rhttpproxy (Install.ReverseProxy or None) – Port numbers on which the vCenter Server Appliance communicates with the other vSphere components. Default value used reverse proxy not provided
ssh (Ssh) – Whether to enable SSH on the vCenter Appliance.

class Psc(standalone=None, replicated=None, ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either #vcsaEmbedded or #vcsaExternal must be provided.

Tip

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

Parameters

standalone (PscStandalone or None) – Spec used to configure a standalone Platform Services Controller. This section describes how the standalone PSC should be configured. Mutually exclusive between standalone and replicated
replicated (PscReplicated or None) – Spec used to configure a replicated Platform Services Controller. This section describes how the replicated PSC should be configured. Mutually exclusive between standalone and replicated
ceip_enabled (bool) – This key describes the enabling option for the VMware’s Customer Experience Improvement Program (CEIP). By default we have ceipEnabled: true, which indicates that you are joining CEIP. If you prefer not to participate in the VMware’s CEIP for this product, you must disable CEIP by setting ceipEnabled: false. You may join or leave VMware’s CEIP for this product at any time.

class ReverseProxy(http_port=None, https_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Port numbers on which the vCenter Server Appliance communicates with the other vSphere components.

Tip

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

Parameters

http_port (long or None) – Reverse proxy http port. If None, defaults to 8080
https_port (long or None) – Reverse proxy https port. If None, defaults to 8443

class Spec(destination_location=None, destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

destination_location (DestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Install.DestinationAppliance) – Spec to describe the new appliance.

class VcsaEmbedded(standalone=None, replicated=None, ceip_enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured.

Tip

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

Parameters

standalone (EmbeddedStandaloneVcsa or None) – Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. Mutually exclusive between standalone and replicated
replicated (EmbeddedReplicatedVcsa or None) – Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. Mutually exclusive between standalone and replicated
ceip_enabled (bool) – This key describes the enabling option for the VMware’s Customer Experience Improvement Program (CEIP). By default we have ceipEnabled: true, which indicates that you are joining CEIP. If you prefer not to participate in the VMware’s CEIP for this product, you must disable CEIP by setting ceipEnabled: false. You may join or leave VMware’s CEIP for this product at any time.

check_task(spec, options=None)¶

Performs a precheck for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters

spec (Install.Spec) – The specification of the deployment.
options (DeploymentOption or None) – The deployment precheck options.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the given spec and/or option contains error.

start_task(spec)¶

Deploys the appliance for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters: spec (Install.Spec) – The specification of the deployment.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the given specification contains error.

class com.vmware.vcenter.lcm_client.Log(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service that provides logs associated with a task of a given task ID.

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

get(task_id)¶

Retrieves the zipped files that contains operation log, serialized task flow, record of all configuration, and a current status of the operation.

Parameters: task_id (str) – The vmodl.lang_client.ID of the operation. must exist in the server. If for any reason the server reboots during an operation, all vmodl.lang_client.ID`s previously stored is lost. The parameter must be an identifier for the resource type: ``com.vmware.cis.task`.
Return type: str
Returns: A zipped file that contains the files mentioned above.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the given ID does not exist in the server. There might be a cause of task ID does not exist including, error in taskID, or log files been purged by system or manually.

class com.vmware.vcenter.lcm_client.Migrate(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service to migrate a windows VC to Embedded VCSA, PSC, and Management VCSA.

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

class MigrateDestinationAppliance(appliance_name=None, appliance_type=None, appliance_size=None, appliance_disk_size=None, root_password=None, thin_disk_mode=None, ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None, ovftool_location=None, ovftool_location_ssl_verify=None, ovftool_location_ssl_thumbprint=None, active_directory_domain=None, active_directory_username=None, active_directory_password=None, services=None, temporary_network=None, history=None, ovftool_arguments=None, vcsa_embedded=None, psc=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters

appliance_name (str) – The name of the appliance to deploy.
appliance_type (ApplianceType or None) – The type of appliance to deploy. If None, defaults to VCSA_EMBEDDED
appliance_size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If None, defaults to SMALL
appliance_disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If None, defaults to REGULAR
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)
thin_disk_mode (bool) – Whether to deploy the appliance with thin mode virtual disks.
ova_location (str) – The location of the OVA file.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted
ovftool_location (str) – The location of the OVF Tool.
ovftool_location_ssl_verify (bool or None) – Flag to indicate whether or not to verify the SSL thumbprint of OVF Tool location. if None, Default to be True.
ovftool_location_ssl_thumbprint (str or None) – SSL thumbprint of OVF Tool location to be verified. When ovftoolLocationSslVerify is set to False, this field can be omitted.
active_directory_domain (str or None) – The name of the Active Directory domain to which the source Windows installation is joined. If the source Windows installation is not joined to an Active Directory domain, omit this parameter. Not required when active directory is not applicable
active_directory_username (str or None) – Administrator user name of the Active Directory domain to which the source Windows installation is joined. The format can be either ‘username’ or ‘username\@domain’ Not required when active directory is not applicable
active_directory_password (str or None) – Password for the active directory user. Not required when active directory is not applicable
services (UpgradeDestinationApplianceService) – Spec to configure vCenter server services.
temporary_network (TemporaryNetwork) – The network settings of the appliance to be deployed.
history (History or None) – History data to be included in the upgrade and migrate Default value will be applied when absent
ovftool_arguments ((dict of str and str) or None) – The OVF Tool arguments to be included. Not required when no OVF Tool argument to pass through
vcsa_embedded (CeipOnlySso) – Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.VCSA_EMBEDDED.
psc (CeipOnlySso) – Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either vcsaEmbedded or #vcsaExternal must be provided. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.PSC.

class Spec(destination_location=None, destination_appliance=None, source_vc_windows=None, existing_migration_assistant=None, start_migration_assistant=None, source_vum_location=None, source_vum=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the configuration parameters that are required for migrating a Windows vCenter Server.

Tip

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

Parameters

destination_location (DestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Migrate.MigrateDestinationAppliance) – Spec to describe the new appliance.
source_vc_windows (SourceVcWindows) – Spec to describe the existing Windows vCenter server to migrate.
existing_migration_assistant (ExistingMigrationAssistant or None) – Spec to describe the attributes of a running Migration Assistant on the Windows vCenter server. Only applicable when migration assistant is already running on the source appliance
start_migration_assistant (MigrationAssistant or None) – Spec to automate the invocation of Migration Assistant. Automatic invocation works only if the source Windows installation is running as a virtual machine. Only applicable when migration assistant is not running on the source appliance.
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.
source_vum (SourceVum or None) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade. Not applicable for appliance not having source vSphere Update Manager

check_task(spec, options=None)¶

Performs a precheck for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters

spec (Migrate.Spec) – The specification of the deployment.
options (DeploymentOption or None) – The deployment precheck options.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the given spec and/or option contains error.

start_task(spec)¶

Deploys the appliance for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters: spec (Migrate.Spec) – The specification of the deployment.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the given specification contains error.

class com.vmware.vcenter.lcm_client.MigrationAssistant(source_location=None, settings=None, guest_credentials=None, migration_assistant_installer_location=None, migration_assistant_installer_location_ssl_verify=None, migration_assistant_installer_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the migration assistant to be uploaded and started on source Windows VC.

Tip

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

Parameters

source_location (Connection) – The configuration to connect to an ESX/VC.
settings (MigrationAssistantSetting) – Spec to automatically launch the Migration Assistant.
guest_credentials (GuestCredential) – Credentials for the Windows system on which the vCenter server is running.
migration_assistant_installer_location (str or None) – Installer location of the migration assistant to be uploaded.
migration_assistant_installer_location_ssl_verify (bool or None) – A flag to indicate whether to verify ssl connection. when SSL thumbprint is provided, SSL verify is not required.
migration_assistant_installer_location_ssl_thumbprint (str or None) – SSL thumbprint of the source appliance. if ssl verify is set to False, thumbprint is not required.

class com.vmware.vcenter.lcm_client.MigrationAssistantSetting(migrated_ip=None, https_port=None, export_dir=None, service_account_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the setting of migration assistant to be uploaded and started on source Windows VC.

Tip

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

Parameters

migrated_ip (str or None) – The IP address of the network adapter that will be migrated. Only required if the Windows vCenter Server has multiple network adapters, making its system name resolve to multiple IP addresses. May not be applicable.
https_port (long or None) – Migration Assistant port number shown in the Migration Assistant console. The default port is 9123 If None, defaults to 9123
export_dir (str or None) – Directory to export source configuration and data. Optional. If None, defaults to /var/tmp
service_account_password (str or None) – The password of the vCenter Server service account. Required only if the vCenter Server service is running under a non LocalSystem account. Service account may not be applicable

class com.vmware.vcenter.lcm_client.Network(hostname=None, ip_family=None, mode=None, ip=None, dns_servers=None, prefix=None, gateway=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Network configuration of the appliance to be deployed.

Tip

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

Parameters

hostname (str or None) – Primary network identity. Can be either an IP address or a fully qualified domain name(FQDN). host name may not be applicable
ip_family (TemporaryNetwork.IpType or None) – Network IP address family. If None, defaults to IPV4
mode (TemporaryNetwork.NetworkMode) – Network mode.
ip (str) – Network IP address. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
dns_servers (list of str) – A comma-separated list of IP addresses of DNS servers. A JSON array such as [“1.2.3.4”, “127.0.0.1”]. Required for static mode only. DNS servers must be reachable from the machine that runs CLI installer This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
prefix (long) – Network prefix length. Required for static mode only. Remove if the mode is “dhcp”. 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. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
gateway (str) – Gateway of the network. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.

class com.vmware.vcenter.lcm_client.Notification(id=None, time=None, message=None, resolution=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Notification messages of a single task.

Tip

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

Parameters

id (str) – The identifier of the message.
time (datetime.datetime or None) – The time the notification was raised/found. Only set if the time information is available.
message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message.
resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. Only set for warnings and errors.

class com.vmware.vcenter.lcm_client.PscReplicated(sso_admin_password=None, sso_domain_name=None, partner_hostname=None, ssl_verify=None, ssl_thumbprint=None, https_port=None, sso_site_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the replicated Single Sign-On for PSC type deployment.

Tip

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

Parameters

sso_admin_password (str) – Administrator password of the PSC to be replicated.
sso_domain_name (str) – Domain name of the remote PSC. For example, ‘vsphere.local’
partner_hostname (str) – The IP address or DNS resolvable name of the remote PSC.
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 False
ssl_thumbprint (str or None) – SHA1 thumbprint of the server SSL certificate which will be used for verification. If sslVerify is set to False, this field can be omitted
https_port (long or None) – The HTTPS port of the remote PSC. If None, defaults to 443
sso_site_name (str or None) – Site name of the newly deployed PSC. Site name may not be applicable

class com.vmware.vcenter.lcm_client.PscStandalone(sso_admin_password=None, sso_domain_name=None, sso_site_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the standalone Single Sign-On for Embedded type deployment.

Tip

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

Parameters

sso_admin_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)
sso_domain_name (str) – Domain name of the newly deployed PSC. For example, ‘vsphere.local’
sso_site_name (str or None) – Site name of the PSC. Site name may not be applicable

class com.vmware.vcenter.lcm_client.Recommendation(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service that provide recommendation.

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

class DatastoreDestinationAppliance(appliance_size=None, appliance_disk_size=None, ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The configuration of destination appliance to recommend datastore.

Tip

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

Parameters

appliance_size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If None, defaults to SMALL
appliance_disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If None, defaults to REGULAR
ova_location (str or None) – The location of the ova file. Not required.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted

class DatastoreDestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters

esx (Recommendation.DatastoreEsx 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 (Recommendation.DatastoreVc or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class DatastoreEsx(connection=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host.

Tip

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

Parameters: connection (Connection) – The configuration to connect to an ESX/VC.

class DatastoreInfo(freespace=None, freespace_after_placement=None, required_space=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Datastore space information. Space information are in GB unit.

Tip

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

Parameters

freespace (float) – The amount of space that the datastore currently has.
freespace_after_placement (float) – The amount of space that the datastore will have after deployment.
required_space (float) – The amount of space that the deployment will occupy.

class DatastoreRequest(destination_location=None, destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request for recommending datastore.

Tip

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

Parameters

destination_location (Recommendation.DatastoreDestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Recommendation.DatastoreDestinationAppliance) – Spec to describe the new appliance.

class DatastoreVc(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the vCenter on which to deploy the 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.
inventory (Recommendation.DatastoreVcInventory) – 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’. You must always provide the ‘network_name’ key. 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’. 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’. 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 DatastoreVcInventory(host_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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’. You must always provide the ‘network_name’ key. 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’. 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’. 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’.

Tip

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

Parameters: host_path (str) – Full path to an ESX host. Format: /{datacenter folder}/{datacenter name}/host/{host name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Host

class DeploymentSizeDestinationAppliance(ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters

ova_location (str or None) – The location of the ova file. Not required.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted

class MigrateDeploymentSizeRequest(destination_appliance=None, source_vc_windows=None, existing_migration_assistant=None, start_migration_assistant=None, source_vum_location=None, source_vum=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request for recommending migrate deployment size.

Tip

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

Parameters

destination_appliance (Recommendation.DeploymentSizeDestinationAppliance) – Spec to describe the new appliance.
source_vc_windows (SourceVcWindows) – Spec to describe the existing Windows vCenter server to migrate.
existing_migration_assistant (ExistingMigrationAssistant or None) – Spec to describe the attributes of a running Migration Assistant on the Windows vCenter server. Only applicable when migration assistant is already running on the source appliance
start_migration_assistant (MigrationAssistant or None) – Spec to automate the invocation of Migration Assistant. Automatic invocation works only if the source Windows installation is running as a virtual machine. Only applicable when migration assistant is not running on the source appliance.
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.
source_vum (SourceVum or None) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade. Not applicable for appliance not having source vSphere Update Manager

class UpgradeDeploymentSizeRequest(destination_appliance=None, source_location=None, source_appliance=None, source_vum=None, source_vum_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request for recommending upgrade deployment size.

Tip

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

Parameters

destination_appliance (Recommendation.DeploymentSizeDestinationAppliance) – Spec to describe the new appliance
source_location (Connection) – The configuration to connect to an ESX/VC.
source_appliance (UpgradeSourceAppliance) – Spec to describe the existing appliance to upgrade.
source_vum (SourceVum or None) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade. Not applicable for appliance not having source vSphere Update Manager
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.

scan_datastore_task(spec)¶

Recommend a datastore for the appliance to be deployed in.

Parameters

spec (Recommendation.DatastoreRequest) – The specification contains the information needed to recommend datastore

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

scan_migrate_deployment_size_task(spec)¶

Recommend deployment sizes based on the configuration given in the specification.

Parameters

spec (Recommendation.MigrateDeploymentSizeRequest) – The specification that contains information needed to recommend deloyment size.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

scan_upgrade_deployment_size_task(spec)¶

Recommend deployment sizes based on the configuration given in the specification.

Parameters

spec (Recommendation.UpgradeDeploymentSizeRequest) – The specification that contains information needed to recommend deloyment size.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

class com.vmware.vcenter.lcm_client.Result(info=None, warnings=None, errors=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Container of info, warning and error messages associated with a single task.

Tip

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

Parameters

info (list of Notification or None) – Info notification messages reported. Only set if an info was reported by the task.
warnings (list of Notification or None) – Warning notification messages reported. Only set if an warning was reported by the task.
errors (list of Notification or None) – Error notification messages reported. Only set if an error was reported by the task.

class com.vmware.vcenter.lcm_client.SourceVcWindows(hostname=None, username=None, password=None, ssl_verify=None, ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the source Windows VC.

Tip

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

Parameters

hostname (str) – The IP address or FQDN of the source Windows vCenter server to migrate. If an FQDN is provided, it must be resolvable from the machine that is running the installer.
username (str) – Single Sign-On administrator user on the source Windows vCenter server. For example, administrator\@vsphere.local. Important: The user must be administrator\@your_domain_name.
password (str) – The password of the Single Sign-On administrator on the source Windows vCenter server.
ssl_verify (bool or None) –
ssl_thumbprint (str or None) –

class com.vmware.vcenter.lcm_client.SourceVum(hostname=None, os_username=None, os_password=None, export_dir=None, port=None, start_migration_assistant=None, existing_migration_assistant=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the source VUM.

Tip

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

Parameters

hostname (str) – IP address or fully qualified domain name (FQDN) of the vSphere Update Manager host. If an FQDN is provided, it has to be resolvable from the machine that is running the installer.
os_username (str) – Administrator username for the source vSphere Update Manager Windows operating system.
os_password (str) – Administrator user password for the source vSphere Update Manager Windows operating system.
export_dir (str or None) – Directory to export source configuration and data. If None, defaults to for mac/lin: /var/tmp, for windows: %TEMP%
port (long or None) – The port of the source vum. default to be 9123
start_migration_assistant (SourceVumMigrationAssistant or None) – Configuration of migration assistant to be deployed to the vSphere Upgrade Manager. Mutually exclusive between start migration assistant and existing migration assistant.
existing_migration_assistant (ExistingMigrationAssistant or None) – Configuration of migration assistant that are already running on the vSphere Upgrade Manager.

class com.vmware.vcenter.lcm_client.SourceVumMigrationAssistant(installer_location=None, installer_location_ssl_verify=None, installer_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of migration assistant to be deployed to the vSphere Upgrade Manager.

Tip

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

Parameters

installer_location (str or None) – Location of the installer of migration assistant to be uploaded to the source vSphere Update Manager. Mutually exclusive between start migration assistant and existing migration assistant.
installer_location_ssl_verify (bool or None) – A flag to indicate whether to verify ssl connection of the location of the installer of migration assistant. when SSL thumbprint is provided, SSL verify is not required.
installer_location_ssl_thumbprint (str or None) – SSL thumbprint of the location of the installer of migration assistant. if ssl verify is set to False, thumbprint is not required.

class com.vmware.vcenter.lcm_client.Ssh(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Setting to enable SSH on the deployed appliance.

Tip

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

Parameters: enabled (bool or None) – Whether to enable SSH. If None, defaults to False

class com.vmware.vcenter.lcm_client.StorageSize(string)¶

Bases: vmware.vapi.bindings.enum.Enum

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_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_client.SubTaskInfo(progress=None, last_updated_time=None, result=None, external_tools=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: vmware.vapi.bindings.struct.VapiStruct

Container that contains the status information about a single task.

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.
last_updated_time (datetime.datetime) – The time that the last update is registered.
result (Result or None) – Result of the task. This attribute will be None if result is not available at the current step of the task.
external_tools (list of ExternalTool) – External tools used for the deployment.
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 com.vmware.vcenter.lcm_client.TaskInfo(metadata_file=None, state=None, progress=None, last_updated_time=None, subtask_order=None, subtasks=None, appliance_info=None, result=None, additional_info=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: vmware.vapi.bindings.struct.VapiStruct

The container that contains the status information of a deployment.

Tip

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

Parameters

metadata_file (str) – The path of the metadata file.
state (str or None) – The state of appliance being deployed. May not have any state information.
progress (com.vmware.cis.task_client.Progress) – The total progress of the deployment operation. 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.FAILED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.BLOCKED.
last_updated_time (datetime.datetime) – The time that the last update is registered.
subtask_order (list of list of str or None) – The ordered list of subtasks for this deployment operation. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
subtasks ((dict of str and SubTaskInfo) or None) – The map of the deployment subtasks and their status information. Only set when the appliance state is RUNNING_IN_PROGRESS, FAILED, CANCELLED and SUCCEEDED.
appliance_info (DeploymentInfo or None) – Information about the appliance deployed. Such information may not be available for requests that are not for deployment (validation/recommendation).
result (DataValue or None) – The result of validation or recommendation requests. Not applicable for precheck/deployment operation.
additional_info (str or None) – Additional information that a response may contain. Not all response will contain additional information.
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 com.vmware.vcenter.lcm_client.TemporaryNetwork(ip_family=None, mode=None, ip=None, dns_servers=None, prefix=None, gateway=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the temporary network which is used during upgrade/migrate.

Tip

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

Parameters

ip_family (TemporaryNetwork.IpType or None) – Network IP address family. If None, defaults to IPV4
mode (TemporaryNetwork.NetworkMode) – Network mode.
ip (str) – Network IP address. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
dns_servers (list of str) – A comma-separated list of IP addresses of DNS servers. A JSON array such as [“1.2.3.4”, “127.0.0.1”]. Required for static mode only. DNS servers must be reachable from the machine that runs CLI installer This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
prefix (long) – Network prefix length. Required for static mode only. Remove if the mode is “dhcp”. 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. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.
gateway (str) – Gateway of the network. Required for static mode only. This attribute is optional and it is only relevant when the value of mode is TemporaryNetwork.NetworkMode.STATIC.

class IpType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Network IP address family.

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.

IPV6 = IpType(string='IPV6')¶: IPv6 Type of IP address.

class NetworkMode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Network mode.

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.

STATIC = NetworkMode(string='STATIC')¶: Static IP mode.

class com.vmware.vcenter.lcm_client.Time(ntp_servers=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

NTP setting of the appliance to be deployed.

Tip

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

Parameters: ntp_servers (list of str or None) – To configure NTP time synchronization for the appliance, set the value to a comma - separated list of host names or IP addresses of Network Time Protocol(NTP) servers. If “ntp_servers” is not provided, the appliance clock will be synced to the ESX. For example: [“time.nist.gov”]. Times tool sync will be enabled when ntp server is not provided. If None, defaults to []

class com.vmware.vcenter.lcm_client.Upgrade(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service to upgrade an existing appliance to Embedded VCSA, PSC, and Management VCSA.

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

class Spec(destination_location=None, destination_appliance=None, source_location=None, source_appliance=None, source_vum=None, source_vum_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the configuration parameters that are required for upgrade of a vCenter Server Appliance.

Tip

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

Parameters

destination_location (DestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Upgrade.UpgradeDestinationAppliance) – Spec to describe the new appliance
source_location (Connection) – The configuration to connect to an ESX/VC.
source_appliance (UpgradeSourceAppliance) – Spec to describe the existing appliance to upgrade.
source_vum (SourceVum or None) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade. Not applicable for appliance not having source vSphere Update Manager
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.

class UpgradeDestinationAppliance(appliance_name=None, appliance_type=None, appliance_size=None, appliance_disk_size=None, thin_disk_mode=None, ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None, ovftool_location=None, ovftool_location_ssl_verify=None, ovftool_location_ssl_thumbprint=None, services=None, temporary_network=None, history=None, ovftool_arguments=None, vcsa_embedded=None, psc=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance

Tip

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

Parameters

appliance_name (str) – The name of the appliance to deploy.
appliance_type (ApplianceType) – The type of appliance to deploy.
appliance_size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If None, defaults to SMALL
appliance_disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If None, defaults to REGULAR
thin_disk_mode (bool) – Whether to deploy the appliance with thin mode virtual disks.
ova_location (str) – The location of the OVA file.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted
ovftool_location (str) – The location of the OVF Tool.
ovftool_location_ssl_verify (bool or None) – Flag to indicate whether or not to verify the SSL thumbprint of OVF Tool location. Default to be True.
ovftool_location_ssl_thumbprint (str or None) – SSL thumbprint of OVF Tool location to be verified. When ovftoolLocationSslVerify is set to False, this field can be omitted.
services (UpgradeDestinationApplianceService) – Spec to configure vCenter server services.
temporary_network (TemporaryNetwork) – The network settings of the appliance to be deployed.
history (History or None) – History data to be included in the upgrade and migrate Default value will be applied when absent
ovftool_arguments ((dict of str and str) or None) – The OVF Tool arguments to be included. Not required when no OVF Tool argument to pass through
vcsa_embedded (CeipOnlySso) – Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.VCSA_EMBEDDED.
psc (CeipOnlySso) – Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either vcsaEmbedded or #vcsaExternal must be provided. This attribute is optional and it is only relevant when the value of applianceType is ApplianceType.PSC.

check_task(spec, options=None)¶

Performs a precheck for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters

spec (Upgrade.Spec) – The specification of the deployment.
options (DeploymentOption or None) – The deployment precheck options.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the given spec and/or option contains error.

start_task(spec)¶

Deploys the appliance for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call.

Parameters: spec (Upgrade.Spec) – The specification of the deployment.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the given specification contains error.

class com.vmware.vcenter.lcm_client.UpgradeDestinationApplianceService(ssh=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configurable services of destination appliance for upgrade/migrate operation.

Tip

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

Parameters: ssh (Ssh) – Whether to enable SSH on the vCenter Appliance.

class com.vmware.vcenter.lcm_client.UpgradeSourceAppliance(hostname=None, sso_admin_username=None, sso_admin_password=None, root_password=None, https_port=None, ssl_verify=None, ssl_thumbprint=None, export_dir=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Configuration of the source appliance to be upgraded/migrated.

Tip

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

Parameters

hostname (str) – The IP address or fully qualified domain name (FQDN) of the vCenter Server instance. If an FQDN is provided, it has to be resolvable from the machine that is running the installer.
sso_admin_username (str) – vCenter Single Sign-On administrator user name of the source appliance.
sso_admin_password (str) – vCenter Single Sign-On administrator password of the source appliance.
root_password (str) – Password of the operating system root user of the appliance.
https_port (long or None) – The HTTPS port number to connect to the source appliance. If None, defaults to 443
ssl_verify (bool or None) –
ssl_thumbprint (str or None) –
export_dir (str or None) – Export directory of the source appliance. Default to be “/var/tmp/”.

class com.vmware.vcenter.lcm_client.Validation(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The service that provides validation of a section of full deployment specification.

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

class ApplianceNameDestinationAppliance(appliance_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Data container for appliance name information used in validation of appliance name request.

Tip

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

Parameters: appliance_name (str) – The name of the appliance to deploy.

class ApplianceNameDestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

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

Parameters

esx (Validation.ApplianceNameEsx 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 (Validation.ApplianceNameVc or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class ApplianceNameEsx(connection=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host.

Tip

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

Parameters: connection (Connection) – The configuration to connect to an ESX/VC.

class ApplianceNameEsxInventory(resource_pool_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The configuration of ESX inventory.

Tip

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

Parameters: 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 ApplianceNameRequest(destination_location=None, destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Data container that contains the information needed to validate appliance name.

Tip

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

Parameters

destination_location (Validation.ApplianceNameDestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Validation.ApplianceNameDestinationAppliance) – Spec to describe the new appliance.

class ApplianceNameVc(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the vCenter on which to deploy the 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.
inventory (Validation.ApplianceNameVcInventory) – 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’. You must always provide the ‘network_name’ key. 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’. 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’. 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 ApplianceNameVcInventory(vm_folder_path=None, resource_pool_path=None, cluster_path=None, host_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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’. You must always provide the ‘network_name’ key. 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’. 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’. 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’.

Tip

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

Parameters

vm_folder_path (str or None) –
resource_pool_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
cluster_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
host_path (str or None) – Full path to an ESX host. Format: /{datacenter folder}/{datacenter name}/host/{host name}. e.g: /Your Datacenter Folder/Your Datacenter/host/Your Host Mutually exclusive between #resource_pool_path, #cluster_path, and #host_path

class ContainerWithoutInventory(connection=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host.

Tip

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

Parameters: connection (Connection) – The configuration to connect to an ESX/VC.

class DestinationLocationEsx(connection=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host.

Tip

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

Parameters: connection (Connection) – The configuration to connect to an ESX/VC.

class DestinationLocationRequest(destination_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters: destination_location (Validation.ValidationDestinationLocation) – The destination location configuration.

class DestinationLocationVc(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the vCenter on which to deploy the 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.
inventory (VcInventory or None) – 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’. You must always provide the ‘network_name’ key. 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’. 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’. 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 EsxDestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters

esx (Validation.ContainerWithoutInventory 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 (Validation.ContainerWithoutInventory or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class EsxRequest(destination_location=None, source_location=None, source_vum_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains the information to verify esx management status.

Tip

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

Parameters

destination_location (Validation.EsxDestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
source_location (Connection or None) – The configuration to connect to an ESX/VC.
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.

class HostConfigDestinationAppliance(appliance_name=None, appliance_type=None, appliance_size=None, appliance_disk_size=None, thin_disk_mode=None, ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Data container for appliance name information used in validation of appliance name request.

Tip

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

Parameters

appliance_name (str) – The name of the appliance to deploy.
appliance_type (ApplianceType) – The type of appliance to deploy.
appliance_size (ApplianceSize or None) – A size descriptor based on the number of virtual machines which will be managed by the new vCenter appliance. If None, defaults to SMALL
appliance_disk_size (StorageSize or None) – The disk size of the new vCenter appliance. If None, defaults to REGULAR
thin_disk_mode (bool) – Whether to deploy the appliance with thin mode virtual disks.
ova_location (str or None) – The location of the ova file. Not required.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted

class HostConfigDestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters

esx (Validation.HostConfigEsx 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 (Validation.HostConfigVc or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

class HostConfigEsx(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This section describes the ESX host on which to deploy the appliance. Required if you are deploying the appliance directly on an ESX host.

Tip

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

Parameters

connection (Connection) – The configuration to connect to an ESX/VC.
inventory (Validation.HostConfigEsxInventory) – The configuration of ESX inventory.

class HostConfigEsxInventory(datastore_name=None, resource_pool_path=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The configuration of ESX inventory.

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 and must have at least 25 GB of free space. Otherwise, the new appliance might not power on.
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 HostConfigRequest(destination_location=None, destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Data container that contains the information needed to validate appliance name.

Tip

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

Parameters

destination_location (Validation.HostConfigDestinationLocation) – This subsection describes the ESX or VC on which to deploy the appliance.
destination_appliance (Validation.HostConfigDestinationAppliance) – Spec to describe the new appliance.

class HostConfigVc(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the vCenter on which to deploy the 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.
inventory (Validation.HostConfigVcInventory) – 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’. You must always provide the ‘network_name’ key. 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’. 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’. 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 HostConfigVcInventory(vm_folder_path=None, resource_pool_path=None, cluster_path=None, host_path=None, datastore_name=None, datastore_cluster_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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’. You must always provide the ‘network_name’ key. 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’. 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’. 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’.

Tip

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

Parameters

vm_folder_path (str or None) – Path of the VM folder. VM folder must be visible by the Data Center of the compute resourceFormat:{vm_folder1}/{vm_folder2}e.g.:’VM Folder 0/VM Folder1’. Mutually exclusive between #resource_pool_path, #cluster_path, and #host_path
resource_pool_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
cluster_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
host_path (str or None) –
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 be accessible from the ESX host and must have at least 25 GB of free space. Otherwise, the new appliance might not power on. 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. Mutually exclusive between #datastore_name and #datastore_cluster_name

class MigrateSourceApplianceRequest(destination_appliance=None, source_vc_windows=None, existing_migration_assistant=None, start_migration_assistant=None, source_vum_location=None, source_vum=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters

destination_appliance (Recommendation.DeploymentSizeDestinationAppliance) – Spec to describe the new appliance.
source_vc_windows (SourceVcWindows) – Spec to describe the existing Windows vCenter server to migrate.
existing_migration_assistant (ExistingMigrationAssistant or None) – Spec to describe the attributes of a running Migration Assistant on the Windows vCenter server. Only applicable when migration assistant is already running on the source appliance
start_migration_assistant (MigrationAssistant or None) – Spec to automate the invocation of Migration Assistant. Automatic invocation works only if the source Windows installation is running as a virtual machine. Only applicable when migration assistant is not running on the source appliance.
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.
source_vum (SourceVum or None) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade. Not applicable for appliance not having source vSphere Update Manager

class NetworkDestinationAppliance(network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters: network (Network) – The network settings of the appliance to be deployed.

class NetworkRequest(destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains network information to be validated.

Tip

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

Parameters: destination_appliance (Validation.NetworkDestinationAppliance) – Spec to describe the new appliance.

class NtpServerDestinationAppliance(time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters: time (Time) – Configuration of the vCSA time synchronization.

class NtpServerRequest(destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

A request that contains the information needed to validate the given ntp servers.

Tip

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

Parameters: destination_appliance (Validation.NtpServerDestinationAppliance) – Spec to describe the new appliance.

class OsPasswordDestinationAppliance(root_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters: 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)

class OsPasswordRequest(destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains information needed to verify the given password conforms password policy.

Tip

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

Parameters: destination_appliance (Validation.OsPasswordDestinationAppliance) – Spec to describe the new appliance.

class SourceLocationRequest(source_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters: source_location (Connection) – The source location configuration

class SourceVumRequest(source_vc_windows=None, source_appliance=None, source_vum_location=None, source_vum=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains information needed to verify the credentials of source vSphere Update Manager and run the migration assistant.

Tip

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

Parameters

source_vc_windows (Validation.SourceVumSourceVcWindows or None) – Spec to describe the existing Windows vCenter server to migrate.
source_appliance (Validation.SourceVumUpgradeSourceAppliance or None) – Source appliance configuration for upgrade service.
source_vum_location (Connection or None) – The configuration to connect to an ESX/VC.
source_vum (SourceVum) – This section describes the source vSphere Update Manager (VUM) which you want to upgrade.

class SourceVumSourceVcWindows(username=None, password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the existing Windows vCenter server to migrate.

Tip

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

Parameters

username (str) – Single Sign-On administrator user on the source Windows vCenter server. For example, administrator\@vsphere.local. Important: The user must be administrator\@your_domain_name.
password (str) – The password of the Single Sign-On administrator on the source Windows vCenter server.

class SourceVumUpgradeSourceAppliance(sso_admin_username=None, sso_admin_password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Source appliance configuration for upgrade service.

Tip

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

Parameters

sso_admin_username (str) – vCenter Single Sign-On administrator user name of the source appliance.
sso_admin_password (str) – vCenter Single Sign-On administrator password of the source appliance.

class SsoConfigurationDestinationAppliance(vcsa_embedded=None, psc=None, vcsa_external=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters

vcsa_embedded (Validation.SsoConfigurationVcsaEmbedded or None) – Configuration of Single Sign-On for deploying Embedded. Mutuall exclusive between embedded, PSC, and management node.
psc (Validation.SsoConfigurationPsc or None) – Configuration of Single Sign-On for deploying PSC. Mutuall exclusive between embedded, PSC, and management node.
vcsa_external (ExternalVcsa or None) – Configuration of Single Sign-On for deploying management node. Mutuall exclusive between embedded, PSC, and management node.

class SsoConfigurationPsc(standalone=None, replicated=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec used to configure a Platform Services Controller. This section describes how the Platform Services Controller appliance should be configured. If unset, either #vcsaEmbedded or #vcsaExternal must be provided.

Tip

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

Parameters

standalone (PscStandalone or None) – Spec used to configure a standalone Platform Services Controller. This section describes how the standalone PSC should be configured. Mutually exclusive between standalone and replicated
replicated (PscReplicated or None) – Spec used to configure a replicated Platform Services Controller. This section describes how the replicated PSC should be configured. Mutually exclusive between standalone and replicated

class SsoConfigurationRequest(destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains information needed to verify the Single Sign-On configuration.

Tip

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

Parameters: destination_appliance (Validation.SsoConfigurationDestinationAppliance) – Destination appliance configuration needed to validate Single Sign-On.

class SsoConfigurationVcsaEmbedded(standalone=None, replicated=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured.

Tip

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

Parameters

standalone (EmbeddedStandaloneVcsa or None) – Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. Mutually exclusive between standalone and replicated
replicated (EmbeddedReplicatedVcsa or None) – Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. Mutually exclusive between standalone and replicated

class TemporaryNetworkDestinationAppliance(network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters: network (TemporaryNetwork) – The network settings of the appliance to be deployed.

class TemporaryNetworkRequest(destination_appliance=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The request that contains network information to be validated.

Tip

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

Parameters: destination_appliance (Validation.TemporaryNetworkDestinationAppliance) – Spec to describe the new appliance.

class UpgradeSourceApplianceDestinationAppliance(ova_location=None, ova_location_ssl_verify=None, ova_location_ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Spec to describe the new appliance.

Tip

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

Parameters

ova_location (str or None) – The location of the ova file. Not required.
ova_location_ssl_verify (bool or None) – A flag to indicate whether the ssl verification is required. If ovaLocationSslThumbprint is provided, this field can be omitted If None, defaults to True
ova_location_ssl_thumbprint (str or None) – SSL thumbprint of ssl verification. If provided, ssl_verify can be omitted or set to true. If omitted, ssl_verify must be false. If omitted and ssl_verify is true, an error will occur. If ova_location_ssl_verify is False, this field can be omitted

class UpgradeSourceApplianceRequest(destination_appliance=None, source_appliance=None, source_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The configuration to validate source appliance for upgrade.

Tip

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

Parameters

destination_appliance (Validation.UpgradeSourceApplianceDestinationAppliance) – Spec to describe the new appliance.
source_appliance (UpgradeSourceAppliance) – The source appliance configuration.
source_location (Connection) – The source location configuration.

class ValidationDestinationLocation(esx=None, vcenter=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This subsection describes the ESX or VC on which to deploy the appliance.

Tip

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

Parameters

esx (Validation.DestinationLocationEsx 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 (Validation.DestinationLocationVc or None) – This subsection describes the vCenter on which to deploy the appliance. Mutual exclusive between esx and vcenter

check_appliance_name_task(spec)¶

Validate the name of the appliance to be deployed.

1. Return False if the there is already an appliance that has the same name as given in the spec exist in the path.

Parameters

spec (Validation.ApplianceNameRequest) – The configuration needed to validate the name of the appliance to be deployed.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_destination_location_task(spec)¶

Validate the ESX of the appliance to be deployed.

Parameters

spec (Validation.DestinationLocationRequest) – The configuration needed to validate the ESX of the appliance to be deployed.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_host_config_task(spec)¶

Validate the host configuration.

1. Return False if the provided appliance type, appliance size, and disk size combination is not valid.
2. Return False if the provided deployment path does not have sufficient memory allocated.
3. Return False if the provided deployment path does not have sufficient cpu allocated.
3. Return False if the provided deployment path does not have sufficient datastore space.

Parameters

spec (Validation.HostConfigRequest) – The configuration needed to validate host configuration.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_migrate_source_appliance_task(spec)¶

Validate the source appliance to be migrated.

1. Return False if the provided source windows vc credentials are incorrect
1. Return False if migration assistant precheck results in error.

Parameters

spec (Validation.MigrateSourceApplianceRequest) – The configuration of the source appliance to be migrated.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_network_task(spec)¶

Check to see if the given network configuration is valid.

1. Return False if the given network will cause conflict.
1. Always return True if network mode is set to DHCP.

Parameters

spec (Validation.NetworkRequest) – The configuration needed to validate network.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_os_password_task(spec)¶

Validate if the given password conforms password policy.

1. Return False if the password in the spec violates password policy

Parameters

spec (Validation.OsPasswordRequest) – The configuration needed to validate the given password against password policy.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_source_vum_task(spec)¶

Validate the source VUM configuration.

Parameters

spec (Validation.SourceVumRequest) – The configuration needed to validate the source VUM.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_temporary_network_task(spec)¶

Check to see if the given network configuration is valid.

1. Return False if the given network will cause conflict.
1. Always return True if network mode is set to DHCP.

Parameters

spec (Validation.TemporaryNetworkRequest) – The configuration needed to validate network.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

check_upgrade_source_appliance_task(spec)¶

Validate the source appliance to be upgraded.

1. Return False if the provided source appliance credentials are incorrect
2. Return False if the provided source location credentials are incorrect.
1. Return False if upgrade runner precheck results in error.
1. Return False if export directory provided is invalid.

Parameters

spec (Validation.UpgradeSourceApplianceRequest) – The configuration of the source appliance to be upgraded.

Return type

class: vmware.vapi.stdlib.client.task.Task

Returns

Task instance

class com.vmware.vcenter.lcm_client.Vc(connection=None, inventory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

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.
inventory (VcInventory) – 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’. You must always provide the ‘network_name’ key. 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’. 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’. 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_client.VcInventory(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

Inventory information about a VCenter.

Tip

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

Parameters

vm_folder_path (str or None) – Path of the VM folder. VM folder must be visible by the Data Center of the compute resourceFormat:{vm_folder1}/{vm_folder2}e.g.:’VM Folder 0/VM Folder1’. Mutually exclusive between #resource_pool_path, #cluster_path, and #host_path
resource_pool_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
cluster_path (str or None) – Full 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 #resource_pool_path, #cluster_path, and #host_path
host_path (str or None) –
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 be accessible from the ESX host and must have at least 25 GB of free space. Otherwise, the new appliance might not power on. 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. Mutually exclusive between #datastore_name and #datastore_cluster_name
network_name (str) – Name of the network. e.g. VM Network

com.vmware.vcenter.ovf_client module¶

The com.vmware.vcenter.ovf_client module provides services to capture and deploy Open Virtualization Format (OVF) packages to and from the content library.

It provides the ability to deploy OVF packages from the content library with support for advanced network topologies, network services, creating virtual appliances and virtual machines in hosts, resource pools or clusters. It also provides the ability to export virtual appliances and virtual machines from hosts, resource pools or clusters as OVF packages to the content library.

class com.vmware.vcenter.ovf_client.CertificateParams(issuer=None, subject=None, is_valid=None, is_self_signed=None, x509=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CertificateParams class contains information about the public key certificate used to sign the OVF package. This class will only be returned if the OVF package is signed.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

issuer (str) – Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
subject (str) – Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
is_valid (bool) – Is the certificate chain validated. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
is_self_signed (bool) – Is the certificate self-signed. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
x509 (str) – The X509 representation of the certificate. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.DeploymentOption(key=None, label=None, description=None, default_choice=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentOption class contains the information about a deployment option as defined in the OVF specification.

This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This class represents one item from that set.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

key (str) – The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
label (str) – A localizable label for the deployment option. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – A localizable description for the deployment option. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
default_choice (bool) – A bool flag indicates whether this deployment option is the default choice. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None or false, it is not the default.

class com.vmware.vcenter.ovf_client.DeploymentOptionParams(deployment_options=None, selected_key=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentOptionParams class describes the possible deployment options as well as the choice provided by the user.

This information based on the ovf:DeploymentOptionSection.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

deployment_options (list of DeploymentOption) – list of deployment options. This attribute corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
selected_key (str) – The selected deployment option. Identifies the DeploymentOption in the list in the deploymentOptions attribute with a matching value in the DeploymentOption.key attribute. This attribute is optional in the input parameters when deploying an OVF package. If None the server will use the default deployment configuration, usually it’s the first one in DeploymentOptionParams.deployment_options list. This attribute is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.DiskProvisioningType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The DiskProvisioningType class defines the virtual disk provisioning types that can be set for a disk on the target platform.

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

eagerZeroedThick = DiskProvisioningType(string='eagerZeroedThick')¶

An eager zeroed thick provisioned virtual disk has all space allocated and wiped clean of any previous contents on the physical media at creation time.

Disks specified as eager zeroed thick may take longer time to create than disks specified with the other disk provisioning types.

thick = DiskProvisioningType(string='thick')¶: A thick provisioned virtual disk has all space allocated at creation time and the space is zeroed on demand as the space is used.

thin = DiskProvisioningType(string='thin')¶: A thin provisioned virtual disk has space allocated and zeroed on demand as the space is used.

class com.vmware.vcenter.ovf_client.ExportFlag(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ExportFlag class provides methods for retrieving information about the export flags supported by the server. Export flags can be specified in a LibraryItem.CreateSpec to customize an OVF export.

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

class Info(option=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExportFlag.Info class describes an export flag supported by the server.

Tip

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

Parameters

option (str) – The name of the export flag that is supported by the server.
description (com.vmware.vapi.std_client.LocalizableMessage) – Localizable description of the export flag.

list()¶

Returns information about the supported export flags by the server.

The supported flags are:

PRESERVE_MAC: Include MAC addresses for network adapters.
EXTRA_CONFIG: Include extra configuration in OVF export.

Future server versions might support additional flags.

Return type

list of ExportFlag.Info

Returns

A list of supported export flags.

Raise

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

Method execution requires System.Read.

class com.vmware.vcenter.ovf_client.ExtraConfig(key=None, value=None, virtual_system_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExtraConfig class contains the information about a vmw:ExtraConfig element which can be used to specify configuration settings that are transferred directly to the .vmx file. The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

vmw:ExtraConfig elements may occur as direct child elements of a VirtualHardwareSection, or as child elements of individual virtual hardware items.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

key (str) – The key of the ExtraConfig element. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
value (str) – The value of the ExtraConfig element. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
virtual_system_id (str) – The identifier of the virtual system containing the vmw:ExtraConfig element. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ExtraConfigParams(extra_configs=None, exclude_keys=None, include_keys=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ExtraConfigParams class contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

extra_configs (list of ExtraConfig) – list of vmw:ExtraConfig elements in the OVF package. This attribute is optional in the input parameters when deploying an OVF package. If None there are no extra configuration elements to use for this OVF package deployment. This attribute will always be present in the result when retrieving information about an OVF package. It will be an empty list if there are no extra configuration elements in the OVF package.
exclude_keys (list of str) –
Specifies which extra configuration items in the list in the extraConfigs field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key attribute. This attribute is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.include_keys. This attribute is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.include_keys.
include_keys (list of str) –
Specifies which extra configuration items in the list in the extraConfigs field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.key attribute. This attribute is optional in the input parameters when deploying an OVF package. It is an error to set both this and ExtraConfigParams.exclude_keys. This attribute is optional in the result when retrieving information about an OVF package. It is an error to set both this and ExtraConfigParams.exclude_keys.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ImportFlag(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ImportFlag class provides methods for retrieving information about the import flags supported by the deployment platform. Import flags can be specified in a LibraryItem.ResourcePoolDeploymentSpec to customize an OVF deployment.

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

class Info(option=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ImportFlag.Info class describes an import flag supported by the deployment platform.

Tip

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

Parameters

option (str) – The name of the import flag that is supported by the deployment platform.
description (com.vmware.vapi.std_client.LocalizableMessage) – Localizable description of the import flag.

list(rp)¶

Returns information about the import flags supported by the deployment platform.

The supported flags are:

LAX: Lax mode parsing of the OVF descriptor.

Future server versions might support additional flags.

Parameters

rp (str) – The identifier of resource pool target for retrieving the import flag(s). The parameter must be an identifier for the resource type: ResourcePool.

Return type

list of ImportFlag.Info

Returns

A list of supported import flags.

Raise

com.vmware.vapi.std.errors_client.NotFound If the resource pool associated with rp does not exist.

Raise

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

Method execution requires System.Read.
The resource ResourcePool referenced by the parameter rp requires System.Read.

class com.vmware.vcenter.ovf_client.IpAllocationParams(supported_allocation_scheme=None, supported_ip_allocation_policy=None, ip_allocation_policy=None, supported_ip_protocol=None, ip_protocol=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The IpAllocationParams class specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment.

Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.

The settings in IpAllocationParams class are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.

This information is based on the vmw:IpAssignmentSection in OVF package.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

supported_allocation_scheme (list of IpAllocationParams.IpAllocationScheme) – Specifies the IP allocation schemes supported by the guest software. This attribute defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See IpAllocationParams.ip_allocation_policy. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
supported_ip_allocation_policy (list of IpAllocationParams.IpAllocationPolicy) – Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the IpAllocationParams.supported_allocation_scheme attribute. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
ip_allocation_policy (IpAllocationParams.IpAllocationPolicy) – Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. This attribute is optional in the input parameters when deploying an OVF package. If None there is no IP allocation policy. This attribute will always be present in the result when retrieving information about an OVF package.
supported_ip_protocol (list of IpAllocationParams.IpProtocol) – Specifies the IP protocols supported by the guest. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
ip_protocol (IpAllocationParams.IpProtocol) – Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See IpAllocationParams.supported_ip_protocol. This attribute is optional in the input parameters when deploying an OVF package. If None there is no IP protocol chosen. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class IpAllocationPolicy(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpAllocationPolicy class defines the possible IP allocation policy for a deployment.

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

DHCP = IpAllocationPolicy(string='DHCP')¶: Specifies that DHCP will be used to allocate IP addresses.

STATIC_IPPOOL = IpAllocationPolicy(string='STATIC_IPPOOL')¶: Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.

STATIC_MANUAL = IpAllocationPolicy(string='STATIC_MANUAL')¶: Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.

TRANSIENT_IPPOOL = IpAllocationPolicy(string='TRANSIENT_IPPOOL')¶: Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.

class IpAllocationScheme(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpAllocationScheme class defines the possible IP allocation schemes that can be supported by the guest software.

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

DHCP = IpAllocationScheme(string='DHCP')¶: It supports DHCP to acquire IP configuration.

OVF_ENVIRONMENT = IpAllocationScheme(string='OVF_ENVIRONMENT')¶: It supports setting the IP configuration through the properties provided in the OVF environment.

class IpProtocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpAllocationParams.IpProtocol class defines the IP protocols supported by the guest software.

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

IPV4 = IpProtocol(string='IPV4')¶: It supports the IPv4 protocol.

IPV6 = IpProtocol(string='IPV6')¶: It supports the IPv6 protocol.

class com.vmware.vcenter.ovf_client.LibraryItem(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The LibraryItem class provides methods to deploy virtual machines and virtual appliances from library items containing Open Virtualization Format (OVF) packages in content library, as well as methods to create library items in content library from virtual machines and virtual appliances.

To deploy a virtual machine or a virtual appliance from a library item:

Create a LibraryItem.DeploymentTarget to specify the target deployment type and target deployment designation.
Create a LibraryItem.ResourcePoolDeploymentSpec to specify the parameters for the target deployment.
Use the deploy method with the created target and parameter specifications, along with the identifier of the specified source content library item. See LibraryItem.deploy().

To create a library item in content library from a virtual machine or virtual appliance:

Create a LibraryItem.DeployableIdentity to specify the source virtual machine or virtual appliance to be used as the OVF template source.
Create a LibraryItem.CreateTarget to specify the target library and library item.
Create a LibraryItem.CreateSpec to specify the settings for the OVF package to be created.
Use the create method with the created target and parameter specifications, along with the specified source entity. See LibraryItem.create().

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

class CreateResult(succeeded=None, ovf_library_item_id=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateResult class defines the result of the create method. See LibraryItem.create().

Tip

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

Parameters

succeeded (bool) – Whether the create method completed successfully.
ovf_library_item_id (str or None) – Identifier of the created or updated library item. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.library.Item. If None, the create method failed and LibraryItem.CreateResult.error will describe the error(s) that caused the failure.
error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the create method. If None, no errors, warnings, or informational messages were reported by the create method.

class CreateSpec(name=None, description=None, flags=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateSpec class defines the information used to create or update a library item containing an OVF package.

Tip

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

Parameters

name (str or None) – Name to use in the OVF descriptor stored in the library item. If None, the server will use source’s current name.
description (str or None) – Description to use in the OVF descriptor stored in the library item. If None, the server will use source’s current annotation.
flags (list of str or None) – Flags to use for OVF package creation. The supported flags can be obtained using ExportFlag.list(). If None, no flags will be used.

class CreateTarget(library_id=None, library_item_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.CreateTarget class specifies the target library item when capturing a virtual machine or virtual appliance as an OVF package in a library item in a content library. The target can be an existing library item, which will be updated, creating a new version, or it can be a newly created library item in a specified library. See LibraryItem.create().

Tip

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

Parameters

library_id (str or None) – Identifier of the library in which a new library item should be created. This attribute is not used if the libraryItemId attribute is specified. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.Library. If None, the libraryItemId attribute must be specified.
library_item_id (str or None) – Identifier of the library item that should be should be updated. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.library.Item. If None, a new library item will be created. The libraryId attribute must be specified if this attribute is None.

DEPLOYABLE = ['VirtualMachine', 'VirtualApp']¶: The types of resources that can be created by deploying an OVF package and can be captured to create a library item using the LibraryItem class.

class DeployableIdentity(type=None, id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeployableIdentity class describes the resource created by a deployment, or the source resource from which library item can be created, by specifying its resource type and resource identifier.

Tip

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

Parameters

type (str) – Type of the deployable resource. When clients pass a value of this class as a parameter, the attribute must be one of VirtualMachine or VirtualApp. When methods return a value of this class as a return value, the attribute will be one of VirtualMachine or VirtualApp.
id (str) – Identifier of the deployable resource. When clients pass a value of this class as a parameter, the attribute must be an identifier for one of these resource types: null or null. When methods return a value of this class as a return value, the attribute will be an identifier for one of these resource types: null or null.

class DeploymentResult(succeeded=None, resource_id=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeploymentResult class defines the result of the deploy method. See LibraryItem.deploy().

Tip

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

Parameters

succeeded (bool) – Whether the deploy method completed successfully.
resource_id (LibraryItem.DeployableIdentity or None) – Identifier of the deployed resource entity. If None, the deploy method failed and LibraryItem.DeploymentResult.error will describe the error(s) that caused the failure.
error (LibraryItem.ResultInfo or None) – Errors, warnings, and informational messages produced by the deploy method. If None, no errors, warnings, or informational messages were reported by the deploy method.

class DeploymentTarget(resource_pool_id=None, host_id=None, folder_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.DeploymentTarget class describes the location (target) where a virtual machine or virtual appliance should be deployed. It is used in the deploy and filter methods. See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

resource_pool_id (str) – Identifier of the resource pool to which the virtual machine or virtual appliance should be attached. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ResourcePool. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ResourcePool.
host_id (str or None) – Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by LibraryItem.DeploymentTarget.resource_pool_id. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. If None, the server will automatically select a target host from the resource pool if LibraryItem.DeploymentTarget.resource_pool_id is a stand-alone host or a cluster with Distributed Resource Scheduling (DRS) enabled.
folder_id (str or None) – Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Folder. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Folder. If None, the server will choose the deployment folder.

class OvfSummary(name=None, annotation=None, eulas=None, networks=None, storage_groups=None, additional_params=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.OvfSummary class defines the result of the filter method. See LibraryItem.filter(). The attributes in the class describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy method. See LibraryItem.deploy().

Tip

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

Parameters

name (str or None) – Default name for the virtual machine or virtual appliance. If None, the OVF descriptor did not specify a name.
annotation (str or None) – Default annotation for the virtual machine or virtual appliance. If None, the OVF descriptor did not specify an annotation.
eulas (list of str) – End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the deploy method to succeed. See LibraryItem.ResourcePoolDeploymentSpec.accept_all_eula.
networks (list of str or None) – Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.network_mappings. If None, the OVF descriptor did not specify any networks.
storage_groups (list of str or None) – Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.storage_mappings. If None, the OVF descriptor did not specify any storage groups.
additional_params (list of vmware.vapi.struct.VapiStruct or None) – Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItem.ResourcePoolDeploymentSpec.additional_parameters for the deploy method. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in OvfParams. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in OvfParams. If None, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.

class ResourcePoolDeploymentSpec(name=None, annotation=None, accept_all_eula=None, network_mappings=None, storage_mappings=None, storage_provisioning=None, storage_profile_id=None, locale=None, flags=None, additional_parameters=None, default_datastore_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.ResourcePoolDeploymentSpec class defines the deployment parameters that can be specified for the deploy method where the deployment target is a resource pool. See LibraryItem.deploy().

Tip

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

Parameters

name (str or None) – Name assigned to the deployed target virtual machine or virtual appliance. If None, the server will use the name from the OVF package.
annotation (str or None) – Annotation assigned to the deployed target virtual machine or virtual appliance. If None, the server will use the annotation from the OVF package.
accept_all_eula (bool) – Whether to accept all End User License Agreements. See LibraryItem.OvfSummary.eulas.
network_mappings ((dict of str and str) or None) – Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the dict is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. When clients pass a value of this class as a parameter, the value in the attribute dict must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the value in the attribute dict will be an identifier for the resource type: Network. If None, the server will choose a network mapping.
storage_mappings ((dict of str and LibraryItem.StorageGroupMapping) or None) – Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the dict is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See LibraryItem.StorageGroupMapping. If None, the server will choose a storage mapping.
storage_provisioning (DiskProvisioningType or None) – Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor. If None, the server will choose the provisioning type.
storage_profile_id (str or None) – Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: StorageProfile. If None, the server will choose the default profile.
locale (str or None) – The locale to use for parsing the OVF descriptor. If None, the server locale will be used.
flags (list of str or None) – Flags to be use for deployment. The supported flag values can be obtained using ImportFlag.list(). If None, no flags will be used.
additional_parameters (list of vmware.vapi.struct.VapiStruct or None) –
Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this attribute include, but are not limited to:
When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in OvfParams. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in OvfParams. If None, the server will choose default settings for all parameters necessary for the deploy method. See LibraryItem.deploy().
default_datastore_id (str or None) – Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. If None, the server will choose the default datastore.

class ResultInfo(errors=None, warnings=None, information=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.ResultInfo class defines the information returned along with the result of a create or deploy method to describe errors, warnings, and informational messages produced by the server.

Tip

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

Parameters

errors (list of OvfError) – Errors reported by the create or deploy method. These errors would have prevented the create or deploy method from completing successfully.
warnings (list of OvfWarning) – Warnings reported by the create or deploy method. These warnings would not have prevented the create or deploy method from completing successfully, but there might be issues that warrant attention.
information (list of OvfInfo) – Information messages reported by the create or deploy method. For example, a non-required parameter was ignored.

class StorageGroupMapping(type=None, datastore_id=None, storage_profile_id=None, provisioning=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItem.StorageGroupMapping class defines the storage deployment target and storage provisioning type for a section of type vmw:StorageGroupSection in the OVF descriptor.

Tip

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

Parameters

type (LibraryItem.StorageGroupMapping.Type) – Type of storage deployment target to use for the vmw:StorageGroupSection section. The specified value must be LibraryItem.StorageGroupMapping.Type.DATASTORE or LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.
datastore_id (str) – Target datastore to be used for the storage group. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is optional and it is only relevant when the value of type is LibraryItem.StorageGroupMapping.Type.DATASTORE.
storage_profile_id (str) – Target storage profile to be used for the storage group. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItem.StorageGroupMapping.Type.STORAGE_PROFILE.
provisioning (DiskProvisioningType or None) – Target provisioning type to use for the storage group. If None, LibraryItem.ResourcePoolDeploymentSpec.storage_provisioning will be used.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LibraryItem.StorageGroupMapping.Type class defines the supported types of storage targets for sections of type vmw:StorageGroupSection in the OVF descriptor.

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

DATASTORE = Type(string='DATASTORE')¶: Storage deployment target is a datastore.

STORAGE_PROFILE = Type(string='STORAGE_PROFILE')¶: Storage deployment target is a storage profile.

create(source, target, create_spec, client_token=None)¶

Creates a library item in content library from a virtual machine or virtual appliance.

This method creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this method, the original content is overwritten.

Parameters

client_token (str or None) – Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If None, the server will create a token.
source (LibraryItem.DeployableIdentity) – Identifier of the virtual machine or virtual appliance to use as the source.
target (LibraryItem.CreateTarget) – Specification of the target content library and library item.
create_spec (LibraryItem.CreateSpec) – Information used to create the OVF package from the source virtual machine or virtual appliance.

Return type

LibraryItem.CreateResult

Returns

Information about the success or failure of the method, along with the details of the result or failure.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if create_spec contains invalid arguments.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if source describes an unexpected resource type.

Raise

com.vmware.vapi.std.errors_client.NotFound if the virtual machine or virtual appliance specified by source does not exist.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library or library item specified by target does not exist.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation cannot be performed because of the specified virtual machine or virtual appliance’s current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there was an error accessing a file from the source virtual machine or virtual appliance.

Raise

com.vmware.vapi.std.errors_client.ResourceBusy if the specified virtual machine or virtual appliance is busy.

Raise

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

Method execution requires System.Read.
The resource null or null referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export.
The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library_id requires ContentLibrary.AddLibraryItem.
The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library_item_id requires System.Read.

deploy(ovf_library_item_id, target, deployment_spec, client_token=None)¶

Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance.

This method deploys an OVF package which is stored in the library item specified by ovf_library_item_id. It uses the deployment specification in deployment_spec to deploy the OVF package to the location specified by target.

Parameters

client_token (str or None) – Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If None, the server will create a token.
ovf_library_item_id (str) – Identifier of the content library item containing the OVF package to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
target (LibraryItem.DeploymentTarget) – Specification of the deployment target.
deployment_spec (LibraryItem.ResourcePoolDeploymentSpec) – Specification of how the OVF package should be deployed to the target.

Return type

LibraryItem.DeploymentResult

Returns

Information about the success or failure of the method, along with the details of the result or failure.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if target contains invalid arguments.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if deployment_spec contains invalid arguments or has attributes that are inconsistent with target.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library item specified by ovf_library_item_id does not exist.

Raise

com.vmware.vapi.std.errors_client.NotFound if any resource specified by a attribute of the LibraryItem.DeploymentTarget class, specified by target, does not exist.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there was an error accessing the OVF package stored in the library item specified by ovf_library_item_id.

Raise

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

Method execution requires VirtualMachine.Config.AddNewDisk if the OVF descriptor has a disk drive (type 17) section.
Method execution requires VirtualMachine.Config.AdvancedConfig if the OVF descriptor has an ExtraConfig section.
Method execution requires Extension.Register for specified resource group if the OVF descriptor has a vServiceDependency section.
Method execution requires Network.Assign for target network if specified.
Method execution requires Datastore.AllocateSpace for target datastore if specified.

Raise

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

Method execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter ovf_library_item_id requires System.Read.
The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host_id requires System.Read.
The resource Network referenced by the dict value of attribute LibraryItem.ResourcePoolDeploymentSpec.network_mappings requires System.Read.
The resource StorageProfile referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.storage_profile_id requires System.Read.
The resource Datastore referenced by the attribute LibraryItem.ResourcePoolDeploymentSpec.default_datastore_id requires System.Read.
The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource_pool_id requires VApp.Import.
The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder_id requires VApp.Import.

filter(ovf_library_item_id, target)¶

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy().

This method retrieves information from the descriptor of the OVF package stored in the library item specified by ovf_library_item_id. The information returned by the method can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.

Parameters

ovf_library_item_id (str) – Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
target (LibraryItem.DeploymentTarget) – Specification of the deployment target.

Return type

LibraryItem.OvfSummary

Returns

Information that can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if target contains invalid arguments.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library item specified by ovf_library_item_id does not exist.

Raise

com.vmware.vapi.std.errors_client.NotFound if any resource specified by a attribute of the LibraryItem.DeploymentTarget class, specified by target, does not exist.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there was an error accessing the OVF package at the specified ovf_library_item_id.

Raise

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

Method execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter ovf_library_item_id requires System.Read.
The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource_pool_id requires System.Read.
The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host_id requires System.Read.
The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder_id requires System.Read.

class com.vmware.vcenter.ovf_client.OvfError(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfError class describes an error related to accessing, validating, deploying, or exporting an OVF package.

Tip

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

Parameters

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class com.vmware.vcenter.ovf_client.OvfInfo(messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfInfo class contains informational messages related to accessing, validating, deploying, or exporting an OVF package.

Tip

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

Parameters: messages (list of com.vmware.vapi.std_client.LocalizableMessage) – A list of localizable messages (see com.vmware.vapi.std_client.LocalizableMessage).

class com.vmware.vcenter.ovf_client.OvfMessage(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfMessage class describes a base OVF handling error message related to accessing, validating, deploying, or exporting an OVF package.

These messages fall into different categories defined in OvfMessage.Category:

Tip

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

Parameters

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class Category(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The OvfMessage.Category class defines the categories of messages (see OvfMessage).

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.

INPUT = Category(string='INPUT')¶: The user provided input parameters are invalid.

SERVER = Category(string='SERVER')¶: Server error.

VALIDATION = Category(string='VALIDATION')¶: The OVF descriptor is invalid, for example, syntax errors or schema errors.

class com.vmware.vcenter.ovf_client.OvfParams(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfParams class defines the common attributes for all OVF deployment parameters. OVF parameters serve several purposes:

Describe information about a given OVF package.
Describe default deployment configuration.
Describe possible deployment values based on the deployment environment.
Provide deployment-specific configuration.

Each OVF parameters class specifies a particular configurable aspect of OVF deployment. An aspect has both a query-model and a deploy-model. The query-model is used when the OVF package is queried, and the deploy-model is used when deploying an OVF package.

Most OVF parameter classes provide both informational and deployment parameters. However, some are purely informational (for example, download size) and some are purely deployment parameters (for example, the flag to indicate whether registration as a vCenter extension is accepted).

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters: type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.OvfWarning(category=None, issues=None, name=None, value=None, message=None, error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The OvfWarning class describes a warning related to accessing, validating, deploying, or exporting an OVF package.

Tip

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

Parameters

category (OvfMessage.Category) – The message category.
issues (list of ParseIssue) – list of parse issues (see ParseIssue). This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.VALIDATION.
name (str) – The name of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
value (str) – The value of input parameter. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.INPUT.
error (vmware.vapi.struct.VapiStruct) – Represents a server com.vmware.vapi.std.errors_client.Error. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. When methods return a value of this class as a return value, the attribute will contain all the attributes defined in com.vmware.vapi.std.errors_client.Error. This attribute is optional and it is only relevant when the value of category is OvfMessage.Category.SERVER.

class com.vmware.vcenter.ovf_client.ParseIssue(category=None, file=None, line_number=None, column_number=None, message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ParseIssue class contains the information about the issue found when parsing an OVF package during deployment or exporting an OVF package including:

Parsing and validation error on OVF descriptor (which is an XML document), manifest and certificate files.
OVF descriptor generating and device error.
Unexpected server error.

Tip

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

Parameters

category (ParseIssue.Category) – The category of the parse issue.
file (str) – The name of the file in which the parse issue was found.
line_number (long) – The line number of the line in the file (see ParseIssue.file) where the parse issue was found (or -1 if not applicable).
column_number (long) – The position in the line (see ParseIssue.line_number) (or -1 if not applicable).
message (com.vmware.vapi.std_client.LocalizableMessage) – A localizable message describing the parse issue.

class Category(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ParseIssue.Category class defines the categories of issues that can be found when parsing files inside an OVF package (see ParseIssue) including OVF descriptor (which is an XML document), manifest and certificate files, or exporting an OVF package.

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.

ATTRIBUTE_ILLEGAL = Category(string='ATTRIBUTE_ILLEGAL')¶: Illegal attribute error. It indicates that an illegal attribute is set for an element in the OVF descriptor. For example, empty disks do not use format, parentRef, and populatedSize attributes, if these attributes are present in an empty disk element then will get this pasrse issue.

ATTRIBUTE_REQUIRED = Category(string='ATTRIBUTE_REQUIRED')¶: Required attribute error. It indicates that a required attribute is missing from an element in the OVF descriptor.

ELEMENT_ILLEGAL = Category(string='ELEMENT_ILLEGAL')¶: Illegal element error. It indicates that an element is present in a location which is not allowed, or found multiple elements but only one is allowed at the location in the OVF descriptor.

ELEMENT_REQUIRED = Category(string='ELEMENT_REQUIRED')¶: Required element error. It indicates that a required element is missing from the OVF descriptor.

ELEMENT_UNKNOWN = Category(string='ELEMENT_UNKNOWN')¶: Unknown element error. It indicates that an element is unsupported when parsing an OVF descriptor.

EXPORT_ERROR = Category(string='EXPORT_ERROR')¶: Issue during OVF export, for example, malformed deviceId, controller not found, or file backing for a device not found.

GENERATE_ERROR = Category(string='GENERATE_ERROR')¶: OVF descriptor (which is an XML document) generating error, for example, well-formedness errors as well as unexpected processing conditions.

INTERNAL_ERROR = Category(string='INTERNAL_ERROR')¶: Server encountered an unexpected error which prevented it from fulfilling the request.

PARSE_ERROR = Category(string='PARSE_ERROR')¶

OVF package parsing error, including:

OVF descriptor parsing errors, for example, syntax errors or schema errors.
Manifest file parsing and verification errors.
Certificate file parsing and verification errors.

SECTION_RESTRICTION = Category(string='SECTION_RESTRICTION')¶: Section restriction error. It indicates that a section appears in place in the OVF descriptor where it is not allowed, a section appears fewer times than is required, or a section appears more times than is allowed.

SECTION_UNKNOWN = Category(string='SECTION_UNKNOWN')¶: Section unknown error. It indicates that a section is unsupported when parsing an OVF descriptor.

VALIDATION_ERROR = Category(string='VALIDATION_ERROR')¶: An issue with the manifest and signing.

VALUE_ILLEGAL = Category(string='VALUE_ILLEGAL')¶: Illegal value error. For example, the value is malformed, not a number, or outside of the given range, and so on.

class com.vmware.vcenter.ovf_client.Property(class_id=None, id=None, instance_id=None, category=None, ui_optional=None, label=None, description=None, type=None, value=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Property class contains the information about a property in an OVF package.

A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see Property.class_id, Property.id, and Property.instance_id). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

class_id (str) – The classId of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
id (str) – The identifier of this OVF property. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
instance_id (str) – The instanceId of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
category (str) – If this is set to a non-empty string, this property starts a new category. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None, the property is in the same category as the previous item, otherwise, it starts a new category.
ui_optional (bool) –
Whether a category is UI optional. This is only used if this property starts a new category (see Property.category).

The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package.
label (str) – The display name of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – A description of this OVF property. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package.
type (str) – The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
value (str) – The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.PropertyParams(properties=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PropertyParams class contains a list of OVF properties that can be configured when the OVF package is deployed.

This is based on the ovf:ProductSection.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

properties (list of Property) – list of OVF properties. This attribute is optional in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.ScaleOutGroup(id=None, description=None, instance_count=None, minimum_instance_count=None, maximum_instance_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScaleOutGroup class contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

This is based on the ovf2:ScaleOutSection.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

id (str) – The identifier of the scale-out group. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
description (str) – The description of the scale-out group. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
instance_count (long) – The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
minimum_instance_count (long) – The minimum scaling factor. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.
maximum_instance_count (long) – The maximum scaling factor. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. This will be None if there is no explicit limit.

class com.vmware.vcenter.ovf_client.ScaleOutParams(groups=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ScaleOutParams class contains information about the scale-out groups described in the OVF package.

When deploying an OVF package, a deployment specific instance count can be specified (see ScaleOutGroup.instance_count.

This is based on the ovf2:ScaleOutSection.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

groups (list of ScaleOutGroup) – The list of scale-out groups. This attribute is optional in the input parameters when deploying an OVF package. If None there are no scale-out groups. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.SizeParams(approximate_download_size=None, approximate_flat_deployment_size=None, approximate_sparse_deployment_size=None, variable_disk_size=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The SizeParams class contains estimates of the download and deployment sizes.

This information is based on the file references and the ovf:DiskSection in the OVF descriptor.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

approximate_download_size (long) –
A best guess as to the total amount of data that must be transferred to download the OVF package.

This may be inaccurate due to disk compression etc.

This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
approximate_flat_deployment_size (long) – A best guess as to the total amount of space required to deploy the OVF package if using flat disks. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
approximate_sparse_deployment_size (long) – A best guess as to the total amount of space required to deploy the OVF package using sparse disks. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. It will be None if there is insufficient information to provide a proper estimate.
variable_disk_size (bool) –
Whether the OVF uses variable disk sizes.

For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package. This attribute is not used in the input parameters when deploying an OVF package. This attribute is optional in the result when retrieving information about an OVF package. If None or false, the OVF does not use variable disk sizes.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_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.ovf_client.UnknownSection(tag=None, info=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The UnknownSection class contains information about an unknown section in an OVF package.

Tip

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

Parameters

tag (str) – A namespace-qualified tag in the form {ns}tag.
info (str) – The description of the Info element.

class com.vmware.vcenter.ovf_client.UnknownSectionParams(unknown_sections=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The UnknownSectionParams class contains a list of unknown, non-required sections.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

unknown_sections (list of UnknownSection) – list of unknown, non-required sections. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

class com.vmware.vcenter.ovf_client.VcenterExtensionParams(required=None, registration_accepted=None, type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The VcenterExtensionParams class specifies that the OVF package should be registered as a vCenter extension. The virtual machine or virtual appliance will gain unrestricted access to the vCenter Server APIs. It must be connected to a network with connectivity to the vCenter server.

See LibraryItem.deploy() and LibraryItem.filter().

Tip

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

Parameters

required (bool) – Whether registration as a vCenter extension is required. This attribute is not used in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
registration_accepted (bool) –
Whether registration as a vCenter extension is accepted.

If registration as a vCenter extension is required (see VcenterExtensionParams.required), this must be set to true during deployment. Defaults to false when returned from server. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.
type (str) – Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This attribute must be provided in the input parameters when deploying an OVF package. This attribute will always be present in the result when retrieving information about an OVF package.

com.vmware.vcenter.services_client module¶

class com.vmware.vcenter.services_client.Service(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Service class provides methods to manage a single/set of vCenter Server services. This class was added in vSphere API 6.7.

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

class Health(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.Health class defines the possible values for health of a service. This enumeration was added in vSphere API 6.7.

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

DEGRADED = Health(string='DEGRADED')¶: Service is in degraded state, it is not functional. This class attribute was added in vSphere API 6.7.

HEALTHY = Health(string='HEALTHY')¶: Service is in a healthy state and is fully functional. This class attribute was added in vSphere API 6.7.

HEALTHY_WITH_WARNINGS = Health(string='HEALTHY_WITH_WARNINGS')¶: Service is healthy with warnings. This class attribute was added in vSphere API 6.7.

class Info(name_key=None, description_key=None, startup_type=None, state=None, health=None, health_messages=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Service.Info class contains information about a service. This class was added in vSphere API 6.7.

Tip

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

Parameters

name_key (str) – Service name key. Can be used to lookup resource bundle. This attribute was added in vSphere API 6.7.
description_key (str) – Service description key. Can be used to lookup resource bundle. This attribute was added in vSphere API 6.7.
startup_type (Service.StartupType) – Startup Type. This attribute was added in vSphere API 6.7.
state (Service.State) – Running State. This attribute was added in vSphere API 6.7.
health (Service.Health) – Health of service. This attribute was added in vSphere API 6.7. This attribute is optional and it is only relevant when the value of state is Service.State.STARTED.
health_messages (list of com.vmware.vapi.std_client.LocalizableMessage) – Localizable messages associated with the health of the service. This attribute was added in vSphere API 6.7. This attribute is optional and it is only relevant when the value of state is Service.State.STARTED.

class StartupType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.StartupType class defines valid Startup Type for vCenter Server services. This enumeration was added in vSphere API 6.7.

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

AUTOMATIC = StartupType(string='AUTOMATIC')¶: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it. This class attribute was added in vSphere API 6.7.

DISABLED = StartupType(string='DISABLED')¶: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic. This class attribute was added in vSphere API 6.7.

MANUAL = StartupType(string='MANUAL')¶: Service Startup type is Manual, thus issuing an explicit start on the service will start it. This class attribute was added in vSphere API 6.7.

class State(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Service.State class defines valid Run State for services. This enumeration was added in vSphere API 6.7.

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.

STARTED = State(string='STARTED')¶: Service Run State is Started, it is fully functional. This class attribute was added in vSphere API 6.7.

STARTING = State(string='STARTING')¶: Service Run State is Starting, it is still not functional. This class attribute was added in vSphere API 6.7.

STOPPED = State(string='STOPPED')¶: Service Run State is Stopped. This class attribute was added in vSphere API 6.7.

STOPPING = State(string='STOPPING')¶: Service Run State is Stopping, it is not functional. This class attribute was added in vSphere API 6.7.

class UpdateSpec(startup_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Service.UpdateSpec class describes the changes to be made to the configuration of the service. This class was added in vSphere API 6.7.

Tip

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

Parameters: startup_type (Service.StartupType or None) – Startup Type. This attribute was added in vSphere API 6.7. If unspecified, leaves value unchanged.

get(service)¶

Returns the state of a service. This method was added in vSphere API 6.7.

Parameters: service (str) – identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Return type: Service.Info
Returns: Service Info structure.
Raise: com.vmware.vapi.std.errors_client.NotFound if the service associated with service does not exist.
Raise: com.vmware.vapi.std.errors_client.Error if any other error occurs during the execution of the operation.

list_details()¶

Lists details of vCenter services. This method was added in vSphere API 6.7.

Return type: dict of str and Service.Info
Returns: Map of service identifiers to service Info structures. The key in the return value dict will be an identifier for the resource type: com.vmware.vcenter.services.Service.
Raise: com.vmware.vapi.std.errors_client.Error if any error occurs during the execution of the operation.

restart(service)¶

Restarts a service. This method was added in vSphere API 6.7.

Parameters: service (str) – identifier of the service to restart The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Raise: com.vmware.vapi.std.errors_client.NotFound if the service associated with service does not exist.
Raise: com.vmware.vapi.std.errors_client.TimedOut if any timeout occurs during the execution of the restart operation.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation is denied in the current state of the service. If a stop or start operation is in progress, issuing a restart operation will lead to this error.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if a restart operation is issued on a service which has startup type Service.StartupType.DISABLED
Raise: com.vmware.vapi.std.errors_client.Error if any other error occurs during the execution of the operation.

start(service)¶

Starts a service. This method was added in vSphere API 6.7.

Parameters: service (str) – identifier of the service to start The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Raise: com.vmware.vapi.std.errors_client.NotFound if the service associated with service does not exist.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation is denied in the current state of the service. If a stop or restart operation is in progress, the start operation will not be allowed.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if start operation is issued on a service which has startup type Service.StartupType.DISABLED.
Raise: com.vmware.vapi.std.errors_client.TimedOut if any timeout occurs during the execution of the start operation. Timeout occurs when the service takes longer than StartTimeout to start.
Raise: com.vmware.vapi.std.errors_client.Error if any other error occurs during the execution of the operation.

stop(service)¶

Stops a service. This method was added in vSphere API 6.7.

Parameters: service (str) – identifier of the service to stop The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
Raise: com.vmware.vapi.std.errors_client.NotFound if the service associated with service does not exist.
Raise: com.vmware.vapi.std.errors_client.Error if any other error occurs during the execution of the operation.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation is denied in the current state of the service. If a stop operation is in progress, issuing another stop operation will lead to this error.

update(service, spec)¶

Updates the properties of a service. This method was added in vSphere API 6.7.

Parameters

service (str) – identifier of the service whose properties are being updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.services.Service.
spec (Service.UpdateSpec) – Service Update specification.

Raise

com.vmware.vapi.std.errors_client.NotFound if the service associated with service does not exist.

Raise

com.vmware.vapi.std.errors_client.Error if any other error occurs during the execution of the operation.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation is denied in the current state of the service. If a start, stop or restart operation is in progress, update operation will fail with this error.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if a request to set the Service.UpdateSpec.startup_type attribute of spec to Service.StartupType.DISABLED comes in for a service that is not in Service.State.STOPPED state.

class com.vmware.vcenter.services_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.storage_client module¶

class com.vmware.vcenter.storage_client.Policies(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Policies class provides methods for managing the storage policies. This class was added in vSphere API 6.7.

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

class CompatibilityInfo(compatible_datastores=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policies.CompatibilityInfo class contains info about a list of datastores compatible with a specific storage policy. This class was added in vSphere API 6.7.

Tip

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

Parameters: compatible_datastores (list of Policies.CompatibleDatastoreInfo) – Info about a list of datastores compatible with a specific storage policy. This attribute was added in vSphere API 6.7.

class CompatibleDatastoreInfo(datastore=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policies.CompatibleDatastoreInfo class contains compatible datastore’s information. This class was added in vSphere API 6.7.

Tip

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

Parameters: datastore (str) – Identifier of the datastore. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore.

class FilterSpec(policies=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policies.FilterSpec class contains attributes used to filter the results when listing the storage policies (see Policies.list()). This class was added in vSphere API 6.7.

Tip

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

Parameters: policies (set of str or None) – Identifiers of storage policies that can match the filter. This attribute was added in vSphere API 6.7. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.StoragePolicy. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.StoragePolicy. If None or empty, storage policies with any identifiers match the filter.

RESOURCE_TYPE = 'com.vmware.vcenter.StoragePolicy'¶: Resource type for vAPI metadata policy. This class attribute was added in vSphere API 6.7.

class Summary(policy=None, name=None, description=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Policies.Summary class contains commonly used information about a storage policy. This class was added in vSphere API 6.7.

Tip

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

Parameters

policy (str) – Identifier of the storage policy. This attribute was added in vSphere API 6.7. 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.
name (str) – Name of the storage policy. This attribute was added in vSphere API 6.7.
description (str) – Description of the storage policy. This attribute was added in vSphere API 6.7.

check_compatibility(policy, datastores)¶

Returns datastore compatibility summary about a specific storage policy. This method was added in vSphere API 6.7.

Parameters

policy (str) – The storage policy identifier The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.
datastores (set of str) – Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore.

Return type

Policies.CompatibilityInfo

Returns

datastore compatibility summary about a specific storage policy.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.NotFound if the storage policy specified does not exist.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

Raise

com.vmware.vapi.std.errors_client.UnableToAllocateResource if input more than 1024 datastores.

list(filter=None)¶

Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. This method was added in vSphere API 6.7.

Parameters: filter (Policies.FilterSpec or None) – Specification of matching storage policies for which information should be returned. If None, the behavior is equivalent to a Policies.FilterSpec with all attributes None which means all storage policies match the filter
Return type: list of Policies.Summary
Returns: Commonly used Information about the storage policies.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if the Policies.FilterSpec contains a value that is not supported by the server.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.
Raise: com.vmware.vapi.std.errors_client.UnableToAllocateResource if more than 1024 storage policies exist.

class com.vmware.vcenter.storage_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.system_config_client module¶

class com.vmware.vcenter.system_config_client.DeploymentType(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The DeploymentType class provides methods to get/set the type of the appliance. This class was added in vSphere API 6.7.

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

class ConvergenceSpec(psc=None, replication_partner_hostname=None, only_precheck=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentType.ConvergenceSpec class contains information used for vCenter external to embedded PSC convergence operation. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

psc (DeploymentType.PscInfo) – The information about the Platform Service Controller. This attribute was added in vSphere API 6.7.2.
replication_partner_hostname (str or None) – The (earlier converged) embedded node with which the Platform Services Controller replication has to be set during convergence. This attribute was added in vSphere API 6.7.2. If set then the converged embedded node will be set in replication mode with this node.
only_precheck (bool or None) – Flag to pass if only pre-check to be performed. This attribute was added in vSphere API 6.7.2. If set will perform only pre-checks.

class DomainInfo(ad_domain_name=None, ad_domain_admin_username=None, ad_domain_admin_password=None, dns_server=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentType.DomainInfo class contains information used to join the converged node to the AD domain. This is used when participating PSC node is already joined to AD. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

ad_domain_name (str) – The Platform Services Controller node’s AD domain name if exits. This attribute was added in vSphere API 6.7.2.
ad_domain_admin_username (str) – The AD domain username with privileges to join any machine to the provided domain. This attribute was added in vSphere API 6.7.2.
ad_domain_admin_password (str) – AD domain password with privileges to join any machine to the provided domain. This attribute was added in vSphere API 6.7.2.
dns_server (str) – IP address of the DNS server of the Active Directory server. This attribute was added in vSphere API 6.7.2.

class Info(type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentType.Info class contains the fields used to get the appliance type. This class was added in vSphere API 6.7.

Tip

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

Parameters: type (com.vmware.vcenter.deployment_client.ApplianceType) – The type of the appliance. This attribute was added in vSphere API 6.7.

class PscInfo(sso_admin_username=None, sso_admin_password=None, skip_ad_domain_join=None, ad_domain=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentType.PscInfo class contains information about Platform Services Controller node participating in reconfiguration. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

sso_admin_username (str) – The SSO administrator username for example “administrator\@vsphere.local”. This attribute was added in vSphere API 6.7.2.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.2.
skip_ad_domain_join (bool or None) – A flag to skip domain join operation for embedded node during convergence. If the Platform Services Controller node is joined to an AD domain, the same is expected to be configured for converged embedded node, but there can be situations (e.g. no domain admin credentials with VI admin) during convergence when needs to be done later via existing UI option. This attribute was added in vSphere API 6.7.2. If set will skip AD domain join operations
ad_domain (DeploymentType.DomainInfo or None) – Information about the domain which Platform Services Controller node is joined to. The reconfigured machine will be joined to the same domain. This attribute was added in vSphere API 6.7.2. If set then converged embedded node will be joined to this AD domain.

class ReconfigureSpec(type=None, remote_psc=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DeploymentType.ReconfigureSpec class contains the fields used to get and set the appliance type. This class was added in vSphere API 6.7.

Tip

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

Parameters

type (com.vmware.vcenter.deployment_client.ApplianceType) – The type of the appliance. This attribute was added in vSphere API 6.7.
remote_psc (com.vmware.vcenter.deployment_client.RemotePscSpec or None) – External PSC to register with when reconfiguring a VCSA_EMBEDDED appliance to a VCSA_EXTERNAL appliance. This attribute was added in vSphere API 6.7. Only required when reconfiguring an VCSA_EMBEDDED node to a VCSA_EXTERNAL.

convert_to_vcsa_embedded_task(spec)¶

Convert the type of the vCenter appliance to vCSA embedded. This method was added in vSphere API 6.7.2.

Parameters: spec (DeploymentType.ConvergenceSpec) – ConvergenceSpec to provide all needed information for convergence operation.
Raise: com.vmware.vapi.std.errors_client.Unsupported if the appliance is in not a management node.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is already an embedded node.

get()¶

Get the type of the vCenter appliance. This method was added in vSphere API 6.7.

Return type: DeploymentType.Info
Returns: The type of the vCenter appliance.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if appliance is not in CONFIGURED state.

reconfigure(spec)¶

Reconfigure the type of the vCenter appliance. This method was added in vSphere API 6.7.

Parameters: spec (DeploymentType.ReconfigureSpec) – ReconfigureSpec to set the appliance type.
Raise: com.vmware.vapi.std.errors_client.Unsupported if the appliance is in CONFIGURED state and if not changing the type from VCSA_EMBEDDED to VCSA_EXTERNAL.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if external PSC credentials are not valid.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is not in INITIALIZED or CONFIGURED state.

class com.vmware.vcenter.system_config_client.PscRegistration(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The PscRegistration class provides methods to get and set the PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This class was added in vSphere API 6.7.

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

class Info(address=None, https_port=None, sso_domain=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PscRegistration.Info class has fields to specify information about the PSC node. This class was added in vSphere API 6.7.

Tip

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

Parameters

address (str) – The IP address or DNS resolvable name of the PSC this appliance is registered with. This attribute was added in vSphere API 6.7.
https_port (long) – The HTTPs port used by the external PSC. This attribute was added in vSphere API 6.7.
sso_domain (str) – The Single Sign-On domain name of the external PSC. This attribute was added in vSphere API 6.7.

get()¶

Get information of the PSC that this appliance is registered with. This method was added in vSphere API 6.7.

Return type: PscRegistration.Info
Returns: Info structure containing information about the external PSC node this appliance is registered with.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is in NOT_INITIALIZED state.

repoint(spec)¶

Repoint this vCenter Server appliance to a different external PSC. This method was added in vSphere API 6.7.

Parameters: spec (com.vmware.vcenter.deployment_client.RemotePscSpec) – RemotePscSpec structure containing information about the external PSC node to repoint this vCenter Server appliance to.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the passed external PSC credentials is invalid.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if the passed external PSC is not a replicating with the current PSC this appliance is registered with.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.
Raise: com.vmware.vapi.std.errors_client.Unsupported if the current appliance is not of the type VCSA_EXTERNAL.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the appliance is NOT in CONFIGURED state.

class com.vmware.vcenter.system_config_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.tokenservice_client module¶

The com.vmware.vcenter.tokenservice_client module provides Token classes.

exception com.vmware.vcenter.tokenservice_client.Error(messages=None, data=None)¶

Bases: vmware.vapi.bindings.error.VapiError

The Error exception describes theattributes common to all standard exceptions.

This exception serves two purposes:

It is the exception that clients in many programming languages can catch to handle all standard exceptions. Typically those clients will display one or more of the localizable messages from Error.messages to a human.
It is the exception that methods can report when they need to report some exception, but the exception doesn’t fit into any other standard exception, and in fact the only reasonable way for a client to react to the exception is to display the message(s) to a human.

Tip

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

Parameters

messages (list of com.vmware.vapi.std_client.LocalizableMessage) –
Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the “cause” of the prior message.
data (vmware.vapi.struct.VapiStruct or None) –
Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports. The null, null, and null classes are intended as possible values for this attribute. com.vmware.vapi.std_client.DynamicID may also be useful as a value for this attribute (although that is not its primary purpose). Some classes may provide their own specific classes for use as the value of this attribute when reporting exceptions from their methods. Some methods will not set this attribute when reporting exceptions.

exception com.vmware.vcenter.tokenservice_client.InvalidGrant(messages=None, data=None)¶

Bases: com.vmware.vcenter.tokenservice_client.Error

The InvalidGrant exception indicates that provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

messages (list of com.vmware.vapi.std_client.LocalizableMessage) –
Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the “cause” of the prior message.
data (vmware.vapi.struct.VapiStruct or None) –
Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports. The null, null, and null classes are intended as possible values for this attribute. com.vmware.vapi.std_client.DynamicID may also be useful as a value for this attribute (although that is not its primary purpose). Some classes may provide their own specific classes for use as the value of this attribute when reporting exceptions from their methods. Some methods will not set this attribute when reporting exceptions.

exception com.vmware.vcenter.tokenservice_client.InvalidRequest(messages=None, data=None)¶

Bases: com.vmware.vcenter.tokenservice_client.Error

The InvalidRequest exception indicates that TokenExchange.ExchangeSpec is missing a required parameter, includes an unsupported parameter value (other than TokenExchange.ExchangeSpec.grant_type). Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

messages (list of com.vmware.vapi.std_client.LocalizableMessage) –
Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the “cause” of the prior message.
data (vmware.vapi.struct.VapiStruct or None) –
Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports. The null, null, and null classes are intended as possible values for this attribute. com.vmware.vapi.std_client.DynamicID may also be useful as a value for this attribute (although that is not its primary purpose). Some classes may provide their own specific classes for use as the value of this attribute when reporting exceptions from their methods. Some methods will not set this attribute when reporting exceptions.

exception com.vmware.vcenter.tokenservice_client.InvalidScope(messages=None, data=None)¶

Bases: com.vmware.vcenter.tokenservice_client.Error

The InvalidScope exception indicates requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

messages (list of com.vmware.vapi.std_client.LocalizableMessage) –
Stack of one or more localizable messages for human exception consumers.

The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the “cause” of the prior message.
data (vmware.vapi.struct.VapiStruct or None) –
Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

Methods may provide data that clients can use when responding to exceptions. Since the data that clients need may be specific to the context of the method reporting the exception, different methods that report the same exception may provide different data in the exception. The documentation for each each method will describe what, if any, data it provides for each exception it reports. The null, null, and null classes are intended as possible values for this attribute. com.vmware.vapi.std_client.DynamicID may also be useful as a value for this attribute (although that is not its primary purpose). Some classes may provide their own specific classes for use as the value of this attribute when reporting exceptions from their methods. Some methods will not set this attribute when reporting exceptions.

class com.vmware.vcenter.tokenservice_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.tokenservice_client.TokenExchange(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The TokenExchange interface provides possibility to exchange between different tokens types. Implementation of “OAuth 2.0 Token Exchange” standard (https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12). Warning: This class is available as technical preview. It may be changed in a future release.

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

ACCESS_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:access_token'¶: Class attribute indicates OAuth 2.0 access token type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

BEARER_TOKEN_METHOD_TYPE = 'Bearer'¶: Class attribute indicates that the security token is a bearer token. Warning: This class attribute is available as technical preview. It may be changed in a future release.

class ExchangeSpec(grant_type=None, resource=None, audience=None, scope=None, requested_token_type=None, subject_token=None, subject_token_type=None, actor_token=None, actor_token_type=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The TokenExchange.ExchangeSpec class contains arguments required for token exchange. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

grant_type (str) – The value of TokenExchange.TOKEN_EXCHANGE_GRANT indicates that a token exchange is being performed. Warning: This attribute is available as technical preview. It may be changed in a future release.
resource (str or None) – Indicates the location of the target service or resource where the client intends to use the requested security token. Warning: This attribute is available as technical preview. It may be changed in a future release. if can be inferred from other arguments or not needed for specific case of exchange.
audience (str or None) – The logical name of the target service where the client intends to use the requested security token. This serves a purpose similar to the TokenExchange.ExchangeSpec.resource parameter, but with the client providing a logical name rather than a location. Warning: This attribute is available as technical preview. It may be changed in a future release. if can be inferred from other arguments or not needed for specific case of exchange.
scope (str or None) – A list of space-delimited, case-sensitive strings, that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used. Warning: This attribute is available as technical preview. It may be changed in a future release. if can be inferred from other arguments or not needed for specific case of exchange.
requested_token_type (str or None) – An identifier for the type of the requested security token. If the requested type is unspecified, the issued token type is at the discretion of the server and may be dictated by knowledge of the requirements of the service or resource indicated by the TokenExchange.ExchangeSpec.resource or TokenExchange.ExchangeSpec.audience parameter. Warning: This attribute is available as technical preview. It may be changed in a future release. if can be inferred from other arguments or not needed for specific case of exchange.
subject_token (str) – A security token that represents the identity of the party on behalf of whom exchange is being made. Typically, the subject of this token will be the subject of the security token issued. Token is base64-encoded. Warning: This attribute is available as technical preview. It may be changed in a future release.
subject_token_type (str) – An identifier, that indicates the type of the security token in the TokenExchange.ExchangeSpec.subject_token parameter. Warning: This attribute is available as technical preview. It may be changed in a future release.
actor_token (str or None) – A security token that represents the identity of the acting party. Typically, this will be the party that is authorized to use the requested security token and act on behalf of the subject. Warning: This attribute is available as technical preview. It may be changed in a future release. if not needed for specific case of exchange.
actor_token_type (str or None) – An identifier, that indicates the type of the security token in the TokenExchange.ExchangeSpec.actor_token parameter. Warning: This attribute is available as technical preview. It may be changed in a future release. if TokenExchange.ExchangeSpec.actor_token parameter is not present.

ID_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:id_token'¶: Class attribute indicates OIDC ID token type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

class Info(access_token=None, issued_token_type=None, token_type=None, expires_in=None, scope=None, refresh_token=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The TokenExchange.Info class contains data that represents successful token exchange response. Warning: This class is available as technical preview. It may be changed in a future release.

Tip

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

Parameters

access_token (str) – The security token issued by the server in response to the token exchange request. Token is base64-encoded. Warning: This attribute is available as technical preview. It may be changed in a future release.
issued_token_type (str) – An identifier, that indicates the type of the security token in the TokenExchange.Info.access_token parameter. Warning: This attribute is available as technical preview. It may be changed in a future release.
token_type (str) – A case-insensitive value specifying the method of using the access token issued. Warning: This attribute is available as technical preview. It may be changed in a future release.
expires_in (long or None) – The validity lifetime, in seconds, of the token issued by the server. Warning: This attribute is available as technical preview. It may be changed in a future release. if not applicable for issued token.
scope (str or None) – Scope of the issued security token. Warning: This attribute is available as technical preview. It may be changed in a future release. if the scope of the issued security token is identical to the scope requested by the client.
refresh_token (str or None) – A refresh token can be issued in cases where the client of the token exchange needs the ability to access a resource even when the original credential is no longer valid. Warning: This attribute is available as technical preview. It may be changed in a future release. if not needed for specific case of exchange.

N_A_TOKEN_METHOD_TYPE = 'N_A'¶: Class attribute indicates TokenExchange.Info.token_type identifier is not applicable in that context. Warning: This class attribute is available as technical preview. It may be changed in a future release.

REFRESH_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:refresh_token'¶: Class attribute indicates OAuth 2.0 refresh token type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

SAML1_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:saml1'¶: Class attribute indicates base64-encoded SAML 1.1 token type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

SAML2_TOKEN_TYPE = 'urn:ietf:params:oauth:token-type:saml2'¶: Class attribute indicates base64-encoded SAML 2.0 token type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

TOKEN_EXCHANGE_GRANT = 'urn:ietf:params:oauth:grant-type:token-exchange'¶: Class attribute indicates that token exchange grant type. Warning: This class attribute is available as technical preview. It may be changed in a future release.

exchange(spec)¶

Exchanges incoming token based on the spec and current client authorization data. Warning: This method is available as technical preview. It may be changed in a future release.

Parameters: spec (TokenExchange.ExchangeSpec) – TokenExchange.ExchangeSpec class contains arguments that define exchange process.
Return type: TokenExchange.Info
Returns: TokenExchange.Info class that contains new token.
Raise: InvalidGrant provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.
Raise: InvalidScope If the server is unwilling or unable to issue a token for all the target services indicated by the TokenExchange.ExchangeSpec.resource or TokenExchange.ExchangeSpec.audience parameters.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if authorization is not given to a caller.

com.vmware.vcenter.topology_client module¶

class com.vmware.vcenter.topology_client.Nodes(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Nodes interface provides methods to retrieve vCenter and Platform Services Controller nodes information in the topology. This class was added in vSphere API 6.7.2.

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

class ApplianceType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Nodes.ApplianceType class defines values for valid appliance types for the vCenter and Platform Services Controller node. See Nodes.Info. This enumeration was added in vSphere API 6.7.2.

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

PSC_EXTERNAL = ApplianceType(string='PSC_EXTERNAL')¶: An external Platform Services Controller. This class attribute was added in vSphere API 6.7.2.

VCSA_EMBEDDED = ApplianceType(string='VCSA_EMBEDDED')¶: vCenter Server Appliance with an embedded Platform Services Controller. This class attribute was added in vSphere API 6.7.2.

VCSA_EXTERNAL = ApplianceType(string='VCSA_EXTERNAL')¶: vCenter Server Appliance with an external Platform Services Controller. This class attribute was added in vSphere API 6.7.2.

class FilterSpec(types=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Nodes.FilterSpec class contains attribute used to filter the results when listing vCenter and Platform Services Controller nodes (see Nodes.list()). This class was added in vSphere API 6.7.2.

Tip

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

Parameters: types (set of Nodes.ApplianceType or None) – Types of the appliance that a vCenter and Platform Services Controller node must be to match the filter (see Nodes.ApplianceType. This attribute was added in vSphere API 6.7.2. If None or empty, node of any ApplianceType match the filter.

class Info(domain=None, type=None, replication_partners=None, client_affinity=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Nodes.Info class contains vCenter or Platform Services Controller node details. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

domain (str) – Domain name of the node. This attribute was added in vSphere API 6.7.2.
type (Nodes.ApplianceType) – Appliance type of the node. This attribute was added in vSphere API 6.7.2.
replication_partners (list of str) – List of replication partners’ node identifiers. Identifiers can be either IP address or DNS resolvable name of the partner node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. This attribute is optional and it is only relevant when the value of type is one of Nodes.ApplianceType.VCSA_EMBEDDED or Nodes.ApplianceType.PSC_EXTERNAL.
client_affinity (str) – Identifier of the affinitized Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the affinitized node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. 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.VCenter.name. This attribute is optional and it is only relevant when the value of type is Nodes.ApplianceType.VCSA_EXTERNAL.

class Summary(node=None, type=None, replication_partners=None, client_affinity=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Nodes.Summary class contains commonly used information of vCenter or Platform Services Controller node. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

node (str) – Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. 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.VCenter.name.
type (Nodes.ApplianceType) – Appliance type of the node. This attribute was added in vSphere API 6.7.2.
replication_partners (list of str) – List of replication partners’ node identifiers. Identifiers can be either IP address or DNS resolvable name of the partner node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. This attribute is optional and it is only relevant when the value of type is one of Nodes.ApplianceType.VCSA_EMBEDDED or Nodes.ApplianceType.PSC_EXTERNAL.
client_affinity (str) – Identifier of the affinitized Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the affinitized node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. 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.VCenter.name. This attribute is optional and it is only relevant when the value of type is Nodes.ApplianceType.VCSA_EXTERNAL.

get(node)¶

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

Parameters: node (str) – Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.
Return type: Nodes.Info
Returns: vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Nodes.Info.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.
Raise: com.vmware.vapi.std.errors_client.NotFound if a node doesn’t exist for given node identifier.

list(filter=None)¶

Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. This method was added in vSphere API 6.7.2.

Parameters: filter (Nodes.FilterSpec or None) – Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If None, the behavior is equivalent to a Nodes.FilterSpec with all attributes None which means all nodes match the filter.
Return type: list of Nodes.Summary
Returns: commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if the Nodes.FilterSpec.types attribute contains a value that is not supported.

class com.vmware.vcenter.topology_client.Pscs(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Pscs class provides methods to decommission the external Platform Services Controller node. This class was added in vSphere API 6.7.2.

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

class DecommissionSpec(sso_admin_username=None, sso_admin_password=None, ssl_thumbprint=None, ssl_verify=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Pscs.DecommissionSpec class contains information about the Platform Services Controller node to be decommissioned. This class was added in vSphere API 6.7.2.

Tip

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

Parameters

sso_admin_username (str) – The SSO administrator username for example “administrator\@vsphere.local”. This attribute was added in vSphere API 6.7.2.
sso_admin_password (str) – The SSO administrator account password. This attribute was added in vSphere API 6.7.2.
ssl_thumbprint (str or None) – SHA1 thumbprint of the external Platform Services Controller node to be decommissioned that will be used for verification. This attribute was added in vSphere API 6.7.2. This attribute is only relevant if sslVerify is set or has the value true. No verification will be performed if sslVerify value is set to false.
ssl_verify (bool or None) – SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7.2. If None, ssl_verify false will be used.

decommission_task(hostname, spec, only_precheck=None)¶

Decommission the external Platform Services Controller node. This method was added in vSphere API 6.7.2.

Parameters

hostname (str) – FQDN or IP address of external Platform Services Controller node to be decommissioned. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.
spec (Pscs.DecommissionSpec) – Information needed to decommission the external Platform Services Controller node.
only_precheck (bool or None) – Flag indicating whether only a pre-check should be performed. If None the full decommission will be performed.

Raise

com.vmware.vapi.std.errors_client.Unsupported if the appliance is in not a management node.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if passed arguments are invalid.

Raise

com.vmware.vapi.std.errors_client.UnverifiedPeer If the SSL certificate of the foreign external Platform Services Controller node cannot be validated. The value of the data attribute of null will be a class that contains all the attributes defined in null.

Raise

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

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the provided Platform Services Controller node doesn’t qualify for decommission due to some reasons like it has some other nodes connected to it.

class com.vmware.vcenter.topology_client.ReplicationStatus(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The ReplicationStatus interface provides methods to retrieve replication status information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). This class was added in vSphere API 6.7.2.

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

class FilterSpec(nodes=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ReplicationStatus.FilterSpec class contains attribute used to filter the results when listing replication status for the vCenter and Platform Services Controller nodes (see ReplicationStatus.list()) of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). This class was added in vSphere API 6.7.2.

Tip

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

Parameters: nodes (set of str or None) – Identifier that a vCenter and Platform Services Controller node must have to match the filter. (see ReplicationStatus.Summary.node). This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. If None or empty, all vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.

class Summary(node=None, replication_partner=None, partner_available=None, status_available=None, replicating=None, change_lag=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ReplicationStatus.Summary class contains replication information of partner vCenter or Platform Services Controller node of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type). This class was added in vSphere API 6.7.2.

Tip

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

Parameters

node (str) – Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. 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.VCenter.name.
replication_partner (str) – Identifier for the vCenter or Platform Services Controller replication partner. Identifier can be either IP address or DNS resolvable name of the replication partner. This attribute was added in vSphere API 6.7.2. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. 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.VCenter.name.
partner_available (bool) – Indicates if the VMware Directory Service on partner is reachable or not. This attribute was added in vSphere API 6.7.2.
status_available (bool) – Indicates if the replication status for the node with respect to replication partner can be retrieved or not. This attribute was added in vSphere API 6.7.2.
replicating (bool or None) – Indicates if node is processing replication changes from the replication partner. This attribute was added in vSphere API 6.7.2. This attribute will be None if the partner host or replication status is not available, i.e, if ReplicationStatus.Summary.partner_available or ReplicationStatus.Summary.status_available is false.
change_lag (long or None) – Number of replication changes node is behind the replication partner. This attribute was added in vSphere API 6.7.2. This attribute will be None if the partner host or replication status is not available, i.e, if ReplicationStatus.Summary.partner_available or ReplicationStatus.Summary.status_available is false.

list(filter=None)¶

Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see Nodes.Info.type) matching the ReplicationStatus.FilterSpec. This method was added in vSphere API 6.7.2.

Parameters: filter (ReplicationStatus.FilterSpec or None) – Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If None, the behavior is equivalent to a ReplicationStatus.FilterSpec with all attributes None which means all vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL match the filter.
Return type: list of ReplicationStatus.Summary
Returns: Commonly used replication information about vCenter and Platform Services Controller nodes matching the ReplicationStatus.FilterSpec.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument if the ReplicationStatus.FilterSpec.nodes attribute contains a invalid value.

class com.vmware.vcenter.topology_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.vcha_client module¶

The com.vmware.vcenter.vcha_client module provides classes for deploying and monitoring a vCenter High Availability (VCHA) Cluster.

class com.vmware.vcenter.vcha_client.CertificateInfo(ssl_thumbprint=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CertificateInfo Class contains information about the SSL certificate for a management vCenter server. This class was added in vSphere API 6.7.1.

Tip

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

Parameters: ssl_thumbprint (str) – The SHA-256 thumbprint of the SSL certificate for a management vCenter server. This attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.Cluster(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Cluster class provides methods to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster. This class was added in vSphere API 6.7.1.

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

class ActiveSpec(ha_network_type=None, ha_network=None, ha_ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.ActiveSpec class contains the deploy specification for the Active Node of the VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

ha_network_type (NetworkType or None) – The type of the Network object used by the HA network. If the Cluster.ActiveSpec.ha_network attribute is set, then the Cluster.ActiveSpec.ha_network_type field must be set. If the Cluster.ActiveSpec.ha_network attribute is None, then the Cluster.ActiveSpec.ha_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. If None and the Cluster.ActiveSpec.ha_network attribute is unset, then the second NIC is assumed to be already configured. If None and the Cluster.ActiveSpec.ha_network attribute is set, then an error is reported.
ha_network (str or None) – The identifier of the Network object used for the HA network. If the Cluster.ActiveSpec.ha_network attribute is set, then the Cluster.ActiveSpec.ha_network_type attribute must be set. If the Cluster.ActiveSpec.ha_network attribute is None, then the Cluster.ActiveSpec.ha_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network:VCenter. If None and the Cluster.ActiveSpec.ha_network_type attribute is unset, then the second NIC is assumed to be already configured. If None and the Cluster.ActiveSpec.ha_network attribute is set, then an error is reported.
ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in vSphere API 6.7.1.

class ClusterMode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.ClusterMode class defines the possible modes for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

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

DISABLED = ClusterMode(string='DISABLED')¶: VCHA Cluster is disabled. State replication between the Active and Passive node is disabled and automatic failover is not allowed. This class attribute was added in vSphere API 6.7.1.

ENABLED = ClusterMode(string='ENABLED')¶: VCHA Cluster is enabled. State replication between the Active and Passive node is enabled and automatic failover is allowed. This class attribute was added in vSphere API 6.7.1.

MAINTENANCE = ClusterMode(string='MAINTENANCE')¶: VCHA Cluster is in maintenance mode. State replication between the Active and Passive node is enabled but automatic failover is not allowed. This class attribute was added in vSphere API 6.7.1.

class ClusterState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.ClusterState class defines the possible for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

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

DEGRADED = ClusterState(string='DEGRADED')¶

A VCHA Cluster is said to be in a degraded state for either or all of the following reasons:

There is a node loss.
State replication between the Active and Passive node fails.

. This class attribute was added in vSphere API 6.7.1.

HEALTHY = ClusterState(string='HEALTHY')¶: All three nodes in a VCHA Cluster are healthy and connected. State replication between Active and Passive node is working and both nodes are in sync. This class attribute was added in vSphere API 6.7.1.

ISOLATED = ClusterState(string='ISOLATED')¶: All three nodes are isolated from each other. This class attribute was added in vSphere API 6.7.1.

class ConfigState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.ConfigState class defines the VCHA configuration state. This enumeration was added in vSphere API 6.7.1.

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

CONFIGURED = ConfigState(string='CONFIGURED')¶: VCHA cluster is configured. This class attribute was added in vSphere API 6.7.1.

INVALID = ConfigState(string='INVALID')¶: VCHA cluster is in an invalid/dirty state. This class attribute was added in vSphere API 6.7.1.

NOTCONFIGURED = ConfigState(string='NOTCONFIGURED')¶: VCHA cluster is not configured. This class attribute was added in vSphere API 6.7.1.

PREPARED = ConfigState(string='PREPARED')¶: vCenter server appliance has been prepared for VCHA cluster configuration. This class attribute was added in vSphere API 6.7.1.

class DeploySpec(vc_spec=None, deployment=None, active=None, passive=None, witness=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.DeploySpec class contains the deploy specification for the three nodes of a VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

vc_spec (CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. This attribute was added in vSphere API 6.7.1. If None, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
deployment (Cluster.Type) – Contains the deployment type. This attribute was added in vSphere API 6.7.1.
active (Cluster.ActiveSpec) – Contains the active node’s network configuration. This attribute was added in vSphere API 6.7.1.
passive (Cluster.PassiveSpec) – Contains the passive node’s placement configuration. This attribute was added in vSphere API 6.7.1.
witness (Cluster.WitnessSpec) – Contains the witness node’s placement configuration. This attribute was added in vSphere API 6.7.1.

class ErrorCondition(error=None, recommendation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.ErrorCondition class contains an error condition and a recommendation to handle the error condition. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

error (com.vmware.vapi.std_client.LocalizableMessage) – Contains an error condition. This attribute was added in vSphere API 6.7.1.
recommendation (com.vmware.vapi.std_client.LocalizableMessage or None) – Contains a recommendation on handling the error condition. This attribute was added in vSphere API 6.7.1. If None, there is no tip for the error condition.

class Info(config_state=None, node1=None, node2=None, witness=None, mode=None, health_state=None, health_exception=None, health_warnings=None, manual_failover_allowed=None, auto_failover_allowed=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.Info class contains the configuration and health information of the three nodes in a VCHA Cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

config_state (Cluster.ConfigState or None) – Configuration state of the VCHA cluster. The active node’s management vCenter server credentials are not required to populate this attribute. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable.
node1 (Cluster.NodeInfo or None) – Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable.
node2 (Cluster.NodeInfo or None) – Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the node is not cloned yet.
witness (Cluster.WitnessInfo or None) – Node configuration information for the VCHA cluster. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the node is not cloned yet.
mode (Cluster.ClusterMode or None) – Operational mode of the VCHA Cluster. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the node is not cloned yet.
health_state (Cluster.ClusterState or None) – Last known state of the VCHA Cluster. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the node is not cloned yet.
health_exception (list of com.vmware.vapi.std_client.LocalizableMessage or None) – Health warning messages if the health information is unavailable. This attribute was added in vSphere API 6.7.1. If None, then the cluster is in a healthy state.
health_warnings (list of Cluster.ErrorCondition or None) – A collection of messages describing the reason for a non-healthy Cluster. This attribute was added in vSphere API 6.7.1. If None, then the cluster is in a healthy state.
manual_failover_allowed (bool or None) – Specifies if manual failover is allowed. This attribute was added in vSphere API 6.7.1. If None, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.
auto_failover_allowed (bool or None) – Specifies if automatic failover is allowed. This attribute was added in vSphere API 6.7.1. If None, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.

class IpFamily(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.IpFamily class defines the IP address family. This enumeration was added in vSphere API 6.7.1.

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

IPV4 = IpFamily(string='IPV4')¶: IPV4 address family. This class attribute was added in vSphere API 6.7.1.

IPV6 = IpFamily(string='IPV6')¶: IPV6 address family. This class attribute was added in vSphere API 6.7.1.

class IpInfo(ip_family=None, ipv4=None, ipv6=None, gateway_ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.IpInfo class contains attributes related to an ip. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

ip_family (Cluster.IpFamily) – Family of the ip. This attribute was added in vSphere API 6.7.1.
ipv4 (Cluster.Ipv4Info) – If the type of the ip family is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. This attribute is optional and it is only relevant when the value of ipFamily is Cluster.IpFamily.IPV4.
ipv6 (Cluster.Ipv6Info) – If the type of the ip family is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. This attribute is optional and it is only relevant when the value of ipFamily is Cluster.IpFamily.IPV6.
gateway_ip (str or None) – Gateway IP address. This attribute was added in vSphere API 6.7.1. If None, no gateway is specified.

class Ipv4Info(address=None, subnet_mask=None, prefix=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.Ipv4Info class contains attributes to describe IPV4 information of the configured network interface. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

address (str) – IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
subnet_mask (str) – The subnet mask of the interface. This attribute was added in vSphere API 6.7.1.
prefix (long or None) – The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1. If None , then the subnet mask is invalid.

class Ipv6Info(address=None, prefix=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.Ipv6Info class contains attributes to describe IPV6 information of the configured network interface. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

address (str) – IP address of the configured network interface. This attribute was added in vSphere API 6.7.1.
prefix (long) – The CIDR prefix of the interface. This attribute was added in vSphere API 6.7.1.

class NodeInfo(failover_ip=None, ha_ip=None, runtime=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.NodeInfo class defines the configuration information for the active and passive nodes in the cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

failover_ip (Cluster.IpInfo or None) – Failover IP address that this node will assume after the failover to serve client requests. Each failover node can have a different failover IP address. The active node’s management vCenter server credentials are not required to populate Cluster.NodeInfo.failover_ip. This attribute was added in vSphere API 6.7.1. If None, then it will assume the public IP address of the Active vCenter Server.
ha_ip (Cluster.IpInfo) – VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network. The active node’s management vCenter server credentials are not required to populate this Cluster.NodeInfo.ha_ip. This attribute was added in vSphere API 6.7.1.
runtime (Cluster.NodeRuntimeInfo or None) – Runtime information for the node in the VCHA Cluster. The active node’s management vCenter server credentials are required to populate some attributes of Cluster.NodeInfo.runtime. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet.

class NodeRole(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.NodeRole class defines the role node can be in a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

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

ACTIVE = NodeRole(string='ACTIVE')¶: Node is having a role of Active. In this role, node runs a vCenter Server that serves client requests. This class attribute was added in vSphere API 6.7.1.

PASSIVE = NodeRole(string='PASSIVE')¶: Node is having a role of Passive. In this role node, runs as a standby for the Active vCenter Server and receives state updates. This node takes over the role of Active vCenter Server upon failover. This class attribute was added in vSphere API 6.7.1.

WITNESS = NodeRole(string='WITNESS')¶: Node is having a role of Witness. In this role, node acts as a quorum node for avoiding the classic split-brain problem. This class attribute was added in vSphere API 6.7.1.

class NodeRuntimeInfo(state=None, role=None, placement=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.NodeRuntimeInfo class describes a node’s runtime information in a VCHA Cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

state (Cluster.NodeState or None) – Last known state of the node. The active node’s management vCenter server credentials are not required to populate Cluster.NodeRuntimeInfo.state. This attribute was added in vSphere API 6.7.1. If None, then information is unavailable or the passive and witness nodes are not cloned yet.
role (Cluster.NodeRole or None) – Last known role of the node. The active node’s management vCenter server credentials are not required to populate Cluster.NodeRuntimeInfo.role. This attribute was added in vSphere API 6.7.1. If None, then information is unavailable or the passive and witness nodes are not cloned yet.
placement (PlacementInfo or None) – Placement information of the node. The active node’s management vCenter server credentials are required to populate most attributes of Cluster.NodeRuntimeInfo.placement. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the specified Active vCenter server management credentials are invalid or the node is not cloned yet or the VCHA cluster was deployed in a manual fashion.

class NodeState(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.NodeState class defines possible state a node can be in a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

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

DOWN = NodeState(string='DOWN')¶: Node is down and has left the VCHA Cluster. This class attribute was added in vSphere API 6.7.1.

UP = NodeState(string='UP')¶: Node is up and has joined the VCHA Cluster. This class attribute was added in vSphere API 6.7.1.

class NodeVmInfo(vm=None, bios_uuid=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.NodeVmInfo class contains information to describe the Virtual Machine of a node of a VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

vm (str) – The identifier of the virtual machine of the VCHA node. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: VirtualMachine:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: VirtualMachine:VCenter.
bios_uuid (str) – BIOS UUID for the node. This attribute was added in vSphere API 6.7.1.

class PassiveSpec(placement=None, ha_ip=None, failover_ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.PassiveSpec class contains the deploy specification for the Passive Node of the VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

placement (PlacementSpec or None) – Contains the placement configuration of the node. This attribute was added in vSphere API 6.7.1. If None, then the it is assumed that the clone will be done manually by the customer. In this case, the placement configuration for the witness node should also be omitted. Only the network configuration will be setup. Once the passive and witness nodes are cloned from the active node, the VCHA high availability is turned on.
ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in vSphere API 6.7.1.
failover_ip (IpSpec or None) – IP specification for the management network. This attribute was added in vSphere API 6.7.1. If None, then it will assume the public IP address of the Active vCenter Server.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Cluster.Type class defines the possible deployment types for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

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

AUTO = Type(string='AUTO')¶: Passive and witness nodes are cloned automatically. This class attribute was added in vSphere API 6.7.1.

MANUAL = Type(string='MANUAL')¶: Passive and witness nodes are not cloned automatically. After deployment, the customer should clone the passive and witness virtual machines. This class attribute was added in vSphere API 6.7.1.

class UndeploySpec(vc_spec=None, force_delete=None, vms=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.UndeploySpec class contains the undeploy specification for a VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

vc_spec (CredentialsSpec or None) – Contains the active node’s management vCenter server credentials. This attribute was added in vSphere API 6.7.1. If None, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
force_delete (bool or None) –
Flag controlling in what circumstances the virtual machines will be deleted. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment.
- If true, the Cluster.UndeploySpec.vms attribute will be ignored, the VCHA cluster specific information is removed, and the passive and witness virtual machines will be deleted.
- If false, the Cluster.UndeploySpec.vms attribute contains the information identifying the passive and witness virtual machines.
- If the Cluster.UndeploySpec.vms attribute is set, then it will be validated prior to deleting the passive and witness virtual machines and VCHA cluster specific information is removed.
- If the Cluster.UndeploySpec.vms attribute is None, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
. This attribute was added in vSphere API 6.7.1. If None, the Cluster.UndeploySpec.vms attribute contains the information identifying the passive and witness virtual machines.
- If the Cluster.UndeploySpec.vms attribute is set, then it will be validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.
- If the Cluster.UndeploySpec.vms attribute is None, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
vms (Cluster.VmInfo or None) –
Contains virtual machine information for the passive and witness virtual machines. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment.

If set, the Cluster.UndeploySpec.force_delete attribute controls whether this information is validated.
- If the Cluster.UndeploySpec.force_delete attribute is true, then this information is ignored, VCHA cluster specific information is removed and the passive and witness virtual machines will be deleted.
- If the Cluster.UndeploySpec.force_delete attribute is None or false, then this information is validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.
. This attribute was added in vSphere API 6.7.1. If None, the Cluster.UndeploySpec.force_delete attribute controls the deletion of the passive and witness virtual machines.
- If the Cluster.UndeploySpec.force_delete attribute is true, then the passive and witness virtual machines will be deleted. VCHA cluster specific information is removed.
- If the Cluster.UndeploySpec.force_delete attribute is None or false, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.

class VmInfo(passive=None, witness=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.VmInfo class contains information to describe the Virtual Machines of passive and witness nodes of a VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

passive (Cluster.NodeVmInfo) – The virtual machine information of the passive node. This attribute was added in vSphere API 6.7.1.
witness (Cluster.NodeVmInfo) – The virtual machine information of the witness node. This attribute was added in vSphere API 6.7.1.

class WitnessInfo(ha_ip=None, runtime=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.WitnessInfo class defines the configuration and runtime information for the witness node in the cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

ha_ip (Cluster.IpInfo) – VCHA Cluster network configuration of the node. All cluster communication (state replication, heartbeat, cluster messages) happens over this network. The active node’s management vCenter server credentials are not required to populate Cluster.WitnessInfo.ha_ip. This attribute was added in vSphere API 6.7.1.
runtime (Cluster.NodeRuntimeInfo or None) – Runtime information for the node in the VCHA Cluster. The active node’s management vCenter server credentials are required to populate some attributes of Cluster.WitnessInfo.runtime. This attribute was added in vSphere API 6.7.1. If None, then the information is unavailable or the node is not cloned yet.

class WitnessSpec(placement=None, ha_ip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Cluster.WitnessSpec class contains the deploy specification for the Witness Node of the VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

placement (PlacementSpec or None) – Contains the placement configuration of the node. This attribute was added in vSphere API 6.7.1. If None, then it is assumed that the clone will be done manually by the customer. In this case, the placement configuration for the witness node should also be omitted. Only the network configuration will be setup. Once the passive and witness nodes are cloned from the active node, the VCHA high availability is turned on.
ha_ip (IpSpec) – IP specification for the HA network. This attribute was added in vSphere API 6.7.1.

deploy_task(spec)¶

Prepares, clones, and configures a VCHA cluster. This method was added in vSphere API 6.7.1.

Parameters: spec (Cluster.DeploySpec) – Contains the deploy specification for all three nodes of a VCHA cluster.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the credentials provided for authenticating with the active node’s management vCenter server are invalid.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Raise: com.vmware.vapi.std.errors_client.UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in CertificateInfo.
Raise: com.vmware.vapi.std.errors_client.Error If any other error occurs.

failover_task(planned)¶

Initiates failover from the active vCenter node to the passive node.

For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover.

For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss.

A failover is allowed only in the following cases:

Cluster’s mode is enabled and all cluster members are present.
Cluster’s mode is maintenance and all cluster members are present.

. This method was added in vSphere API 6.7.1.

Parameters: planned (bool) – If false, a failover is initiated immediately and may result in data loss. If true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Raise: com.vmware.vapi.std.errors_client.Error If any other error occurs.

get(vc_spec=None, partial=None)¶

Retrieves the status of a VCHA cluster. This method was added in vSphere API 6.7.1.

Parameters

vc_spec (CredentialsSpec or None) – Contains active node’s management vCenter server credentials. If None, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
partial (bool or None) –
If true, then return only the information that does not require connecting to the Active vCenter Server.

If false or unset, then return all the information.

If None, then return all the information.

Return type

Cluster.Info

Returns

Info structure containing the VCHA configuration and health information.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the credentials provided for authenticating with the active node’s management vCenter server are invalid.

Raise

com.vmware.vapi.std.errors_client.Unauthorized If the user has insufficient privilege to perform the operation.

If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
If partial is true, then the operation execution requires the System.Read privilege.

Raise

com.vmware.vapi.std.errors_client.UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in CertificateInfo.

Raise

com.vmware.vapi.std.errors_client.Error If any other error occurs.

undeploy_task(spec)¶

Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed.

If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.. This method was added in vSphere API 6.7.1.

Parameters: spec (Cluster.UndeploySpec) – Contains the undeploy specification for a VCHA cluster.
Raise: com.vmware.vapi.std.errors_client.InvalidArgument If the credentials provided for authenticating with the active node’s management vCenter server are invalid.
Raise: com.vmware.vapi.std.errors_client.NotFound If the passive virtual machine is not managed by the specified vCenter server.
Raise: com.vmware.vapi.std.errors_client.NotFound If the witness virtual machine is not managed by the specified vCenter server.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Raise: com.vmware.vapi.std.errors_client.UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains all the attributes defined in CertificateInfo.
Raise: com.vmware.vapi.std.errors_client.Error If any other error occurs.

class com.vmware.vcenter.vcha_client.ConnectionSpec(hostname=None, port=None, ssl_thumbprint=None, username=None, password=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ConnectionSpec class contains information required to connect to a vCenter server. The connection to the vCenter server always uses the HTTPS protocol. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

hostname (str) – IP Address or DNS of the vCenter. This attribute was added in vSphere API 6.7.1.
port (long or None) – Port number. This attribute was added in vSphere API 6.7.1. If None, port 443 will be used.
ssl_thumbprint (str or None) – SHA1 hash of the server SSL certificate. This attribute was added in vSphere API 6.7.1. If None, empty ssl thumbprint is assumed.
username (str or None) – Username to access the server. This attribute was added in vSphere API 6.7.1. This attribute is currently required. If None, an error is returned. In the future, if this attribute is None, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.
password (str or None) – Password for the specified user. This attribute was added in vSphere API 6.7.1. This attribute is currently required. If None, an empty password is assumed. In the future, if this attribute is None, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.

class com.vmware.vcenter.vcha_client.CredentialsSpec(active_location=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The CredentialsSpec class contains information to connect to the vCenter server managing the VCHA nodes. This class was added in vSphere API 6.7.1.

Tip

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

Parameters: active_location (ConnectionSpec) – Connection information for the management vCenter Server of the Active Node in a VCHA Cluster. This attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.DiskInfo(datastore=None, datastore_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DiskInfo class contains information to describe the storage configuration of a vCenter virtual machine. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

datastore (str) – The identifier of the datastore to put all the virtual disks on. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore:VCenter.
datastore_name (str) – The name of the datastore. This attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.DiskSpec(datastore=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DiskSpec class contains information to describe the storage configuration of a vCenter virtual machine. This class was added in vSphere API 6.7.1.

Tip

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

Parameters: datastore (str or None) – The identifier of the datastore to put all the virtual disks on. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore:VCenter. This field needs to be set. If None, then see vim.vm.RelocateSpec.datastore.

class com.vmware.vcenter.vcha_client.IpFamily(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The IpFamily class defines the Ip address family. This enumeration was added in vSphere API 6.7.1.

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

IPV4 = IpFamily(string='IPV4')¶: IPV4 address family. This class attribute was added in vSphere API 6.7.1.

IPV6 = IpFamily(string='IPV6')¶: IPv6 address family. This class attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.IpSpec(ip_family=None, ipv4=None, ipv6=None, default_gateway=None, dns_servers=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The IpSpec class contains IP information used to configure a network interface. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

ip_family (IpFamily) – Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1.
ipv4 (Ipv4Spec) – If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. This attribute is optional and it is only relevant when the value of ipFamily is IpFamily.IPV4.
ipv6 (Ipv6Spec) – If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. This attribute is optional and it is only relevant when the value of ipFamily is IpFamily.IPV6.
default_gateway (str or None) – The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. If None, gateway will not be used for the network interface.
dns_servers (list of str or None) – The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. If None, DNS servers will not be used for the network interface.

class com.vmware.vcenter.vcha_client.Ipv4Spec(address=None, subnet_mask=None, prefix=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ipv4Spec class contains IPV4 information used to configure a network interface. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

address (str) – IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
subnet_mask (str or None) – The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. If None and the prefix attribute is None, then an error will be reported. If None and the prefix attribute is set, then the prefix attribute will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0. If both the subnetMask attribute and the prefix attribute are set and they do not represent the same value, then an error will be reported.
prefix (long or None) – The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. If None and the subnetMask attribute is None, this an error will be reported. If None and the subnetMask attribute is set, then the subnetMask attribute will be used. If both the subnetMask attribute and the prefix attribute are set and they do not represent the same value, then an error will be reported.

class com.vmware.vcenter.vcha_client.Ipv6Spec(address=None, prefix=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ipv6Spec class contains IPV6 information used to configure a network interface. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

address (str) – IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
prefix (long) – The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.NetworkType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The NetworkType class defines the type of a vCenter Server network. This enumeration was added in vSphere API 6.7.1.

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

DISTRIBUTED_PORTGROUP = NetworkType(string='DISTRIBUTED_PORTGROUP')¶: Distributed virtual switch. This class attribute was added in vSphere API 6.7.1.

STANDARD_PORTGROUP = NetworkType(string='STANDARD_PORTGROUP')¶: vSphere standard portgroup network. This class attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vcha_client.Operations(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Operations class provides methods to figure out the currently active operations and currently disabled operations in a vCenter High Availability (VCHA) cluster. This class was added in vSphere API 6.7.1.

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

CLUSTER_DEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.deploy'¶: Identifier of the cluster deploy operation. This class attribute was added in vSphere API 6.7.1.

CLUSTER_FAILOVER_OP = 'com.vmware.vcenter.vcha.cluster.failover'¶: Identifier of the cluster failover operation. This class attribute was added in vSphere API 6.7.1.

CLUSTER_GET_OP = 'com.vmware.vcenter.vcha.cluster.get'¶: Identifier of the cluster get operation. This class attribute was added in vSphere API 6.7.1.

CLUSTER_UNDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.undeploy'¶: Identifier of the cluster undeploy operation. This class attribute was added in vSphere API 6.7.1.

class Info(disabled=None, active=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Operations.Info class contains information about which the VCHA operations cannot be invoked in the current state of the system and the list of currently active VCHA operations. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

disabled (set of str) – Identifiers of the operations that are current disabled. These operation strings are one of Operations.CLUSTER_DEPLOY_OP, Operations.CLUSTER_FAILOVER_OP, Operations.PASSIVE_REDEPLOY_OP, Operations.WITNESS_REDEPLOY_OP, Operations.MODE_SET_OP, Operations.CLUSTER_UNDEPLOY_OP and Operations.CLUSTER_GET_OP. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vapi.operation.
active (set of str) – Identifiers of the operations that are currently running. These operation strings are one of Operations.CLUSTER_DEPLOY_OP, Operations.CLUSTER_FAILOVER_OP, Operations.PASSIVE_REDEPLOY_OP, Operations.WITNESS_REDEPLOY_OP, Operations.MODE_SET_OP, and Operations.CLUSTER_UNDEPLOY_OP. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vapi.operation.

MODE_GET_OP = 'com.vmware.vcenter.vcha.cluster.mode.get'¶: Identifier of the get mode operation. This class attribute was added in vSphere API 6.7.1.

MODE_SET_OP = 'com.vmware.vcenter.vcha.cluster.mode.set'¶: Identifier of the set mode operation. This class attribute was added in vSphere API 6.7.1.

PASSIVE_REDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.passive.redeploy'¶: Identifier of the passive redeploy operation. This class attribute was added in vSphere API 6.7.1.

WITNESS_REDEPLOY_OP = 'com.vmware.vcenter.vcha.cluster.witness.redeploy'¶: Identifier of the witness redeploy operation. This class attribute was added in vSphere API 6.7.1.

get()¶

Retrieves the current active and disabled operations of a VCHA cluster. This method was added in vSphere API 6.7.1.

Return type: Operations.Info
Returns: Info structure containing the current running and disabled operations of a VCHA cluster.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Raise: com.vmware.vapi.std.errors_client.Error If any other error occurs.

class com.vmware.vcenter.vcha_client.PlacementInfo(management_vcenter_name=None, vm_name=None, datacenter=None, datacenter_name=None, host=None, host_name=None, cluster=None, cluster_name=None, ha_network=None, ha_network_name=None, ha_network_type=None, management_network=None, management_network_name=None, management_network_type=None, storage=None, bios_uuid=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PlacementInfo class contains information to describe the inventory placement of a single node of a VCHA cluster. The active node’s management vCenter server credentials are required to populate all attributes except biosUuid. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

management_vcenter_name (str) – The hostname of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 6.7.1.
vm_name (str) – The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
datacenter (str) – The identifier of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datacenter:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datacenter:VCenter.
datacenter_name (str) – The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
host (str) – The identifier of the host of the VCHA node. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem:VCenter.
host_name (str) – The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
cluster (str or None) – The identifier of the cluster of which host is member. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ClusterComputeResource:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ClusterComputeResource:VCenter. If None, host is a standalone host.
cluster_name (str or None) – The name of the cluster of which host is member. This attribute was added in vSphere API 6.7.1. If None, host is a standalone host.
ha_network (str or None) – The identifier of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network:VCenter. If None, the information is currently unavailable or the haNetwork is not configured.
ha_network_name (str or None) – The name of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. If None, the information is currently unavailable or the haNetwork is not configured.
ha_network_type (NetworkType or None) – The type of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. If None, the information is currently unavailable or the haNetwork is not configured.
management_network (str) – The identifier of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network:VCenter.
management_network_name (str) – The name of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
management_network_type (NetworkType) – The type of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
storage (DiskInfo) – The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
bios_uuid (str or None) – BIOS UUID for the node. This attribute was added in vSphere API 6.7.1. If None, the information is currently unavailable.

class com.vmware.vcenter.vcha_client.PlacementSpec(name=None, folder=None, host=None, resource_pool=None, ha_network_type=None, ha_network=None, management_network_type=None, management_network=None, storage=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The PlacementSpec class contains information to describe the inventory placement of a single node of a VCHA cluster. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

name (str) – The name of the VCHA node to be used for the virtual machine name. This attribute was added in vSphere API 6.7.1.
folder (str) – The identifier of the folder to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Folder:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Folder:VCenter.
host (str or None) – The identifier of the host to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem:VCenter. If None, see vim.vm.RelocateSpec.host.
resource_pool (str or None) – The identifier of the resource pool to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ResourcePool:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ResourcePool:VCenter. If None, then the active node’s resource pool will be used.
ha_network_type (NetworkType or None) – The type of the Network object used by the HA network. If the PlacementSpec.ha_network attribute is set, then the PlacementSpec.ha_network_type field must be set. If the PlacementSpec.ha_network attribute is None, then the PlacementSpec.ha_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. If None and the PlacementSpec.ha_network attribute is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If None and the PlacementSpec.ha_network attribute is set, then an error is reported.
ha_network (str or None) – The identifier of the Network object used for the HA network. If the PlacementSpec.ha_network attribute is set, then the {#link #haNetworkType} attribute must be set. If the PlacementSpec.ha_network attribute is None, then the PlacementSpec.ha_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network:VCenter. If None and the PlacementSpec.ha_network_type attribute is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
management_network_type (NetworkType or None) – The type of the Network object used by the Management network. If the PlacementSpec.management_network attribute is set, then the {#link #managementNetworkType} field must be set. If the PlacementSpec.management_network attribute is None, then the PlacementSpec.management_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. If None and the PlacementSpec.management_network attribute is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If None and the PlacementSpec.management_network attribute is set, then an error is reported.
management_network (str or None) – The identifier of the Network object used for the Management network. If the PlacementSpec.management_network attribute is set, then the PlacementSpec.management_network_type attribute must be set. If the PlacementSpec.management_network attribute is None, then the PlacementSpec.management_network_type attribute is ignored. This attribute was added in vSphere API 6.7.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network:VCenter. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network:VCenter. If None and the PlacementSpec.management_network_type attribute is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
storage (DiskSpec or None) – The storage specification to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. If None, see vim.vm.RelocateSpec.datastore.

class com.vmware.vcenter.vcha_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.vm_client module¶

The com.vmware.vcenter.vm_client module provides classes for managing virtual machines.

class com.vmware.vcenter.vm_client.GuestOS(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The GuestOS class defines the valid guest operating system types used for configuring a virtual machine.

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

AMAZONLINUX2_64 = GuestOS(string='AMAZONLINUX2_64')¶: Amazon Linux 2 (64 bit). This class attribute was added in vSphere API 6.7.1.

ASIANUX_3 = GuestOS(string='ASIANUX_3')¶: Asianux Server 3

ASIANUX_3_64 = GuestOS(string='ASIANUX_3_64')¶: Asianux Server 3 (64 bit)

ASIANUX_4 = GuestOS(string='ASIANUX_4')¶: Asianux Server 4

ASIANUX_4_64 = GuestOS(string='ASIANUX_4_64')¶: Asianux Server 4 (64 bit)

ASIANUX_5_64 = GuestOS(string='ASIANUX_5_64')¶: Asianux Server 5 (64 bit)

ASIANUX_7_64 = GuestOS(string='ASIANUX_7_64')¶: Asianux Server 7 (64 bit)

ASIANUX_8_64 = GuestOS(string='ASIANUX_8_64')¶: Asianux Server 8 (64 bit). This class attribute was added in vSphere API 6.7.

CENTOS = GuestOS(string='CENTOS')¶: CentOS 4/5

CENTOS_6 = GuestOS(string='CENTOS_6')¶: CentOS 6

CENTOS_64 = GuestOS(string='CENTOS_64')¶: CentOS 4/5 (64-bit)

CENTOS_6_64 = GuestOS(string='CENTOS_6_64')¶: CentOS 6 (64-bit)

CENTOS_7 = GuestOS(string='CENTOS_7')¶: CentOS 7

CENTOS_7_64 = GuestOS(string='CENTOS_7_64')¶: CentOS 7 (64-bit)

CENTOS_8_64 = GuestOS(string='CENTOS_8_64')¶: CentOS 8 (64-bit). This class attribute was added in vSphere API 6.7.

COREOS_64 = GuestOS(string='COREOS_64')¶: CoreOS Linux (64 bit)

DARWIN = GuestOS(string='DARWIN')¶: Mac OS 10.5

DARWIN_10 = GuestOS(string='DARWIN_10')¶: Mac OS 10.6

DARWIN_10_64 = GuestOS(string='DARWIN_10_64')¶: Mac OS 10.6 (64 bit)

DARWIN_11 = GuestOS(string='DARWIN_11')¶: Mac OS 10.7

DARWIN_11_64 = GuestOS(string='DARWIN_11_64')¶: Mac OS 10.7 (64 bit)

DARWIN_12_64 = GuestOS(string='DARWIN_12_64')¶: Mac OS 10.8 (64 bit)

DARWIN_13_64 = GuestOS(string='DARWIN_13_64')¶: Mac OS 10.9 (64 bit)

DARWIN_14_64 = GuestOS(string='DARWIN_14_64')¶: Mac OS 10.10 (64 bit)

DARWIN_15_64 = GuestOS(string='DARWIN_15_64')¶: Mac OS 10.11 (64 bit)

DARWIN_16_64 = GuestOS(string='DARWIN_16_64')¶: Mac OS 10.12 (64 bit)

DARWIN_17_64 = GuestOS(string='DARWIN_17_64')¶: Mac OS 10.13 (64 bit). This class attribute was added in vSphere API 6.7.

DARWIN_18_64 = GuestOS(string='DARWIN_18_64')¶: Mac OS 10.14 (64 bit). This class attribute was added in vSphere API 6.7.

DARWIN_64 = GuestOS(string='DARWIN_64')¶: Mac OS 10.5 (64 bit)

DEBIAN_10 = GuestOS(string='DEBIAN_10')¶: Debian GNU/Linux 10

DEBIAN_10_64 = GuestOS(string='DEBIAN_10_64')¶: Debian GNU/Linux 10 (64 bit)

DEBIAN_4 = GuestOS(string='DEBIAN_4')¶: Debian GNU/Linux 4

DEBIAN_4_64 = GuestOS(string='DEBIAN_4_64')¶: Debian GNU/Linux 4 (64 bit)

DEBIAN_5 = GuestOS(string='DEBIAN_5')¶: Debian GNU/Linux 5

DEBIAN_5_64 = GuestOS(string='DEBIAN_5_64')¶: Debian GNU/Linux 5 (64 bit)

DEBIAN_6 = GuestOS(string='DEBIAN_6')¶: Debian GNU/Linux 6

DEBIAN_6_64 = GuestOS(string='DEBIAN_6_64')¶: Debian GNU/Linux 6 (64 bit)

DEBIAN_7 = GuestOS(string='DEBIAN_7')¶: Debian GNU/Linux 7

DEBIAN_7_64 = GuestOS(string='DEBIAN_7_64')¶: Debian GNU/Linux 7 (64 bit)

DEBIAN_8 = GuestOS(string='DEBIAN_8')¶: Debian GNU/Linux 8

DEBIAN_8_64 = GuestOS(string='DEBIAN_8_64')¶: Debian GNU/Linux 8 (64 bit)

DEBIAN_9 = GuestOS(string='DEBIAN_9')¶: Debian GNU/Linux 9

DEBIAN_9_64 = GuestOS(string='DEBIAN_9_64')¶: Debian GNU/Linux 9 (64 bit)

DOS = GuestOS(string='DOS')¶: MS-DOS.

ECOMSTATION = GuestOS(string='ECOMSTATION')¶: eComStation 1.x

ECOMSTATION_2 = GuestOS(string='ECOMSTATION_2')¶: eComStation 2.0

FEDORA = GuestOS(string='FEDORA')¶: Fedora Linux

FEDORA_64 = GuestOS(string='FEDORA_64')¶: Fedora Linux (64 bit)

FREEBSD = GuestOS(string='FREEBSD')¶: FreeBSD 10 or earlier

FREEBSD_11 = GuestOS(string='FREEBSD_11')¶: FreeBSD 11. This class attribute was added in vSphere API 6.7.

FREEBSD_11_64 = GuestOS(string='FREEBSD_11_64')¶: FreeBSD 11 x64. This class attribute was added in vSphere API 6.7.

FREEBSD_12 = GuestOS(string='FREEBSD_12')¶: FreeBSD 12 or later. This class attribute was added in vSphere API 6.7.

FREEBSD_12_64 = GuestOS(string='FREEBSD_12_64')¶: FreeBSD 12 x64 or later. This class attribute was added in vSphere API 6.7.

FREEBSD_64 = GuestOS(string='FREEBSD_64')¶: FreeBSD 10 x64 or earlier

GENERIC_LINUX = GuestOS(string='GENERIC_LINUX')¶: Other Linux

MANDRAKE = GuestOS(string='MANDRAKE')¶: Mandrake Linux

MANDRIVA = GuestOS(string='MANDRIVA')¶: Mandriva Linux

MANDRIVA_64 = GuestOS(string='MANDRIVA_64')¶: Mandriva Linux (64 bit)

NETWARE_4 = GuestOS(string='NETWARE_4')¶: Novell NetWare 4

NETWARE_5 = GuestOS(string='NETWARE_5')¶: Novell NetWare 5.1

NETWARE_6 = GuestOS(string='NETWARE_6')¶: Novell NetWare 6.x

NLD_9 = GuestOS(string='NLD_9')¶: Novell Linux Desktop 9

OES = GuestOS(string='OES')¶: Open Enterprise Server

OPENSERVER_5 = GuestOS(string='OPENSERVER_5')¶: SCO OpenServer 5

OPENSERVER_6 = GuestOS(string='OPENSERVER_6')¶: SCO OpenServer 6

OPENSUSE = GuestOS(string='OPENSUSE')¶: OpenSUSE Linux

OPENSUSE_64 = GuestOS(string='OPENSUSE_64')¶: OpenSUSE Linux (64 bit)

ORACLE_LINUX = GuestOS(string='ORACLE_LINUX')¶: Oracle Linux 4/5

ORACLE_LINUX_6 = GuestOS(string='ORACLE_LINUX_6')¶: Oracle Linux 6

ORACLE_LINUX_64 = GuestOS(string='ORACLE_LINUX_64')¶: Oracle Linux 4/5 (64-bit)

ORACLE_LINUX_6_64 = GuestOS(string='ORACLE_LINUX_6_64')¶: Oracle Linux 6 (64-bit)

ORACLE_LINUX_7 = GuestOS(string='ORACLE_LINUX_7')¶: Oracle Linux 7

ORACLE_LINUX_7_64 = GuestOS(string='ORACLE_LINUX_7_64')¶: Oracle Linux 7 (64-bit)

ORACLE_LINUX_8_64 = GuestOS(string='ORACLE_LINUX_8_64')¶: Oracle Linux 8 (64-bit). This class attribute was added in vSphere API 6.7.

OS2 = GuestOS(string='OS2')¶: OS/2

OTHER = GuestOS(string='OTHER')¶: Other Operating System

OTHER_24X_LINUX = GuestOS(string='OTHER_24X_LINUX')¶: Linux 2.4x Kernel

OTHER_24X_LINUX_64 = GuestOS(string='OTHER_24X_LINUX_64')¶: Linux 2.4x Kernel (64 bit) (experimental)

OTHER_26X_LINUX = GuestOS(string='OTHER_26X_LINUX')¶: Linux 2.6x Kernel

OTHER_26X_LINUX_64 = GuestOS(string='OTHER_26X_LINUX_64')¶: Linux 2.6x Kernel (64 bit) (experimental)

OTHER_3X_LINUX = GuestOS(string='OTHER_3X_LINUX')¶: Linux 3.x Kernel

OTHER_3X_LINUX_64 = GuestOS(string='OTHER_3X_LINUX_64')¶: Linux 3.x Kernel (64 bit)

OTHER_4X_LINUX = GuestOS(string='OTHER_4X_LINUX')¶: Linux 4.x Kernel. This class attribute was added in vSphere API 6.7.

OTHER_4X_LINUX_64 = GuestOS(string='OTHER_4X_LINUX_64')¶: Linux 4.x Kernel (64 bit). This class attribute was added in vSphere API 6.7.

OTHER_64 = GuestOS(string='OTHER_64')¶: Other Operating System (64 bit) (experimental)

OTHER_LINUX = GuestOS(string='OTHER_LINUX')¶: Linux 2.2x Kernel

OTHER_LINUX_64 = GuestOS(string='OTHER_LINUX_64')¶: Linux (64 bit) (experimental)

REDHAT = GuestOS(string='REDHAT')¶: Red Hat Linux 2.1

RHEL_2 = GuestOS(string='RHEL_2')¶: Red Hat Enterprise Linux 2

RHEL_3 = GuestOS(string='RHEL_3')¶: Red Hat Enterprise Linux 3

RHEL_3_64 = GuestOS(string='RHEL_3_64')¶: Red Hat Enterprise Linux 3 (64 bit)

RHEL_4 = GuestOS(string='RHEL_4')¶: Red Hat Enterprise Linux 4

RHEL_4_64 = GuestOS(string='RHEL_4_64')¶: Red Hat Enterprise Linux 4 (64 bit)

RHEL_5 = GuestOS(string='RHEL_5')¶: Red Hat Enterprise Linux 5

RHEL_5_64 = GuestOS(string='RHEL_5_64')¶: Red Hat Enterprise Linux 5 (64 bit) (experimental)

RHEL_6 = GuestOS(string='RHEL_6')¶: Red Hat Enterprise Linux 6

RHEL_6_64 = GuestOS(string='RHEL_6_64')¶: Red Hat Enterprise Linux 6 (64 bit)

RHEL_7 = GuestOS(string='RHEL_7')¶: Red Hat Enterprise Linux 7

RHEL_7_64 = GuestOS(string='RHEL_7_64')¶: Red Hat Enterprise Linux 7 (64 bit)

RHEL_8_64 = GuestOS(string='RHEL_8_64')¶: Red Hat Enterprise Linux 8 (64 bit). This class attribute was added in vSphere API 6.7.

SJDS = GuestOS(string='SJDS')¶: Sun Java Desktop System

SLES = GuestOS(string='SLES')¶: Suse Linux Enterprise Server 9

SLES_10 = GuestOS(string='SLES_10')¶: Suse linux Enterprise Server 10

SLES_10_64 = GuestOS(string='SLES_10_64')¶: Suse Linux Enterprise Server 10 (64 bit) (experimental)

SLES_11 = GuestOS(string='SLES_11')¶: Suse linux Enterprise Server 11

SLES_11_64 = GuestOS(string='SLES_11_64')¶: Suse Linux Enterprise Server 11 (64 bit)

SLES_12 = GuestOS(string='SLES_12')¶: Suse linux Enterprise Server 12

SLES_12_64 = GuestOS(string='SLES_12_64')¶: Suse Linux Enterprise Server 12 (64 bit)

SLES_15_64 = GuestOS(string='SLES_15_64')¶: Suse Linux Enterprise Server 15 (64 bit). This class attribute was added in vSphere API 6.7.

SLES_64 = GuestOS(string='SLES_64')¶: Suse Linux Enterprise Server 9 (64 bit)

SOLARIS_10 = GuestOS(string='SOLARIS_10')¶: Solaris 10 (32 bit) (experimental)

SOLARIS_10_64 = GuestOS(string='SOLARIS_10_64')¶: Solaris 10 (64 bit) (experimental)

SOLARIS_11_64 = GuestOS(string='SOLARIS_11_64')¶: Solaris 11 (64 bit)

SOLARIS_6 = GuestOS(string='SOLARIS_6')¶: Solaris 6

SOLARIS_7 = GuestOS(string='SOLARIS_7')¶: Solaris 7

SOLARIS_8 = GuestOS(string='SOLARIS_8')¶: Solaris 8

SOLARIS_9 = GuestOS(string='SOLARIS_9')¶: Solaris 9

SUSE = GuestOS(string='SUSE')¶: Suse Linux

SUSE_64 = GuestOS(string='SUSE_64')¶: Suse Linux (64 bit)

TURBO_LINUX = GuestOS(string='TURBO_LINUX')¶: Turbolinux

TURBO_LINUX_64 = GuestOS(string='TURBO_LINUX_64')¶: Turbolinux (64 bit)

UBUNTU = GuestOS(string='UBUNTU')¶: Ubuntu Linux

UBUNTU_64 = GuestOS(string='UBUNTU_64')¶: Ubuntu Linux (64 bit)

UNIXWARE_7 = GuestOS(string='UNIXWARE_7')¶: SCO UnixWare 7

VMKERNEL = GuestOS(string='VMKERNEL')¶: VMware ESX 4

VMKERNEL_5 = GuestOS(string='VMKERNEL_5')¶: VMware ESX 5

VMKERNEL_6 = GuestOS(string='VMKERNEL_6')¶: VMware ESX 6

VMKERNEL_65 = GuestOS(string='VMKERNEL_65')¶: VMware ESX 6.5

VMWARE_PHOTON_64 = GuestOS(string='VMWARE_PHOTON_64')¶: VMware Photon (64 bit)

WINDOWS_7 = GuestOS(string='WINDOWS_7')¶: Windows 7

WINDOWS_7_64 = GuestOS(string='WINDOWS_7_64')¶: Windows 7 (64 bit)

WINDOWS_7_SERVER_64 = GuestOS(string='WINDOWS_7_SERVER_64')¶: Windows Server 2008 R2 (64 bit)

WINDOWS_8 = GuestOS(string='WINDOWS_8')¶: Windows 8

WINDOWS_8_64 = GuestOS(string='WINDOWS_8_64')¶: Windows 8 (64 bit)

WINDOWS_8_SERVER_64 = GuestOS(string='WINDOWS_8_SERVER_64')¶: Windows 8 Server (64 bit)

WINDOWS_9 = GuestOS(string='WINDOWS_9')¶: Windows 10

WINDOWS_9_64 = GuestOS(string='WINDOWS_9_64')¶: Windows 10 (64 bit)

WINDOWS_9_SERVER_64 = GuestOS(string='WINDOWS_9_SERVER_64')¶: Windows 10 Server (64 bit)

WINDOWS_HYPERV = GuestOS(string='WINDOWS_HYPERV')¶: Windows Hyper-V

WIN_2000_ADV_SERV = GuestOS(string='WIN_2000_ADV_SERV')¶: Windows 2000 Advanced Server

WIN_2000_PRO = GuestOS(string='WIN_2000_PRO')¶: Windows 2000 Professional

WIN_2000_SERV = GuestOS(string='WIN_2000_SERV')¶: Windows 2000 Server

WIN_31 = GuestOS(string='WIN_31')¶: Windows 3.1

WIN_95 = GuestOS(string='WIN_95')¶: Windows 95

WIN_98 = GuestOS(string='WIN_98')¶: Windows 98

WIN_LONGHORN = GuestOS(string='WIN_LONGHORN')¶: Windows Longhorn (experimental)

WIN_LONGHORN_64 = GuestOS(string='WIN_LONGHORN_64')¶: Windows Longhorn (64 bit) (experimental)

WIN_ME = GuestOS(string='WIN_ME')¶: Windows Millennium Edition

WIN_NET_BUSINESS = GuestOS(string='WIN_NET_BUSINESS')¶: Windows Small Business Server 2003

WIN_NET_DATACENTER = GuestOS(string='WIN_NET_DATACENTER')¶: Windows Server 2003, Datacenter Edition

WIN_NET_DATACENTER_64 = GuestOS(string='WIN_NET_DATACENTER_64')¶: Windows Server 2003, Datacenter Edition (64 bit) (experimental)

WIN_NET_ENTERPRISE = GuestOS(string='WIN_NET_ENTERPRISE')¶: Windows Server 2003, Enterprise Edition

WIN_NET_ENTERPRISE_64 = GuestOS(string='WIN_NET_ENTERPRISE_64')¶: Windows Server 2003, Enterprise Edition (64 bit)

WIN_NET_STANDARD = GuestOS(string='WIN_NET_STANDARD')¶: Windows Server 2003, Standard Edition

WIN_NET_STANDARD_64 = GuestOS(string='WIN_NET_STANDARD_64')¶: Windows Server 2003, Standard Edition (64 bit)

WIN_NET_WEB = GuestOS(string='WIN_NET_WEB')¶: Windows Server 2003, Web Edition

WIN_NT = GuestOS(string='WIN_NT')¶: Windows NT 4

WIN_VISTA = GuestOS(string='WIN_VISTA')¶: Windows Vista

WIN_VISTA_64 = GuestOS(string='WIN_VISTA_64')¶: Windows Vista (64 bit)

WIN_XP_HOME = GuestOS(string='WIN_XP_HOME')¶: Windows XP Home Edition

WIN_XP_PRO = GuestOS(string='WIN_XP_PRO')¶: Windows XP Professional

WIN_XP_PRO_64 = GuestOS(string='WIN_XP_PRO_64')¶: Windows XP Professional Edition (64 bit)

class com.vmware.vcenter.vm_client.GuestOSFamily(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The GuestOSFamily class defines the valid guest operating system family types reported by a virtual machine. This enumeration was added in vSphere API 6.7.

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

DARWIN = GuestOSFamily(string='DARWIN')¶: Mac OS operating system. This class attribute was added in vSphere API 6.7.

LINUX = GuestOSFamily(string='LINUX')¶: Linux operating system. This class attribute was added in vSphere API 6.7.

NETWARE = GuestOSFamily(string='NETWARE')¶: Novell Netware. This class attribute was added in vSphere API 6.7.

OTHER = GuestOSFamily(string='OTHER')¶: Other operating systems. This class attribute was added in vSphere API 6.7.

SOLARIS = GuestOSFamily(string='SOLARIS')¶: Solaris operating system. This class attribute was added in vSphere API 6.7.

WINDOWS = GuestOSFamily(string='WINDOWS')¶: Windows operating system. This class attribute was added in vSphere API 6.7.

class com.vmware.vcenter.vm_client.Hardware(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Hardware class provides methods for configuring the virtual hardware of a virtual machine.

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

class Info(version=None, upgrade_policy=None, upgrade_version=None, upgrade_status=None, upgrade_error=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Hardware.Info class contains information related to the virtual hardware of a virtual machine.

Tip

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

Parameters

version (Hardware.Version) – Virtual hardware version.
upgrade_policy (Hardware.UpgradePolicy) – Scheduled upgrade policy.
upgrade_version (Hardware.Version) – Target hardware version to be used on the next scheduled virtual hardware upgrade. This attribute is optional and it is only relevant when the value of upgradePolicy is one of Hardware.UpgradePolicy.AFTER_CLEAN_SHUTDOWN or Hardware.UpgradePolicy.ALWAYS.
upgrade_status (Hardware.UpgradeStatus) – Scheduled upgrade status.
upgrade_error (Exception) – Reason for the scheduled upgrade failure. This attribute is optional and it is only relevant when the value of upgradeStatus is Hardware.UpgradeStatus.FAILED.

class UpdateSpec(upgrade_policy=None, upgrade_version=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Hardware.UpdateSpec class describes the updates to virtual hardware settings of a virtual machine.

Tip

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

Parameters

upgrade_policy (Hardware.UpgradePolicy or None) –
Scheduled upgrade policy.

If set to Hardware.UpgradePolicy.NEVER, the Hardware.Info.upgrade_version attribute will be reset to None. If None, the value is unchanged.
upgrade_version (Hardware.Version or None) –
Target hardware version to be used on the next scheduled virtual hardware upgrade.

If specified, this attribute must represent a newer virtual hardware version than the current virtual hardware version reported in Hardware.Info.version. If Hardware.UpdateSpec.upgrade_policy is set to Hardware.UpgradePolicy.NEVER, this attribute must be None. Otherwise, if this attribute is None, default to the most recent virtual hardware version supported by the server.

class UpgradePolicy(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.UpgradePolicy class defines the valid virtual hardware upgrade policies for a virtual machine.

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

AFTER_CLEAN_SHUTDOWN = UpgradePolicy(string='AFTER_CLEAN_SHUTDOWN')¶: Run scheduled upgrade when the virtual machine is powered on after a clean shutdown of the guest operating system.

ALWAYS = UpgradePolicy(string='ALWAYS')¶: Run scheduled upgrade when the virtual machine is powered on.

NEVER = UpgradePolicy(string='NEVER')¶: Do not upgrade the virtual machine when it is powered on.

class UpgradeStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.UpgradeStatus class defines the valid virtual hardware upgrade statuses for a virtual machine.

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

FAILED = UpgradeStatus(string='FAILED')¶: The most recent scheduled upgrade was not successful.

NONE = UpgradeStatus(string='NONE')¶: No scheduled upgrade has been attempted.

PENDING = UpgradeStatus(string='PENDING')¶: Upgrade is scheduled but has not yet been run.

SUCCESS = UpgradeStatus(string='SUCCESS')¶: The most recent scheduled upgrade was successful.

class Version(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Hardware.Version class defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).

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

VMX_03 = Version(string='VMX_03')¶: Hardware version 3, first supported in ESXi 2.5.

VMX_04 = Version(string='VMX_04')¶: Hardware version 4, first supported in ESXi 3.0.

VMX_06 = Version(string='VMX_06')¶: Hardware version 6, first supported in WS 6.0.

VMX_07 = Version(string='VMX_07')¶: Hardware version 7, first supported in ESXi 4.0.

VMX_08 = Version(string='VMX_08')¶: Hardware version 8, first supported in ESXi 5.0.

VMX_09 = Version(string='VMX_09')¶: Hardware version 9, first supported in ESXi 5.1.

VMX_10 = Version(string='VMX_10')¶: Hardware version 10, first supported in ESXi 5.5.

VMX_11 = Version(string='VMX_11')¶: Hardware version 11, first supported in ESXi 6.0.

VMX_12 = Version(string='VMX_12')¶: Hardware version 12, first supported in Workstation 12.0.

VMX_13 = Version(string='VMX_13')¶: Hardware version 13, first supported in ESXi 6.5.

VMX_14 = Version(string='VMX_14')¶: Hardware version 14, first supported in ESXi 6.7. This class attribute was added in vSphere API 6.7.

VMX_15 = Version(string='VMX_15')¶: Hardware version 15, first supported in ESXi 6.7.0 Update 2. This class attribute was added in vSphere API 6.7.2.

get(vm)¶

Returns the virtual hardware settings of a virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Return type: Hardware.Info
Returns: Virtual hardware settings of the virtual machine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

update(vm, spec)¶

Updates the virtual hardware settings of a virtual machine.

Parameters

vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
spec (Hardware.UpdateSpec) – Specification for updating the virtual hardware settings of the virtual machine.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual machine is already configured for the desired hardware version.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if the requested virtual hardware version is not newer than the current version.

Raise

com.vmware.vapi.std.errors_client.Unsupported if the requested virtual hardware version is not supported by the server.

Raise

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

upgrade(vm, version=None)¶

Upgrades the virtual machine to a newer virtual hardware version.

Parameters

vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
version (Hardware.Version or None) – New virtual machine version. If None, defaults to the most recent virtual hardware version supported by the server.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is not powered off.

Raise

com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual machine is already configured for the desired hardware version.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if version is older than the current virtual hardware version.

Raise

com.vmware.vapi.std.errors_client.Unsupported if version is not supported by the server.

Raise

com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is busy performing another operation.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration state cannot be accessed.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm_client.Identity(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Identity class provides methods for managing the identity of a virtual machine. This class was added in vSphere API 6.7.1.

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

class Info(name=None, bios_uuid=None, instance_uuid=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Identity.Info class contains information about the identity of a virtual machine. This class was added in vSphere API 6.7.1.

Tip

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

Parameters

name (str) – Virtual machine name. This attribute was added in vSphere API 6.7.1.
bios_uuid (str) – 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in “12345678-abcd-1234-cdef-123456789abc” format. This attribute was added in vSphere API 6.7.1.
instance_uuid (str) – VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID. This attribute was added in vSphere API 6.7.1.

class com.vmware.vcenter.vm_client.Power(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Power class provides methods for managing the power state of a virtual machine.

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

class Info(state=None, clean_power_off=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Power.Info class contains information about the power state of a virtual machine.

Tip

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

Parameters

state (Power.State) – Power state of the virtual machine.
clean_power_off (bool) – Flag indicating whether the virtual machine was powered off cleanly. This attribute may be used to detect that the virtual machine crashed unexpectedly and should be restarted. This attribute is optional and it is only relevant when the value of state is Power.State.POWERED_OFF.

class State(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Power.State class defines the valid power states for a virtual machine.

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.

POWERED_OFF = State(string='POWERED_OFF')¶: The virtual machine is powered off.

POWERED_ON = State(string='POWERED_ON')¶: The virtual machine is powered on.

SUSPENDED = State(string='SUSPENDED')¶: The virtual machine is suspended.

get(vm)¶

Returns the power state information of a virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Return type: Power.Info
Returns: Power state information for the specified virtual machine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine’s configuration or execution state cannot be accessed.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

reset(vm)¶

Resets a powered-on virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is powered off or suspended.
Raise: com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is performing another operation
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

start(vm)¶

Powers on a powered-off or suspended virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual machine is already powered on.
Raise: com.vmware.vapi.std.errors_client.Unsupported if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
Raise: com.vmware.vapi.std.errors_client.UnableToAllocateResource if resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
Raise: com.vmware.vapi.std.errors_client.ResourceInaccessible if resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
Raise: com.vmware.vapi.std.errors_client.ResourceInUse if resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
Raise: com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is performing another operation.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

stop(vm)¶

Powers off a powered-on or suspended virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual machine is already powered off.
Raise: com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is performing another operation.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

suspend(vm)¶

Suspends a powered-on virtual machine.

Parameters: vm (str) – Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
Raise: com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.
Raise: com.vmware.vapi.std.errors_client.NotFound if the virtual machine is not found.
Raise: com.vmware.vapi.std.errors_client.AlreadyInDesiredState if the virtual machine is already suspended.
Raise: com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the virtual machine is powered off.
Raise: com.vmware.vapi.std.errors_client.ResourceBusy if the virtual machine is performing another operation.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailable if the system is unable to communicate with a service to complete the request.
Raise: com.vmware.vapi.std.errors_client.Unauthenticated if the user can not be authenticated.
Raise: com.vmware.vapi.std.errors_client.Unauthorized if the user doesn’t have the required privileges.

class com.vmware.vcenter.vm_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.vm_template_client module¶

The com.vmware.vcenter.vm_template_client module provides classes and classes that will let its client manage VMTX template in Content Library.

class com.vmware.vcenter.vm_template_client.LibraryItems(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The LibraryItems class provides methods to deploy virtual machines from library items containing virtual machine templates, as well as methods to create library items containing virtual machine templates. The LibraryItems class also provides an operation to retrieve information about the template contained in the library item. This class was added in vSphere API 6.8.

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

class CpuInfo(count=None, cores_per_socket=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CpuInfo class contains CPU related information about the virtual machine template. This class was added in vSphere API 6.8.

Tip

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

Parameters

count (long) – Number of CPU cores. This attribute was added in vSphere API 6.8.
cores_per_socket (long) – Number of CPU cores per socket. This attribute was added in vSphere API 6.8.

class CpuUpdateSpec(num_cpus=None, num_cores_per_socket=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CpuUpdateSpec class describes updates to the CPU configuration of the deployed virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters

num_cpus (long or None) – Number of virtual processors in the deployed virtual machine. This attribute was added in vSphere API 6.8. If {\@term.unset}, the deployed virtual machine has the same CPU count as the source virtual machine template contained in the library item.
num_cores_per_socket (long or None) – Number of cores among which to distribute CPUs in the deployed virtual machine. This attribute was added in vSphere API 6.8. If {\@term.unset}, the deployed virtual machine has the same number of cores per socket as the source virtual machine template contained in the library item.

class CreatePlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreatePlacementSpec class contains information used to place a virtual machine template onto resources within the vCenter inventory. This class was added in vSphere API 6.8.

Tip

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

Parameters

folder (str or None) – Virtual machine folder into which the virtual machine template should be placed. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Folder. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Folder. If None, the virtual machine template will be placed in the same folder as the source virtual machine.
resource_pool (str or None) – Resource pool into which the virtual machine template should be placed. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ResourcePool. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ResourcePool. If None, the system will attempt to choose a suitable resource pool for the virtual machine template; if a resource pool cannot be chosen, the library item creation operation will fail.
host (str or None) – Host onto which the virtual machine template should be placed. If host and resourcePool are both specified, resourcePool must belong to host. If host and cluster are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. This attribute may be None if resourcePool or cluster is specified. If None, the system will attempt to choose a suitable host for the virtual machine template; if a host cannot be chosen, the library item creation operation will fail.
cluster (str or None) – Cluster onto which the virtual machine template should be placed. If cluster and resourcePool are both specified, resourcePool must belong to cluster. If cluster and host are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ClusterComputeResource. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ClusterComputeResource. If resourcePool or host is specified, it is recommended that this attribute be None.

class CreateSpec(source_vm=None, name=None, description=None, library=None, vm_home_storage=None, disk_storage=None, disk_storage_overrides=None, placement=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreateSpec class defines the information required to create a library item containing a virtual machine template. This class was added in vSphere API 6.8.

Tip

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

Parameters

source_vm (str) – Identifier of the source virtual machine to create the library item from. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: VirtualMachine. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: VirtualMachine.
name (str) – Name of the library item. This attribute was added in vSphere API 6.8.
description (str or None) – Description of the library item. This attribute was added in vSphere API 6.8. If None, the newly created library item has the same description as the source virtual machine.
library (str) – Identifier of the library in which the new library item should be created. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.content.Library.
vm_home_storage (LibraryItems.CreateSpecVmHomeStorage or None) – Storage location for the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8. If None, the virtual machine template’s configuration and log files are placed on the default storage backing associated with the library specified by library.
disk_storage (LibraryItems.CreateSpecDiskStorage or None) –
Storage specification for the virtual machine template’s disks. This attribute was added in vSphere API 6.8. If both diskStorageOverrides and diskStorage are None, the virtual machine template’s disks are placed in the default storage backing associated with the library specified by library.

If diskStorageOverrides is None and diskStorage is specified, all of the virtual machine template’s disks are created with the storage spec specified by diskStorage.

If diskStorageOverrides is specified and diskStorage is None, disks with identifiers that are not in diskStorageOverrides are placed in the default storage backing associated with the library specified by library.

If both diskStorageOverrides and diskStorage are specified, disks with identifiers that are not in diskStorageOverrides are created with the storage spec specified by diskStorage.
disk_storage_overrides ((dict of str and LibraryItems.CreateSpecDiskStorage) or None) –
Storage specification for individual disks in the virtual machine template. This is specified as a mapping between disk identifiers in the source virtual machine and their respective storage specifications. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. If both diskStorageOverrides and diskStorage are None, the virtual machine template’s disks are placed in the default storage backing associated with the library specified by library.

If diskStorageOverrides is None and diskStorage is specified, all of the virtual machine template’s disks are created with the storage spec specified by diskStorage.

If diskStorageOverrides is specified and diskStorage is None, disks with identifiers that are not in diskStorageOverrides are placed in the default storage backing associated with the library specified by library.

If both diskStorageOverrides and diskStorage are specified, disks with identifiers that are not in diskStorageOverrides are created with the storage spec specified by diskStorage.
placement (LibraryItems.CreatePlacementSpec or None) –
Information used to place the virtual machine template. This attribute was added in vSphere API 6.8. This attribute is currently required. In the future, if this attribute is None, the system will place the virtual machine template on a suitable resource.

If specified, each attribute will be used for placement. If the attributes result in disjoint placement, the operation will fail. If the attributes along with the placement values of the source virtual machine result in disjoint placement, the operation will fail.

class CreateSpecDiskStorage(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreateSpecDiskStorage class defines the storage specification for a virtual machine template’s disks. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str or None) –
Identifier for the datastore associated with a virtual machine template’s disk. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is currently required. If None, storagePolicy must be set. The server picks a datastore that is compatible with the specified storage policy.

If both datastore and storagePolicy are specified, and the storage policy is incompatible with the datastore, then the disk will be flagged as being out of compliance with the specified storage policy.
storage_policy (LibraryItems.CreateSpecDiskStoragePolicy or None) – Storage policy for a virtual machine template’s disk. This attribute was added in vSphere API 6.8. If None, datastore must be specified and the virtual machine template’s disk is created with the default storage policy associated with the datastore.

class CreateSpecDiskStoragePolicy(type=None, policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreateSpecDiskStoragePolicy class defines the storage policy specification for a virtual machine template’s disks. This class was added in vSphere API 6.8.

Tip

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

Parameters

type (LibraryItems.CreateSpecDiskStoragePolicy.Type) – Policy type to be used when creating a virtual machine template’s disk. This attribute was added in vSphere API 6.8.
policy (str) – Identifier for the storage policy to use. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItems.CreateSpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Policy type for a virtual machine template’s disk. This enumeration was added in vSphere API 6.8.

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

USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')¶: Use the specified policy. This class attribute was added in vSphere API 6.8.

class CreateSpecVmHomeStorage(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreateSpecVmHomeStorage class defines the storage specification for a virtual machine template’s configuration and log files. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str or None) –
Identifier of the datastore for the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is currently required. If None, storagePolicy must be set. The server picks a datastore that is compatible with the specified storage policy.

If both datastore and storagePolicy are specified, and the storage policy is incompatible with the datastore, then the virtual machine template will be flagged as being out of compliance with the specified storage policy.
storage_policy (LibraryItems.CreateSpecVmHomeStoragePolicy or None) – Storage policy for the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8. If None, datastore must be specified and the virtual machine template’s configuration and log files are created with the default storage policy associated with the datastore.

class CreateSpecVmHomeStoragePolicy(type=None, policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.CreateSpecVmHomeStoragePolicy class defines the storage policy specification for a virtual machine template’s configuration and log files. This class was added in vSphere API 6.8.

Tip

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

Parameters

type (LibraryItems.CreateSpecVmHomeStoragePolicy.Type) – Policy type to be used when creating the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8.
policy (str) – Identifier for the storage policy to use. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItems.CreateSpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Policy type for the virtual machine template’s configuration and log files. This enumeration was added in vSphere API 6.8.

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

USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')¶: Use the specified policy. This class attribute was added in vSphere API 6.8.

class DeployPlacementSpec(folder=None, resource_pool=None, host=None, cluster=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeployPlacementSpec class contains information used to place a virtual machine onto resources within the vCenter inventory. This class was added in vSphere API 6.8.

Tip

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

Parameters

folder (str or None) –
Virtual machine folder into which the deployed virtual machine should be placed. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Folder. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Folder. This attribute is currently required.

If None, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine deployment operation will fail.
resource_pool (str or None) – Resource pool into which the deployed virtual machine should be placed. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ResourcePool. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ResourcePool. If None, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine deployment operation will fail.
host (str or None) – Host onto which the virtual machine should be placed. If host and resourcePool are both specified, resourcePool must belong to host. If host and cluster are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: HostSystem. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: HostSystem. This attribute may be None if resourcePool or cluster is specified. If None, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine deployment operation will fail.
cluster (str or None) – Cluster onto which the deployed virtual machine should be placed. If cluster and resourcePool are both specified, resourcePool must belong to cluster. If cluster and host are both specified, host must be a member of cluster. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: ClusterComputeResource. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: ClusterComputeResource. If resourcePool or host is specified, it is recommended that this attribute be None.

class DeploySpec(name=None, description=None, vm_home_storage=None, disk_storage=None, disk_storage_overrides=None, placement=None, powered_on=None, guest_customization=None, hardware_customization=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeploySpec class defines the deployment parameters that can be specified for the deploy method. This class was added in vSphere API 6.8.

Tip

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

Parameters

name (str) – Name of the deployed virtual machine. This attribute was added in vSphere API 6.8.
description (str or None) – Description of the deployed virtual machine. This attribute was added in vSphere API 6.8. If None, the deployed virtual machine has the same description as the source library item.
vm_home_storage (LibraryItems.DeploySpecVmHomeStorage or None) – Storage location for the deployed virtual machine’s configuration and log files. This attribute was added in vSphere API 6.8. If None, the deployed virtual machine’s configuration and log files are created with the same storage spec as the source virtual machine template’s configuration and log files.
disk_storage (LibraryItems.DeploySpecDiskStorage or None) –
Storage specification for the deployed virtual machine’s disks. This attribute was added in vSphere API 6.8. If both diskStorageOverrides and diskStorage are None, the deployed virtual machine’s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.

If diskStorageOverrides is None and diskStorage is specified, all of the deployed virtual machine’s disks are created with the storage spec specified by diskStorage.

If diskStorageOverrides is specified and diskStorage is None, disks with identifiers that are not in diskStorageOverrides are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.

If both diskStorageOverrides and diskStorage are specified, disks with identifiers that are not in diskStorageOverrides are created with the storage spec specified by diskStorage.
disk_storage_overrides ((dict of str and LibraryItems.DeploySpecDiskStorage) or None) –
Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. If both diskStorageOverrides and diskStorage are None, the deployed virtual machine’s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.

If diskStorageOverrides is None and diskStorage is specified, all of the deployed virtual machine’s disks are created with the storage spec specified by diskStorage.

If diskStorageOverrides is specified and diskStorage is None, disks with identifiers that are not in diskStorageOverrides are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item.

If both diskStorageOverrides and diskStorage are specified, disks with identifiers that are not in diskStorageOverrides are created with the storage spec specified by diskStorage.
placement (LibraryItems.DeployPlacementSpec or None) –
Information used to place the deployed virtual machine. This attribute was added in vSphere API 6.8. This attribute is currently required. In the future, if this attribute is None, the system will use the values from the source virtual machine template contained in the library item.

If specified, each attribute will be used for placement. If the attributes result in disjoint placement, the operation will fail. If the attributes along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.
powered_on (bool or None) – Specifies whether the deployed virtual machine should be powered on after deployment. This attribute was added in vSphere API 6.8. If None, the virtual machine will not be powered on after deployment.
guest_customization (LibraryItems.GuestCustomizationSpec or None) – Guest customization spec to apply to the deployed virtual machine. This attribute was added in vSphere API 6.8. If None, the guest operating system is not customized after deployment.
hardware_customization (LibraryItems.HardwareCustomizationSpec or None) – Hardware customization spec which specifies updates to the deployed virtual machine. This attribute was added in vSphere API 6.8. If None, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item.

class DeploySpecDiskStorage(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeploySpecDiskStorage class contains the storage specification for disks in the virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str or None) –
Identifier for the datastore associated the deployed virtual machine’s disk. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is currently required. If None, storagePolicy must be set. The server picks a datastore that is compatible with the specified storage policy.

If both datastore and storagePolicy are specified, and the storage policy is incompatible with the datastore, then the disk will be flagged as being out of compliance with the specified storage policy.
storage_policy (LibraryItems.DeploySpecDiskStoragePolicy or None) – Storage policy for the deployed virtual machine’s disk. This attribute was added in vSphere API 6.8. If None, datastore must be specified and the deployed virtual machine’s disk is created with the default storage policy associated with the datastore.

class DeploySpecDiskStoragePolicy(type=None, policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeploySpecDiskStoragePolicy class describes the storage policy specification for the deployed virtual machine’s disks. This class was added in vSphere API 6.8.

Tip

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

Parameters

type (LibraryItems.DeploySpecDiskStoragePolicy.Type) – Policy type to be used when creating the deployed virtual machine’s disk. This attribute was added in vSphere API 6.8.
policy (str) – Identifier of the storage policy to use. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItems.DeploySpecDiskStoragePolicy.Type.USE_SPECIFIED_POLICY.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Policy type for the deployed virtual machine’s disk. This enumeration was added in vSphere API 6.8.

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

USE_SOURCE_POLICY = Type(string='USE_SOURCE_POLICY')¶: Use the storage policy that is associated with the corresponding disk in the source virtual machine template. This class attribute was added in vSphere API 6.8.

USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')¶: Use the specified policy. This class attribute was added in vSphere API 6.8.

class DeploySpecVmHomeStorage(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeploySpecVmHomeStorage class defines the storage specification for a deployed virtual machine’s configuration and log files. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str or None) –
Identifier of the datastore for the deployed virtual machine’s configuration and log files. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore. This attribute is currently required. If None, storagePolicy must be set. The server picks a datastore that is compatible with the specified storage policy.

If both datastore and storagePolicy are specified, and the storage policy is incompatible with the datastore, then the deployed virtual machine will be flagged as being out of compliance with the specified storage policy.
storage_policy (LibraryItems.DeploySpecVmHomeStoragePolicy or None) – Storage policy for the deployed virtual machine’s configuration and log files. This attribute was added in vSphere API 6.8. If None, datastore must be specified and the deployed virtual machine’s configuration and log files are created with the default storage policy associated with the datastore.

class DeploySpecVmHomeStoragePolicy(type=None, policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DeploySpecVmHomeStoragePolicy class defines the storage policy specification for the deployed virtual machine’s configuration and log files. This class was added in vSphere API 6.8.

Tip

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

Parameters

type (LibraryItems.DeploySpecVmHomeStoragePolicy.Type) – Policy type to be used when creating the deployed virtual machine’s configuration and log files. This attribute was added in vSphere API 6.8.
policy (str) – Identifier for the storage policy to use. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. This attribute is optional and it is only relevant when the value of type is LibraryItems.DeploySpecVmHomeStoragePolicy.Type.USE_SPECIFIED_POLICY.

class Type(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Policy type for the deployed virtual machine’s configuration and log files. This enumeration was added in vSphere API 6.8.

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

USE_SOURCE_POLICY = Type(string='USE_SOURCE_POLICY')¶: Use the storage policy that is associated with the source virtual machine template’s configuration and log files. This class attribute was added in vSphere API 6.8.

USE_SPECIFIED_POLICY = Type(string='USE_SPECIFIED_POLICY')¶: Use the specified policy. This class attribute was added in vSphere API 6.8.

class DiskInfo(capacity=None, disk_storage=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DiskInfo class contains information about the virtual machine template’s virtual disk. This class was added in vSphere API 6.8.

Tip

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

Parameters

capacity (long or None) – Capacity of the virtual disk in bytes. This attribute was added in vSphere API 6.8. This attribute will be None if the virtual disk is inaccessible.
disk_storage (LibraryItems.DiskStorageInfo) – Disk storage related information. This attribute was added in vSphere API 6.8.

class DiskStorageInfo(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DiskStorageInfo class contains storage related information about a virtual machine template’s virtual disk. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str) – Identifier of the datastore where the disk is stored. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore.
storage_policy (str or None) – Identifier of the storage policy associated with the virtual disk. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. If None, the virtual disk does not have a storage policy associated with it.

class DiskUpdateSpec(capacity=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.DiskUpdateSpec class describes updates to the configuration of a virtual disk in the deployed virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters: capacity (long) – Updated capacity of the virtual disk backing in bytes. This value has to be larger than the original capacity of the disk. This attribute was added in vSphere API 6.8.

class EthernetInfo(backing_type=None, mac_type=None, network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.EthernetInfo class contains information about a virtual machine template’s virtual Ethernet adapter. This class was added in vSphere API 6.8.

Tip

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

Parameters

backing_type (LibraryItems.EthernetInfo.NetworkBackingType) – Network backing type for the virtual Ethernet adapter. This attribute was added in vSphere API 6.8.
mac_type (LibraryItems.EthernetInfo.MacAddressType) – MAC address type of the ethernet adapter. This attribute was added in vSphere API 6.8.
network (str or None) – Identifier of the network backing the virtual Ethernet adapter. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network. This attribute will be None if the identifier of the network backing could not be determined.

class MacAddressType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LibraryItems.EthernetInfo.MacAddressType class defines the valid MAC address origins for a virtual Ethernet adapter. This enumeration was added in vSphere API 6.8.

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

ASSIGNED = MacAddressType(string='ASSIGNED')¶: MAC address is assigned by vCenter Server. This class attribute was added in vSphere API 6.8.

GENERATED = MacAddressType(string='GENERATED')¶: MAC address is generated automatically. This class attribute was added in vSphere API 6.8.

MANUAL = MacAddressType(string='MANUAL')¶: MAC address is assigned statically. This class attribute was added in vSphere API 6.8.

class NetworkBackingType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LibraryItems.EthernetInfo.NetworkBackingType class defines valid network backing types for a virtual Ethernet adapter. This enumeration was added in vSphere API 6.8.

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

DISTRIBUTED_PORTGROUP = NetworkBackingType(string='DISTRIBUTED_PORTGROUP')¶: Distributed virtual switch backing. This class attribute was added in vSphere API 6.8.

HOST_DEVICE = NetworkBackingType(string='HOST_DEVICE')¶: Legacy host device network backing. Imported VMs may have virtual Ethernet adapters with this type of backing, but this type of backing cannot be used to create or to update a virtual Ethernet adapter. This class attribute was added in vSphere API 6.8.

OPAQUE_NETWORK = NetworkBackingType(string='OPAQUE_NETWORK')¶: Opaque network backing. This class attribute was added in vSphere API 6.8.

STANDARD_PORTGROUP = NetworkBackingType(string='STANDARD_PORTGROUP')¶: vSphere standard portgroup network backing. This class attribute was added in vSphere API 6.8.

class EthernetUpdateSpec(network=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.EthernetUpdateSpec class describes the network that the ethernet adapter of the deployed virtual machine should be connected to. This class was added in vSphere API 6.8.

Tip

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

Parameters

network (str or None) –

Identifier of the network backing the virtual Ethernet adapter. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network. This attribute is currently required.

If None, the virtual Ethernet adapter will be connected to same network as it was in the source virtual machine template.

class GuestCustomizationSpec(name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.GuestCustomizationSpec class contains information required to customize the deployed virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters: name (str or None) – Name of the customization specification. This attribute was added in vSphere API 6.8. If None, no guest customization is performed.

class HardwareCustomizationSpec(nics=None, disks_to_remove=None, disks_to_update=None, cpu_update=None, memory_update=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.HardwareCustomizationSpec class defines the hardware customization options that are applied to the deployed virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters

nics ((dict of str and LibraryItems.EthernetUpdateSpec) or None) – Map of Ethernet network adapters to update. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. If None, all Ethernet adapters will remain connected to the same network as they were in the source virtual machine template. An Ethernet adapter with a MacAddressType of MANUAL will not change. An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED will receive a new address.
disks_to_remove (set of str or None) – Idenfiers of disks to remove from the deployed virtual machine. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. If None, all disks will be copied.
disks_to_update ((dict of str and LibraryItems.DiskUpdateSpec) or None) – Disk update specification for individual disks in the deployed virtual machine. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. If None, disks in the deployed virtual machine will have the same settings as the corresponding disks in the source virtual machine template contained in the library item.
cpu_update (LibraryItems.CpuUpdateSpec or None) – CPU update specification for the deployed virtual machine. This attribute was added in vSphere API 6.8. If {\@term.unset}, the deployed virtual machine has the same CPU settings as the source virtual machine template contained in the library item.
memory_update (LibraryItems.MemoryUpdateSpec or None) – Memory update specification for the deployed virtual machine. This attribute was added in vSphere API 6.8. If {\@term.unset}, the deployed virtual machine has the same memory settings as the source virtual machine template contained in the library item.

class Info(guest_os=None, cpu=None, memory=None, vm_home_storage=None, disks=None, nics=None, vm_template=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.Info class contains information about a virtual machine template item in content library. This class was added in vSphere API 6.8.

Tip

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

Parameters

guest_os (com.vmware.vcenter.vm_client.GuestOS) – Configured guest operating system of the virtual machine template. This attribute was added in vSphere API 6.8.
cpu (LibraryItems.CpuInfo) – CPU configuration of the virtual machine template. This attribute was added in vSphere API 6.8.
memory (LibraryItems.MemoryInfo) – Memory configuration of the virtual machine template. This attribute was added in vSphere API 6.8.
vm_home_storage (LibraryItems.VmHomeStorageInfo) – Storage information about the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8.
disks (dict of str and LibraryItems.DiskInfo) – Storage information about the virtual machine template’s virtual disks. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
nics (dict of str and LibraryItems.EthernetInfo) – Information about the virtual machine template’s virtual ethernet adapters. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the key in the attribute dict must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When methods return a value of this class as a return value, the key in the attribute dict will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
vm_template (str) – Identifier of the latest virtual machine template contained in the library item. This attribute is the managed object identifier used to identify the virtual machine template in the vSphere Management (SOAP) API. This attribute was added in vSphere API 6.8.

class MemoryInfo(size_mib=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.MemoryInfo class contains memory related information about the virtual machine template. This class was added in vSphere API 6.8.

Tip

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

Parameters: size_mib (long) – Memory size in mebibytes. This attribute was added in vSphere API 6.8.

class MemoryUpdateSpec(memory=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.MemoryUpdateSpec class describes updates to the memory configuration of the deployed virtual machine. This class was added in vSphere API 6.8.

Tip

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

Parameters: memory (long or None) – Size of a virtual machine’s memory in MB. This attribute was added in vSphere API 6.8. If {\@term.unset}, the deployed virtual machine has the same memory size as the source virtual machine template.

class VmHomeStorageInfo(datastore=None, storage_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LibraryItems.VmHomeStorageInfo class contains storage information about the virtual machine template’s configuration and log files. This class was added in vSphere API 6.8.

Tip

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

Parameters

datastore (str) – Identifier of the datastore where the virtual machine template’s configuration and log files are stored. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Datastore. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Datastore.
storage_policy (str or None) – Identifier of the storage policy associated with the virtual machine template’s configuration and log files. This attribute was added in vSphere API 6.8. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.spbm.StorageProfile. If None, the virtual machine template’s configuration and log files do not have a storage policy associated with them.

create(spec)¶

Creates a library item in content library from a virtual machine. This method creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. This method was added in vSphere API 6.8.

Parameters

spec (LibraryItems.CreateSpec) – information used to create the library item from the source virtual machine.

Return type

str

Returns

Identifier of the newly created library item. The return value will be an identifier for the resource type: com.vmware.content.library.Item.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists if an entity with the name specified by LibraryItems.CreateSpec.name already exists in the folder specified by LibraryItems.CreatePlacementSpec.folder.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if LibraryItems.CreateSpec contains invalid arguments.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the operation cannot be performed because of the source virtual machine’s current state.

Raise

com.vmware.vapi.std.errors_client.NotFound if the source virtual machine specified by LibraryItems.CreateSpec.source_vm does not exist.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library specified by LibraryItems.CreateSpec.library does not exist.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there was an error accessing a file from the source virtual machine.

Raise

com.vmware.vapi.std.errors_client.ResourceInUse if the source virtual machine is busy.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if any of the services involved in the method are unavailable.

Raise

com.vmware.vapi.std.errors_client.UnableToAllocateResource if any of the resources needed to create the virtual machine template could not be allocated.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user that requested the method cannot be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user that requested the method is not authorized to perform the method.

Raise

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

Method execution requires System.Read.
The resource com.vmware.content.Library referenced by the attribute LibraryItems.CreateSpec.library requires ContentLibrary.AddLibraryItem.
The resource VirtualMachine referenced by the attribute LibraryItems.CreateSpec.source_vm requires System.Read.
The resource Datastore referenced by the attribute LibraryItems.CreateSpecVmHomeStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecVmHomeStoragePolicy.policy requires System.Read.
The resource Datastore referenced by the attribute LibraryItems.CreateSpecDiskStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.CreateSpecDiskStoragePolicy.policy requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the dict key of attribute LibraryItems.CreateSpec.disk_storage_overrides requires System.Read.
The resource Folder referenced by the attribute LibraryItems.CreatePlacementSpec.folder requires System.Read.
The resource ResourcePool referenced by the attribute LibraryItems.CreatePlacementSpec.resource_pool requires System.Read.
The resource HostSystem referenced by the attribute LibraryItems.CreatePlacementSpec.host requires System.Read.
The resource ClusterComputeResource referenced by the attribute LibraryItems.CreatePlacementSpec.cluster requires System.Read.

deploy(template_library_item, spec)¶

Deploys a virtual machine as a copy of the source virtual machine template contained in the library item specified by template_library_item. It uses the deployment specification in spec. If LibraryItems.DeploySpec.powered_on and/or LibraryItems.DeploySpec.guest_customization are specified, the server triggers the power on and/or guest customization operations, which are executed asynchronously. This method was added in vSphere API 6.8.

Parameters

template_library_item (str) – identifier of the content library item containing the source virtual machine template to be deployed. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
spec (LibraryItems.DeploySpec) – specification of how the virtual machine should be deployed.

Return type

str

Returns

Identifier of the deployed virtual machine. The return value will be an identifier for the resource type: VirtualMachine.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists if a virtual machine with the name specified by LibraryItems.DeploySpec.name already exists.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if spec contains invalid arguments.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if either a specified host or a specified datastore is in an invalid state for the deployment, such as maintenance mode.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library item specified by template_library_item cannot be found.

Raise

com.vmware.vapi.std.errors_client.NotFound if any resource specified by a attribute of the LibraryItems.DeploySpec class, specified by spec cannot be found.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there was an error accessing the source virtual machine template contained in the library item specified by template_library_item.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if there an error accessing any of the resources specified in the spec.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if any of the services involved in the method are unavailable.

Raise

com.vmware.vapi.std.errors_client.UnableToAllocateResource if there was an error in allocating any of the resources required by the method.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user that requested the method cannot be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user that requested the method is not authorized to perform the method.

Raise

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

Method execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter template_library_item requires VirtualMachine.Provisioning.DeployTemplate.
The resource Datastore referenced by the attribute LibraryItems.DeploySpecVmHomeStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecVmHomeStoragePolicy.policy requires System.Read.
The resource Datastore referenced by the attribute LibraryItems.DeploySpecDiskStorage.datastore requires System.Read.
The resource com.vmware.spbm.StorageProfile referenced by the attribute LibraryItems.DeploySpecDiskStoragePolicy.policy requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the dict key of attribute LibraryItems.DeploySpec.disk_storage_overrides requires System.Read.
The resource Folder referenced by the attribute LibraryItems.DeployPlacementSpec.folder requires System.Read.
The resource ResourcePool referenced by the attribute LibraryItems.DeployPlacementSpec.resource_pool requires System.Read.
The resource HostSystem referenced by the attribute LibraryItems.DeployPlacementSpec.host requires System.Read.
The resource ClusterComputeResource referenced by the attribute LibraryItems.DeployPlacementSpec.cluster requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Ethernet referenced by the dict key of attribute LibraryItems.HardwareCustomizationSpec.nics requires System.Read.
The resource Network referenced by the attribute LibraryItems.EthernetUpdateSpec.network requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the attribute LibraryItems.HardwareCustomizationSpec.disks_to_remove requires System.Read.
The resource com.vmware.vcenter.vm.hardware.Disk referenced by the dict key of attribute LibraryItems.HardwareCustomizationSpec.disks_to_update requires System.Read.

get(template_library_item)¶

Returns information about a virtual machine template contained in the library item specified by template_library_item. This method was added in vSphere API 6.8.

Parameters

template_library_item (str) – identifier of the library item containing the virtual machine template. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Return type

LibraryItems.Info or None

Returns

Information about the virtual machine template item contained in the library item. If None, the library item specified by template_library_item does not contain a virtual machine template.

Raise

com.vmware.vapi.std.errors_client.Error if the system reports an error while responding to the request.

Raise

com.vmware.vapi.std.errors_client.NotFound if the library item could not be found.

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the virtual machine template’s configuration state cannot be accessed.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable if any of the services involved in the method are unavailable.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the user that requested the method cannot be authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user that requested the method is not authorized to perform the method.

Raise

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

Method execution requires System.Read.
The resource com.vmware.content.library.Item referenced by the parameter template_library_item requires System.Read.

class com.vmware.vcenter.vm_template_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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