interface trunk ip¶

Global IP configuration subcommands

ip Specification¶

Parameter Value

Type Configuration Resource

Element Name ip

Element URI /axapi/v3/interface/trunk/{ifnum}/ip

Element Attributes ip_attributes

Partition Visibility shared

Schema ip schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/interface/trunk/{ifnum}/ip	ip attributes
POST /axapi/v3/interface/trunk/1/ip Payload: { "ip": { "stateful-firewall": { "inside": 1 }, "dhcp": 1 } }
Get Object	GET	/axapi/v3/interface/trunk/{ifnum}/ip	ip attributes
GET /axapi/v3/interface/trunk/1/ip Reponse: { "ip": { "dhcp": 1, "allow-promiscuous-vip": 0, "client": 0, "server": 0, "cache-spoofing-port": 0, "nat": { "inside": 0, "outside": 0 }, "ttl-ignore": 0, "syn-cookie": 0, "slb-partition-redirect": 0, "generate-membership-query": 0, "unnumbered": 0, "uuid": "9e1a6c62-5001-11ee-ac8d-3b5bd4b1e0b9", "stateful-firewall": { "inside": 1, "outside": 0, "uuid": "9e1a7b26-5001-11ee-ac8d-3b5bd4b1e0b9", "a10-url": "/axapi/v3/interface/trunk/1/ip/stateful-firewall" }, "a10-url": "/axapi/v3/interface/trunk/1/ip" } }
Modify Object	POST	/axapi/v3/interface/trunk/{ifnum}/ip	ip attributes
Replace Object	PUT	/axapi/v3/interface/trunk/{ifnum}/ip	ip attributes
PUT /axapi/v3/interface/trunk/1/ip Payload: { "ip": { "stateful-firewall": { "inside": 1, "class-list": "abcd" }, "dhcp": 0 } }
Delete Object	DELETE	/axapi/v3/interface/trunk/{ifnum}/ip	ip attributes
DELETE /axapi/v3/interface/trunk/1/ip Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

ip attributes¶

address-list

Type: List

allow-promiscuous-vip

Description Allow traffic to be associated with promiscuous VIP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cache-spoofing-port

Description This interface connects to spoofing cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

client

Description Client facing interface for IPv4/v6 traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dhcp

Description Use DHCP to configure IP address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

generate-membership-query

Description Enable Membership Query

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

helper-address-list

Type: List

max-resp-time

Description Maximum Response Time (Max Response Time (Default is 100))

Type: number

Range: 1-255

Default: 100

nat

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

Type: Object

ospf

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

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf

query-interval

Description 1 - 255 (Default is 125)

Type: number

Range: 1-255

Default: 125

rip

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

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/rip

router

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

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/router

server

Description Server facing interface for IPv4/v6 traffic

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

slb-partition-redirect

Description Redirect SLB traffic across partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stateful-firewall

Description: stateful-firewall is a JSON Block. Please see below for stateful-firewall

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/stateful-firewall

syn-cookie

Description Enable SYN-cookie on the interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ttl-ignore

Description Ignore TTL decrement for a received packet

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unnumbered

Description Set the interface as unnumbered

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

helper-address-list¶

Specification Value

Type list

Block object keys

helper-address

Description Helper address for DHCP packets (IP address)

Type: string

Format: ipv4-address

stateful-firewall¶

Specification Value

Type object

access-list

Description Access-list for traffic from the outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

acl-id

Description ACL id

Type: number

Range: 1-199

class-list

Description Class List (Class List Name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

inside

Description Inside (private) interface for stateful firewall

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Outside (public) interface for stateful firewall

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

rip¶

Specification Value

Type object

authentication

Description: authentication is a JSON Block. Please see below for rip_authentication

Type: Object

receive-cfg

Description: receive-cfg is a JSON Block. Please see below for rip_receive-cfg

Type: Object

receive-packet

Description Enable receiving packet through the specified interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

send-cfg

Description: send-cfg is a JSON Block. Please see below for rip_send-cfg

Type: Object

send-packet

Description Enable sending packets through the specified interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

split-horizon-cfg

Description: split-horizon-cfg is a JSON Block. Please see below for rip_split-horizon-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

rip_receive-cfg¶

Specification Value

Type object

receive

Description Advertisement reception

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description ‘1’: RIP version 1; ‘2’: RIP version 2; ‘1-2’: RIP version 1 & 2;

Type: string

Supported Values: 1, 2, 1-2

rip_split-horizon-cfg¶

Specification Value

Type object

state

Description ‘poisoned’: Perform split horizon with poisoned reverse; ‘disable’: Disable split horizon; ‘enable’: Perform split horizon without poisoned reverse;

Type: string

Supported Values: poisoned, disable, enable

Default: poisoned

rip_authentication¶

Specification Value

Type object

key-chain

Description: key-chain is a JSON Block. Please see below for rip_authentication_key-chain

Type: Object

mode

Description: mode is a JSON Block. Please see below for rip_authentication_mode

Type: Object

str

Description: str is a JSON Block. Please see below for rip_authentication_str

Type: Object

rip_authentication_key-chain¶

Specification Value

Type object

key-chain

Description Authentication key-chain (Name of key-chain)

Type: string

Format: string-rlx

rip_authentication_mode¶

Specification Value

Type object

mode

Description ‘md5’: Keyed message digest; ‘text’: Clear text authentication;

Type: string

Supported Values: md5, text

Default: text

rip_authentication_str¶

Specification Value

Type object

string

Description The RIP authentication string

Type: string

Format: string-rlx

Maximum Length: 16 characters

Maximum Length: 1 characters

rip_send-cfg¶

Specification Value

Type object

send

Description Advertisement transmission

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

version

Description ‘1’: RIP version 1; ‘2’: RIP version 2; ‘1-compatible’: RIPv1-compatible; ‘1-2’: RIP version 1 & 2;

Type: string

Supported Values: 1, 2, 1-compatible, 1-2

nat¶

Specification Value

Type object

inside

Description Configure interface as inside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

outside

Description Configure interface as outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-list¶

Specification Value

Type list

Block object keys

ipv4-address

Description IP address

Type: string

Format: ipv4-address

ipv4-netmask

Description IP subnet mask

Type: string

Format: ipv4-netmask

router¶

Specification Value

Type object

isis

Description: isis is a JSON Block. Please see below for router_isis

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/router/isis

router_isis¶

Specification Value

Type object

tag

Description ISO routing area tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ospf¶

Specification Value

Type object

ospf-global

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

Type: Object

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-global

ospf-ip-list

Type: List

Reference Object: /axapi/v3/interface/trunk/{ifnum}/ip/ospf/ospf-ip/{ip-addr}

ospf_ospf-ip-list¶

Specification Value

Type list

Block object keys

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

ip-addr

Description Address of interface

Type: string

Format: ipv4-address

message-digest-cfg

Type: List

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ospf_ospf-ip-list_message-digest-cfg¶

Specification Value

Type list

Block object keys

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ospf_ospf-global¶

Specification Value

Type object

authentication-cfg

Description: authentication-cfg is a JSON Block. Please see below for ospf_ospf-global_authentication-cfg

Type: Object

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

bfd-cfg

Description: bfd-cfg is a JSON Block. Please see below for ospf_ospf-global_bfd-cfg

Type: Object

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter-cfg

Description: database-filter-cfg is a JSON Block. Please see below for ospf_ospf-global_database-filter-cfg

Type: Object

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

disable

Description ‘all’: All functionality;

Type: string

Supported Values: all

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

message-digest-cfg

Type: List

mtu

Description OSPF interface MTU (MTU size)

Type: number

Range: 576-65535

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

network

Description: network is a JSON Block. Please see below for ospf_ospf-global_network

Type: Object

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ospf_ospf-global_network¶

Specification Value

Type object

broadcast

Description Specify OSPF broadcast multi-access network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: broadcast,non-broadcast, point-to-point, and point-to-multipoint are mutually exclusive

non-broadcast

Description Specify OSPF NBMA network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: non-broadcast,broadcast, point-to-point, and point-to-multipoint are mutually exclusive

p2mp-nbma

Description Specify non-broadcast point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

point-to-multipoint

Description Specify OSPF point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-multipoint,broadcast, non-broadcast, and point-to-point are mutually exclusive

point-to-point

Description Specify OSPF point-to-point network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-point,broadcast, non-broadcast, and point-to-multipoint are mutually exclusive

ospf_ospf-global_authentication-cfg¶

Specification Value

Type object

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ospf_ospf-global_database-filter-cfg¶

Specification Value

Type object

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf_ospf-global_bfd-cfg¶

Specification Value

Type object

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf_ospf-global_message-digest-cfg¶

Specification Value

Type list

Block object keys

md5

Description: md5 is a JSON Block. Please see below for ospf_ospf-global_message-digest-cfg_md5

Type: Object

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ospf_ospf-global_message-digest-cfg_md5¶

Specification Value

Type object

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters