Syslog Server Commands

nv show system syslog

Show syslog configuration.

It shows the next information: log format, servers list, trap level.

Syntax Description

N/A

Default

N/A

History

25.02.2002

Example

REST API

GET https://<ip>/nvue_v1/system/syslog

Related Commands

nv show system log rotation

Notes

nv show system syslog format

Show syslog format.

Syntax Description

N/A

Default

N/A

History

25.02.2002

Example

REST API

GET https://<ip>/nvue_v1/system/syslog/format

Related Commands

nv show system log rotation

Notes

nv show system syslog server

Show remote syslog servers.

Syntax Description

N/A

Default

N/A

History

25.02.2002

Example

REST API

GET https://<ip>/nvue_v1/system/syslog/server

Related Commands

Notes

nv show system syslog server <server-id>

Show remote syslog server configuration.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

Default

N/A

History

25.02.2002

Example

REST API

GET https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes

nv unset system syslog

Clear syslog global parameters. It completely removes syslog configuration.

Syntax Description

N/A

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog

Related Commands

nv show system log rotation

Notes

nv set system syslog format [standard | welf]

nv unset system syslog format

Set the log format.

The unset form of the command resets format to default value.

Syntax Description

N/A

Default

Standard

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/format

Related Commands

nv set system syslog format welf firewall-name

Notes

nv set system server <server-id> filter exclude <regex>

nv unset system server <server-id> filter exclude

Define the filter to exclude logs from sending to remote server.

The unset form of the command clears the filter.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

regex

Pattern to exclude logs from sending

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}/filter

Related Commands

nv set system syslog server filter include

Notes

Setting exclude filter clears include filter.

nv set system server <server-id> filter include <regex>

nv unset system server <server-id> filter include

Define the filter to include logs to send to remote server.

The unset form of the command clears the filter.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

regex

Pattern to include logs to send

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}/filter/include

Related Commands

nv set system syslog server filter exclude

Notes

Setting include filter clears exclude filter.

nv set system format welf firewall-name <name>

nv unset system format welf firewall-name

Set WELF format firewall name.

The unset form of that command clears the firewall name.

Syntax Description

Name

Log firewall name to include into WELF log format.

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/format/welf

Related Commands

Notes

nv unset system syslog server

Clear remote syslog servers.

Syntax Description

N/A

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server

Related Commands

Notes

nv set system syslog server {server-id}

nv unset system syslog server {server-id}

Set new remote syslog server.

The unset form of the command clears a specific server.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes

nv set system server <server-id> trap <severity>

nv unset system server <server-id> trap

Set the minimum log level to send the logs to remote server.

The unset form of the command clears trap.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

severity

Options: debug | info | notice | warn | error | critical | none

Default

N/A

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes

Overrides global syslog trap.

nv set system server <server-id> port <port-number>

nv unset system server <server-id> port

Set the port over which to communicate with remote syslog server.

The unset form of the command returns port to default.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

port-number

Port number of the remote syslog server: 1–65535

Default

512

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes

nv set system server <server-id> protocol [tcp | udp]

nv unset system server <server-id> protocol

Set the protocol over which to communicate with remote syslog server.

The unset form of the command returns the protocol to default.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

Default

udp

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes

nv set system server <server-id> vrf [default | mgmt]

nv unset system server <server-id> vrf [default | mgmt]

Specify the VRF over which to communicate with the remote server.

The unset form of the command returns VRF to default.

Syntax Description

server-id

Remote syslog server ipv4, or ipv6, or hostname

Default

default

History

25.02.2002

Example

REST API

PATCH https://<ip>/nvue_v1/system/syslog/server/{server-id}

Related Commands

Notes