logging host¶
Set remote syslog host DNS name or ip address
host Specification¶
Type Intermediate Resource Element Name host Element URI /axapi/v3/logging/host Element Attributes host_attributes Schema host schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Get Object | GET | /axapi/v3/logging/host | host_attributes |
host attributes¶
ipv4addr-list
Type: List
Reference Object: /axapi/v3/logging/host/ipv4addr/{host-ipv4}
ipv6addr-list
Type: List
Reference Object: /axapi/v3/logging/host/ipv6addr/{host-ipv6}
partition
Description: partition is a JSON Block. Please see below for partition
Type: Object
Reference Object: /axapi/v3/logging/host/partition
ipv6addr-list¶
Specification Type list Block object keys host-ipv6
Description Set syslog host ipv6 address
Type: string
Format: ipv6-address
over-tls
Description Enable remote logging over TLS session
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
partition¶
Specification Type object partition-name
Description Select partition name for logging
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Mutual Exclusion: partition-name and shared are mutually exclusive
Reference Object: /axapi/v3/partition
shared
Description Select shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared and partition-name are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ipv4addr-list¶
Specification Type list Block object keys host-ipv4
Description Set syslog host ip address
Type: string
Format: host
over-tls
Description Enable remote logging over TLS session
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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