router isis¶

Intermediate System - Intermediate System (IS-IS)

isis Specification¶

Parameter Value

Type Collection

Object Key(s) tag

Collection Name isis-list

Collection URI /axapi/v3/router/isis

Element Name isis

Element URI /axapi/v3/router/isis/{tag}

Element Attributes isis_attributes

Partition Visibility shared

Schema isis schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/router/isis	isis attributes
POST /axapi/v3/router/isis/ Payload: { "isis": { "tag": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/router/isis	isis attributes
Get Object	GET	/axapi/v3/router/isis/{tag}	isis attributes
GET /axapi/v3/router/isis/a Reponse: { "isis": { "tag": "a", "adjacency-check": 1, "ignore-lsp-errors": 0, "is-type": "level-1", "lsp-refresh-interval": 900, "max-lsp-lifetime": 1200, "set-overload-bit-cfg": { "set-overload-bit": 0 }, "uuid": "94fd8dd2-504a-11ee-831e-392ad702ec20", "user-tag": "a", "a10-url": "/axapi/v3/router/isis/a" } }
Get List	GET	/axapi/v3/router/isis	isis-list
Modify Object	POST	/axapi/v3/router/isis/{tag}	isis attributes
Replace Object	PUT	/axapi/v3/router/isis/{tag}	isis attributes
PUT /axapi/v3/router/isis/a Payload: { "isis": { "tag": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/router/isis	isis-list
Delete Object	DELETE	/axapi/v3/router/isis/{tag}	isis attributes
DELETE /axapi/v3/router/isis/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

isis-list¶

isis-list is JSON List of isis attributes

isis-list : [

{ isis attributes },

{ isis attributes },

…

]

isis attributes¶

address-family

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/address-family

adjacency-check

Description Check ISIS neighbor protocol support

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

area-password-cfg

Description: area-password-cfg is a JSON Block. Please see below for area-password-cfg

Type: Object

authentication

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

Type: Object

bfd

Description ‘all-interfaces’: Enable BFD on all interfaces;

Type: string

Supported Values: all-interfaces

default-information

Description ‘originate’: Distribute a default route;

Type: string

Supported Values: originate

distance-list

Type: List

domain-password-cfg

Description: domain-password-cfg is a JSON Block. Please see below for domain-password-cfg

Type: Object

ha-standby-extra-cost

Type: List

ignore-lsp-errors

Description Ignore LSPs with bad checksums

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

is-type

Description ‘level-1’: Act as a station router only; ‘level-1-2’: Act as both a station router and an area router; ‘level-2-only’: Act as an area router only;

Type: string

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

Default: level-1

log-adjacency-changes-cfg

Description: log-adjacency-changes-cfg is a JSON Block. Please see below for log-adjacency-changes-cfg

Type: Object

lsp-gen-interval-list

Type: List

lsp-refresh-interval

Description Set LSP refresh interval (LSP refresh time in seconds)

Type: number

Range: 1-65535

Default: 900

max-lsp-lifetime

Description Set maximum LSP lifetime (Maximum LSP lifetime in seconds)

Type: number

Range: 350-65535

Default: 1200

metric-style-list

Type: List

net-list

Type: List

passive-interface-list

Type: List

protocol-list

Type: List

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/redistribute

set-overload-bit-cfg

Description: set-overload-bit-cfg is a JSON Block. Please see below for set-overload-bit-cfg

Type: Object

spf-interval-exp-list

Type: List

summary-address-list

Type: List

tag

Description ISO routing area tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Default:

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

domain-password-cfg¶

Specification Value

Type object

authenticate

Description: authenticate is a JSON Block. Please see below for domain-password-cfg_authenticate

Type: Object

password

Description Set the authentication password for a routing domain (Routing domain password)

Type: string

Format: string-rlx

Maximum Length: 254 characters

Maximum Length: 1 characters

domain-password-cfg_authenticate¶

Specification Value

Type object

snp

Description ‘send-only’: Send but do not check PDUs on receiving; ‘validate’: Send and check PDUs on receiving;

Type: string

Supported Values: send-only, validate

set-overload-bit-cfg¶

Specification Value

Type object

on-startup

Description: on-startup is a JSON Block. Please see below for set-overload-bit-cfg_on-startup

Type: Object

set-overload-bit

Description Signal other touers not to use us in SPF

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

suppress-cfg

Description: suppress-cfg is a JSON Block. Please see below for set-overload-bit-cfg_suppress-cfg

Type: Object

set-overload-bit-cfg_suppress-cfg¶

Specification Value

Type object

external

Description If overload-bit set, don’t advertise IP prefixes learned from other protocols

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interlevel

Description If overload-bit set, don’t advertise IP prefixes learned from another ISIS level

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

set-overload-bit-cfg_on-startup¶

Specification Value

Type object

delay

Description Time in seconds to advertise ourself as overloaded after reboot

Type: number

Range: 5-86400

Mutual Exclusion: delay and wait-for-bgp are mutually exclusive

wait-for-bgp

Description Let BGP decide when to unset the overload bit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: wait-for-bgp and delay are mutually exclusive

net-list¶

Specification Value

Type list

Block object keys

net

Description A Network Entity Title for this process (XX.XXXX. … .XXXX.XX Network entity title (NET))

Type: string

Format: nasp-string

Maximum Length: 63 characters

Maximum Length: 1 characters

metric-style-list¶

Specification Value

Type list

Block object keys

level

Description ‘level-1’: Level-1 only; ‘level-1-2’: Level-1-2; ‘level-2’: Level-2 only;

Type: string

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

Default: level-1-2

type

Description ‘narrow’: Use old style of TLVs with narrow metric; ‘wide’: Use new style of TLVs to carry wider metric; ‘transition’: Send and accept both styles of TLVs during transition; ‘narrow-transition’: Send old style of TLVs with narrow metric with accepting both styles of TLVs; ‘wide-transition’: Send new style of TLVs to carry wider metric with accepting both styles of TLVs;

Type: string

Supported Values: narrow, wide, transition, narrow-transition, wide-transition

Default: narrow

authentication¶

Specification Value

Type object

key-chain-list

Type: List

mode-list

Type: List

send-only-list

Type: List

authentication_key-chain-list¶

Specification Value

Type list

Block object keys

key-chain

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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

authentication_mode-list¶

Specification Value

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’: Authentication mode;

Type: string

Supported Values: md5

authentication_send-only-list¶

Specification Value

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

protocol-list¶

Specification Value

Type list

Block object keys

protocol-topology

Description Protocol Topology

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log-adjacency-changes-cfg¶

Specification Value

Type object

state

Description ‘detail’: Log changes in adjacency state; ‘disable’: Disable logging;

Type: string

Supported Values: detail, disable

spf-interval-exp-list¶

Specification Value

Type list

Block object keys

level

Description ‘level-1’: Set interval for level 1 only; ‘level-2’: Set interval for level 2 only;

Type: string

Supported Values: level-1, level-2

max

Description Maximum Delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 50000

min

Description Minimum Delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 500

passive-interface-list¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet interface (Port number)

Type: number

Format: interface

lif

Description Logical interface (Lif interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

loopback

Description Loopback interface (Port number)

Type: number

Format: interface

trunk

Description Trunk interface (Trunk interface number)

Type: number

Format: interface

tunnel

Description Tunnel interface (Tunnel interface number)

Type: number

Format: interface

ve

Description Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

summary-address-list¶

Specification Value

Type list

Block object keys

level

Description ‘level-1’: Summarize into level-1 area; ‘level-1-2’: Summarize into both area and sub-domain; ‘level-2’: Summarize into level-2 sub-domain;

Type: string

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

Default: level-2

prefix

Description IP network prefix

Type: string

Format: ipv4-cidr

address-family¶

Specification Value

Type object

ipv6

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/address-family/ipv6

address-family_ipv6¶

Specification Value

Type object

adjacency-check

Description Check ISIS neighbor protocol support

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

default-information

Description ‘originate’: Distribute a default route;

Type: string

Supported Values: originate

distance

Description ISIS Administrative Distance (Distance value)

Type: number

Range: 1-255

Default: 115

multi-topology-cfg

Description: multi-topology-cfg is a JSON Block. Please see below for address-family_ipv6_multi-topology-cfg

Type: Object

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/address-family/ipv6/redistribute

summary-prefix-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute¶

Specification Value

Type object

isis

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

Type: Object

redist-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip-list

Type: List

address-family_ipv6_redistribute_vip-list¶

Specification Value

Type list

Block object keys

vip-level

Description ‘level-1’: IS-IS level-1 routes only; ‘level-1-2’: IS-IS level-1 and level-2 routes; ‘level-2’: IS-IS level-2 routes only;

Type: string

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

Default: level-2

vip-metric

Description Metric for redistributed routes (IS-IS default metric)

Type: number

Range: 0-4261412864

Default: 0

vip-metric-type

Description ‘external’: Set IS-IS External metric type; ‘internal’: Set IS-IS Internal metric type;

Type: string

Supported Values: external, internal

Default: internal

vip-route-map

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

vip-type

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

Type: string

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

address-family_ipv6_redistribute_redist-list¶

Specification Value

Type list

Block object keys

level

Description ‘level-1’: IS-IS level-1 routes only; ‘level-1-2’: IS-IS level-1 and level-2 routes; ‘level-2’: IS-IS level-2 routes only;

Type: string

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

Default: level-2

metric

Description Metric for redistributed routes (IS-IS default metric)

Type: number

Range: 0-4261412864

Default: 0

metric-type

Description ‘external’: Set IS-IS External metric type; ‘internal’: Set IS-IS Internal metric type;

Type: string

Supported Values: external, internal

Default: internal

route-map

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

type

Description ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘lw4o6’: LW4O6 Prefix; ‘nat-map’: NAT MAP Prefix; ‘static-nat’: Static NAT; ‘nat64’: NAT64 Prefix; ‘ospf’: Open Shortest Path First (OSPF); ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, ip-nat, lw4o6, nat-map, static-nat, nat64, ospf, rip, static

address-family_ipv6_redistribute_isis¶

Specification Value

Type object

level-1-from

Description: level-1-from is a JSON Block. Please see below for address-family_ipv6_redistribute_isis_level-1-from

Type: Object

level-2-from

Description: level-2-from is a JSON Block. Please see below for address-family_ipv6_redistribute_isis_level-2-from

Type: Object

address-family_ipv6_redistribute_isis_level-2-from¶

Specification Value

Type object

into-2

Description: into-2 is a JSON Block. Please see below for address-family_ipv6_redistribute_isis_level-2-from_into-2

Type: Object

address-family_ipv6_redistribute_isis_level-2-from_into-2¶

Specification Value

Type object

distribute-list

Description Select routes (Access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

level-1

Description Inter-area routes into level-2

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family_ipv6_redistribute_isis_level-1-from¶

Specification Value

Type object

into-1

Description: into-1 is a JSON Block. Please see below for address-family_ipv6_redistribute_isis_level-1-from_into-1

Type: Object

address-family_ipv6_redistribute_isis_level-1-from_into-1¶

Specification Value

Type object

distribute-list

Description Select routes (Access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

level-2

Description Inter-area routes into level-2

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family_ipv6_multi-topology-cfg¶

Specification Value

Type object

level

Description ‘level-1’: Level-1 only; ‘level-1-2’: Level-1-2; ‘level-2’: Level-2 only;

Type: string

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

Mutual Exclusion: level and transition are mutually exclusive

level-transition

Description Accept and generate both IS-IS IPv6 and Multi-topology IPV6 TLVs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

multi-topology

Description Enable multi-topology mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

transition

Description Accept and generate both IS-IS IPv6 and Multi-topology IPV6 TLVs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: transition and level are mutually exclusive

address-family_ipv6_summary-prefix-list¶

Specification Value

Type list

Block object keys

level

Description ‘level-1’: Summarize into level-1 area; ‘level-1-2’: Summarize into both area and sub-domain; ‘level-2’: Summarize into level-2 sub-domain;

Type: string

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

Default: level-2

prefix

Description IPv6 prefix

Type: string

Format: ipv6-address-plen

redistribute¶

Specification Value

Type object

isis

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

Type: Object

redist-list

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip-list

Type: List

redistribute_vip-list¶

Specification Value

Type list

Block object keys

vip-level

Description ‘level-1’: IS-IS level-1 routes only; ‘level-1-2’: IS-IS level-1 and level-2 routes; ‘level-2’: IS-IS level-2 routes only;

Type: string

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

Default: level-2

vip-metric

Description Metric for redistributed routes (IS-IS default metric)

Type: number

Range: 0-4261412864

Default: 0

vip-metric-type

Description ‘external’: Set IS-IS External metric type; ‘internal’: Set IS-IS Internal metric type;

Type: string

Supported Values: external, internal

Default: internal

vip-route-map

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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 Value

Type list

Block object keys

level

Description ‘level-1’: IS-IS level-1 routes only; ‘level-1-2’: IS-IS level-1 and level-2 routes; ‘level-2’: IS-IS level-2 routes only;

Type: string

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

Default: level-2

metric

Description Metric for redistributed routes (IS-IS default metric)

Type: number

Range: 0-4261412864

Default: 0

metric-type

Description ‘external’: Set IS-IS External metric type; ‘internal’: Set IS-IS Internal metric type;

Type: string

Supported Values: external, internal

Default: internal

route-map

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

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

type

Description ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘lw4o6’: LW4O6 Prefix; ‘nat-map’: NAT MAP Prefix; ‘static-nat’: Static NAT; ‘ospf’: Open Shortest Path First (OSPF); ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

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

redistribute_isis¶

Specification Value

Type object

level-1-from

Description: level-1-from is a JSON Block. Please see below for redistribute_isis_level-1-from

Type: Object

level-2-from

Description: level-2-from is a JSON Block. Please see below for redistribute_isis_level-2-from

Type: Object

redistribute_isis_level-2-from¶

Specification Value

Type object

into-2

Description: into-2 is a JSON Block. Please see below for redistribute_isis_level-2-from_into-2

Type: Object

redistribute_isis_level-2-from_into-2¶

Specification Value

Type object

distribute-list

Description Select routes (Access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

level-1

Description Inter-area routes into level-2

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redistribute_isis_level-1-from¶

Specification Value

Type object

into-1

Description: into-1 is a JSON Block. Please see below for redistribute_isis_level-1-from_into-1

Type: Object

redistribute_isis_level-1-from_into-1¶

Specification Value

Type object

distribute-list

Description Select routes (Access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

level-2

Description Inter-area routes into level-2

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

area-password-cfg¶

Specification Value

Type object

authenticate

Description: authenticate is a JSON Block. Please see below for area-password-cfg_authenticate

Type: Object

password

Description Configure the authentication password for an area (Area password)

Type: string

Format: string-rlx

Maximum Length: 254 characters

Maximum Length: 1 characters

area-password-cfg_authenticate¶

Specification Value

Type object

snp

Description ‘send-only’: Send but do not check PDUs on receiving; ‘validate’: Send and check PDUs on receiving;

Type: string

Supported Values: send-only, validate

lsp-gen-interval-list¶

Specification Value

Type list

Block object keys

interval

Description Minimum interval in seconds

Type: number

Range: 1-120

Default: 30

level

Description ‘level-1’: Set interval for level 1 only; ‘level-2’: Set interval for level 2 only;

Type: string

Supported Values: level-1, level-2

distance-list¶

Specification Value

Type list

Block object keys

System-ID

Description System-ID in XXXX.XXXX.XXXX

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

acl

Description Access list name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

distance

Description ISIS Administrative Distance (Distance value)

Type: number

Range: 1-255

Default: 115

ha-standby-extra-cost¶

Specification Value

Type list

Block object keys

extra-cost

Description The extra cost value

Type: number

Range: 1-65535

group

Description Group (Group ID)

Type: number

Range: 0-31