openconfig-messages

openconfig-version: 0.0.1

Description

This module defines configuration and operational state data related to Syslog messages that a device may generate.

These messages are historically obtained through the Syslog transport, however this module allows for obtaining them through an alternative transport, such as a Subscribe operation over an RPC.

This module does not usurp traditional syslog servers, which may still be configured through the /yang/system/openconfig-system.yang model, rather it provies the Operator with an alternative method of consuming messages.

Imports

openconfig-extensions
openconfig-system-logging

Identities

base: DEBUG_SERVICE

description:
Base identity for debug services. Identities within this base identity are to be augmented in by vendors.

Data elements

/
messages

description:
Top-level container for Syslog messages.

nodetype: container (rw)

/messages/
config

description:
Configuration data for Syslog messages.

nodetype: container (rw)

/messages/config/
severity

description:
Specifies that only messages of the given severity (or greater severity) are sent over the RPC. This is analogous to differentiating which severity is to be sent to legacy Syslog servers, as opposed to local buffer or files.

nodetype: leaf (rw)

type: oc-log:syslog-severity

/messages/
state

description:
Operational state data for a Syslog messages.

nodetype: container (ro)

/messages/state/
severity

description:
Specifies that only messages of the given severity (or greater severity) are sent over the RPC. This is analogous to differentiating which severity is to be sent to legacy Syslog servers, as opposed to local buffer or files.

nodetype: leaf (ro)

type: oc-log:syslog-severity

/messages/state/
message

description:
Syslog messages the client is Subscribing to. This is all messages currently configured to be sent according to syslog-severity.

nodetype: container (ro)

/messages/state/message/
msg

description:
Message payload. If other leafs within this container not supported, this leaf MAY include the entire message, inclding pri, procid, app-name etc..

nodetype: leaf (ro)

type: string

/messages/state/message/
priority

description:
The Priority value (PRIVAL) represents both the Facility and Severity.

nodetype: leaf (ro)

type: uint8

/messages/state/message/
app-name

description:
The APP-NAME field SHOULD identify the device or application that originated the message.

nodetype: leaf (ro)

type: string

/messages/state/message/
procid

description:
PROCID is a value that is included in the message, having no interoperable meaning, except that a change in the value indicates there has been a discontinuity in syslog reporting.

nodetype: leaf (ro)

type: string

/messages/state/message/
msgid

description:
The MSGID SHOULD identify the type of message. For example, a firewall might use the MSGID 'TCPIN' for incoming TCP traffic and the MSGID 'TCPOUT' for outgoing TCP traffic.

nodetype: leaf (ro)

type: string

/messages/
debug-entries

description:
Enclosing container for list of debugs to enable.

nodetype: container (rw)

/messages/debug-entries/
debug-service

description:
List of debugging entries.

nodetype: list (rw)

list keys: [service]

/messages/debug-entries/debug-service/
service

description:
Reference to the debug-enable service key.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/service

/messages/debug-entries/debug-service/
config

description:
Configuration data for debug service entries.

nodetype: container (rw)

/messages/debug-entries/debug-service/config/
service

description:
Enumeration of all services which can have debugging enabled. Vendors are to augment this base identity with their platform or OS specific debug options.

nodetype: leaf (rw)

type: identityref

  • base: DEBUG_SERVICE

/messages/debug-entries/debug-service/config/
enabled

description:
Enable and disable debugging.

nodetype: leaf (rw)

type: boolean

default: false

/messages/debug-entries/debug-service/
state

description:
Operational state data for enabled debugs.

nodetype: container (ro)

/messages/debug-entries/debug-service/state/
service

description:
Enumeration of all services which can have debugging enabled. Vendors are to augment this base identity with their platform or OS specific debug options.

nodetype: leaf (ro)

type: identityref

  • base: DEBUG_SERVICE

/messages/debug-entries/debug-service/state/
enabled

description:
Enable and disable debugging.

nodetype: leaf (ro)

type: boolean

default: false