router rip

Routing Information Protocol (RIP)

rip Specification

Type Configuration Resource
Element Name rip
Element URI /axapi/v3/router/rip
Element Attributes rip_attributes
Schema rip schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/router/rip

rip Attributes

Get Object

GET

/axapi/v3/router/rip

rip Attributes

Modify Object

POST

/axapi/v3/router/rip

rip Attributes

Replace Object

PUT

/axapi/v3/router/rip

rip Attributes

Delete Object

DELETE

/axapi/v3/router/rip

rip Attributes

rip Attributes

cisco-metric-behavior

Description: ‘enable’: Enables updating metric consistent with Cisco; ‘disable’: Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco)

Type: string

Supported Values: enable, disable

Default: disable

default-information

Description: ‘originate’: originate; (Distribute default route)

Type: string

Supported Values: originate

default-metric

Description: Set a metric of redistribute routes (Default metric)

Type: number

Range: 1-16

Default: 1

distance-list-cfg

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

Type: List

distribute-list

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

Type: Object

Reference Object: /axapi/v3/router/rip/distribute-list

neighbor

Description: neighbor is a JSON List . Please see below for neighbor

Type: List

network-addresses

Description: network-addresses is a JSON List . Please see below for network-addresses

Type: List

network-interface-list-cfg

Description: network-interface-list-cfg is a JSON List . Please see below for network-interface-list-cfg

Type: List

offset-list

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

Type: Object

Reference Object: /axapi/v3/router/rip/offset-list

passive-interface-list

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

Type: List

recv-buffer-size

Description: Set the RIP UDP receive buffer size (the RIP UDP receive buffer size value)

Type: number

Range: 8192-2147483647

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/rip/redistribute

rip-maximum-prefix-cfg

Description: rip-maximum-prefix-cfg is a JSON Block . Please see below for rip-maximum-prefix-cfg

Type: Object

route-cfg

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

Type: List

timers

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

Type: Object

uuid

Description: uuid of the object

Type: string

version

Description: Set routing protocol version (RIP version)

Type: number

Range: 1-2

Default: 2

rip-maximum-prefix-cfg

Specification
Type object

maximum-prefix

Description: Set the maximum number of RIP routes

Type: number

Range: 1-2048

maximum-prefix-thres

Description: Percentage of maximum routes to generate a warning (Default 75%)

Type: number

Range: 1-100

Default: 75

route-cfg

Specification
Type list
Block object keys

route

Description: Static route advertisement (debugging purpose) (IP prefix network/length)

Type: string

Format: ipv4-cidr

passive-interface-list

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

redistribute

Specification
Type object

redist-list

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

Type: List

uuid

Description: uuid of the object

Type: string

vip-list

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

Type: List

redistribute.vip-list

Specification
Type list
Block object keys

vip-metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

vip-route-map

Description: Route map reference (Pointer to route-map entries)

Type: string

vip-type

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

route-map

Description: Route map reference (Pointer to route-map entries)

Type: string

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘isis’: ISO IS-IS; ‘lw4o6’: LW4O6 Prefix; ‘ospf’: Open Shortest Path First (OSPF); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, ospf, static

network-interface-list-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

timers

Specification
Type object

timers-cfg

Description: timers-cfg is a JSON Block . Please see below for l377_timers-cfg

Type: Object

timers.timers-cfg

Specification
Type object

basic

Description: Basic routing protocol update timers (Routing table update timer value in second. Default is 30)

Type: number

Range: 5-2147483647

val-2

Description: Routing information timeout timer. Default is 180

Type: number

Range: 5-2147483647

val-3

Description: Garbage collection timer. Default is 120

Type: number

Range: 5-2147483647

neighbor

Specification
Type list
Block object keys

value

Description: Neighbor address

Type: string

Format: ipv4-address

offset-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l377_acl-cfg

Type: List

uuid

Description: uuid of the object

Type: string

offset-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

metric

Description: Metric value

Type: number

Range: 0-16

offset-list-direction

Description: ‘in’: Filter incoming updates; ‘out’: Filter outgoing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

distribute-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l377_acl-cfg

Type: List

prefix

Description: prefix is a JSON Block . Please see below for l377_prefix

Type: Object

Reference Object: /axapi/v3/router/rip/distribute-list/prefix

uuid

Description: uuid of the object

Type: string

distribute-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

acl-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

distribute-list.prefix

Specification
Type object

prefix-cfg

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

Type: List

uuid

Description: uuid of the object

Type: string

distribute-list.prefix.prefix-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

prefix-list

Description: Filter prefixes in routing updates (Name of a prefix list)

Type: string

prefix-list-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

distance-list-cfg

Specification
Type list
Block object keys

distance

Description: Administrative distance (Distance value)

Type: number

Range: 1-255

Default: 120

distance-acl

Description: Access list name

Type: string

distance-ipv4-mask

Description: IP source prefix

Type: string

Format: ipv4-cidr

network-addresses

Specification
Type list
Block object keys

network-ipv4-mask

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

Type: string

Format: ipv4-cidr