This API has a deprecated equivalent from v7.0U1.
Test Forwarding
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.”
Request
URLURL
https://{api_host}/api/appliance/logging/forwarding?action=test
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
LoggingForwardingTestRequestBody of mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"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 unset, no test message will be sent to the configured remote logging servers.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
LoggingForwardingConnectionStatus
of type application/json
Information about the status of the connection to each of the remote logging servers.
[
{
"hostname": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"state": "UP"
}
]
string
hostname
Required
FQDN or IP address of the configured remote logging servers.
state
Required
The Forwarding.ConnectionStatus.State enumerated type defines the state values that a remote logging server can be in.
UP : The remote logging server is reachable.
DOWN : The remote logging server is not reachable.
UNKNOWN : The status of remote logging server is unknown.
Possible values are: UP , DOWN , UNKNOWN
message
Optional
Message associated with the state of the configured remote logging server. If unset, there is no message to be shown.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LoggingForwardingTestRequestBody = Initialize-LoggingForwardingTestRequestBody -SendTestMessage $false
Invoke-TestLoggingForwarding -LoggingForwardingTestRequestBody $LoggingForwardingTestRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"send_test_message":false}' https://{api_host}/api/appliance/logging/forwarding?action=test
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/logging/forwarding?action=test
x-vmw-doc-operation: test
Availability
Added in 7.0U2
