PlcmLoggingV2

PlcmLoggingV2

PlcmLoggingV2 Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
loggingLevelLoggingLevel The Logging level: production, debug, verbose_debug
advancedDiagnosticsboolean !! DEPRECATED, value may be ignored !!! Check to include advanced diagnostics in log downloads
rollingFrequencyRollingFrequency Log file rolling frequency: hourly, halfday, daily, weekly
retentionPeriodRetentionPeriod Log file retention period in days Mandatory
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.
remoteLogEnabledboolean Enables you to forward selected log entries to a central log management server
remoteServerRemoteServer The address of the destination server. It must be running some version of syslog.
syslogFacilitySyslogFacility The facility value.
logsToForwardArray of LogsToForward The log or logs to forward.
remoteServerPortint The port to use to connect to the destination syslog server.
remoteServerTransportRemoteServerTransport The transport protocol to use when connecting to the destination syslog server.

LogsToForward Fields

NameTypeDescriptionAttributes
namestringMandatory
forwardboolean Whether this log file should be forwarded. Default false.


Nested Types/Restrictions


NameTypeRestrictions
RemoteServerTransportstring
Value must be one of:
  • UDP
  • TCP
  • TLS
SyslogFacilitystring
Value must be one of:
  • LOG_DAEMON
  • LOG_LOCAL0
  • LOG_LOCAL1
  • LOG_LOCAL2
  • LOG_LOCAL3
  • LOG_LOCAL4
  • LOG_LOCAL5
  • LOG_LOCAL6
  • LOG_LOCAL7
  • LOG_USER
  • UNKNOWN
RemoteServerstring
Length of value must be >=0
Length of value must be <=256
EntityTagstring
Length of value must be >=1
Length of value must be <=64
RetentionPeriodint
RollingFrequencystring
Value must be one of:
  • hourly
  • halfday
  • daily
  • weekly
LoggingLevelstring
Value must be one of:
  • production
  • debug
  • verbose_debug