vcenter hvc links sync providers: session info

The session_info 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.

Representation:

{
    "exception"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"{
            "<string>"{
                "dt""2015-01-01T22:13:05.651Z",
                "s""string",
                "d"1.5,
                "precision"1,
                "format""SHORT_DATE",
                "i"1,
                "l"{
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{}
                            }
                        }
                    }
                }
            }
        }
    },
    "start_time""2015-01-01T22:13:05.651Z",
    "completed_work"1,
    "completion_time""2015-01-01T22:13:05.651Z",
    "stage""CHANGE_DETECTION",
    "total_work"1
}
{
    "exception"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"[
            {
                "value"{
                    "dt""2015-01-01T22:13:05.651Z",
                    "s""string",
                    "d"1.5,
                    "precision"1,
                    "format""SHORT_DATE",
                    "i"1,
                    "l"{
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                },
                "key""string"
            }
        ]
    },
    "start_time""2015-01-01T22:13:05.651Z",
    "completed_work"1,
    "completion_time""2015-01-01T22:13:05.651Z",
    "stage""CHANGE_DETECTION",
    "total_work"1
}

Attributes:

Name Type Description
Required
-.stage string 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.

The stage structure 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. Value is one of:
CHANGE_DETECTION: Changes are being detected on the source replica. Warning: This constant 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: Changes from the source replica are being enumerated. Warning: This constant 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_APPLICATION: Changes are being applied to the destination replica. Warning: This constant 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: Sync has completed. Warning: This constant 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: Sync failed. Warning: This constant 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: Session is waiting for progress to be set. Warning: This constant 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.

-.start_time date_time 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.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-.exception.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-.exception.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Optional
-.completion_time date_time 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.

Optional. It is only relevant when stage has value [FAILED, COMPLETED]. If unset there is an ongoing sync that has not completed.

-.exception localizable_message 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.

Optional. It is only relevant when stage has value [FAILED]. This field is optional and it is only relevant when the value of stage is FAILED.

-.exception.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.

-.exception.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.