REST API - get

appliance logging forwarding: get

Returns the configuration for forwarding log messages to remote logging servers. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/logging/forwarding
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "hostname""string",
            "protocol""TLS",
            "port"1
        },
        {
            "hostname""string",
            "protocol""TLS",
            "port"1
        }
    ]
}

Response Type:

Name Type Description
bold = required
value config[] Information about the configuration for forwarding log messages to remote logging servers.
value[].hostname string FQDN or IP address of the logging server to which messages are forwarded. This attribute was added in vSphere API 6.7.

value[].port long The port on which the remote logging server is listening for forwarded log messages. This attribute was added in vSphere API 6.7.

value[].protocol string Transport protocol used to forward log messages. This attribute was added in vSphere API 6.7.

Defines transport protocols for outbound log messages. This enumeration was added in vSphere API 6.7. Value is one of:
TLS: Log messages will be forwarded to the remote host by using the TLS protocol. This constant was added in vSphere API 6.7.
UDP: Log messages will be forwarded to the remote host using the UDP protocol. This constant was added in vSphere API 6.7.
TCP: Log messages will be forwarded to the remote host using the TCP protocol. This constant was added in vSphere API 6.7.

Errors:

None