.. _logging: logging ======= System logging configuration logging Specification --------------------- ===================================== ================================================ **Parameter** **Value** ===================================== ================================================ **Type** *Intermediate Resource* **Element Name** logging **Element URI** /axapi/v3/logging **Element Attributes** logging_attributes **Partition Visibility** None **Schema** :download:`logging schema ` ===================================== ================================================ **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/logging .. raw:: html logging_attributes .. raw:: html
.. _916_logging_attributes: logging attributes ------------------ **auditlog** **Description:** auditlog is a **JSON Block**. Please see below for :ref:`916_auditlog` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/auditlog ` **buffered** **Description:** buffered is a **JSON Block**. Please see below for :ref:`916_buffered` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/buffered ` **console** **Description:** console is a **JSON Block**. Please see below for :ref:`916_console` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/console ` **disable-partition-name** **Description:** disable-partition-name is a **JSON Block**. Please see below for :ref:`916_disable-partition-name` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/disable-partition-name ` **email** **Description:** email is a **JSON Block**. Please see below for :ref:`916_email` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/email ` **email-address** **Description:** email-address is a **JSON Block**. Please see below for :ref:`916_email-address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/email-address ` **export** **Description:** export is a **JSON Block**. Please see below for :ref:`916_export` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/export ` **facility** **Description:** facility is a **JSON Block**. Please see below for :ref:`916_facility` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/facility ` **host** **Description:** host is a **JSON Block**. Please see below for :ref:`916_host` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/host ` **monitor** **Description:** monitor is a **JSON Block**. Please see below for :ref:`916_monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/monitor ` **single-priority-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/logging/single-priority/{levelname} ` **syslog** **Description:** syslog is a **JSON Block**. Please see below for :ref:`916_syslog` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/syslog ` **trap** **Description:** trap is a **JSON Block**. Please see below for :ref:`916_trap` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/trap ` .. _916_buffered: buffered ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_email-address: email-address ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **email-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_email-address_email-list: email-address_email-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **email-address** **Description** Email address information of recipients **Type:** string **Format:** email-addr **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _916_console: console ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_monitor: monitor ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_facility: facility ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_disable-partition-name: disable-partition-name ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_email: email ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **buffer** **Description:** buffer is a **JSON Block**. Please see below for :ref:`916_email_buffer` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/email/buffer ` **filter-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/logging/email/filter/{filter-id} ` **level** **Description:** level is a **JSON Block**. Please see below for :ref:`916_email_level` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/email/level ` .. _916_email_buffer: email_buffer ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_email_filter-list: email_filter-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 511 characters **Maximum Length:** 1 characters **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_email_level: email_level ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_syslog: syslog ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_host: host ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv4addr-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/logging/host/ipv4addr/{host-ipv4} ` **ipv6addr-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/logging/host/ipv6addr/{host-ipv6} ` **partition** **Description:** partition is a **JSON Block**. Please see below for :ref:`916_host_partition` **Type:** Object **Reference Object:** :doc:`/axapi/v3/logging/host/partition ` .. _916_host_ipv6addr-list: host_ipv6addr-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_host_partition: host_partition ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_host_ipv4addr-list: host_ipv4addr-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_export: export ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _916_trap: trap ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_auditlog: auditlog ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 31 characters **Maximum Length:** 1 characters **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _916_single-priority-list: single-priority-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 64 characters **Maximum Length:** 1 characters