HvcLinksSyncProvidersSessionInfo

The Providers.SessionInfo structure contains sync session information. Warning: This structure 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.


Properties

integer as int64
completed_work Required

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.


string as date-time
completion_time Optional

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 unset there is an ongoing sync that has not completed


exception Optional

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 field is optional and it is only relevant when the value of Providers.SessionInfo.stage is FAILED.


stage Required

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.

Possible values are: CHANGE_DETECTIONCHANGE_ENUMERATIONCHANGE_APPLICATIONCOMPLETEDFAILEDWAITING


string as date-time
start_time Required

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.


integer as int64
total_work Required

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.

JSON Example

{
    "completed_work": 0,
    "stage": "enum",
    "start_time": "string",
    "total_work": 0
}
Feedback

Was this page helpful?