cgnv6 template logging¶
Logging Template
logging Specification¶
Parameter
Value
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/cgnv6/template/logging
Element Name
logging
Element URI
/axapi/v3/cgnv6/template/logging/{name}
Element Attributes
logging_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/cgnv6/template/logging | ||
Create List | POST | /axapi/v3/cgnv6/template/logging | ||
Get Object | GET | /axapi/v3/cgnv6/template/logging/{name} | ||
Get List | GET | /axapi/v3/cgnv6/template/logging | ||
Modify Object | POST | /axapi/v3/cgnv6/template/logging/{name} | ||
Replace Object | PUT | /axapi/v3/cgnv6/template/logging/{name} | ||
Replace List | PUT | /axapi/v3/cgnv6/template/logging | ||
Delete Object | DELETE | /axapi/v3/cgnv6/template/logging/{name} | ||
logging-list¶
logging-list is JSON List of logging attributes
logging-list : [
]
logging attributes¶
batched-logging-disable
Description Disable multiple logs per packet
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom
Description: custom is a JSON Block. Please see below for custom
Type: Object
disable-log-by-destination
Description: disable-log-by-destination is a JSON Block. Please see below for disable-log-by-destination
Type: Object
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination
facility
Description ‘kernel’: 0: Kernel; ‘user’: 1: User-level; ‘mail’: 2: Mail; ‘daemon’: 3: System daemons; ‘security-authorization’: 4: Security/authorization; ‘syslog’: 5: Syslog internal; ‘line-printer’: 6: Line printer; ‘news’: 7: Network news; ‘uucp’: 8: UUCP subsystem; ‘cron’: 9: Time-related; ‘security-authorization-private’: 10: Private security/authorization; ‘ftp’: 11: FTP; ‘ntp’: 12: NTP; ‘audit’: 13: Audit; ‘alert’: 14: Alert; ‘clock’: 15: Clock-related; ‘local0’: 16: Local use 0; ‘local1’: 17: Local use 1; ‘local2’: 18: Local use 2; ‘local3’: 19: Local use 3; ‘local4’: 20: Local use 4; ‘local5’: 21: Local use 5; ‘local6’: 22: Local use 6; ‘local7’: 23: Local use 7;
Type: string
Supported Values: kernel, user, mail, daemon, security-authorization, syslog, line-printer, news, uucp, cron, security-authorization-private, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7
Default: local0
format
Description ‘binary’: Binary logging format; ‘compact’: Compact ASCII logging format (Hex format with compact representation); ‘custom’: Arbitrary custom logging format; ‘default’: Default A10 logging format (ASCII); ‘rfc5424’: RFC5424 compliant logging format; ‘cef’: Common Event Format for logging;
Type: string
Supported Values: binary, compact, custom, default, rfc5424, cef
Default: default
include-destination
Description Include the destination IP and port in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-http
Description: include-http is a JSON Block. Please see below for include-http
Type: Object
include-inside-user-mac
Description Include the inside user MAC address in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-partition-name
Description Include partition name in logging events
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-port-block-account
Description include bytes accounting information in port-batch-v2 port-mapping and fixed-nat user-ports messages
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-radius-attribute
Description: include-radius-attribute is a JSON Block. Please see below for include-radius-attribute
Type: Object
include-session-byte-count
Description include byte count in session deletion logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-year
Description including the 4-digit year in CEF, compact and default logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log
Description: log is a JSON Block. Please see below for log
Type: Object
log-receiver
Description: log-receiver is a JSON Block. Please see below for log-receiver
Type: Object
name
Description Logging template name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
resolution
Description ‘seconds’: Logging timestamp resolution in seconds (default); ‘10-milliseconds’: Logging timestamp resolution in 10s of milli-seconds;
Type: string
Supported Values: seconds, 10-milliseconds
Default: seconds
rfc-custom
Description: rfc-custom is a JSON Block. Please see below for rfc-custom
Type: Object
rule
Description: rule is a JSON Block. Please see below for rule
Type: Object
service-group
Description Set NAT logging service-group
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
severity
Description: severity is a JSON Block. Please see below for severity
Type: Object
shared
Description Service group is in shared patition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
source-address
Description: source-address is a JSON Block. Please see below for source-address
Type: Object
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/source-address
source-port
Description: source-port is a JSON Block. Please see below for source-port
Type: Object
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
log¶
Specification
Value
Type
object
fixed-nat
Description: fixed-nat is a JSON Block. Please see below for log_fixed-nat
Type: Object
http-requests
Description ‘host’: Log the HTTP Host Header; ‘url’: Log the HTTP Request URL;
Type: string
Supported Values: host, url
map-dhcpv6
Description: map-dhcpv6 is a JSON Block. Please see below for log_map-dhcpv6
Type: Object
merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
one-to-one-nat
Description: one-to-one-nat is a JSON Block. Please see below for log_one-to-one-nat
Type: Object
port-mappings
Description ‘creation’: Log only creation of NAT mappings; ‘disable’: Disable Log creation and deletion of NAT mappings; ‘both’: Log creation and deletion of NAT mappings;
Type: string
Supported Values: creation, disable, both
Default: both
port-overloading
Description Force logging of all port-overloading sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sessions
Description Log all data sessions created using NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-data
Description Log LSN Subscriber Information
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log_fixed-nat¶
Specification
Value
Type
object
fixed-nat-http-requests
Description ‘host’: Log the HTTP Host Header; ‘url’: Log the HTTP Request URL;
Type: string
Supported Values: host, url
fixed-nat-merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fixed-nat-port-mappings
Description ‘both’: Log creation and deletion of NAT mappings; ‘creation’: Log creation of NAT mappings;
Type: string
Supported Values: both, creation
fixed-nat-sessions
Description Log all Fixed NAT sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-ports
Description: user-ports is a JSON Block. Please see below for log_fixed-nat_user-ports
Type: Object
log_fixed-nat_user-ports¶
Specification
Value
Type
object
days
Description Specify period in days
Type: number
Range: 1-30
start-time
Description Time when periodic logging starts (Specify start time(hh:mm))
Type: string
Format: time-hhmm
user-ports
Description Log Fixed NAT User Ports Configured
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log_one-to-one-nat¶
Specification
Value
Type
object
one-to-one-merged-style
Description Merge creation and deletion of session logs to one
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
one-to-one-nat-sessions
Description Log all One-to-One NAT sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log_map-dhcpv6¶
Specification
Value
Type
object
map-dhcpv6-msg-type
Type: List
map-dhcpv6-prefix-all
Description Log MAP DHCPv6 prefix assignment/renewal/release
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: map-dhcpv6-prefix-all and map-dhcpv6-msg-type are mutually exclusive
log_map-dhcpv6_map-dhcpv6-msg-type¶
Specification
Value
Type
list
Block object keys
map-dhcpv6-msg-type
Description ‘prefix-assignment’: Log MAP DHCPv6 prefix assignment; ‘prefix-renewal’: Log MAP DHCPv6 prefix renewal; ‘prefix-release’: Log MAP DHCPv6 prefix release;
Type: string
Supported Values: prefix-assignment, prefix-renewal, prefix-release
Mutual Exclusion: map-dhcpv6-msg-type and map-dhcpv6-prefix-all are mutually exclusive
include-radius-attribute¶
Specification
Value
Type
object
attr-cfg
Type: List
framed-ipv6-prefix
Description Include radius attributes for the prefix
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
insert-if-not-existing
Description Configure what string is to be inserted for custom RADIUS attributes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
no-quote
Description No quotation marks for RADIUS attributes in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
prefix-length
Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;
Type: string
Supported Values: 32, 48, 64, 80, 96, 112
zero-in-custom-attr
Description Insert 0000 for standard and custom attributes in log string
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-radius-attribute_attr-cfg¶
Specification
Value
Type
list
Block object keys
attr
Description ‘imei’: Include IMEI; ‘imsi’: Include IMSI; ‘msisdn’: Include MSISDN; ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3; ‘custom4’: Customized attribute 4; ‘custom5’: Customized attribute 5; ‘custom6’: Customized attribute 6;
Type: string
Supported Values: imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6
attr-event
Description ‘http-requests’: Include in HTTP request logs; ‘port-mappings’: Include in port-mapping logs; ‘sessions’: Include in session logs; ‘user-data’: Include in user-data logs;
Type: string
Supported Values: http-requests, port-mappings, sessions, user-data
include-http¶
Specification
Value
Type
object
file-extension
Description HTTP file extension
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
header-cfg
Type: List
l4-session-info
Description Log the L4 session information of the HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
method
Description Log the HTTP Request Method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
request-number
Description HTTP Request Number
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-http_header-cfg¶
Specification
Value
Type
list
Block object keys
custom-header-name
Description Header name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
custom-max-length
Description Max length for a HTTP request log (Max header length (Default: 100 char))
Type: number
Range: 100-1000
Default: 100
http-header
Description ‘cookie’: Log HTTP Cookie Header; ‘referer’: Log HTTP Referer Header; ‘user-agent’: Log HTTP User-Agent Header; ‘header1’: Log HTTP Header 1; ‘header2’: Log HTTP Header 2; ‘header3’: Log HTTP Header 3;
Type: string
Supported Values: cookie, referer, user-agent, header1, header2, header3
max-length
Description Max length for a HTTP request log (Max header length (Default: 100 char))
Type: number
Range: 100-1000
Default: 100
rule¶
Specification
Value
Type
object
interim-update-interval
Description Log interim update of NAT mappings (Interim update interval in minutes(Interval is floored to a multiple of 5))
Type: number
Range: 15-120
rule-http-requests
Description: rule-http-requests is a JSON Block. Please see below for rule_rule-http-requests
Type: Object
rule_rule-http-requests¶
Specification
Value
Type
object
dest-port
Type: List
disable-sequence-check
Description Disable http packet sequence check and don’t drop out of order packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
include-all-headers
Description Include all configured headers despite of absence in HTTP request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
log-every-http-request
Description Log every HTTP request in an HTTP 1.1 session (Default: Log the first HTTP request in a session)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-url-len
Description Max length of URL log (Max URL length (Default: 128 char))
Type: number
Range: 100-1000
Default: 128
rule_rule-http-requests_dest-port¶
Specification
Value
Type
list
Block object keys
dest-port-number
Description
Type: number
Range: 1-65535
include-byte-count
Description Include the byte count of HTTP Request/Response in CGN session deletion logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
severity¶
Specification
Value
Type
object
severity-string
Description ‘emergency’: 0: Emergency; ‘alert’: 1: Alert; ‘critical’: 2: Critical; ‘error’: 3: Error; ‘warning’: 4: Warning; ‘notice’: 5: Notice; ‘informational’: 6: Informational; ‘debug’: 7: Debug;
Type: string
Supported Values: emergency, alert, critical, error, warning, notice, informational, debug
Default: debug
Mutual Exclusion: severity-string and severity-val are mutually exclusive
severity-val
Description Logging severity level
Type: number
Range: 0-7
Default: 7
Mutual Exclusion: severity-val and severity-string are mutually exclusive
log-receiver¶
Specification
Value
Type
object
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
radius
Description Use RADIUS server for NAT logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-string
Description The RADIUS server’s secret
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
source-port¶
Specification
Value
Type
object
any
Description Use any source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: any and source-port-num are mutually exclusive
source-port-num
Description Set source port for sending NAT syslogs (default: 514)
Type: number
Range: 1-65535
Default: 514
Mutual Exclusion: source-port-num and any are mutually exclusive
rfc-custom¶
Specification
Value
Type
object
header
Description: header is a JSON Block. Please see below for rfc-custom_header
Type: Object
message
Description: message is a JSON Block. Please see below for rfc-custom_message
Type: Object
rfc-custom_header¶
Specification
Value
Type
object
use-alternate-timestamp
Description Use alternate non-RFC5424 compliant timestamp. Ex: 1990 Jan 15 12:30:30
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rfc-custom_message¶
Specification
Value
Type
object
dhcpv6-map-prefix-assigned
Description MAP DHCPv6 prefix assigned
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
dhcpv6-map-prefix-released
Description MAP DHCPv6 prefix released
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
dhcpv6-map-prefix-renewed
Description MAP DHCPv6 prefix renewed
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
http-request-got
Description HTTP request got (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
ipv6-tech
Type: List
session-created
Description Session created (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
session-deleted
Description Session deleted (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
rfc-custom_message_ipv6-tech¶
Specification
Value
Type
list
Block object keys
fixed-nat-allocated
Description Fixed-NAT allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
fixed-nat-freed
Description Fixed-NAT freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-allocated
Description Port allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-allocated
Description Port Batch allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-freed
Description Port Batch freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-v2-allocated
Description Port Batch v2 allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-batch-v2-freed
Description Port Batch v2 freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
port-freed
Description Port freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
tech-type
Description ‘lsn’: LSN; ‘nat64’: NAT64; ‘ds-lite’: DS-Lite; ‘sixrd-nat64’: 6rd-NAT64;
Type: string
Supported Values: lsn, nat64, ds-lite, sixrd-nat64
custom¶
Specification
Value
Type
object
custom-header
Description ‘use-syslog-header’: Use syslog header as custom log header;
Type: string
Supported Values: use-syslog-header
custom-message
Description: custom-message is a JSON Block. Please see below for custom_custom-message
Type: Object
custom-time-stamp-format
Description Customize the time stamp format (Customize the time-stamp format. Default:%Y%m%d%H%M%S)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
custom_custom-message¶
Specification
Value
Type
object
custom-dhcpv6-map-prefix-assigned
Description MAP DHCPv6 prefix assigned
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-dhcpv6-map-prefix-released
Description MAP DHCPv6 prefix released
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-dhcpv6-map-prefix-renewed
Description MAP DHCPv6 prefix renewed
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-allocated
Description Fixed-NAT allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-freed
Description Fixed-NAT freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-fixed-nat-interim-update
Description Fixed-NAT interim update (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-http-request-got
Description HTTP request got (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-allocated
Description Port allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-allocated
Description Port Batch allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-freed
Description Port Batch freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-allocated
Description Port Batch v2 allocated (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-freed
Description Port Batch v2 freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-batch-v2-interim-update
Description Port Batch v2 interim update (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-port-freed
Description Port freed (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-session-created
Description Session created (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
custom-session-deleted
Description Session deleted (Custom message string)
Type: string
Format: string-rlx
Maximum Length: 255 characters
Maximum Length: 1 characters
source-address¶
Specification
Value
Type
object
ip
Description Specify source IP address
Type: string
Format: ipv4-address
ipv6
Description Specify source IPv6 address
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-log-by-destination¶
Specification
Value
Type
object
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip/{ipv4-addr}
ip6-list
Type: List
Reference Object: /axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip6/{ipv6-addr}
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-log-by-destination_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
disable-log-by-destination_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
disable-log-by-destination_ip-list¶
Specification
Value
Type
list
Block object keys
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv4-addr
Description Configure an IP subnet
Type: string
Format: ipv4-cidr
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-log-by-destination_ip-list_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
disable-log-by-destination_ip-list_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
disable-log-by-destination_ip6-list¶
Specification
Value
Type
list
Block object keys
icmp
Description Disable logging for icmp traffic
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6-addr
Description Configure an IPv6 subnet
Type: string
Format: ipv6-address-plen
others
Description Disable logging for other L4 protocols
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-list
Type: List
udp-list
Type: List
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-log-by-destination_ip6-list_tcp-list¶
Specification
Value
Type
list
Block object keys
tcp-port-end
Description Port Range End
Type: number
tcp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number
disable-log-by-destination_ip6-list_udp-list¶
Specification
Value
Type
list
Block object keys
udp-port-end
Description Port Range End
Type: number
udp-port-start
Description Destination Port (Single Destination Port or Port Range Start)
Type: number