log-forwarding-configuration

log-forwarding-configuration
log-forwarding-configuration

Represents the Log Forwarding Configuration object

JSON Example
{
    "enabled": false,
    "entities": [
        "string"
    ],
    "host": "string",
    "protocol": "string",
    "port": 0,
    "useSSL": false,
    "sslCertPath": "string",
    "cluster": "string"
}
boolean
enabled
Optional

Indicates whether the logs should go to external log server or not

array of string
entities
Required

Entities to forward the logs from

Possible values are : ANALYTICS, COLLECTOR, WEB, GEMFIRE, VIEW_BRIDGE, VCOPS_BRIDGE, SUITEAPI, ADMIN_UI, TOMCAT_WEBAPP, VPOSTGRES, WATCHDOG, UPGRADE, CALL_STACK, OTHER,
string
host
Required

The host to forward the logs to

string
protocol
Required

Enumeration of the forwarding protocols

Possible values are : CFAPI, SYSLOG, UNKNOWN,
integer As int32 As int32
port
Optional

The Forwarding port


The port takes default value based on the protocol and whether SSL is enabled or not:
Protocol CFAPI, SSL disabled, Default port: 9000
Protocol CFAPI, SSL enabled, Default port: 9543
Protocol SYSLOG, SSL disabled, Default port: 514
Protocol SYSLOG, SSL enabled, Default port: 6514

boolean
useSSL
Optional

Flag that indicates whether SSL protocol is used or not

string
sslCertPath
Optional

The path to certificate authority file

string
cluster
Required

The name of the cluster

Parameter To
Returned By