Set Forwarding
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Sets the configuration for forwarding log messages to remote log servers.
Request
URLURL
https://{api_host}/rest/appliance/logging/forwarding
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
LoggingForwardingSetRequestBody of type application/json (required){
"cfg_list": [
{
"hostname": "string",
"port": 0,
"protocol": "enum"
}
]
}
array of
LoggingForwardingConfig
cfg_list
Required
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.
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cfg_list":[{"hostname":"string","port":0,"protocol":"enum"}]}' https://{api_host}/rest/appliance/logging/forwarding
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if an invalid configuration is provided.
404
com.vmware.vapi.std.errors.error : if there is any internal error during the execution of the operation.
507
com.vmware.vapi.std.errors.unable_to_allocate_resource : if the number of configurations exceeds the maximum number of supported configurations.
