Appliance Logging Liagent LogCollection Config

Appliance Logging Liagent LogCollection Config
Appliance Logging Liagent LogCollection Config

The Appliance Logging Liagent LogCollection Config schema defines the configurations for loginsight agent to stream vCenter service logs to loginsight server.

This schema was added in vSphere API 9.1.0.0.

JSON Example
{
    "enabled": false,
    "unitid": "string",
    "unittype": "string",
    "content": "string",
    "host": "string",
    "port": 0,
    "protocol": "string",
    "loglevel": "string",
    "certificates": [
        "string"
    ]
}
boolean
enabled
Required

Specifies whether log collection is enabled for this unit. If set to 'false', the 'content' field will contain the appropriate configuration required to disable log collection for the underlying loginsight agent.

This property was added in vSphere API 9.1.0.0.

string
unitid
Required

A unique identifier for the log collection unit, typically aligned with the component's logical or infrastructure identity.

This property was added in vSphere API 9.1.0.0.

string
unittype
Required

Value indicating the nature of the component (vCenterServer or ESXi)

For more information see: Appliance Logging Liagent LogCollection UnitType.

This property was added in vSphere API 9.1.0.0.

string
content
Required

The raw text/string content for the loginsight agent's configuration.

This property was added in vSphere API 9.1.0.0.

string
host
Optional

The hostname of the loginsight server.

This property was added in vSphere API 9.1.0.0.

If missing or null, host is not required when the liagent is being disabled.

integer As int64 As int64
port
Optional

The port number for sending log traffic to the specified loginsight server. Used in conjunction with the 'host' field to fully identify the log destination endpoint.

This property was added in vSphere API 9.1.0.0.

If missing or null, port is not required when the liagent is being disabled.

string
protocol
Optional

The protocol used for forwarding logs. Currently supported values are "cfapi" and "syslog".

This property was added in vSphere API 9.1.0.0.

If missing or null, protocol is not required when the liagent is being disabled.

string
loglevel
Optional

Desired overall log verbosity for the component.

This property was added in vSphere API 9.1.0.0.

If missing or null, loglevel is not required for vcenter, as it will be controlled in the config content.

array of string
certificates
Optional

List of PEM-encoded Certificates which will be configured to establish trust with Log insight server.

This property was added in vSphere API 9.1.0.0.

If missing or null, there is no certificate to be used.

Property Of