router bgp address-family

Enter Address Family command mode

address-family Specification

Type Intermediate Resource
Element Name address-family
Element URI /axapi/v3/router/bgp/{as-number}/address-family
Element Attributes address-family_attributes
Schema address-family schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/router/bgp/{as-number}/address-family

address-family_attributes

address-family Attributes

ipv6

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

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6

ipv6

Specification
Type object

aggregate-address-list

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

Type: List

auto-summary

Description: Enable automatic network number summarization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bgp

Description: bgp is a JSON Block . Please see below for l342_bgp

Type: Object

distance

Description: distance is a JSON Block . Please see below for l342_distance

Type: Object

maximum-paths-value

Description: Supported BGP multipath numbers

Type: number

Range: 1-10

Default: 1

neighbor

Description: neighbor is a JSON Block . Please see below for l342_neighbor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor

network

Description: network is a JSON Block . Please see below for l342_network

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network

originate

Description: Distribute an IPv6 default route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/redistribute

synchronization

Description: Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ipv6.distance

Specification
Type object

distance-ext

Description: Distance for routes external to the AS

Type: number

Range: 1-255

distance-int

Description: Distance for routes internal to the AS

Type: number

Range: 1-255

distance-local

Description: Distance for local routes

Type: number

Range: 1-255

ipv6.redistribute

Specification
Type object

connected-cfg

Description: connected-cfg is a JSON Block . Please see below for l342_connected-cfg

Type: Object

floating-ip-cfg

Description: floating-ip-cfg is a JSON Block . Please see below for l342_floating-ip-cfg

Type: Object

ip-nat-cfg

Description: ip-nat-cfg is a JSON Block . Please see below for l342_ip-nat-cfg

Type: Object

ip-nat-list-cfg

Description: ip-nat-list-cfg is a JSON Block . Please see below for l342_ip-nat-list-cfg

Type: Object

isis-cfg

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

Type: Object

lw4o6-cfg

Description: lw4o6-cfg is a JSON Block . Please see below for l342_lw4o6-cfg

Type: Object

nat64-cfg

Description: nat64-cfg is a JSON Block . Please see below for l342_nat64-cfg

Type: Object

ospf-cfg

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

Type: Object

rip-cfg

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

Type: Object

static-cfg

Description: static-cfg is a JSON Block . Please see below for l342_static-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

vip

Description: vip is a JSON Block . Please see below for l342_vip

Type: Object

ipv6.redistribute.ip-nat-list-cfg

Specification
Type object

ip-nat-list

Description: IP NAT list

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.lw4o6-cfg

Specification
Type object

lw4o6

Description: LW4O6 Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.nat64-cfg

Specification
Type object

nat64

Description: NAT64 Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.connected-cfg

Specification
Type object

connected

Description: Connected

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.ip-nat-cfg

Specification
Type object

ip-nat

Description: IP NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.floating-ip-cfg

Specification
Type object

floating-ip

Description: Floating IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.isis-cfg

Specification
Type object

isis

Description: ISO IS-IS

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.vip

Specification
Type object

only-flagged-cfg

Description: only-flagged-cfg is a JSON Block . Please see below for l342_only-flagged-cfg

Type: Object

only-not-flagged-cfg

Description: only-not-flagged-cfg is a JSON Block . Please see below for l342_only-not-flagged-cfg

Type: Object

ipv6.redistribute.vip.only-not-flagged-cfg

Specification
Type object

only-not-flagged

Description: Only not flagged

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.vip.only-flagged-cfg

Specification
Type object

only-flagged

Description: Selected Virtual IP (VIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.rip-cfg

Specification
Type object

rip

Description: Routing Information Protocol (RIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.ospf-cfg

Specification
Type object

ospf

Description: Open Shortest Path First (OSPF)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

ipv6.redistribute.static-cfg

Specification
Type object

route-map

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

Type: string

static

Description: Static routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6.aggregate-address-list

Specification
Type list
Block object keys

aggregate-address

Description: Configure BGP aggregate entries (Aggregate IPv6 prefix)

Type: string

Format: ipv6-address-plen

as-set

Description: Generate AS set path information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

summary-only

Description: Filter more specific routes from updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ipv6.bgp

Specification
Type object

dampening

Description: Enable route-flap dampening

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dampening-half

Description: Reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

dampening-max-supress

Description: Maximum duration to suppress a stable route(minutes)

Type: number

Range: 1-255

dampening-start-reuse

Description: Value to start reusing a route

Type: number

Range: 1-20000

dampening-start-supress

Description: Value to start suppressing a route

Type: number

Range: 1-20000

dampening-unreachability

Description: Un-reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

route-map

Description: Route-map to specify criteria for dampening (Route-map name)

Type: string

ipv6.network

Specification
Type object

ipv6-network-list

Description: ipv6-network-list is a JSON List . Please see below for l342_ipv6-network-list

Type: List

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/ipv6-network/{network-ipv6}

synchronization

Description: synchronization is a JSON Block . Please see below for l342_synchronization

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/synchronization

ipv6.network.ipv6-network-list

Specification
Type list
Block object keys

backdoor

Description: Specify a BGP backdoor route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

comm-value

Description: community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

Type: string

Format: string-rlx

description

Description: Network specific description (Up to 80 characters describing this network)

Type: string

Format: string-rlx

network-ipv6

Description: Specify a network to announce via BGP

Type: string

Format: ipv6-address-plen

route-map

Description: Route-map to modify the attributes (Name of the route map)

Type: string

uuid

Description: uuid of the object

Type: string

ipv6.network.synchronization

Specification
Type object

network-synchronization

Description: Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

ipv6.neighbor

Specification
Type object

ipv4-neighbor-list

Description: ipv4-neighbor-list is a JSON List . Please see below for l342_ipv4-neighbor-list

Type: List

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv4-neighbor/{neighbor-ipv4}

ipv6-neighbor-list

Description: ipv6-neighbor-list is a JSON List . Please see below for l342_ipv6-neighbor-list

Type: List

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv6-neighbor/{neighbor-ipv6}

peer-group-neighbor-list

Description: peer-group-neighbor-list is a JSON List . Please see below for l342_peer-group-neighbor-list

Type: List

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/peer-group-neighbor/{peer-group}

ipv6.neighbor.peer-group-neighbor-list

Specification
Type list
Block object keys

activate

Description: Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description: Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description: Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

default-originate

Description: Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Description: distribute-lists is a JSON List . Please see below for l342_distribute-lists

Type: List

inbound

Description: Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description: Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l342_neighbor-filter-lists

Type: List

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l342_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l342_neighbor-route-map-lists

Type: List

next-hop-self

Description: Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group

Description: Neighbor tag

Type: string

prefix-list-direction

Description: ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description: Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description: Route-map to specify criteria to originate default (route-map name)

Type: string

send-community-val

Description: ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: both, none, standard, extended

Default: both

unsuppress-map

Description: Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

uuid

Description: uuid of the object

Type: string

weight

Description: Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

ipv6.neighbor.peer-group-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

Description: Filter updates to/from this neighbor (Name of a prefix list)

Type: string

nbr-prefix-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.peer-group-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

Description: Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

distribute-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.peer-group-neighbor-list.neighbor-route-map-lists

Specification
Type list
Block object keys

nbr-rmap-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description: Apply route map to neighbor (Name of route map)

Type: string

ipv6.neighbor.peer-group-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

Description: Establish BGP filters (AS path access-list name)

Type: string

filter-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv6-neighbor-list

Specification
Type list
Block object keys

activate

Description: Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description: Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description: Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

default-originate

Description: Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Description: distribute-lists is a JSON List . Please see below for l342_distribute-lists

Type: List

inbound

Description: Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description: Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l342_neighbor-filter-lists

Type: List

neighbor-ipv6

Description: Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l342_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l342_neighbor-route-map-lists

Type: List

next-hop-self

Description: Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description: Configure peer-group (peer-group name)

Type: string

prefix-list-direction

Description: ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description: Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description: Route-map to specify criteria to originate default (route-map name)

Type: string

send-community-val

Description: ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: both, none, standard, extended

Default: both

unsuppress-map

Description: Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

uuid

Description: uuid of the object

Type: string

weight

Description: Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

ipv6.neighbor.ipv6-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

Description: Filter updates to/from this neighbor (Name of a prefix list)

Type: string

nbr-prefix-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv6-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

Description: Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

distribute-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv6-neighbor-list.neighbor-route-map-lists

Specification
Type list
Block object keys

nbr-rmap-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description: Apply route map to neighbor (Name of route map)

Type: string

ipv6.neighbor.ipv6-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

Description: Establish BGP filters (AS path access-list name)

Type: string

filter-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv4-neighbor-list

Specification
Type list
Block object keys

activate

Description: Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description: Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description: Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

default-originate

Description: Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Description: distribute-lists is a JSON List . Please see below for l342_distribute-lists

Type: List

inbound

Description: Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description: Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l342_neighbor-filter-lists

Type: List

neighbor-ipv4

Description: Neighbor address

Type: string

Format: ipv4-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l342_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l342_neighbor-route-map-lists

Type: List

next-hop-self

Description: Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description: Configure peer-group (peer-group name)

Type: string

prefix-list-direction

Description: ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description: Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description: Route-map to specify criteria to originate default (route-map name)

Type: string

send-community-val

Description: ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: both, none, standard, extended

Default: both

unsuppress-map

Description: Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

uuid

Description: uuid of the object

Type: string

weight

Description: Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

ipv6.neighbor.ipv4-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

Description: Filter updates to/from this neighbor (Name of a prefix list)

Type: string

nbr-prefix-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv4-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

Description: Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

distribute-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

ipv6.neighbor.ipv4-neighbor-list.neighbor-route-map-lists

Specification
Type list
Block object keys

nbr-rmap-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description: Apply route map to neighbor (Name of route map)

Type: string

ipv6.neighbor.ipv4-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

Description: Establish BGP filters (AS path access-list name)

Type: string

filter-list-direction

Description: ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out