ip

List the global IP parameters and counters.

ip Specification

Type Intermediate Resource
Element Name ip
Element URI /axapi/v3/ip
Element Attributes ip_attributes
Schema ip schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/ip

ip_attributes

ip Attributes

access-list-list

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

Type: List

Reference Object: /axapi/v3/ip/access-list/{name}

address

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

Type: Object

Reference Object: /axapi/v3/ip/address

anomaly-drop

Description: anomaly-drop is a JSON Block . Please see below for anomaly-drop

Type: Object

Reference Object: /axapi/v3/ip/anomaly-drop

as-path-list

Description: as-path-list is a JSON List . Please see below for as-path-list

Type: List

Reference Object: /axapi/v3/ip/as-path/{access-list}+{action}+{value}

community-list

Description: community-list is a JSON Block . Please see below for community-list

Type: Object

Reference Object: /axapi/v3/ip/community-list

default-gateway

Description: default-gateway is a JSON Block . Please see below for default-gateway

Type: Object

Reference Object: /axapi/v3/ip/default-gateway

dns

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

Type: Object

Reference Object: /axapi/v3/ip/dns

extcommunity-list

Description: extcommunity-list is a JSON Block . Please see below for extcommunity-list

Type: Object

Reference Object: /axapi/v3/ip/extcommunity-list

frag

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

Type: Object

Reference Object: /axapi/v3/ip/frag

icmp

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

Type: Object

Reference Object: /axapi/v3/ip/icmp

map-list-list

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

Type: List

Reference Object: /axapi/v3/ip/map-list/{name}

mgmt-traffic-list

Description: mgmt-traffic-list is a JSON List . Please see below for mgmt-traffic-list

Type: List

Reference Object: /axapi/v3/ip/mgmt-traffic/{traffic-type}

nat

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

Type: Object

Reference Object: /axapi/v3/ip/nat

nat-global

Description: nat-global is a JSON Block . Please see below for nat-global

Type: Object

Reference Object: /axapi/v3/ip/nat-global

prefix-list-list

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

Type: List

Reference Object: /axapi/v3/ip/prefix-list/{name}

route

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

Type: Object

Reference Object: /axapi/v3/ip/route

tcp

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

Type: Object

Reference Object: /axapi/v3/ip/tcp

frag

Specification
Type object

buff

Description: Max buff used for fragmentation (Buffer Value(10000-3000000))

Type: number

Range: 10000-3000000

max-packets-per-reassembly

Description: Max number of fragmented packets allowed per reassembly(0 is unlimited) (default 0)

Type: number

Range: 2-16

max-reassembly-sessions

Description: Max number of pending reassembly sessions allowed (default 100000)

Type: number

Range: 1-200000

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l563_sampling-enable

Type: List

timeout

Description: Fragmentation timeout (in milliseconds 4 - 16000 (default is 1000))

Type: number

Range: 4-16000

uuid

Description: uuid of the object

Type: string

frag.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘session-inserted’: Session Inserted; ‘session-expired’: Session Expired; ‘icmp-rcv’: ICMP Received; ‘icmpv6-rcv’: ICMPv6 Received; ‘udp-rcv’: UDP Received; ‘tcp-rcv’: TCP Received; ‘ipip-rcv’: IP-in-IP Received; ‘ipv6ip-rcv’: IPv6-in-IP Received; ‘other-rcv’: Other Received; ‘icmp-dropped’: ICMP Dropped; ‘icmpv6-dropped’: ICMPv6 Dropped; ‘udp-dropped’: UDP Dropped; ‘tcp-dropped’: TCP Dropped; ‘ipip-dropped’: IP-in-IP Dropped; ‘ipv6ip-dropped’: IPv6-in-IP Dropped; ‘other-dropped’: Other Dropped; ‘overlap-error’: Overlapping Fragment Dropped; ‘bad-ip-len’: Bad IP Length; ‘too-small’: Fragment Too Small Drop; ‘first-tcp-too-small’: First TCP Fragment Too Small Drop; ‘first-l4-too-small’: First L4 Fragment Too Small Drop; ‘total-sessions-exceeded’: Total Sessions Exceeded Drop; ‘no-session-memory’: Out of Session Memory; ‘fast-aging-set’: Fragmentation Fast Aging Set; ‘fast-aging-unset’: Fragmentation Fast Aging Unset; ‘fragment-queue-success’: Fragment Queue Success; ‘unaligned-len’: Payload Length Unaligned; ‘exceeded-len’: Payload Length Out of Bounds; ‘duplicate-first-frag’: Duplicate First Fragment; ‘duplicate-last-frag’: Duplicate Last Fragment; ‘total-fragments-exceeded’: Total Queued Fragments Exceeded; ‘fragment-queue-failure’: Fragment Queue Failure; ‘reassembly-success’: Fragment Reassembly Success; ‘max-len-exceeded’: Fragment Max Data Length Exceeded; ‘reassembly-failure’: Fragment Reassembly Failure; ‘policy-drop’: MTU Exceeded Policy Drop; ‘error-drop’: Fragment Processing Drop; ‘max-packets-exceeded’: Too Many Packets Per Reassembly Drop; ‘session-packets-exceeded’: Session Max Packets Exceeded; ‘frag-session-count’: Fragmentation Session Count; ‘high-cpu-threshold’: High CPU Threshold Reached; ‘low-cpu-threshold’: Low CPU Threshold Reached; ‘cpu-threshold-drop’: High CPU Drop; ‘ipd-entry-drop’: DDoS Protection Drop; ‘sctp-rcv’: SCTP Received; ‘sctp-dropped’: SCTP Dropped;

Type: string

Supported Values: all, session-inserted, session-expired, icmp-rcv, icmpv6-rcv, udp-rcv, tcp-rcv, ipip-rcv, ipv6ip-rcv, other-rcv, icmp-dropped, icmpv6-dropped, udp-dropped, tcp-dropped, ipip-dropped, ipv6ip-dropped, other-dropped, overlap-error, bad-ip-len, too-small, first-tcp-too-small, first-l4-too-small, total-sessions-exceeded, no-session-memory, fast-aging-set, fast-aging-unset, fragment-queue-success, unaligned-len, exceeded-len, duplicate-first-frag, duplicate-last-frag, total-fragments-exceeded, fragment-queue-failure, reassembly-success, max-len-exceeded, reassembly-failure, policy-drop, error-drop, max-packets-exceeded, session-packets-exceeded, frag-session-count, high-cpu-threshold, low-cpu-threshold, cpu-threshold-drop, ipd-entry-drop, sctp-rcv, sctp-dropped

extcommunity-list

Specification
Type object

expanded-list

Description: expanded-list is a JSON List . Please see below for l563_expanded-list

Type: List

Reference Object: /axapi/v3/ip/extcommunity-list/expanded/{expanded}

expanded-num-list

Description: expanded-num-list is a JSON List . Please see below for l563_expanded-num-list

Type: List

Reference Object: /axapi/v3/ip/extcommunity-list/expanded-num/{ext-list-num}

standard-list

Description: standard-list is a JSON List . Please see below for l563_standard-list

Type: List

Reference Object: /axapi/v3/ip/extcommunity-list/standard/{standard}

standard-num-list

Description: standard-num-list is a JSON List . Please see below for l563_standard-num-list

Type: List

Reference Object: /axapi/v3/ip/extcommunity-list/standard-num/{std-list-num}

extcommunity-list.expanded-num-list

Specification
Type list
Block object keys

ext-list-num

Description: Extended Community list number (expanded)

Type: number

Range: 100-199

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

uuid

Description: uuid of the object

Type: string

extcommunity-list.expanded-num-list.rules-list

Specification
Type list
Block object keys

ext-list-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

ext-list-value

Description: An ordered list as a regular-expression

Type: string

Format: string-rlx

extcommunity-list.expanded-list

Specification
Type list
Block object keys

expanded

Description: Add an expanded extcommunity-list entry (Extended Community list name)

Type: string

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

uuid

Description: uuid of the object

Type: string

extcommunity-list.expanded-list.rules-list

Specification
Type list
Block object keys

expanded-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

expanded-value

Description: An ordered list as a regular-expression

Type: string

Format: string-rlx

extcommunity-list.standard-num-list

Specification
Type list
Block object keys

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

std-list-num

Description: Extended Community list number (standard)

Type: number

Range: 1-99

uuid

Description: uuid of the object

Type: string

extcommunity-list.standard-num-list.rules-list

Specification
Type list
Block object keys

std-list-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

std-list-value

Description: rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn

Type: string

Format: string-rlx

extcommunity-list.standard-list

Specification
Type list
Block object keys

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

standard

Description: Add a standard extcommunity-list entry (Extended Community list name)

Type: string

uuid

Description: uuid of the object

Type: string

extcommunity-list.standard-list.rules-list

Specification
Type list
Block object keys

standard-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

standard-value

Description: rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn

Type: string

Format: string-rlx

nat

Specification
Type object

alg

Description: alg is a JSON Block . Please see below for l563_alg

Type: Object

Reference Object: /axapi/v3/ip/nat/alg

icmp

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

Type: Object

Reference Object: /axapi/v3/ip/nat/icmp

inside

Description: inside is a JSON Block . Please see below for l563_inside

Type: Object

Reference Object: /axapi/v3/ip/nat/inside

nat-global

Description: nat-global is a JSON Block . Please see below for nat-global

Type: Object

Reference Object: /axapi/v3/ip/nat/nat-global

pool-group-list

Description: pool-group-list is a JSON List . Please see below for l563_pool-group-list

Type: List

Reference Object: /axapi/v3/ip/nat/pool-group/{pool-group-name}

pool-list

Description: pool-list is a JSON List . Please see below for l563_pool-list

Type: List

Reference Object: /axapi/v3/ip/nat/pool/{pool-name}

range-list-list

Description: range-list-list is a JSON List . Please see below for l563_range-list-list

Type: List

Reference Object: /axapi/v3/ip/nat/range-list/{name}

template

Description: template is a JSON Block . Please see below for l563_template

Type: Object

Reference Object: /axapi/v3/ip/nat/template

translation

Description: translation is a JSON Block . Please see below for l563_translation

Type: Object

Reference Object: /axapi/v3/ip/nat/translation

nat.range-list-list

Specification
Type list
Block object keys

global-netmaskv4

Description: Mask for this Address range

Type: string

Format: ipv4-netmask

global-start-ipv4-addr

Description: Global Start IPv4 Address of this list

Type: string

Format: ipv4-address

global-start-ipv6-addr

Description: Global Start IPv6 Address of this list

Type: string

Format: ipv6-address-plen

local-netmaskv4

Description: Mask for this Address range

Type: string

Format: ipv4-netmask

local-start-ipv4-addr

Description: Local Start IPv4 Address of this list

Type: string

Format: ipv4-address

local-start-ipv6-addr

Description: Local Start IPv6 Address of this list

Type: string

Format: ipv6-address-plen

name

Description: Name for this Static List

Type: string

uuid

Description: uuid of the object

Type: string

v4-count

Description: Number of addresses to be translated in this range

Type: number

Range: 1-200000

v4-vrid

Description: VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

Reference Object: /axapi/v3/vrrp-a/vrid

v6-count

Description: Number of addresses to be translated in this range

Type: number

Range: 1-200000

v6-vrid

Description: VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

Reference Object: /axapi/v3/vrrp-a/vrid

nat.alg

Specification
Type object

pptp

Description: pptp is a JSON Block . Please see below for l563_pptp

Type: Object

Reference Object: /axapi/v3/ip/nat/alg/pptp

nat.alg.pptp

Specification
Type object

pptp

Description: ‘disable’: Disable PPTP NAT ALG; ‘enable’: Enable PPTP NAT ALG;

Type: string

Supported Values: disable, enable

Default: disable

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l563_sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

nat.alg.pptp.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘current-smp-sessions’: current-smp-sessions; ‘current-gre-sessions’: current-gre-sessions; ‘smp-session-creation-failure’: smp-session-creation-failure; ‘truncated-pns-message’: truncated-pns-message; ‘truncated-pac-message’: truncated-pac-message; ‘mismatched-pns-call-id’: mismatched-pns-call-id; ‘mismatched-pac-call-id’: mismatched-pac-call-id; ‘retransmitted-pns-message’: retransmitted-pns-message; ‘retransmitted-pac-message’: retransmitted-pac-message; ‘truncated-gre-packet’: truncated-gre-packet; ‘unknown-gre-version’: unknown-gre-version; ‘no-matching-gre-session’: no-matching-gre-session;

Type: string

Supported Values: all, current-smp-sessions, current-gre-sessions, smp-session-creation-failure, truncated-pns-message, truncated-pac-message, mismatched-pns-call-id, mismatched-pac-call-id, retransmitted-pns-message, retransmitted-pac-message, truncated-gre-packet, unknown-gre-version, no-matching-gre-session

nat.pool-group-list

Specification
Type list
Block object keys

member-list

Description: member-list is a JSON List . Please see below for l563_member-list

Type: List

Reference Object: /axapi/v3/ip/nat/pool-group/{pool-group-name}/member/{pool-name}

pool-group-name

Description: Specify pool group name

Type: string

Format: string-rlx

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vrid

Description: Specify VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

Reference Object: /axapi/v3/vrrp-a/vrid

nat.pool-group-list.member-list

Specification
Type list
Block object keys

pool-name

Description: Specify NAT pool name

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.nat-global

Specification
Type object

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l563_sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

nat.nat-global.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘cross_cpu_helper_created’: Cross CPU Helper Created; ‘cross_cpu_helper_free’: Cross CPU Helper Free; ‘cross_cpu_sent’: Cross CPU Helper Packets Sent; ‘cross_cpu_rcv’: Cross CPU Helper Packets Received; ‘cross_cpu_helper_nat_pool_standby’: Cross CPU Helper Standby; ‘cross_cpu_helper_cpu_mismatch’: Cross CPU Helper CPU Mismatch; ‘cross_cpu_bad_l3’: Cross CPU Unsupported L3; ‘cross_cpu_bad_l4’: Cross CPU Unsupported L4; ‘cross_cpu_no_session’: Cross CPU No Session Found; ‘cross_cpu_helper_deleted’: Cross CPU Helper Deleted; ‘cross_cpu_helper_free_retry_lookup’: Cross CPU Helper Free Retry Lookup; ‘cross_cpu_helper_free_not_found’: Cross CPU Helper Free Not Found;

Type: string

Supported Values: all, cross_cpu_helper_created, cross_cpu_helper_free, cross_cpu_sent, cross_cpu_rcv, cross_cpu_helper_nat_pool_standby, cross_cpu_helper_cpu_mismatch, cross_cpu_bad_l3, cross_cpu_bad_l4, cross_cpu_no_session, cross_cpu_helper_deleted, cross_cpu_helper_free_retry_lookup, cross_cpu_helper_free_not_found

nat.template

Specification
Type object

logging-list

Description: logging-list is a JSON List . Please see below for l563_logging-list

Type: List

Reference Object: /axapi/v3/ip/nat/template/logging/{name}

nat.template.logging-list

Specification
Type list
Block object keys

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

include-destination

Description: Include the destination IP and port in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-rip-rport

Description: Include the IP and port of real server in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log

Description: log is a JSON Block . Please see below for l563_log

Type: Object

name

Description: NAT logging template name

Type: string

Format: string-rlx

service-group

Description: Set NAT logging service-group

Type: string

Format: string-rlx

Reference Object: /axapi/v3/slb/service-group

severity

Description: severity is a JSON Block . Please see below for l563_severity

Type: Object

source-port

Description: source-port is a JSON Block . Please see below for l563_source-port

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.template.logging-list.severity

Specification
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

nat.template.logging-list.log

Specification
Type object

port-mappings

Description: ‘creation’: Log creation of NAT mappgins; ‘disable’: Disable Log creation and deletion of NAT mappings;

Type: string

Supported Values: creation, disable

nat.template.logging-list.source-port

Specification
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

nat.translation

Specification
Type object

icmp-timeout

Description: icmp-timeout is a JSON Block . Please see below for l563_icmp-timeout

Type: Object

service-timeout-list

Description: service-timeout-list is a JSON List . Please see below for l563_service-timeout-list

Type: List

Reference Object: /axapi/v3/ip/nat/translation/service-timeout/{service-type}+{port}

tcp-timeout

Description: TCP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))

Type: number

Range: 2-15000

Default: 300

udp-timeout

Description: UDP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes))

Type: number

Range: 2-15000

Default: 300

uuid

Description: uuid of the object

Type: string

nat.translation.service-timeout-list

Specification
Type list
Block object keys

port

Description: Port Number

Type: number

Range: 1-65535

service-type

Description: ‘tcp’: TCP Protocol; ‘udp’: UDP Protocol;

Type: string

Supported Values: tcp, udp

timeout-type

Description: ‘age’: Expiration time; ‘fast’: Use Fast aging;

Type: string

Supported Values: age, fast

timeout-val

Description: Timeout in seconds (Interval of 60 seconds)

Type: number

Range: 2-15000

uuid

Description: uuid of the object

Type: string

nat.translation.icmp-timeout

Specification
Type object

icmp-timeout

Description: ‘age’: Expiration time; ‘fast’: Use Fast aging;

Type: string

Supported Values: age, fast

Default: fast

icmp-timeout-val

Description: Timeout in seconds (Interval of 60 seconds)

Type: number

Range: 2-15000

nat.icmp

Specification
Type object

always-source-nat-errors

Description: Source NAT intermediate routers’ IPs for ICMP errors (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

respond-to-ping

Description: Respond to ICMP echo requests to NAT pool IPs (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

nat.inside

Specification
Type object

source

Description: source is a JSON Block . Please see below for l563_source

Type: Object

Reference Object: /axapi/v3/ip/nat/inside/source

nat.inside.source

Specification
Type object

class-list

Description: class-list is a JSON Block . Please see below for l563_class-list

Type: Object

Reference Object: /axapi/v3/ip/nat/inside/source/class-list

list

Description: list is a JSON Block . Please see below for l563_list

Type: Object

Reference Object: /axapi/v3/ip/nat/inside/source/list

static-list

Description: static-list is a JSON List . Please see below for l563_static-list

Type: List

Reference Object: /axapi/v3/ip/nat/inside/source/static/{src-address}+{nat-address}

nat.inside.source.static-list

Specification
Type list
Block object keys

nat-address

Description: NAT Address

Type: string

Format: ipv4-address

src-address

Description: Original Source Address

Type: string

Format: ipv4-address

uuid

Description: uuid of the object

Type: string

vrid

Description: VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

Reference Object: /axapi/v3/vrrp-a/vrid

nat.inside.source.list

Specification
Type object

acl-id-list-list

Description: acl-id-list-list is a JSON List . Please see below for l563_acl-id-list-list

Type: List

Reference Object: /axapi/v3/ip/nat/inside/source/list/acl-id-list/{acl-id}

acl-name-list-list

Description: acl-name-list-list is a JSON List . Please see below for l563_acl-name-list-list

Type: List

Reference Object: /axapi/v3/ip/nat/inside/source/list/acl-name-list/{name}

nat.inside.source.list.acl-id-list-list

Specification
Type list
Block object keys

acl-id

Description: Acl id

Type: number

Range: 1-199

msl

Description: Maximum Session Life Value

Type: number

Range: 1-1800

pool

Description: Pool or Pool Group (Pool or Pool Group Name)

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.inside.source.list.acl-name-list-list

Specification
Type list
Block object keys

msl

Description: Maximum Session Life Value

Type: number

Range: 1-1800

name

Description: Apply an access list

Type: string

Reference Object: /axapi/v3/ip/access-list

pool

Description: Pool or Pool Group (Pool or Pool Group Nam)

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.inside.source.class-list

Specification
Type object

name

Description: Class List Name

Type: string

uuid

Description: uuid of the object

Type: string

nat.pool-list

Specification
Type list
Block object keys

end-address

Description: Configure end IP address of NAT pool

Type: string

Format: ipv4-address

ethernet

Description: Ethernet interface

Type: number

Format: interface

gateway

Description: Configure gateway IP

Type: string

Format: ipv4-address

ip-rr

Description: Use IP address round-robin behavior

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

netmask

Description: Configure mask for pool

Type: string

Format: ipv4-netmask-brief

pool-name

Description: Specify pool name or pool group

Type: string

Format: string-rlx

scaleout-device-id

Description: Configure Scaleout device id to which this NAT pool is to be bound (Specify Scaleout device id)

Type: number

Range: 1-64

start-address

Description: Configure start IP address of NAT pool

Type: string

Format: ipv4-address

Mutual Exclusion: start-address and use-if-ip are mutually exclusive

use-if-ip

Description: Use Interface IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: use-if-ip and start-address are mutually exclusive

uuid

Description: uuid of the object

Type: string

vrid

Description: Configure VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

Reference Object: /axapi/v3/vrrp-a/vrid

anomaly-drop

Specification
Type object

bad-content

Description: bad content threshold (threshold value)

Type: number

Range: 1-127

drop-all

Description: drop all IP anomaly packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

frag

Description: drop all fragmented packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-option

Description: drop packets with IP options

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

land-attack

Description: drop IP packets with the same source and destination addresses

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out-of-sequence

Description: out of sequence packet threshold (threshold value)

Type: number

Range: 1-127

packet-deformity

Description: packet-deformity is a JSON Block . Please see below for l563_packet-deformity

Type: Object

ping-of-death

Description: drop oversize ICMP packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l563_sampling-enable

Type: List

security-attack

Description: security-attack is a JSON Block . Please see below for l563_security-attack

Type: Object

tcp-no-flag

Description: drop TCP packets with no flag

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-syn-fin

Description: drop TCP packets with both syn and fin flags set

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tcp-syn-frag

Description: drop fragmented TCP packets with syn flag set

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

zero-window

Description: zero window size threshold (threshold value)

Type: number

Range: 1-127

anomaly-drop.security-attack

Specification
Type object

security-attack-layer-3

Description: drop packets with layer 3 anomaly

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

security-attack-layer-4

Description: drop packets with layer 4 anomaly

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

anomaly-drop.packet-deformity

Specification
Type object

packet-deformity-layer-3

Description: drop packets with layer 3 anomaly

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

packet-deformity-layer-4

Description: drop packets with layer 4 anomaly

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

anomaly-drop.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘land’: land; ‘emp_frg’: emp_frg; ‘emp_mic_frg’: emp_mic_frg; ‘opt’: opt; ‘frg’: frg; ‘bad_ip_hdrlen’: bad_ip_hdrlen; ‘bad_ip_flg’: bad_ip_flg; ‘bad_ip_ttl’: bad_ip_ttl; ‘no_ip_payload’: no_ip_payload; ‘over_ip_payload’: over_ip_payload; ‘bad_ip_payload_len’: bad_ip_payload_len; ‘bad_ip_frg_offset’: bad_ip_frg_offset; ‘csum’: csum; ‘pod’: pod; ‘bad_tcp_urg_offset’: bad_tcp_urg_offset; ‘tcp_sht_hdr’: tcp_sht_hdr; ‘tcp_bad_iplen’: tcp_bad_iplen; ‘tcp_null_frg’: tcp_null_frg; ‘tcp_null_scan’: tcp_null_scan; ‘tcp_syn_fin’: tcp_syn_fin; ‘tcp_xmas’: tcp_xmas; ‘tcp_xmas_scan’: tcp_xmas_scan; ‘tcp_syn_frg’: tcp_syn_frg; ‘tcp_frg_hdr’: tcp_frg_hdr; ‘tcp_bad_csum’: tcp_bad_csum; ‘udp_srt_hdr’: udp_srt_hdr; ‘udp_bad_len’: udp_bad_len; ‘udp_kerb_frg’: udp_kerb_frg; ‘udp_port_lb’: udp_port_lb; ‘udp_bad_csum’: udp_bad_csum; ‘runt_ip_hdr’: runt_ip_hdr; ‘runt_tcp_udp_hdr’: runt_tcp_udp_hdr; ‘ipip_tnl_msmtch’: ipip_tnl_msmtch; ‘tcp_opt_err’: tcp_opt_err; ‘ipip_tnl_err’: ipip_tnl_err; ‘vxlan_err’: vxlan_err; ‘nvgre_err’: nvgre_err; ‘gre_pptp_err’: gre_pptp_err;

Type: string

Supported Values: all, land, emp_frg, emp_mic_frg, opt, frg, bad_ip_hdrlen, bad_ip_flg, bad_ip_ttl, no_ip_payload, over_ip_payload, bad_ip_payload_len, bad_ip_frg_offset, csum, pod, bad_tcp_urg_offset, tcp_sht_hdr, tcp_bad_iplen, tcp_null_frg, tcp_null_scan, tcp_syn_fin, tcp_xmas, tcp_xmas_scan, tcp_syn_frg, tcp_frg_hdr, tcp_bad_csum, udp_srt_hdr, udp_bad_len, udp_kerb_frg, udp_port_lb, udp_bad_csum, runt_ip_hdr, runt_tcp_udp_hdr, ipip_tnl_msmtch, tcp_opt_err, ipip_tnl_err, vxlan_err, nvgre_err, gre_pptp_err

as-path-list

Specification
Type list
Block object keys

access-list

Description: Specify an access list name (Regular expression access-list name)

Type: string

action

Description: ‘deny’: Specify packets to reject; ‘permit’: Specify packets to forward;

Type: string

Supported Values: deny, permit

uuid

Description: uuid of the object

Type: string

value

Description: A regular-expression to match the BGP AS paths

Type: string

Format: string-rlx

route

Specification
Type object

rib-list

Description: rib-list is a JSON List . Please see below for l563_rib-list

Type: List

Reference Object: /axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask}

static

Description: static is a JSON Block . Please see below for l563_static

Type: Object

Reference Object: /axapi/v3/ip/route/static

route.rib-list

Specification
Type list
Block object keys

ip-dest-addr

Description: Destination prefix

Type: string

Format: ipv4-address

ip-mask

Description: Destination prefix mask

Type: string

Format: ipv4-netmask-brief

ip-nexthop-ipv4

Description: ip-nexthop-ipv4 is a JSON List . Please see below for l563_ip-nexthop-ipv4

Type: List

ip-nexthop-lif

Description: ip-nexthop-lif is a JSON List . Please see below for l563_ip-nexthop-lif

Type: List

ip-nexthop-partition

Description: ip-nexthop-partition is a JSON List . Please see below for l563_ip-nexthop-partition

Type: List

ip-nexthop-tunnel

Description: ip-nexthop-tunnel is a JSON List . Please see below for l563_ip-nexthop-tunnel

Type: List

uuid

Description: uuid of the object

Type: string

route.rib-list.ip-nexthop-lif

Specification
Type list
Block object keys

description-nexthop-lif

Description: Description for static route

Type: string

Format: string-rlx

lif

Description: LIF Interface (Logical tunnel interface number)

Type: number

Range: 1-128

route.rib-list.ip-nexthop-ipv4

Specification
Type list
Block object keys

description-nexthop-ip

Description: Description for static route

Type: string

Format: string-rlx

distance-nexthop-ip

Description: Distance value for this route

Type: number

Range: 1-255

Default: 1

ip-next-hop

Description: Forwarding router’s address

Type: string

Format: ipv4-address

route.rib-list.ip-nexthop-tunnel

Specification
Type list
Block object keys

description-nexthop-tunnel

Description: Description for static route

Type: string

Format: string-rlx

distance-nexthop-tunnel

Description: Distance value for this route

Type: number

Range: 1-255

Default: 1

ip-next-hop-tunnel

Description: Forwarding router’s address

Type: string

Format: ipv4-address

tunnel

Description: Tunnel interface (Tunnel interface number)

Type: number

Range: 1-128

route.rib-list.ip-nexthop-partition

Specification
Type list
Block object keys

description-nexthop-partition

Description: Description for static route

Type: string

Format: string-rlx

description-partition-vrid

Description: Description for static route

Type: string

Format: string-rlx

partition-name

Description: Name of network partition

Type: string

vrid-num-in-partition

Description: Specify ha VRRP-A vrid

Type: number

Range: 0-31

route.static

Specification
Type object

bfd-list

Description: bfd-list is a JSON List . Please see below for l563_bfd-list

Type: List

Reference Object: /axapi/v3/ip/route/static/bfd/{local-ip}+{nexthop-ip}

route.static.bfd-list

Specification
Type list
Block object keys

local-ip

Description: Local IP address

Type: string

Format: ipv4-address

nexthop-ip

Description: Nexthop IP address

Type: string

Format: ipv4-address

uuid

Description: uuid of the object

Type: string

access-list-list

Specification
Type list
Block object keys

name

Description: IP Access List Name. Does not support name as digits or start with digit.

Type: string

rules

Description: rules is a JSON List . Please see below for l563_rules

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

access-list-list.rules

Specification
Type list
Block object keys

acl-log

Description: Log matches against this entry

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

action

Description: ‘deny’: Deny; ‘permit’: Permit; ‘l3-vlan-fwd-disable’: Disable L3 forwarding between VLANs;

Type: string

Supported Values: deny, permit, l3-vlan-fwd-disable

any-code

Description: Any ICMP code

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: any-code icmp-code and special-code are mutually exclusive

any-type

Description: Any ICMP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: any-type icmp-type and special-type are mutually exclusive

dscp

Description: DSCP

Type: number

Range: 1-63

dst-any

Description: Any destination host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dst-any dst-host, dst-subnet and dst-object-group are mutually exclusive

dst-eq

Description: Match only packets on a given destination port (port number)

Type: number

Range: 1-65535

Mutual Exclusion: dst-eq dst-gt, dst-lt and dst-range are mutually exclusive

dst-gt

Description: Match only packets with a greater port number

Type: number

Range: 1-65534

Mutual Exclusion: dst-gt dst-eq, dst-lt and dst-range are mutually exclusive

dst-host

Description: A single destination host (Host address)

Type: string

Format: ipv4-address

Mutual Exclusion: dst-host dst-any, dst-subnet and dst-object-group are mutually exclusive

dst-lt

Description: Match only packets with a lesser port number

Type: number

Range: 2-65535

Mutual Exclusion: dst-lt dst-eq, dst-gt and dst-range are mutually exclusive

dst-mask

Description: Destination Mask 0=apply 255=ignore

Type: string

Format: ipv4-rev-netmask

dst-object-group

Description: Destination network object group name (Source network object group name)

Type: string

Mutual Exclusion: dst-object-group dst-any, dst-host and dst-subnet are mutually exclusive

dst-port-end

Description: Edning Destination Port Number

Type: number

Range: 1-65535

dst-range

Description: Match only packets in the range of port numbers (Starting Destination Port Number)

Type: number

Range: 1-65535

Mutual Exclusion: dst-range dst-eq, dst-gt and dst-lt are mutually exclusive

dst-subnet

Description: Destination Address

Type: string

Format: ipv4-address

Mutual Exclusion: dst-subnet dst-any, dst-host and dst-object-group are mutually exclusive

established

Description: TCP established

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fragments

Description: IP fragments

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geo-location

Description: Specify geo-location name

Type: string

icmp

Description: Internet Control Message Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: icmp tcp, udp, ip and service-obj-group are mutually exclusive

icmp-code

Description: ICMP code number

Type: number

Range: 0-254

Mutual Exclusion: icmp-code any-code and special-code are mutually exclusive

icmp-type

Description: ICMP type number

Type: number

Range: 0-254

Mutual Exclusion: icmp-type any-type and special-type are mutually exclusive

ip

Description: Any Internet Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: ip icmp, tcp, udp and service-obj-group are mutually exclusive

remark

Description: Access list entry comment (Notes for this ACL)

Type: string

Format: string-rlx

seq-num

Description: Sequence Number

Type: number

Range: 1-8192

service-obj-group

Description: Service object group (Source object group name)

Type: string

Mutual Exclusion: service-obj-group icmp, tcp, udp and ip are mutually exclusive

special-code

Description: ‘frag-required’: Code 4, fragmentation required; ‘host-unreachable’: Code 1, destination host unreachable; ‘network-unreachable’: Code 0, destination network unreachable; ‘port-unreachable’: Code 3, destination port unreachable; ‘proto-unreachable’: Code 2, destination protocol unreachable; ‘route-failed’: Code 5, source route failed;

Type: string

Supported Values: frag-required, host-unreachable, network-unreachable, port-unreachable, proto-unreachable, route-failed

Mutual Exclusion: special-code any-code and icmp-code are mutually exclusive

special-type

Description: ‘echo-reply’: Type 0, echo reply; ‘echo-request’: Type 8, echo request; ‘info-reply’: Type 16, information reply; ‘info-request’: Type 15, information request; ‘mask-reply’: Type 18, address mask reply; ‘mask-request’: Type 17, address mask request; ‘parameter-problem’: Type 12, parameter problem; ‘redirect’: Type 5, redirect message; ‘source-quench’: Type 4, source quench; ‘time-exceeded’: Type 11, time exceeded; ‘timestamp’: Type 13, timestamp; ‘timestamp-reply’: Type 14, timestamp reply; ‘dest-unreachable’: Type 3, destination unreachable;

Type: string

Supported Values: echo-reply, echo-request, info-reply, info-request, mask-reply, mask-request, parameter-problem, redirect, source-quench, time-exceeded, timestamp, timestamp-reply, dest-unreachable

Mutual Exclusion: special-type icmp-type and any-type are mutually exclusive

src-any

Description: Any source host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: src-any src-host, src-subnet and src-object-group are mutually exclusive

src-eq

Description: Match only packets on a given source port (port number)

Type: number

Range: 1-65535

Mutual Exclusion: src-eq src-gt, src-lt and src-range are mutually exclusive

src-gt

Description: Match only packets with a greater port number

Type: number

Range: 1-65534

Mutual Exclusion: src-gt src-eq, src-lt and src-range are mutually exclusive

src-host

Description: A single source host (Host address)

Type: string

Format: ipv4-address

Mutual Exclusion: src-host src-any, src-subnet and src-object-group are mutually exclusive

src-lt

Description: Match only packets with a lower port number

Type: number

Range: 2-65535

Mutual Exclusion: src-lt src-eq, src-gt and src-range are mutually exclusive

src-mask

Description: Source Mask 0=apply 255=ignore

Type: string

Format: ipv4-rev-netmask

src-object-group

Description: Network object group (Source network object group name)

Type: string

Mutual Exclusion: src-object-group src-any, src-host and src-subnet are mutually exclusive

src-port-end

Description: Ending Port Number

Type: number

Range: 1-65535

src-range

Description: match only packets in the range of port numbers (Starting Port Number)

Type: number

Range: 1-65535

Mutual Exclusion: src-range src-eq, src-gt and src-lt are mutually exclusive

src-subnet

Description: Source Address

Type: string

Format: ipv4-address

Mutual Exclusion: src-subnet src-any, src-host and src-object-group are mutually exclusive

tcp

Description: protocol TCP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: tcp icmp, udp, ip and service-obj-group are mutually exclusive

transparent-session-only

Description: Only log transparent sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

udp

Description: protocol UDP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: udp icmp, tcp, ip and service-obj-group are mutually exclusive

vlan

Description: VLAN ID

Type: number

Range: 1-4094

community-list

Specification
Type object

expanded-list

Description: expanded-list is a JSON List . Please see below for l563_expanded-list

Type: List

Reference Object: /axapi/v3/ip/community-list/expanded/{expanded}

expanded-num-list

Description: expanded-num-list is a JSON List . Please see below for l563_expanded-num-list

Type: List

Reference Object: /axapi/v3/ip/community-list/expanded-num/{ext-list-num}

standard-list

Description: standard-list is a JSON List . Please see below for l563_standard-list

Type: List

Reference Object: /axapi/v3/ip/community-list/standard/{standard}

standard-num-list

Description: standard-num-list is a JSON List . Please see below for l563_standard-num-list

Type: List

Reference Object: /axapi/v3/ip/community-list/standard-num/{std-list-num}

community-list.expanded-num-list

Specification
Type list
Block object keys

ext-list-num

Description: Community list number (expanded)

Type: number

Range: 100-199

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

uuid

Description: uuid of the object

Type: string

community-list.expanded-num-list.rules-list

Specification
Type list
Block object keys

ext-list-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

ext-list-value

Description: An ordered list as a regular-expression

Type: string

Format: string-rlx

community-list.expanded-list

Specification
Type list
Block object keys

expanded

Description: Add an expanded community-list entry (Community list name)

Type: string

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

uuid

Description: uuid of the object

Type: string

community-list.expanded-list.rules-list

Specification
Type list
Block object keys

expanded-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

expanded-value

Description: An ordered list as a regular-expression

Type: string

Format: string-rlx

community-list.standard-num-list

Specification
Type list
Block object keys

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

std-list-num

Description: Community list number (standard)

Type: number

Range: 1-99

uuid

Description: uuid of the object

Type: string

community-list.standard-num-list.rules-list

Specification
Type list
Block object keys

std-list-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

std-list-comm-value

Description: community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

Type: string

Format: string-rlx

community-list.standard-list

Specification
Type list
Block object keys

rules-list

Description: rules-list is a JSON List . Please see below for l563_rules-list

Type: List

standard

Description: Add a standard community-list entry (Community list name)

Type: string

uuid

Description: uuid of the object

Type: string

community-list.standard-list.rules-list

Specification
Type list
Block object keys

standard-action

Description: ‘deny’: Specify community to reject; ‘permit’: Specify community to accept;

Type: string

Supported Values: deny, permit

standard-comm-value

Description: community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

Type: string

Format: string-rlx

tcp

Specification
Type object

syn-cookie

Description: syn-cookie is a JSON Block . Please see below for l563_syn-cookie

Type: Object

uuid

Description: uuid of the object

Type: string

mgmt-traffic-list

Specification
Type list
Block object keys

source-interface

Description: source-interface is a JSON Block . Please see below for l563_source-interface

Type: Object

traffic-type

Description: ‘all’: All; ‘ftp’: FTP; ‘ntp’: NTP; ‘rcp’: RCP; ‘snmp’: SNMP; ‘ssh’: SSH and SCP; ‘syslog’: SYSLOG; ‘telnet’: Telnet; ‘tftp’: TFTP; ‘web’: Web - HTTP and HTTPS;

Type: string

Supported Values: all, ftp, ntp, rcp, snmp, ssh, syslog, telnet, tftp, web

uuid

Description: uuid of the object

Type: string

mgmt-traffic-list.source-interface

Specification
Type object

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

nat-global

Specification
Type object

reset-idle-tcp-conn

Description: Reset Idle TCP Connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

default-gateway

Specification
Type object

gateway-ip

Description: Default gateway address

Type: string

Format: ipv4-address

Reference Object: /axapi/v3/ip/address

uuid

Description: uuid of the object

Type: string

dns

Specification
Type object

primary

Description: primary is a JSON Block . Please see below for l563_primary

Type: Object

Reference Object: /axapi/v3/ip/dns/primary

secondary

Description: secondary is a JSON Block . Please see below for l563_secondary

Type: Object

Reference Object: /axapi/v3/ip/dns/secondary

suffix

Description: suffix is a JSON Block . Please see below for l563_suffix

Type: Object

Reference Object: /axapi/v3/ip/dns/suffix

dns.suffix

Specification
Type object

domain-name

Description: DNS suffix

Type: string

uuid

Description: uuid of the object

Type: string

dns.primary

Specification
Type object

ip-v4-addr

Description: DNS server address

Type: string

Format: ipv4-address

Mutual Exclusion: ip-v4-addr and ip-v6-addr are mutually exclusive

ip-v6-addr

Description: DNS server address

Type: string

Format: ipv6-address

Mutual Exclusion: ip-v6-addr and ip-v4-addr are mutually exclusive

uuid

Description: uuid of the object

Type: string

dns.secondary

Specification
Type object

ip-v4-addr

Description: DNS server address

Type: string

Format: ipv4-address

Mutual Exclusion: ip-v4-addr and ip-v6-addr are mutually exclusive

ip-v6-addr

Description: DNS server address

Type: string

Format: ipv6-address

Mutual Exclusion: ip-v6-addr and ip-v4-addr are mutually exclusive

uuid

Description: uuid of the object

Type: string

address

Specification
Type object

ip-addr

Description: IP address

Type: string

Format: ipv4-address

ip-mask

Description: IP subnet mask

Type: string

Format: ipv4-netmask

uuid

Description: uuid of the object

Type: string

prefix-list-list

Specification
Type list
Block object keys

name

Description: Name of a prefix list

Type: string

rules

Description: rules is a JSON List . Please see below for l563_rules

Type: List

uuid

Description: uuid of the object

Type: string

prefix-list-list.rules

Specification
Type list
Block object keys

action

Description: ‘deny’: Specify packets to reject; ‘permit’: Specify packets to forward;

Type: string

Supported Values: deny, permit

any

Description: Any prefix match. Same as “0.0.0.0/0 le 32”

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description: Prefix-list specific description (Up to 80 characters describing this prefix-list)

Type: string

ge

Description: Minimum prefix length to be matched

Type: number

Range: 0-32

ipaddr

Description: IP prefix, e.g., 35.0.0.0/8

Type: string

Format: ipv4-cidr

le

Description: Maximum prefix length to be matched

Type: number

Range: 0-32

seq

Description: Sequence number of an entry

Type: number

Range: 1-4294967295

icmp

Specification
Type object

redirect

Description: Disable outbound ICMP redirect messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unreachable

Description: Disable outbound ICMP unreachable messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

map-list-list

Specification
Type list
Block object keys

file

Description: Create/Edit a IP Map List stored as a file

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mapping-list

Description: mapping-list is a JSON List . Please see below for l563_mapping-list

Type: List

name

Description: Specify name of the IP Map List

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

map-list-list.mapping-list

Specification
Type list
Block object keys

count

Description: Number of addresses to be translated in this range

Type: number

Range: 1-16777216

global-start-ip

Description: Global Start IPv4 Address of this list

Type: string

Format: ipv4-address

local-start-ip

Description: Local Start IPv4 Address of this list

Type: string

Format: ipv4-address