This API has a deprecated equivalent from v7.0U1.
Get Forwarding
Returns the configuration for forwarding log messages to remote logging servers.
Request
URLURL
https://{api_host}/api/appliance/logging/forwarding
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
LoggingForwardingConfig
of type application/json
Information about the configuration for forwarding log messages to remote logging servers.
[
{
"hostname": "string",
"port": 0,
"protocol": "TLS"
}
]
string
hostname
Required
FQDN or IP address of the logging server to which messages are forwarded.
integer
port
Required
The port on which the remote logging server is listening for forwarded log messages.
protocol
Required
The Forwarding.Protocol enumerated type defines transport protocols for outbound log messages.
TLS : Log messages will be forwarded to the remote host by using the TLS protocol.
UDP : Log messages will be forwarded to the remote host using the UDP protocol.
TCP : Log messages will be forwarded to the remote host using the TCP protocol.
Possible values are: TLS , UDP , TCP
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
Invoke-GetLoggingForwarding
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/logging/forwarding
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/logging/forwarding
x-vmw-doc-operation: get
Availability
Added in 7.0U2
