logging

System logging configuration.

logging Specification

Type Intermediate Resource
Element Name logging
Element URI /axapi/v3/logging
Element Attributes logging_attributes
Schema logging schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/logging

logging_attributes

logging Attributes

auditlog

Description: auditlog is a JSON Block . Please see below for auditlog

Type: Object

Reference Object: /axapi/v3/logging/auditlog

buffered

Description: buffered is a JSON Block . Please see below for buffered

Type: Object

Reference Object: /axapi/v3/logging/buffered

console

Description: console is a JSON Block . Please see below for console

Type: Object

Reference Object: /axapi/v3/logging/console

disable-partition-name

Description: disable-partition-name is a JSON Block . Please see below for disable-partition-name

Type: Object

Reference Object: /axapi/v3/logging/disable-partition-name

email

Description: email is a JSON Block . Please see below for email

Type: Object

Reference Object: /axapi/v3/logging/email

email-address

Description: email-address is a JSON Block . Please see below for email-address

Type: Object

Reference Object: /axapi/v3/logging/email-address

export

Description: export is a JSON Block . Please see below for export

Type: Object

Reference Object: /axapi/v3/logging/export

facility

Description: facility is a JSON Block . Please see below for facility

Type: Object

Reference Object: /axapi/v3/logging/facility

host

Description: host is a JSON Block . Please see below for host

Type: Object

Reference Object: /axapi/v3/logging/host

monitor

Description: monitor is a JSON Block . Please see below for monitor

Type: Object

Reference Object: /axapi/v3/logging/monitor

single-priority-list

Description: single-priority-list is a JSON List . Please see below for single-priority-list

Type: List

Reference Object: /axapi/v3/logging/single-priority/{levelname}

syslog

Description: syslog is a JSON Block . Please see below for syslog

Type: Object

Reference Object: /axapi/v3/logging/syslog

trap

Description: trap is a JSON Block . Please see below for trap

Type: Object

Reference Object: /axapi/v3/logging/trap

buffered

Specification
Type object

buffersize

Description: Logging buffer size (in items), default 30000

Type: number

Range: 10000-50000

Default: 30000

levelname

Description: ‘disable’: Do not send log to buffer; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);

Type: string

Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging

Default: debugging

partition-buffersize

Description: Logging buffer size (in items), default 3000

Type: number

Range: 1000-5000

Default: 3000

uuid

Description: uuid of the object

Type: string

email-address

Specification
Type object

email-list

Description: email-list is a JSON List . Please see below for l437_email-list

Type: List

uuid

Description: uuid of the object

Type: string

email-address.email-list

Specification
Type list
Block object keys

email-address

Description: Email address information of recipients

Type: string

Format: email-addr

console

Specification
Type object

console-levelname

Description: ‘disable’: Do not send log to console; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);

Type: string

Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging

Default: error

uuid

Description: uuid of the object

Type: string

monitor

Specification
Type object

monitor-levelname

Description: ‘disable’: Do not send log to monitor; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);

Type: string

Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging

Default: disable

uuid

Description: uuid of the object

Type: string

facility

Specification
Type object

facilityname

Description: ‘local0’: Local use; ‘local1’: Local use; ‘local2’: Local use; ‘local3’: Local use; ‘local4’: Local use; ‘local5’: Local use; ‘local6’: Local use; ‘local7’: Local use; (Facility parameter for syslog messages)

Type: string

Supported Values: local0, local1, local2, local3, local4, local5, local6, local7

Default: local0

uuid

Description: uuid of the object

Type: string

disable-partition-name

Specification
Type object

disable-partition-name

Description: Disable partition name in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

email

Specification
Type object

buffer

Description: buffer is a JSON Block . Please see below for l437_buffer

Type: Object

Reference Object: /axapi/v3/logging/email/buffer

filter-list

Description: filter-list is a JSON List . Please see below for l437_filter-list

Type: List

Reference Object: /axapi/v3/logging/email/filter/{filter-id}

level

Description: level is a JSON Block . Please see below for l437_level

Type: Object

Reference Object: /axapi/v3/logging/email/level

email.buffer

Specification
Type object

number

Description: Number of log messages that can be buffered (Number of log messages that can be buffered, default 50)

Type: number

Range: 16-256

Default: 50

time

Description: Number of minutes a log message can stay in buffer (Number of minutes a log message can stay in buffer, default 10)

Type: number

Range: 10-1440

Default: 10

uuid

Description: uuid of the object

Type: string

email.filter-list

Specification
Type list
Block object keys

expression

Description: Reverse Polish Notation, consists of level 0-7, module AFLEX/HMON/..., pattern log-content-pattern, and or/and/not

Type: string

Format: string-rlx

filter-id

Description: Logging via email filter settings

Type: number

Range: 1-8

trigger

Description: Trigger email, override buffer settings

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

email.level

Specification
Type object

email-levelname

Description: ‘disable’: Do not send log to email address; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘notification’: Normal but significant conditions (severity=5);

Type: string

Supported Values: disable, emergency, alert, critical, notification

Default: disable

uuid

Description: uuid of the object

Type: string

syslog

Specification
Type object

syslog-levelname

Description: ‘disable’: Do not send log to syslog; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);

Type: string

Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging

Default: disable

uuid

Description: uuid of the object

Type: string

host

Specification
Type object

ipv4addr-list

Description: ipv4addr-list is a JSON List . Please see below for l437_ipv4addr-list

Type: List

Reference Object: /axapi/v3/logging/host/ipv4addr/{host-ipv4}+{use-mgmt-port}

ipv6addr-list

Description: ipv6addr-list is a JSON List . Please see below for l437_ipv6addr-list

Type: List

Reference Object: /axapi/v3/logging/host/ipv6addr/{host-ipv6}

partition

Description: partition is a JSON Block . Please see below for l437_partition

Type: Object

Reference Object: /axapi/v3/logging/host/partition

host.ipv6addr-list

Specification
Type list
Block object keys

host-ipv6

Description: Set syslog host ipv6 address

Type: string

Format: ipv6-address

port

Description: Set remote syslog port number

Type: number

Range: 1-32767

Default: 514

tcp

Description: Use TCP as transport protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description: Use management port for connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

host.partition

Specification
Type object

shared

Description: Select shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

host.ipv4addr-list

Specification
Type list
Block object keys

host-ipv4

Description: Set syslog host ip address

Type: string

Format: host

port

Description: Set remote syslog port number

Type: number

Range: 1-32767

Default: 514

tcp

Description: Use TCP as transport protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description: Use management port for connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

export

Specification
Type object

all

Description: System support messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

remote-file

Description: Remote url

Type: string

Format: url

use-mgmt-port

Description: Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trap

Specification
Type object

trap-levelname

Description: ‘disable’: Do not send trap to snmp host; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2);

Type: string

Supported Values: disable, emergency, alert, critical

Default: disable

uuid

Description: uuid of the object

Type: string

auditlog

Specification
Type object

audit-facility

Description: ‘local0’: Local use; ‘local1’: Local use; ‘local2’: Local use; ‘local3’: Local use; ‘local4’: Local use; ‘local5’: Local use; ‘local6’: Local use; ‘local7’: Local use; (Configure the facility of auditlog)

Type: string

Supported Values: local0, local1, local2, local3, local4, local5, local6, local7

host4

Description: Configure the auditlog host

Type: string

Format: host

Mutual Exclusion: host4 and host6 are mutually exclusive

host6

Description: Configure the auditlog host

Type: string

Format: ipv6-address

Mutual Exclusion: host6 and host4 are mutually exclusive

uuid

Description: uuid of the object

Type: string

single-priority-list

Specification
Type list
Block object keys

levelname

Description: ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);

Type: string

Supported Values: emergency, alert, critical, error, warning, notification, information, debugging

uuid

Description: uuid of the object

Type: string