POST Log Forwarder Testconnection

POST Log Forwarder Testconnection

Tests if a log forwarding destination can be reached.

Request
URI
POST
https://{api_host}/api/v2/log-forwarder/testconnection
COPY
Request Body
forwarders.test.post.request of type(s) application/json
Optional
{
    "host": "10.10.10.10",
    "port": 9000,
    "protocol": "cfapi",
    "transportProtocol": "tcp",
    "name": "test"
}
Authentication
This operation uses the following authentication methods.
Responses
200

Test Successful.

Operation doesn't return any data structure

400

Test failed.

Returns error of type(s) application/json
{
    "errorMessage": "Failed connection with 10.10.10.10:9000."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

495

SSL connection failed.

Returns error of type(s) application/json
{
    "errorMessage": "SSL connection failed. Forwarding destination certificate is not trusted. Use \"acceptCert\":true in request to automatically accept not trusted certificate.",
    "errorDetails": {
        "errorMessage": "SSL connection failed. Forwarding destination certificate is not trusted. Use \"acceptCert\":true in request to automatically accept not trusted certificate.",
        "errorCode": "TEST_ERROR"
    }
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v2/log-forwarder/testconnection