com.vmware.vcenter.hvc.links package¶

Submodules¶

com.vmware.vcenter.hvc.links.sync_client module¶

class com.vmware.vcenter.hvc.links.sync_client.Providers(config)¶

Bases: vmware.vapi.bindings.stub.VapiInterface

The Providers class provides methods to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Credentials class specifies user credentials to make a successful connection to remote endpoint. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
password (str) – Password for the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class Info(last_sync_time=None, status=None, polling_interval_in_seconds=None, current_session_info=None, status_message=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Info class contains information about sync for a provider. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

last_sync_time (datetime.datetime or None) – Last sync time for the provider. This indicates the last time that either a background sync or a force sync was started for the provider. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None no sync was found for the provider.
status (Providers.Status) – Last Sync status for the provider. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
polling_interval_in_seconds (long) – Sync Polling interval between local and remote replicas for the provider. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
current_session_info (Providers.SessionInfo or None) – Returns information on the forced sync for the provider. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None there is no outstanding sync session created for this provider
status_message (com.vmware.vapi.std_client.LocalizableMessage) – Localizable messages associated with sync status. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This attribute is optional and it is only relevant when the value of status is Providers.Status.FAILED.

RESOURCE_TYPE = 'com.vmware.vcenter.hvc.links.sync.Providers'¶: Resource type for Sync Providers. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class SessionInfo(stage=None, completed_work=None, total_work=None, completion_time=None, start_time=None, exception=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.SessionInfo class contains sync session information. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters

stage (Providers.SessionInfo.Stage) – Sync stage for the session. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
completed_work (long) – Completed work for the session. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
total_work (long) – Total work for the session. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
completion_time (datetime.datetime) – Time at which forced sync session was completed. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. If None there is an ongoing sync that has not completed
start_time (datetime.datetime) – Time at which force sync was initiated. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
exception (com.vmware.vapi.std_client.LocalizableMessage) – Exception message if there is a sync failure on forced sync. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This attribute is optional and it is only relevant when the value of stage is Providers.SessionInfo.Stage.FAILED.

class Stage(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.SessionInfo.Stage class defines the different stages of Sync. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

CHANGE_APPLICATION = Stage(string='CHANGE_APPLICATION')¶: Changes are being applied to the destination replica. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

CHANGE_DETECTION = Stage(string='CHANGE_DETECTION')¶: Changes are being detected on the source replica. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

CHANGE_ENUMERATION = Stage(string='CHANGE_ENUMERATION')¶: Changes from the source replica are being enumerated. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

COMPLETED = Stage(string='COMPLETED')¶: Sync has completed. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

FAILED = Stage(string='FAILED')¶: Sync failed. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

WAITING = Stage(string='WAITING')¶: Session is waiting for progress to be set. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Providers.Status class defines valid sync status. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

FAILED = Status(string='FAILED')¶: If Sync failed. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

NO_SYNC_FOUND = Status(string='NO_SYNC_FOUND')¶: If Sync has not been triggered. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

SUCCEEDED = Status(string='SUCCEEDED')¶: If Sync was successful. Warning: This class attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

class Summary(provider=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Providers.Summary class contains information about a provider. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

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

Parameters: provider (str) – Sync provider id. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.sync.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.hvc.links.sync.Providers.

get(link, provider)¶

Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters

link (str) – Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
provider (str) – Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

Return type

Providers.Info

Returns

The Info of sync information for the provider.

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 sync provider associated with provider does not exist.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user is not authorized to perform this operation.

list(link)¶

Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters: link (str) – Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
Return type: list of Providers.Summary
Returns: The list of sync provider information.
Raise: com.vmware.vapi.std.errors_client.Error If list fails.
Raise: com.vmware.vapi.std.errors_client.Unauthorized If the user is not authorized to perform this operation.

start(link, provider)¶

Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Parameters

link (str) – Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
provider (str) – Unique identifier representing the sync provider The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.

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 link associated with link does not exist if the provider associated with provider is not registered for sync

Raise

com.vmware.vapi.std.errors_client.Unauthorized if the user is not authorized to perform this operation.

Raise

com.vmware.vapi.std.errors_client.ResourceBusy if a sync is already running.

class com.vmware.vcenter.hvc.links.sync_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

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