com.vmware.vcenter.deployment package

Submodules

com.vmware.vcenter.deployment.install_client module

class com.vmware.vcenter.deployment.install_client.RemotePsc(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The RemotePsc class provides methods to check if the deployed vCenter Server can register with the remote PSC. This class was added in vSphere API 6.7.

Parameters

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

check(spec)

Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC. This method was added in vSphere API 6.7.

Parameters

spec (com.vmware.vcenter.deployment_client.RemotePscSpec) – Information to connect to the remote PSC.

Return type

com.vmware.vcenter.deployment_client.CheckInfo

Returns

Information about the success or failure of the checks that were performed.

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 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.install_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.migrate_client module

class com.vmware.vcenter.deployment.migrate_client.ActiveDirectory(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The ActiveDirectory class provides methods to check if the migrated vCenter Server appliance can join to the given domain using the provided credentials. This class was added in vSphere API 7.0.0.0.

Parameters

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

class CheckSpec(dns_servers=None, domain=None, username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ActiveDirectory.CheckSpec class contains information used to join the migrated vCenter Server appliance to the Active Directory. This class was added in vSphere API 7.0.0.0.

Tip

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

Parameters

  • dns_servers (list of str) – IP addresses of the DNS servers of the Active Directory server. This attribute was added in vSphere API 7.0.0.0.

  • domain (str) – The domain name of the Active Directory server to which the migrated vCenter Server appliance should be joined. This attribute was added in vSphere API 7.0.0.0.

  • username (str) – Active Directory user that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0.

  • password (str) – Active Directory user password that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0.

check(spec)

Checks whether the provided Active Directory user has permission to join the migrated vCenter Server appliance to the domain. This method was added in vSphere API 7.0.0.0.

Parameters

spec (ActiveDirectory.CheckSpec) – Information to connect to Active Directory.

Return type

com.vmware.vcenter.deployment_client.CheckInfo

Returns

Information about the success or failure of the checks that were performed.

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 INITIALIZED state.

class com.vmware.vcenter.deployment.migrate_client.ActiveDirectorySpec(domain=None, username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ActiveDirectorySpec class contains information used to join the migrated vCenter Server appliance to the Active Directory. This class was added in vSphere API 7.0.0.0.

Tip

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

Parameters

  • domain (str) – The domain name of the Active Directory server to which the migrated vCenter Server appliance should be joined. This attribute was added in vSphere API 7.0.0.0.

  • username (str) – Active Directory user that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0.

  • password (str) – Active Directory user password that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0.

class com.vmware.vcenter.deployment.migrate_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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