System SYSLOG

System SYSLOG Attributes
| Attribute | Values | Default | Req | Description |
|---|---|---|---|---|
| Admin-state | enabled | disabled | False | Y | Whether or not to enable the syslog daemon on the OLT. |
| Server | Container for Syslog servers to sent syslog messages to. | |||
| Index | Uint32 | N/A | Y | The priority to advertise for this bridge via LACP. |
| Admin-state | enabled | disabled | enabled | N | Whether to enable sending messages to this particular syslog server |
| Host | hostname | ip | N/A | Y | The hostname or IP of the syslog server. Hostnames require that the DNS server entry be populated. |
| Protocol | udp | tcp | tls | udp | N | Whether to send the syslog messages via UDP, TCP, or TLS to the syslog server. |
| Secure | e-none | e-client-authentication | e-server-authentication | e-mutual-authentication |
N | N | If TLS is defined, the value must be set to define which type of authentication is preferred. |
| Port | 1..65535 | 514 | N | The port on the Syslog server to send to. The default port is 514, but it is common to use 1514 to avoid use of privileged ports. |
| Others-facility | Int32 | 23 | The default facility type to apply to any messages which don’t have explicit mappings. | |
| Aux-facility-mappings | Container for facility mappings. This allows mapping of syslog message types to specific facility types in the outgoing syslog messages. This allows specific message types to map to the facility expected by the target server. This only needs to be done if you need to change from the default of local-7 facility. | |||
| Index | Int32 | N/A | N | Index of the facility mapping. |
| Log-class | String | N/A | Y | The specific class to map to the specified facility value. |
| Facility | Int32 | 23 | Y | Specifies the facility value to map to |
| Filters | Containers for filters. A Null filter says send all syslog messages. A specified filter says only send messages which match filters in this list. |
|||
| Index | Int32 | N/A | Y | ID of the filter record. |
| Level | Int32 | N/A | Y | The level of messages to forward to the syslog server. -1 Not used. 0 Emergency 1 Alert 2 Critical 3 Error 4 Warning 5 Notice 6 Informational 7 Debug. |
| Log-class | String | N/A | N | The log class to match against in syslog messages that should be forwarded. Null string is a wildcard. |
| Msg-ids | Int32 | N/A | N | The message ID in syslog messages is matched for messages that should be forwarded. |
Note 2: Note that matches in any of the filter fields will forward the message. Combinations of Message IDs, log classes, and levels can be used to match against.
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types –
- *Admin-state – Whether or not to enable the syslog daemon on the OLT.
- enabled | disabled (Default False)
- Server – Container for Syslog servers to send syslog messages to.
- *Index – The id of the syslog server entry.
- Uint32
- Admin-state – The priority to advertise for this bridge via LACP.
- enabled | disabled (default enabled)
- *Host – The hostname or IP of the syslog server. Hostnames require that the DNS server entry be populated.
- hostname | ip
- Protocol – Whether to send the syslog messages via UDP, TCP, or TLS to the syslog server
- udp | tcp | tls (Default udp)
- Secure – If TLS is defined, the value must be set to define which type of authentication is preferred.
- e-none | e-client-authentication | e-server-authentication | e-mutual-authentication (Default e-none)
- Port – The port on the Syslog server to send to. The default port is 514, but it is common to use 1514 to avoid use of privileged ports
- 1..65535 (Default 514)
- Others-facility – The default facility type to apply to any messages which don’t have explicit mappings.
- Int32 (Default 23)
- *Index – The id of the syslog server entry.
- Aux-facility-mappings – Container for facility mappings. This allows mapping of syslog message types to specific facility types in the outgoing syslog messages. This allows specific message types to map to the facility expected by the target server. This only needs to be done if you need to change from the default of local-7 facility.
- Index – Index of the facility mapping
- Int32
- *Log-class – The specific class to map to the specified facility value.
- String
- *Facility – Specifies the facility value to map to
- Int32 (Default 23)
- Index – Index of the facility mapping
- Filters – Containers for filters.
A Null filter says send all syslog messages.
A specified filter says only send messages which match filters in this list.- *Index – ID of the filter record.
- Int32 (Default 23)
- *Level – The level of messages to forward to the syslog server.
-1 Not used.
0 Emergency
1 Alert
2 Critical
3 Error
4 Warning
5 Notice
6 Informational
7 Debug.- Int32
- Log-class – The log class to match against in syslog messages that should be forwarded. Null string is a wildcard.
- String
- Msg-ids – The message ID in syslog messages to match for messages that should be forwarded.
- Int32
- *Index – ID of the filter record.
- *Admin-state – Whether or not to enable the syslog daemon on the OLT.
System Enable Syslog Agent
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- admin-state enabled
- From the MDS1-ESUA<Config># command line, input tolt system syslog config admin-state enabled and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<Config># tolt system syslog config admin-state enabled <enter> MDS1-ESUA<Config># commit <enter> commit complete. MDS1-ESUA<Config># _
System Disable Syslog Agent
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- admin-state disabled
- From the MDS1-ESUA<Config># command line, input tolt system syslog config admin-state disabled and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<Config># tolt system syslog config admin-state disabled <enter> MDS1-ESUA<Config># commit <enter> commit complete. MDS1-ESUA<Config># _
System Add Syslog Server
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- servers 1
- admin-state enabled
- host 172.28.152.168
- port 514
- protocol udp
- From the MDS1-ESUA<config># command line, input tolt system syslog config servers 1 admin-state enabled host 172.28.152.168 port 514 protocol udp and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<config># tolt system syslog config servers 1 admin-state enabled host 172.28.152.168 port 514 protocal udp <enter> MDS1-ESUA<config-servers-1># commit <enter> commit complete. MDS1-ESUA<config-servers-1># exit <enter> MDS1-ESUA<config>#
System Delete Syslog Server
- Command Path – no>tolt>system>syslog>config>
- Action – no
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- servers 1
- From the MDS1-ESUA<Config># command line, input notolt system syslog config servers 1 and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<Config># no tolt system syslog config servers 1 <enter> MDS1-ESUA(<Config># commit <enter> commit complete. MDS1-ESUA<Config># _
System Delete All Syslog Servers
- Command Path – no>tolt>system>syslog>config>
- Action – no
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- servers
- From the MDS1-ESUA<Config># command line, input no tolt system syslog config servers and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<Config># no tolt system syslog config servers <enter> MDS1-ESUA<Config># commit <enter> commit complete. MDS1-ESUA<Config># _
System Enable Syslog Servers
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- servers 1
- admin-state enabled
- From the MDS1-ESUA<config># command line, input tolt system syslog config servers 1 admin-state enabled and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<config># tolt system syslog config servers 1 admin-state enabled <enter> MDS1-ESUA<config-servers-1># commit <enter> commit complete. MDS1-ESUA<config-servers-1># exit <enter> MDS1-ESUA<config>#
System Disable Syslog Servers
- Command Path – tolt>system>syslog>config>
- Module – tolt
- Container – system
- Container – syslog
- Container – config
- Types – Example Parameters
- servers 1
- admin-state enabled
- From the MDS1-ESUA<config># command line, input tolt system syslog config servers 1 admin-state enabled and press Enter.
- Input commit and press Enter. Outputs similar to the following are displayed:
MDS1-ESUA<Config># tolt system syslog config servers 1 admin-state enabled <enter> MDS1-ESUA<config-servers-1># commit <enter> commit complete. MDS1-ESUA<config-servers-1># exit <enter> MDS1-ESUA<config>#
Syslog Facility Code Table
Facility names are used to specify what type of program or software is logging the message. This lets the configuration file specify that messages from different facilities are handled differently.
The following table summarizes the default log facility values for syslog.
|
Number |
Keyword |
Description |
|
0 |
kern |
kernel messages |
|
1 |
user |
user-level messages |
|
2 |
|
mail system |
|
3 |
daemon |
system daemons |
|
4 |
auth |
security/authorization messages |
|
5 |
syslog |
Messages generated internally by syslogd |
|
6 |
lpr |
line printer system |
|
7 |
news |
network news system |
|
8 |
uucp |
UUCP subsystem |
|
9 |
|
clock daemon |
|
10 |
authpriv |
security/authorization messages |
|
11 |
ftp |
FTP daemon |
|
12 |
– |
NTP subsystem |
|
13 |
– |
log audit |
|
14 |
– |
log alert |
|
15 |
cron |
clock daemon |
|
16 |
local0 |
local use 0 (local0) |
|
17 |
local1 |
local use 1 (local1) |
|
18 |
local2 |
local use 2 (local2) |
| 19 | local3 | local use 3 (local3) |
| 20 | local4 | local use 4 (local4) |
| 21 | local5 | local use 5 (local5) |
| 22 | local6 | local use 6 (local6) |
| 23 | local7 | local use 7 (local7) |