interface loopback

Loopback interface

loopback Specification

Type Collection
Object Key(s) ifnum
Collection Name loopback-list
Collection URI /axapi/v3/interface/loopback/
Element Name loopback
Element URI /axapi/v3/interface/loopback/{ifnum}
Element Attributes loopback_attributes
Schema loopback schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/interface/loopback/

loopback Attributes

Create List

POST

/axapi/v3/interface/loopback/

loopback Attributes

Get Object

GET

/axapi/v3/interface/loopback/{ifnum}

loopback Attributes

Get List

GET

/axapi/v3/interface/loopback/

loopback-list

Modify Object

POST

/axapi/v3/interface/loopback/{ifnum}

loopback Attributes

Replace Object

PUT

/axapi/v3/interface/loopback/{ifnum}

loopback Attributes

Replace List

PUT

/axapi/v3/interface/loopback/

loopback-list

Delete Object

DELETE

/axapi/v3/interface/loopback/{ifnum}

loopback Attributes

loopback-list

loopback-list is JSON List of loopback Attributes

loopback-list : [

loopback Attributes

ifnum

Description: Specify the interface number of a loopback interface.

Type: number

Range: 0-10

Required: Yes

ip

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ip

ipv6

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6

isis

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/isis

snmp-server

Description: snmp-server is a JSON Block . Please see below for snmp-server

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

isis

Specification
Type object

authentication

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

Type: Object

bfd-cfg

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

Type: Object

circuit-type

Description: ‘level-1’: Level-1 only adjacencies are formed; ‘level-1-2’: Level-1-2 adjacencies are formed; ‘level-2-only’: Level-2 only adjacencies are formed;

Type: string

Supported Values: level-1, level-1-2, level-2-only

Default: level-1-2

csnp-interval-list

Description: csnp-interval-list is a JSON List . Please see below for l657_csnp-interval-list

Type: List

hello-interval-list

Description: hello-interval-list is a JSON List . Please see below for l657_hello-interval-list

Type: List

hello-interval-minimal-list

Description: hello-interval-minimal-list is a JSON List . Please see below for l657_hello-interval-minimal-list

Type: List

hello-multiplier-list

Description: hello-multiplier-list is a JSON List . Please see below for l657_hello-multiplier-list

Type: List

lsp-interval

Description: Set LSP transmission interval (LSP transmission interval (milliseconds))

Type: number

Range: 1-4294967295

Default: 33

mesh-group

Description: mesh-group is a JSON Block . Please see below for l657_mesh-group

Type: Object

metric-list

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

Type: List

padding

Description: Add padding to IS-IS hello packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

password-list

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

Type: List

priority-list

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

Type: List

retransmit-interval

Description: Set per-LSP retransmission interval (Interval between retransmissions of the same LSP (seconds))

Type: number

Range: 0-65535

Default: 5

uuid

Description: uuid of the object

Type: string

wide-metric-list

Description: wide-metric-list is a JSON List . Please see below for l657_wide-metric-list

Type: List

isis.priority-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify priority for level-1 routing; ‘level-2’: Specify priority for level-2 routing;

Type: string

Supported Values: level-1, level-2

priority

Description: Set priority for Designated Router election (Priority value)

Type: number

Range: 0-127

Default: 64

isis.hello-interval-minimal-list

Specification
Type list
Block object keys

hello-interval-minimal

Description: Set Hello holdtime 1 second, interval depends on multiplier

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

level

Description: ‘level-1’: Specify hello-interval for level-1 IIHs; ‘level-2’: Specify hello-interval for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.mesh-group

Specification
Type object

blocked

Description: Block LSPs on this interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: blocked and value are mutually exclusive

value

Description: Mesh group number

Type: number

Range: 1-4294967295

Mutual Exclusion: value and blocked are mutually exclusive

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

isis.password-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify password for level-1 PDUs; ‘level-2’: Specify password for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

password

Description: Configure the authentication password for interface

Type: string

Format: string-rlx

isis.authentication

Specification
Type object

key-chain-list

Description: key-chain-list is a JSON List . Please see below for l657_key-chain-list

Type: List

mode-list

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

Type: List

send-only-list

Description: send-only-list is a JSON List . Please see below for l657_send-only-list

Type: List

isis.authentication.key-chain-list

Specification
Type list
Block object keys

key-chain

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

Type: string

level

Description: ‘level-1’: Specify authentication key-chain for level-1 PDUs; ‘level-2’: Specify authentication key-chain for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

isis.authentication.mode-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication mode for level-1 PDUs; ‘level-2’: Specify authentication mode for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

mode

Description: ‘md5’: Keyed message digest;

Type: string

Supported Values: md5

isis.authentication.send-only-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication send-only for level-1 PDUs; ‘level-2’: Specify authentication send-only for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

send-only

Description: Authentication send-only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

isis.wide-metric-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Apply metric to level-1 links; ‘level-2’: Apply metric to level-2 links;

Type: string

Supported Values: level-1, level-2

wide-metric

Description: Configure the wide metric for interface

Type: number

Range: 1-16777214

Default: 10

isis.hello-interval-list

Specification
Type list
Block object keys

hello-interval

Description: Set Hello interval in seconds (Hello interval value)

Type: number

Range: 1-65535

Default: 10

level

Description: ‘level-1’: Specify hello-interval for level-1 IIHs; ‘level-2’: Specify hello-interval for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.hello-multiplier-list

Specification
Type list
Block object keys

hello-multiplier

Description: Set multiplier for Hello holding time (Hello multiplier value)

Type: number

Range: 2-100

Default: 3

level

Description: ‘level-1’: Specify hello multiplier for level-1 IIHs; ‘level-2’: Specify hello multiplier for level-2 IIHs;

Type: string

Supported Values: level-1, level-2

isis.metric-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Apply metric to level-1 links; ‘level-2’: Apply metric to level-2 links;

Type: string

Supported Values: level-1, level-2

metric

Description: Configure the metric for interface (Default metric)

Type: number

Range: 1-63

Default: 10

isis.csnp-interval-list

Specification
Type list
Block object keys

csnp-interval

Description: Set CSNP interval in seconds (CSNP interval value)

Type: number

Range: 1-65535

Default: 10

level

Description: ‘level-1’: Speficy interval for level-1 CSNPs; ‘level-2’: Specify interval for level-2 CSNPs;

Type: string

Supported Values: level-1, level-2

snmp-server

Specification
Type object

trap-source

Description: Use this interface as the source interface for SNMP traps.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip

Specification
Type object

address-list

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

Type: List

ospf

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

Type: Object

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

rip

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

Type: Object

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

router

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

Type: Object

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

uuid

Description: uuid of the object

Type: string

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

ip.ospf

Specification
Type object

ospf-global

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

Type: Object

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

ospf-ip-list

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

Type: List

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

ip.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 l657_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

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

ip.ospf.ospf-global

Specification
Type object

authentication-cfg

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

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

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

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

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

ip.ospf.ospf-global.message-digest-cfg

Specification
Type list
Block object keys

md5

Description: md5 is a JSON Block . Please see below for l657_md5

Type: Object

message-digest-key

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

Type: number

Range: 1-255

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

ip.rip

Specification
Type object

authentication

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

Type: Object

receive-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

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

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

ip.rip.authentication

Specification
Type object

key-chain

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

Type: Object

mode

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

Type: Object

str

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

Type: Object

ip.rip.authentication.key-chain

Specification
Type object

key-chain

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

Type: string

Format: string-rlx

ip.rip.authentication.mode

Specification
Type object

mode

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

Type: string

Supported Values: md5, text

Default: text

ip.rip.authentication.str

Specification
Type object

string

Description: The RIP authentication string

Type: string

Format: string-rlx

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

ip.router

Specification
Type object

isis

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

Type: Object

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

ip.router.isis

Specification
Type object

tag

Description: ISO routing area tag

Type: string

uuid

Description: uuid of the object

Type: string

ipv6

Specification
Type object

address-list

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

Type: List

ipv6-enable

Description: Enable the interface to process IPv6 traffic.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/ospf

rip

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/rip

router

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router

uuid

Description: uuid of the object

Type: string

ipv6.address-list

Specification
Type list
Block object keys

anycast

Description: Configure an IPv6 anycast address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6-addr

Description: Set the IPv6 address of an interface

Type: string

Format: ipv6-address-plen

link-local

Description: Configure an IPv6 link local address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6.rip

Specification
Type object

split-horizon-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

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

ipv6.router

Specification
Type object

isis

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/isis

ospf

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

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/ospf

ripng

Description: ripng is a JSON Block . Please see below for l657_ripng

Type: Object

Reference Object: /axapi/v3/interface/loopback/{ifnum}/ipv6/router/ripng

ipv6.router.ripng

Specification
Type object

rip

Description: RIP Routing for IPv6

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ipv6.router.ospf

Specification
Type object

area-list

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

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.router.ospf.area-list

Specification
Type list
Block object keys

area-id-addr

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-id-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

instance-id

Description: Set the interface instance ID

Type: number

Range: 0-255

Default: 0

tag

Description: Set the OSPFv3 process tag

Type: string

ipv6.router.isis

Specification
Type object

tag

Description: ISO routing area tag

Type: string

uuid

Description: uuid of the object

Type: string

ipv6.ospf

Specification
Type object

bfd

Description: Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cost-cfg

Description: cost-cfg is a JSON List . Please see below for l657_cost-cfg

Type: List

dead-interval-cfg

Description: dead-interval-cfg is a JSON List . Please see below for l657_dead-interval-cfg

Type: List

disable

Description: Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

hello-interval-cfg

Description: hello-interval-cfg is a JSON List . Please see below for l657_hello-interval-cfg

Type: List

mtu-ignore-cfg

Description: mtu-ignore-cfg is a JSON List . Please see below for l657_mtu-ignore-cfg

Type: List

priority-cfg

Description: priority-cfg is a JSON List . Please see below for l657_priority-cfg

Type: List

retransmit-interval-cfg

Description: retransmit-interval-cfg is a JSON List . Please see below for l657_retransmit-interval-cfg

Type: List

transmit-delay-cfg

Description: transmit-delay-cfg is a JSON List . Please see below for l657_transmit-delay-cfg

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.ospf.cost-cfg

Specification
Type list
Block object keys

cost

Description: Interface cost

Type: number

Range: 1-65535

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

ipv6.ospf.hello-interval-cfg

Specification
Type list
Block object keys

hello-interval

Description: Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

ipv6.ospf.priority-cfg

Specification
Type list
Block object keys

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

priority

Description: Router priority

Type: number

Range: 0-255

Default: 1

ipv6.ospf.mtu-ignore-cfg

Specification
Type list
Block object keys

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

mtu-ignore

Description: Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6.ospf.retransmit-interval-cfg

Specification
Type list
Block object keys

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

retransmit-interval

Description: Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

ipv6.ospf.transmit-delay-cfg

Specification
Type list
Block object keys

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0

transmit-delay

Description: Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

ipv6.ospf.dead-interval-cfg

Specification
Type list
Block object keys

dead-interval

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

Type: number

Range: 1-65535

Default: 40

instance-id

Description: Specify the interface instance ID

Type: number

Range: 0-255

Default: 0