This API has a deprecated equivalent from v7.0U1.
Set Forwarding
DescriptionSets the configuration for forwarding log messages to remote log 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"
Request Body
Request Body
LoggingForwardingSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"cfg_list": [
{
"hostname": "string",
"port": 0,
"protocol": "TLS"
}
]
}
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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if the number of configurations exceeds the maximum number of supported configurations. | com.vmware.vapi.std.errors.error : if there is any internal error during the execution of the operation.
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
$LoggingForwardingConfig = Initialize-LoggingForwardingConfig -Hostname "MyHostname" -Port 0 -Protocol "TLS"
$LoggingForwardingSetRequestBody = Initialize-LoggingForwardingSetRequestBody -CfgList $LoggingForwardingConfig
Invoke-SetLoggingForwarding -LoggingForwardingSetRequestBody $LoggingForwardingSetRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cfg_list":[{"hostname":"string","port":0,"protocol":"TLS"}]}' 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: put
x-vmw-doc-deprecated-path: /rest/appliance/logging/forwarding
x-vmw-doc-operation: set
Availability
Added in 7.0U2
