REST API - set

appliance logging forwarding: set

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

Request:

HTTP request

PUT https://{server}/rest/appliance/logging/forwarding

Request Body Structure:

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

Request Body Parameters:

Name	Type	Description
bold = required
cfg_list	config[]	The cfgList is a list of Config structure that contains the log message forwarding rules in terms of the host, port, protocol of the log message.
cfg_list[].hostname	string	FQDN or IP address of the logging server to which messages are forwarded. This attribute was added in vSphere API 6.7.
cfg_list[].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.
cfg_list[].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.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
400	invalid_argument	if an invalid configuration is provided.
500	unable_to_allocate_resource	if the number of configurations exceeds the maximum number of supported configurations.
500	error	if there is any internal error during the execution of the operation.