interface ve ip

Configure the virtual Ethernet interface.

ip Specification

Type Configuration Resource
Element Name ip
Element URI /axapi/v3/interface/ve/{ifnum}/ip
Element Attributes ip_attributes
Schema ip schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/interface/ve/{ifnum}/ip

ip Attributes

Get Object

GET

/axapi/v3/interface/ve/{ifnum}/ip

ip Attributes

Modify Object

POST

/axapi/v3/interface/ve/{ifnum}/ip

ip Attributes

Replace Object

PUT

/axapi/v3/interface/ve/{ifnum}/ip

ip Attributes

Delete Object

DELETE

/axapi/v3/interface/ve/{ifnum}/ip

ip Attributes

ip Attributes

address-list

Description: address-list is a JSON List . Please see below for 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

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

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

Type: List

inside

Description: Configure interface as inside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-resp-time

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

Type: number

Range: 1-255

Default: 100

ospf

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

Type: Object

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

outside

Description: Configure interface as outside

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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/ve/{ifnum}/ip/rip

router

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

Type: Object

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

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/ve/{ifnum}/ip/stateful-firewall

uuid

Description: uuid of the object

Type: string

address-list

Specification
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

helper-address-list

Specification
Type list
Block object keys

helper-address

Description: Helper address for DHCP packets (IP address)

Type: string

Format: ipv4-address

stateful-firewall

Specification
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

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

rip

Specification
Type object

authentication

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

Type: Object

receive-cfg

Description: receive-cfg is a JSON Block . Please see below for l500_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 l500_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 l500_split-horizon-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

rip.receive-cfg

Specification
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
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
Type object

key-chain

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

Type: Object

mode

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

Type: Object

str

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

Type: Object

rip.authentication.key-chain

Specification
Type object

key-chain

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

Type: string

Format: string-rlx

rip.authentication.mode

Specification
Type object

mode

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

Type: string

Supported Values: md5, text

Default: text

rip.authentication.str

Specification
Type object

string

Description: The RIP authentication string

Type: string

Format: string-rlx

rip.send-cfg

Specification
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

router

Specification
Type object

isis

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

Type: Object

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

router.isis

Specification
Type object

tag

Description: ISO routing area tag

Type: string

uuid

Description: uuid of the object

Type: string

ospf

Specification
Type object

ospf-global

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

Type: Object

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

ospf-ip-list

Description: ospf-ip-list is a JSON List . Please see below for l500_ospf-ip-list

Type: List

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

ospf.ospf-ip-list

Specification
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

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

Description: message-digest-cfg is a JSON List . Please see below for l500_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

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
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

message-digest-key

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

Type: number

Range: 1-255

ospf.ospf-global

Specification
Type object

authentication-cfg

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

Type: Object

authentication-key

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

Type: string

Format: string-rlx

bfd-cfg

Description: bfd-cfg is a JSON Block . Please see below for l500_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 l500_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

Description: message-digest-cfg is a JSON List . Please see below for l500_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 l500_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

ospf.ospf-global.network

Specification
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
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
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
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
Type list
Block object keys

md5

Description: md5 is a JSON Block . Please see below for l500_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
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