router bgp address-family ipv6¶
ipv6 Address family
ipv6 Specification¶
Parameter Value Type Configuration Resource Element Name ipv6 Element URI /axapi/v3/router/bgp/{as-number}/address-family/ipv6 Element Attributes ipv6_attributes Partition Visibility shared Schema ipv6 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/router/bgp/{as-number}/address-family/ipv6 | ||
Get Object | GET | /axapi/v3/router/bgp/{as-number}/address-family/ipv6 | ||
Modify Object | POST | /axapi/v3/router/bgp/{as-number}/address-family/ipv6 | ||
Replace Object | PUT | /axapi/v3/router/bgp/{as-number}/address-family/ipv6 | ||
ipv6 attributes¶
aggregate-address-list
Type: Listauto-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 bgp
Type: Object
distance
Description: distance is a JSON Block. Please see below for distance
Type: Object
maximum-paths-value
Description Supported BGP multipath numbers
Type: number
Range: 1-64
Default: 1
neighbor
Description: neighbor is a JSON Block. Please see below for 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 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 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
Maximum Length: 64 characters
Maximum Length: 1 characters
distance¶
Specification Value 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
redistribute¶
Specification Value Type object connected-cfg
Description: connected-cfg is a JSON Block. Please see below for redistribute_connected-cfg
Type: Object
floating-ip-cfg
Description: floating-ip-cfg is a JSON Block. Please see below for redistribute_floating-ip-cfg
Type: Object
ip-nat-cfg
Description: ip-nat-cfg is a JSON Block. Please see below for redistribute_ip-nat-cfg
Type: Object
ip-nat-list-cfg
Description: ip-nat-list-cfg is a JSON Block. Please see below for redistribute_ip-nat-list-cfg
Type: Object
isis-cfg
Description: isis-cfg is a JSON Block. Please see below for redistribute_isis-cfg
Type: Object
lw4o6-cfg
Description: lw4o6-cfg is a JSON Block. Please see below for redistribute_lw4o6-cfg
Type: Object
nat-map-cfg
Description: nat-map-cfg is a JSON Block. Please see below for redistribute_nat-map-cfg
Type: Object
nat64-cfg
Description: nat64-cfg is a JSON Block. Please see below for redistribute_nat64-cfg
Type: Object
ospf-cfg
Description: ospf-cfg is a JSON Block. Please see below for redistribute_ospf-cfg
Type: Object
rip-cfg
Description: rip-cfg is a JSON Block. Please see below for redistribute_rip-cfg
Type: Object
static-cfg
Description: static-cfg is a JSON Block. Please see below for redistribute_static-cfg
Type: Object
static-nat-cfg
Description: static-nat-cfg is a JSON Block. Please see below for redistribute_static-nat-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vip
Description: vip is a JSON Block. Please see below for redistribute_vip
Type: Object
redistribute_ip-nat-list-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_lw4o6-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_nat64-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_connected-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_vip¶
Specification Value Type object only-flagged-cfg
Description: only-flagged-cfg is a JSON Block. Please see below for redistribute_vip_only-flagged-cfg
Type: Object
only-not-flagged-cfg
Description: only-not-flagged-cfg is a JSON Block. Please see below for redistribute_vip_only-not-flagged-cfg
Type: Object
redistribute_vip_only-not-flagged-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_vip_only-flagged-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_ip-nat-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_floating-ip-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_isis-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_nat-map-cfg¶
Specification Value Type object nat-map
Description NAT MAP Prefix
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_rip-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_ospf-cfg¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
redistribute_static-nat-cfg¶
Specification Value Type object route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
static-nat
Description Static NAT Prefix
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
redistribute_static-cfg¶
Specification Value Type object route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
static
Description Static routes
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
aggregate-address-list¶
Specification Value 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
bgp¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
network¶
Specification Value Type object ipv6-network-list
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/ipv6-network/{network-ipv6}
monitor
Description: monitor is a JSON Block. Please see below for network_monitor
Type: Object
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/monitor
synchronization
Description: synchronization is a JSON Block. Please see below for network_synchronization
Type: Object
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/synchronization
network_ipv6-network-list¶
Specification Value 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
Maximum Length: 80 characters
Maximum Length: 1 characters
lcomm-value
Description Large community value in the format XX:YY:ZZ
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
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
network_synchronization¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
network_monitor¶
Specification Value Type object default
Description: default is a JSON Block. Please see below for network_monitor_default
Type: Object
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/monitor/default
network_monitor_default¶
Specification Value Type object network-monitor-default
Description default route monitoring
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
neighbor¶
Specification Value Type object ethernet-neighbor-ipv6-list
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ethernet-neighbor-ipv6/{ethernet}
ipv4-neighbor-list
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv4-neighbor/{neighbor-ipv4}
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
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/peer-group-neighbor/{peer-group}
trunk-neighbor-ipv6-list
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/trunk-neighbor-ipv6/{trunk}
ve-neighbor-ipv6-list
Type: List
Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ve-neighbor-ipv6/{ve}
neighbor_ethernet-neighbor-ipv6-list¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface number
Type: number
Format: interface
peer-group-name
Description
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
neighbor_ipv4-neighbor-list¶
Specification Value 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
Type: Listgraceful-restart
Description enable graceful-restart helper for this neighbor
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
maximum-prefix-thres
Description threshold-value, 1 to 100 percent
Type: number
Range: 1-100
neighbor-filter-lists
Type: Listneighbor-ipv4
Description Neighbor address
Type: string
Format: ipv4-address
neighbor-prefix-lists
Type: Listneighbor-route-map-lists
Type: Listnext-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
Maximum Length: 128 characters
Maximum Length: 1 characters
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
restart-min
Description restart value, 1 to 1440 minutes
Type: number
Range: 1-1440
route-map
Description Route-map to specify criteria to originate default (route-map name)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
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: all, both, none, standard, extended, large
Default: both
unsuppress-map
Description Route-map to selectively unsuppress suppressed routes (Name of route map)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
weight
Description Set default weight for routes from this neighbor
Type: number
Range: 0-65535
Default: 0
neighbor_ipv4-neighbor-list_distribute-lists¶
Specification Value Type list Block object keys distribute-list
Description Filter updates to/from this neighbor (IP standard/extended/named access list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
distribute-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out
neighbor_ipv4-neighbor-list_neighbor-route-map-lists¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
neighbor_ipv4-neighbor-list_neighbor-filter-lists¶
Specification Value Type list Block object keys filter-list
Description Establish BGP filters (AS path access-list name)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
filter-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out
neighbor_ipv4-neighbor-list_neighbor-prefix-lists¶
Specification Value Type list Block object keys nbr-prefix-list
Description Filter updates to/from this neighbor (Name of a prefix list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
nbr-prefix-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out
neighbor_peer-group-neighbor-list¶
Specification Value 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
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
maximum-prefix-thres
Description threshold-value, 1 to 100 percent
Type: number
Range: 1-100
neighbor-route-map-lists
Type: Listnext-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
Maximum Length: 128 characters
Maximum Length: 1 characters
remove-private-as
Description Remove private AS number from outbound updates
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
weight
Description Set default weight for routes from this neighbor
Type: number
Range: 0-65535
Default: 0
neighbor_peer-group-neighbor-list_neighbor-route-map-lists¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
neighbor_ve-neighbor-ipv6-list¶
Specification Value Type list Block object keys peer-group-name
Description
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve
Description Virtual ethernet interface number
Type: number
Format: interface
neighbor_trunk-neighbor-ipv6-list¶
Specification Value Type list Block object keys peer-group-name
Description
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
trunk
Description Trunk interface number
Type: number
Format: interface
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
neighbor_ipv6-neighbor-list¶
Specification Value 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
Type: Listgraceful-restart
Description enable graceful-restart helper for this neighbor
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
maximum-prefix-thres
Description threshold-value, 1 to 100 percent
Type: number
Range: 1-100
neighbor-filter-lists
Type: Listneighbor-ipv6
Description Neighbor IPv6 address
Type: string
Format: ipv6-address
neighbor-prefix-lists
Type: Listneighbor-route-map-lists
Type: Listnext-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
Maximum Length: 128 characters
Maximum Length: 1 characters
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
restart-min
Description restart value, 1 to 1440 minutes
Type: number
Range: 1-1440
route-map
Description Route-map to specify criteria to originate default (route-map name)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
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: all, both, none, standard, extended, large
Default: both
unsuppress-map
Description Route-map to selectively unsuppress suppressed routes (Name of route map)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
weight
Description Set default weight for routes from this neighbor
Type: number
Range: 0-65535
Default: 0
neighbor_ipv6-neighbor-list_distribute-lists¶
Specification Value Type list Block object keys distribute-list
Description Filter updates to/from this neighbor (IP standard/extended/named access list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
distribute-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out
neighbor_ipv6-neighbor-list_neighbor-route-map-lists¶
Specification Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
neighbor_ipv6-neighbor-list_neighbor-filter-lists¶
Specification Value Type list Block object keys filter-list
Description Establish BGP filters (AS path access-list name)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
filter-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out
neighbor_ipv6-neighbor-list_neighbor-prefix-lists¶
Specification Value Type list Block object keys nbr-prefix-list
Description Filter updates to/from this neighbor (Name of a prefix list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
nbr-prefix-list-direction
Description ‘in’: in; ‘out’: out;
Type: string
Supported Values: in, out