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
URI
POST
https://{api_host}/api/appliance/logging/forwarding?action=test
COPY
Request Body
Request body for invoking operation: test
{
"send_test_message": false
}
boolean
send_test_message
Optional
Flag specifying whether a default test message should be sent to the configured logging servers.
If missing or null, no test message will be sent to the configured remote logging servers.
Responses
200
Information about the status of the connection to each of the remote logging servers.
[
{
"hostname": "string",
"state": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}
]Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/appliance/logging/forwarding?action=test