logging auditlog¶

Set send auditlog to syslog host

auditlog Specification¶

Parameter Value

Type Configuration Resource

Element Name auditlog

Element URI /axapi/v3/logging/auditlog

Element Attributes auditlog_attributes

Partition Visibility shared

Schema auditlog schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/logging/auditlog	auditlog attributes
POST /axapi/v3/logging/auditlog Payload: { "auditlog": { "audit-facility": "local0", "partition-name": "a", "port": 1 } }
Get Object	GET	/axapi/v3/logging/auditlog	auditlog attributes
GET /axapi/v3/logging/auditlog Reponse: { "auditlog": { "partition-name": "a", "audit-facility": "local0", "port": 1, "uuid": "c0a61450-502b-11ee-b615-95b2f1209a6a", "a10-url": "/axapi/v3/logging/auditlog" } }
Modify Object	POST	/axapi/v3/logging/auditlog	auditlog attributes
Replace Object	PUT	/axapi/v3/logging/auditlog	auditlog attributes
PUT /axapi/v3/logging/auditlog Payload: { "auditlog": { "audit-facility": "local2", "partition-name": "abcd", "port": 2 } }
Delete Object	DELETE	/axapi/v3/logging/auditlog	auditlog attributes
DELETE /axapi/v3/logging/auditlog Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

auditlog attributes¶

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,shared, partition-name, and host6 are mutually exclusive

host6

Description Configure the auditlog host

Type: string

Format: ipv6-address

Mutual Exclusion: host6,shared, partition-name, and host4 are mutually exclusive

partition-name

Description Select partition name for logging

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Mutual Exclusion: partition-name,shared, host6, and host4 are mutually exclusive

Reference Object: /axapi/v3/partition

port

Description Set remote audit log port number(Default 514)

Type: number

Range: 1-32767

Default: 514

shared

Description Select shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared,partition-name, host6, and host4 are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters