REST API - test

appliance logging forwarding: test

Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server.". This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/appliance/logging/forwarding?action=test

Request Body Structure:

JSON

{
"send_test_message": true
}

Request Body Parameters:

Name	Type	Description
bold = required
send_test_message	boolean	Optional. Flag specifying whether a default test message should be sent to the configured logging servers.

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": [
        {
            "hostname": "string",
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "state": "UP"
        },
        {
            "hostname": "string",
            "message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "state": "UP"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	connection_status[]	Information about the status of the connection to each of the remote logging servers.
value[].hostname	string	FQDN or IP address of the configured remote logging servers. This attribute was added in vSphere API 6.7
value[].state	string	State of the configured remote logging server. This attribute was added in vSphere API 6.7 Defines the state values that a remote logging server can be in. This enumeration was added in vSphere API 6.7 Value is one of: UP: The remote logging server is reachable. This constant was added in vSphere API 6.7 DOWN: The remote logging server is not reachable. This constant was added in vSphere API 6.7 UNKNOWN: The status of remote logging server is unknown. This constant was added in vSphere API 6.7
value[].message	localizable_message	Message associated with the state of the configured remote logging server. This attribute was added in vSphere API 6.7 Optional. It is only relevant when state has value [DOWN]. If unset, there is no message to be shown.
value[].message.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.
value[].message.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.
value[].message.args	string[]	Arguments to be substituted into a message template.

Errors:

None