vcenter hlm community: status

The status structure contains fields that are used to describe the outcome of a single direction connectivity check. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "latency"1,
    "destination""string",
    "source""string",
    "failed"true,
    "errors"[
        {
            "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"{}
                                }
                            }
                        }
                    }
                }
            }
        },
        {
            "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"{}
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}
{
    "latency"1,
    "destination""string",
    "source""string",
    "failed"true,
    "errors"[
        {
            "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"
                }
            ]
        },
        {
            "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"
                }
            ]
        }
    ]
}

Attributes:

Name Type Description
Required
-.source string The hostname of the node issuing network calls. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.destination string The hostname of the destination node. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.latency long The latency in milliseconds from source to destination. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.failed boolean This is set to true if there are any error messages in the per path network checks. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.errors localizable_message[] The list of any error messages. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.errors[].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.

-.errors[].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.

-.errors[].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.