BGP-Netconf
Resources Summary
Section titled “Resources Summary”| YANG Path | get/get-config | edit-config | rpc |
|---|---|---|---|
| /bgp/{vrf-name} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global | Y | merge | — |
| /bgp/{vrf-name}/global/ipv4-unicast/aggregate-route/{prefix} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv4-unicast/networks/{prefix} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv4-unicast/redistribution/{route-type} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv4-unicast/vpn-config | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv6-unicast/aggregate-route/{prefix} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv6-unicast/networks/{prefix} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv6-unicast/redistribution/{route-type} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/ipv6-unicast/vpn-config | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/global/segment-routing-srv6 | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/neighbors/{address-or-interface} | Y | merge, replace, create, delete | — |
| /bgp/{vrf-name}/peer-groups/{name} | Y | merge, replace, create, delete | — |
| /clear-bgp | — | — | Y |
| /show-bgp-community-list-json | — | — | Y |
| /show-bgp-neighbors-json | — | — | Y |
| /show-bgp-peer-group-json | — | — | Y |
| /show-bgp-segment-routing-srv6 | — | — | Y |
| /show-bgp-statistics-json | — | — | Y |
| /show-bgp-summary-json | — | — | Y |
| /show-bgp-vrf-all-json | — | — | Y |
| /show-evpn-vni-json | — | — | Y |
| /show-ip-bgp-json | — | — | Y |
Examples
Section titled “Examples”Get All Existing Bgp Configuration On Device
Section titled “Get All Existing Bgp Configuration On Device”Request example via rpc get-config
Section titled “Request example via rpc get-config”<filter type="subtree"> <top> <bgp> <bgp-instance> <vrf-name>Vrf1</vrf-name> <global> </global> </bgp-instance> </bgp> </filter>Reply example for rpc get-config
Section titled “Reply example for rpc get-config”<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <top> <bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <bgp-instance> <vrf-name>Vrf1</vrf-name> <global> <as-number>65100</as-number> <router-id>10.1.0.1</router-id> <ebgp-requires-policy>false</ebgp-requires-policy> <default-ipv4-unicast>true</default-ipv4-unicast> <default-ipv6-unicast>false</default-ipv6-unicast> <route-selection xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"> <multipath-relax>true</multipath-relax> </route-selection> <ipv4-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"> <networks xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <prefix>10.0.0.1/32</prefix> <backdoor>true</backdoor> <route-map>rmap1</route-map> </networks> <networks xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <prefix>20.0.0.1/32</prefix> </networks> </ipv4-unicast> </global> </bgp-instance> </bgp> </top></data>Get Bgp Ipv4 Unicast configuration on Device
Section titled “Get Bgp Ipv4 Unicast configuration on Device”Request example via rpc get-config
Section titled “Request example via rpc get-config” <filter type="subtree"> <top> <bgp> <bgp-instance> <vrf-name>Vrf1</vrf-name> <global> <ipv4-unicast> <networks> </networks> </ipv4-unicast> </global> </bgp-instance> </bgp> </filter>
Reply example for rpc get-config: <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"><top> <bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <bgp-instance> <vrf-name>Vrf1</vrf-name> <global> <ipv4-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"> <networks xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <prefix>10.0.0.1/32</prefix> <backdoor>true</backdoor> <route-map>rmap1</route-map> </networks> <networks xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <prefix>20.0.0.1/32</prefix> </networks> </ipv4-unicast> </global> </bgp-instance> </bgp></data>Get Bgp Neighbors configuration on Device
Section titled “Get Bgp Neighbors configuration on Device”Request example via rpc get-config
Section titled “Request example via rpc get-config”<filter type="subtree"> <top> <bgp> <bgp-instance> <vrf-name>Vrf1</vrf-name> <neighbors> </neighbors> </bgp-instance> </bgp> </filter>Reply example for rpc get-config
Section titled “Reply example for rpc get-config” <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"><top> <bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp"> <bgp-instance> <vrf-name>Vrf1</vrf-name> <neighbors> <neighbor> <address-or-interface>11.11.11.11</address-or-interface> <peer-group-name>PG1</peer-group-name> <remote-as>65101</remote-as> <local-address>11.11.11.12</local-address> <bfd xmlns="http://asterfusion.com/ns/yang/asternos-bgp-neighbor"> <enable>true</enable> </bfd> <ipv4-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"> <enable>true</enable> <default-enable>true</default-enable> <allow-own-as>true</allow-own-as> <allow-own-as-count>10</allow-own-as-count> <default-originate>false</default-originate> <default-originate-route-map>rmap1</default-originate-route-map> <next-hop-self>true</next-hop-self> <next-hop-self-force>true</next-hop-self-force> <route-reflector-client>true</route-reflector-client> <soft-reconfiguration>true</soft-reconfiguration> <route-map-import>rmap1</route-map-import> <route-map-export>rmap2</route-map-export> <as-override>true</as-override> </ipv4-unicast> <ipv6-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"> <enable>false</enable> <default-enable>false</default-enable> <soft-reconfiguration>true</soft-reconfiguration> </ipv6-unicast> </neighbor> <neighbor> <address-or-interface>11.11.11.13</address-or-interface> <peer-group-name>PG1</peer-group-name> <remote-as>65102</remote-as> <solo>true</solo> <local-address>11.11.11.14</local-address> <ebgp-multihop xmlns="http://asterfusion.com/ns/yang/asternos-bgp-neighbor"> <multihop-ttl>2</multihop-ttl> <disable-connected-check>true</disable-connected-check> </ebgp-multihop> <bfd xmlns="http://asterfusion.com/ns/yang/asternos-bgp-neighbor"> <enable>true</enable> </bfd> <ipv4-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"/> <ipv6-unicast xmlns="http://asterfusion.com/ns/yang/asternos-bgp-common"/> </neighbor> </neighbors> </bgp-instance> </bgp></data>Create Bgp Grobal
Section titled “Create Bgp Grobal” <config><top> <bgp> <bgp-instance> <vrf-name>Vrf4</vrf-name> <global> <as-number>65001</as-number> <router-id>10.1.15.10</router-id> <ebgp-requires-policy>false</ebgp-requires-policy> <log-neighbor-changes>true</log-neighbor-changes> <timers> <keepalive>60</keepalive> <holdtime>200</holdtime> </timers> <ipv6-unicast> <redistribution> <route-type>connected</route-type> </redistribution> </ipv6-unicast> </global> <neighbors> <neighbor> <address-or-interface>2000:20::2</address-or-interface> <remote-as>65001</remote-as> <description>sonic-vs2</description> <ipv6-unicast> <enable>true</enable> </ipv6-unicast> </neighbor> <neighbor> <address-or-interface>3000::1</address-or-interface> <remote-as>65003</remote-as> <description>sonic-vs3</description> <ipv6-unicast> <enable>true</enable> </ipv6-unicast> </neighbor> <neighbor> <address-or-interface>Ethernet1</address-or-interface> <remote-as>65005</remote-as> <description>sonic-vs5</description> <ipv6-unicast> <enable>true</enable> </ipv6-unicast> </neighbor> </neighbors> </bgp-instance> </bgp></top></config>Create Bgp Ipv4 Unicast
Section titled “Create Bgp Ipv4 Unicast” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <ipv4-unicast> <networks> <prefix>30.0.0.1/32</prefix> <backdoor>false</backdoor> </networks> <ebgp-distance>10</ebgp-distance> <ibgp-distance>20</ibgp-distance> <local-distance>30</local-distance> </ipv4-unicast> </global> </bgp-instance> </bgp></top></config>Delete Bgp Grobal
Section titled “Delete Bgp Grobal” <config><top> <bgp> <bgp-instance operation="delete"> <vrf-name>Vrf3</vrf-name> </bgp-instance> </bgp></top></config>Show Bgp Summary Json
Section titled “Show Bgp Summary Json”Request example to get bgp summary via rpc
Section titled “Request example to get bgp summary via rpc”<show-bgp-summary-json/>Reply example
Section titled “Reply example” <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:336c7191-680d-46c1-adfa-30155a49a672"> <data> <ipv4Unicast> <routerId>100.1.1.1</routerId> <as>65001</as> <vrfId>0</vrfId> <vrfName>default</vrfName> <tableVersion>6</tableVersion> <ribCount>3</ribCount> <ribMemory>384</ribMemory> <peerCount>1</peerCount> <peerMemory>20592</peerMemory> <peers> <ip_10_20_0_2> <remoteAs>65001</remoteAs> <localAs>65001</localAs> <version>4</version> <msgRcvd>0</msgRcvd> <msgSent>0</msgSent> <tableVersion>0</tableVersion> <outq>0</outq> <inq>0</inq> <peerUptime>never</peerUptime> <peerUptimeMsec>0</peerUptimeMsec> <pfxRcd>0</pfxRcd> <pfxSnt>0</pfxSnt> <state>Active</state> <peerState>OK</peerState> <connectionsEstablished>0</connectionsEstablished> <connectionsDropped>0</connectionsDropped> <idType>ipv4</idType> </ip_10_20_0_2> </peers> <failedPeers>1</failedPeers> <displayedPeers>1</displayedPeers> <totalPeers>1</totalPeers> <dynamicPeers>0</dynamicPeers> <bestPath> <multiPathRelax>false</multiPathRelax> </bestPath> </ipv4Unicast> </data></rpc-reply>Show Bgp Vrf All Json
Section titled “Show Bgp Vrf All Json”Request example to get bgp vrf all configeration via rpc
Section titled “Request example to get bgp vrf all configeration via rpc”<show-bgp-vrf-all-json/>Reply example
Section titled “Reply example” <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:8e4ae283-17d3-462c-ab9e-fc11e69219d6"> <data> <default> <vrfId>0</vrfId> <vrfName>default</vrfName> <tableVersion>0</tableVersion> <routerId>100.1.1.1</routerId> <defaultLocPrf>100</defaultLocPrf> <localAS>65001</localAS> <routes/> </default> </data></rpc-reply>Show Bgp Neighbors Json
Section titled “Show Bgp Neighbors Json”Request example to get bgp neighbors via rpc
Section titled “Request example to get bgp neighbors via rpc”<show-bgp-neighbors-json/>Reply example
Section titled “Reply example” <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:6e5425ac-60b7-41fa-8c9f-bbc3b6967900"> <data> <ip_10_20_0_2> <remoteAs>65001</remoteAs> <localAs>65001</localAs> <nbrInternalLink>True</nbrInternalLink> <localRole>undefined</localRole> <remoteRole>undefined</remoteRole> <hostname>Unknown</hostname> <bgpVersion>4</bgpVersion> <remoteRouterId>0.0.0.0</remoteRouterId> <localRouterId>100.1.1.1</localRouterId> <bgpState>Active</bgpState> <bgpTimerLastRead>168000</bgpTimerLastRead> <bgpTimerLastWrite>456000</bgpTimerLastWrite> <bgpInUpdateElapsedTimeMsecs>456000</bgpInUpdateElapsedTimeMsecs> <bgpTimerConfiguredHoldTimeMsecs>180000</bgpTimerConfiguredHoldTimeMsecs> <bgpTimerConfiguredKeepAliveIntervalMsecs>60000</bgpTimerConfiguredKeepAliveIntervalMsecs> <bgpTimerHoldTimeMsecs>180000</bgpTimerHoldTimeMsecs> <bgpTimerKeepAliveIntervalMsecs>60000</bgpTimerKeepAliveIntervalMsecs> <bgpTcpMssConfigured>0</bgpTcpMssConfigured> <bgpTcpMssSynced>0</bgpTcpMssSynced> <extendedOptionalParametersLength>False</extendedOptionalParametersLength> <bgpTimerConfiguredConditionalAdvertisementsSec>60</bgpTimerConfiguredConditionalAdvertisementsSec> <gracefulRestartInfo> <endOfRibSend/> <endOfRibRecv/> <localGrMode>Helper*</localGrMode> <remoteGrMode>NotApplicable</remoteGrMode> <rBit>False</rBit> <nBit>False</nBit> <timers> <configuredRestartTimer>120</configuredRestartTimer> <configuredLlgrStaleTime>0</configuredLlgrStaleTime> <receivedRestartTimer>0</receivedRestartTimer> </timers> </gracefulRestartInfo> <messageStats> <depthInq>0</depthInq> <depthOutq>0</depthOutq> <opensSent>0</opensSent> <opensRecv>0</opensRecv> <notificationsSent>0</notificationsSent> <notificationsRecv>0</notificationsRecv> <updatesSent>0</updatesSent> <updatesRecv>0</updatesRecv> <keepalivesSent>0</keepalivesSent> <keepalivesRecv>0</keepalivesRecv> <routeRefreshSent>0</routeRefreshSent> <routeRefreshRecv>0</routeRefreshRecv> <capabilitySent>0</capabilitySent> <capabilityRecv>0</capabilityRecv> <totalSent>0</totalSent> <totalRecv>0</totalRecv> </messageStats> <minBtwnAdvertisementRunsTimerMsecs>0</minBtwnAdvertisementRunsTimerMsecs> <addressFamilyInfo> <ipv4Unicast> <commAttriSentToNbr>extendedAndStandard</commAttriSentToNbr> <acceptedPrefixCounter>0</acceptedPrefixCounter> </ipv4Unicast> </addressFamilyInfo> <connectionsEstablished>0</connectionsEstablished> <connectionsDropped>0</connectionsDropped> <lastResetTimerMsecs>168000</lastResetTimerMsecs> <lastResetDueTo>No path to specified Neighbor</lastResetDueTo> <lastResetCode>27</lastResetCode> <softwareVersion>n/a</softwareVersion> <internalBgpNbrMaxHopsAway>255</internalBgpNbrMaxHopsAway> <hostLocal>Unknown</hostLocal> <portLocal>-1</portLocal> <hostForeign>Unknown</hostForeign> <portForeign>-1</portForeign> <nexthop>Unknown</nexthop> <nexthopGlobal>Unknown</nexthopGlobal> <nexthopLocal>Unknown</nexthopLocal> <bgpConnection>Unknown</bgpConnection> <connectRetryTimer>120</connectRetryTimer> <nextConnectTimerDueInMsecs>72000</nextConnectTimerDueInMsecs> <readThread>off</readThread> <writeThread>off</writeThread> <peerBfdInfo> <type>multi hop</type> <detectMultiplier>5</detectMultiplier> <rxMinInterval>400</rxMinInterval> <txMinInterval>400</txMinInterval> <status>Unknown</status> <lastUpdate>never</lastUpdate> </peerBfdInfo> </ip_10_20_0_2> </data></rpc-reply>Show IP Bgp Json
Section titled “Show IP Bgp Json”Request example to get ip bgp via rpc
Section titled “Request example to get ip bgp via rpc”<show-ip-bgp-json/>Reply example
Section titled “Reply example” <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:a6030de5-11fd-422c-a2a7-ad550a50d235"> <data> <vrfId>0</vrfId> <vrfName>default</vrfName> <tableVersion>6</tableVersion> <routerId>100.1.1.1</routerId> <defaultLocPrf>100</defaultLocPrf> <localAS>65001</localAS> <routes> <ip_100_1_1_1_32> <valid>True</valid> <bestpath>True</bestpath> <selectionReason>First path received</selectionReason> <pathFrom>external</pathFrom> <prefix>100.1.1.1</prefix> <prefixLen>32</prefixLen> <network>100.1.1.1/32</network> <version>5</version> <metric>0</metric> <weight>32768</weight> <peerId>(unspec)</peerId> <path/> <origin>incomplete</origin> <nexthops> <ip>0.0.0.0</ip> <hostname>sonic</hostname> <afi>ipv4</afi> <used>True</used> </nexthops> </ip_100_1_1_1_32> <ip_192_168_0_0_20> <valid>True</valid> <bestpath>True</bestpath> <selectionReason>First path received</selectionReason> <pathFrom>external</pathFrom> <prefix>192.168.0.0</prefix> <prefixLen>20</prefixLen> <network>192.168.0.0/20</network> <version>6</version> <metric>0</metric> <weight>32768</weight> <peerId>(unspec)</peerId> <path/> <origin>incomplete</origin> <nexthops> <ip>0.0.0.0</ip> <hostname>sonic</hostname> <afi>ipv4</afi> <used>True</used> </nexthops> </ip_192_168_0_0_20> </routes> </data></rpc-reply>Clear BGP
Section titled “Clear BGP”Request example to clear BGP sessions via rpc
Section titled “Request example to clear BGP sessions via rpc”<clear-bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp-clear"> <vrf>default</vrf> <all/></clear-bgp>Clear BGP with address-family and soft-in action.
<clear-bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp-clear"> <vrf>default</vrf> <afi>ipv6</afi> <safi>unicast</safi> <all/> <clear-action>soft-in</clear-action></clear-bgp>Clear BGP for a specific IPv4 peer.
<clear-bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp-clear"> <vrf>default</vrf> <peer-ipv4>10.0.0.1</peer-ipv4></clear-bgp>Clear BGP for an IPv6 prefix.
<clear-bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp-clear"> <vrf>default</vrf> <afi>ipv6</afi> <safi>unicast</safi> <prefix>2001:db8::/32</prefix></clear-bgp>Clear BGP for an external peer with message-stats reset.
<clear-bgp xmlns="http://asterfusion.com/ns/yang/asternos-bgp-clear"> <vrf>default</vrf> <external/> <clear-action>message-stats</clear-action></clear-bgp>Asdot-Quad AS Number Support
Section titled “Asdot-Quad AS Number Support”The following examples demonstrate BGP configuration using asdot-quad (dotted decimal) AS number format.
Create Bgp with Asdot-Quad AS Number
Section titled “Create Bgp with Asdot-Quad AS Number” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>1.0</as-number> <as-notation>dot</as-notation> <router-id>10.0.0.1</router-id> </global> </bgp-instance> </bgp></top></config>Create Bgp with Asdot-Quad Small AS Number
Section titled “Create Bgp with Asdot-Quad Small AS Number” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>0.65100</as-number> </global> </bgp-instance> </bgp></top></config>Create Bgp Neighbor with Asdot-Quad remote-as
Section titled “Create Bgp Neighbor with Asdot-Quad remote-as” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>65100</as-number> </global> <neighbors> <neighbor> <address-or-interface>10.0.0.1</address-or-interface> <remote-as>1.0</remote-as> </neighbor> </neighbors> </bgp-instance> </bgp></top></config>Create Bgp Neighbor with Asdot-Quad local-as
Section titled “Create Bgp Neighbor with Asdot-Quad local-as” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>65100</as-number> </global> <neighbors> <neighbor> <address-or-interface>10.0.0.1</address-or-interface> <remote-as>65101</remote-as> <local-as>0.65100</local-as> <local-as-no-prepend>true</local-as-no-prepend> <local-as-replace-as>true</local-as-replace-as> </neighbor> </neighbors> </bgp-instance> </bgp></top></config>Create Bgp Confederation with Asdot-Quad
Section titled “Create Bgp Confederation with Asdot-Quad” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>65100</as-number> <confederation> <identifier>2.0</identifier> <member-as>1.0</member-as> <member-as>0.65001</member-as> </confederation> </global> </bgp-instance> </bgp></top></config>Create Bgp Peer Group with Asdot-Quad remote-as
Section titled “Create Bgp Peer Group with Asdot-Quad remote-as” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>65100</as-number> </global> <peer-groups> <peer-group> <name>PG1</name> <remote-as>1.0</remote-as> </peer-group> </peer-groups> </bgp-instance> </bgp></top></config>Full Bgp Configuration with Asdot-Quad
Section titled “Full Bgp Configuration with Asdot-Quad” <config><top> <bgp> <bgp-instance> <vrf-name>default</vrf-name> <global> <as-number>1.0</as-number> <as-notation>dot</as-notation> <router-id>10.0.0.1</router-id> <confederation> <identifier>2.0</identifier> <member-as>1.0</member-as> <member-as>0.65001</member-as> </confederation> </global> <peer-groups> <peer-group> <name>PG1</name> <remote-as>0.65100</remote-as> </peer-group> </peer-groups> <neighbors> <neighbor> <address-or-interface>10.0.0.2</address-or-interface> <remote-as>0.65101</remote-as> <peer-group-name>PG1</peer-group-name> <local-as>0.65100</local-as> <local-as-no-prepend>true</local-as-no-prepend> <local-as-replace-as>true</local-as-replace-as> </neighbor> </neighbors> </bgp-instance> </bgp></top></config>Properties Descriptions
Section titled “Properties Descriptions”Tree Diagram
module: asternos-bgp +--rw bgp +--rw bgp-instance* [vrf-name] +--rw vrf-name vrf:vrf-ref +--rw global | +--rw as-number union | +--rw as-notation? enumeration | +--rw router-id? yang:dotted-quad | +--rw cluster-id? union | +--rw fast-external-failover? boolean | +--rw log-neighbor-changes? boolean | +--rw timers | | +--rw keepalive? uint16 | | +--rw holdtime? uint16 | +--rw confederation | | +--rw identifier? union | | +--rw member-as* union | +--rw med-config | | +--rw max-med-onstart-up-time? uint32 | | +--rw max-med-onstart-up-value? uint32 | +--rw route-selection | | +--rw confed? boolean | | +--rw ignore? boolean | | +--rw multipath-relax? boolean | | +--rw multi-path-as-set? boolean | | +--rw compare-routerid? boolean | +--rw graceful-shutdown? boolean | +--rw default-shutdown? boolean | +--rw default-local-preference? uint32 | +--rw ebgp-requires-policy? boolean | +--rw dynamic-neighbors-limit? uint32 | +--rw reject-as-sets? boolean | +--rw admin-shutdown? boolean | +--rw admin-shutdown-message? string | +--rw route-map-delay-time? uint16 | +--rw graceful-restart? boolean | +--rw graceful-restart-restart-time? uint32 | +--rw graceful-restart-rib-stale-time? uint32 | +--rw network-import-check? boolean | +--rw default-ipv4-unicast? boolean | +--rw default-ipv6-unicast? boolean | +--rw default-ipv4-vpn? boolean | +--rw default-ipv6-vpn? boolean | +--rw default-l2vpn-evpn? boolean | +--rw ipv4-unicast | | +--rw networks* [prefix] | | | +--rw prefix inet:ipv4-prefix | | | +--rw backdoor? boolean | | | +--rw route-map? string | | +--rw aggregate-route* [prefix] | | | +--rw prefix inet:ipv4-prefix | | | +--rw as-set? boolean | | | +--rw summary-only? boolean | | | +--rw route-map-export? string | | | +--rw origin? enumeration | | | +--rw match-med? boolean | | | +--rw suppress-map? string | | +--rw ebgp-maximum-paths? uint16 | | +--rw ibgp-maximum-paths? uint16 | | +--rw ibgp-cluster-length-list? boolean | | +--rw redistribution* [route-type] | | | +--rw route-type route-types | | | +--rw metric? uint32 | | | +--rw route-map-import? string | | +--rw route-map-export? string | | +--rw import-vrf* vrf:vrf-ref | | +--rw import-vrf-route-map? string | | +--rw label-vpn-export? union | | +--rw ebgp-distance? uint8 | | +--rw ibgp-distance? uint8 | | +--rw local-distance? uint8 | | +--rw vpn-config | | +--rw rd? route-distinguisher | | +--rw nexthop? inet:ip-address | | +--rw import-vpn? boolean | | +--rw export-vpn? boolean | | +--rw (rt-direction)? | | | +--:(import-export) | | | | +--rw import-rt-list* route-target | | | | +--rw export-rt-list* route-target | | | +--:(both) | | | +--rw rt-list* route-target | | +--rw (sid-allocation-mode)? | | +--:(manual) | | | +--rw sid? uint32 | | +--:(auto) | | +--rw sid-auto? boolean | +--rw ipv6-unicast | | +--rw networks* [prefix] | | | +--rw prefix inet:ipv6-prefix | | | +--rw backdoor? boolean | | | +--rw route-map? string | | +--rw aggregate-route* [prefix] | | | +--rw prefix inet:ipv6-prefix | | | +--rw as-set? boolean | | | +--rw summary-only? boolean | | | +--rw route-map-export? string | | | +--rw origin? enumeration | | | +--rw match-med? boolean | | | +--rw suppress-map? string | | +--rw ebgp-maximum-paths? uint16 | | +--rw ibgp-maximum-paths? uint16 | | +--rw ibgp-cluster-length-list? boolean | | +--rw redistribution* [route-type] | | | +--rw route-type route-types | | | +--rw metric? uint32 | | | +--rw route-map-import? string | | +--rw route-map-export? string | | +--rw import-vrf* vrf:vrf-ref | | +--rw import-vrf-route-map? string | | +--rw label-vpn-export? union | | +--rw ebgp-distance? uint8 | | +--rw ibgp-distance? uint8 | | +--rw local-distance? uint8 | | +--rw vpn-config | | +--rw rd? route-distinguisher | | +--rw nexthop? inet:ip-address | | +--rw import-vpn? boolean | | +--rw export-vpn? boolean | | +--rw (rt-direction)? | | | +--:(import-export) | | | | +--rw import-rt-list* route-target | | | | +--rw export-rt-list* route-target | | | +--:(both) | | | +--rw rt-list* route-target | | +--rw (sid-allocation-mode)? | | +--:(manual) | | | +--rw sid? uint32 | | +--:(auto) | | +--rw sid-auto? boolean | +--rw l2vpn-evpn | | +--rw advertise-all-vni? boolean | | +--rw advertise-default-gateway? boolean | | +--rw advertise-svi-ip? boolean | | +--rw advertise-pip? boolean | | +--rw advertise-pip-ip? inet:ipv4-address | | +--rw advertise-pip-mac? yang:mac-address | | +--rw default-originate-ipv4? boolean | | +--rw default-originate-ipv6? boolean | | +--rw advertise-ipv4-unicast? boolean | | +--rw advertise-ipv6-unicast? boolean | | +--rw route-distinguisher? string | | +--rw rt-import-list* string | | +--rw rt-export-list* string | +--rw ipv4-vpn | +--rw ipv6-vpn | +--rw segment-routing-srv6 | | +--rw locator? string | +--rw (sid-allocation-mode)? | +--:(manual) | | +--rw sid? uint32 | +--:(auto) | +--rw sid-auto? boolean +--rw neighbors | +--rw neighbor* [address-or-interface] | +--rw address-or-interface union | +--rw peer-group-name? -> ../../../peer-groups/peer-group/name | +--rw remote-as-type? enumeration | +--rw remote-as? union | +--rw description? string | +--rw advertisement-interval? uint16 | +--rw capability-extended-nexthop? boolean | +--rw capability-dynamic? boolean | +--rw port? uint16 | +--rw ttl-security-hops? uint8 | +--rw password? cmn:credential-string | +--rw solo? boolean | +--rw as-path-loop-detect? boolean | +--rw tcp-mss? uint16 | +--rw local-address? union | +--rw ebgp-multihop | | +--rw enabled? boolean | | +--rw multihop-ttl? uint8 | | +--rw disable-connected-check? boolean | +--rw bfd | | +--rw enable? boolean | | +--rw check-ctrlplane-failure? boolean | | +--rw profile? string | | +--rw data-plane? boolean | +--rw admin-status? boolean | +--rw admin-shutdown-message? string | +--rw graceful-restart? boolean | +--rw graceful-restart-helper? boolean | +--rw ipv4-unicast | | +--rw enable? boolean | | +--rw default-enable? boolean | | +--rw allow-own-as? boolean | | +--rw allow-own-as-count? uint8 | | +--rw allow-own-origin-as? boolean | | +--rw default-originate? boolean | | +--rw default-originate-route-map? string | | +--rw next-hop-self? boolean | | +--rw next-hop-self-force? boolean | | +--rw route-reflector-client? boolean | | +--rw soft-reconfiguration? boolean | | +--rw attribute-unchanged | | | +--rw next-hop? boolean | | | +--rw as-path? boolean | | | +--rw med? boolean | | +--rw prefix-list-in? string | | +--rw prefix-list-out? string | | +--rw send-community? enumeration | | +--rw weight? uint16 | | +--rw route-map-import? string | | +--rw route-map-export? string | | +--rw as-override? boolean | | +--rw maximum-prefix? uint32 | | +--rw maximum-prefix-out? uint32 | +--rw ipv6-unicast | | +--rw enable? boolean | | +--rw default-enable? boolean | | +--rw allow-own-as? boolean | | +--rw allow-own-as-count? uint8 | | +--rw allow-own-origin-as? boolean | | +--rw default-originate? boolean | | +--rw default-originate-route-map? string | | +--rw next-hop-self? boolean | | +--rw next-hop-self-force? boolean | | +--rw route-reflector-client? boolean | | +--rw soft-reconfiguration? boolean | | +--rw attribute-unchanged | | | +--rw next-hop? boolean | | | +--rw as-path? boolean | | | +--rw med? boolean | | +--rw prefix-list-in? string | | +--rw prefix-list-out? string | | +--rw send-community? enumeration | | +--rw weight? uint16 | | +--rw route-map-import? string | | +--rw route-map-export? string | | +--rw as-override? boolean | | +--rw maximum-prefix? uint32 | | +--rw maximum-prefix-out? uint32 | +--rw l2vpn-evpn | | +--rw enable? boolean | | +--rw default-enable? boolean | | +--rw allow-own-as? boolean | | +--rw allow-own-as-count? uint8 | | +--rw allow-own-origin-as? boolean | | +--rw next-hop-self? boolean | | +--rw next-hop-self-force? boolean | | +--rw route-reflector-client? boolean | | +--rw soft-reconfiguration? boolean | | +--rw route-map-import? string | | +--rw route-map-export? string | +--rw ipv4-vpn | | +--rw enable? boolean | | +--rw default-enable? boolean | | +--rw next-hop-self? boolean | | +--rw next-hop-self-force? boolean | +--rw ipv6-vpn | | +--rw enable? boolean | | +--rw default-enable? boolean | | +--rw next-hop-self? boolean | | +--rw next-hop-self-force? boolean | +--rw local-as? union | +--rw local-as-no-prepend? boolean | +--rw local-as-replace-as? boolean +--rw peer-groups +--rw peer-group* [name] +--rw name string +--rw ipv4-listen-range* inet:ipv4-prefix +--rw ipv6-listen-range* inet:ipv6-prefix +--rw remote-as-type? enumeration +--rw remote-as? union +--rw description? string +--rw advertisement-interval? uint16 +--rw capability-extended-nexthop? boolean +--rw capability-dynamic? boolean +--rw port? uint16 +--rw ttl-security-hops? uint8 +--rw password? cmn:credential-string +--rw solo? boolean +--rw as-path-loop-detect? boolean +--rw tcp-mss? uint16 +--rw local-address? union +--rw ebgp-multihop | +--rw enabled? boolean | +--rw multihop-ttl? uint8 | +--rw disable-connected-check? boolean +--rw bfd | +--rw enable? boolean | +--rw check-ctrlplane-failure? boolean | +--rw profile? string | +--rw data-plane? boolean +--rw admin-status? boolean +--rw admin-shutdown-message? string +--rw graceful-restart? boolean +--rw graceful-restart-helper? boolean +--rw ipv4-unicast | +--rw enable? boolean | +--rw default-enable? boolean | +--rw allow-own-as? boolean | +--rw allow-own-as-count? uint8 | +--rw allow-own-origin-as? boolean | +--rw default-originate? boolean | +--rw default-originate-route-map? string | +--rw next-hop-self? boolean | +--rw next-hop-self-force? boolean | +--rw route-reflector-client? boolean | +--rw soft-reconfiguration? boolean | +--rw route-map-import? string | +--rw route-map-export? string | +--rw as-override? boolean | +--rw maximum-prefix? uint32 | +--rw maximum-prefix-out? uint32 +--rw ipv6-unicast | +--rw enable? boolean | +--rw default-enable? boolean | +--rw allow-own-as? boolean | +--rw allow-own-as-count? uint8 | +--rw allow-own-origin-as? boolean | +--rw default-originate? boolean | +--rw default-originate-route-map? string | +--rw next-hop-self? boolean | +--rw next-hop-self-force? boolean | +--rw route-reflector-client? boolean | +--rw soft-reconfiguration? boolean | +--rw route-map-import? string | +--rw route-map-export? string | +--rw as-override? boolean | +--rw maximum-prefix? uint32 | +--rw maximum-prefix-out? uint32 +--rw l2vpn-evpn | +--rw enable? boolean | +--rw default-enable? boolean | +--rw allow-own-as? boolean | +--rw allow-own-as-count? uint8 | +--rw allow-own-origin-as? boolean | +--rw next-hop-self? boolean | +--rw next-hop-self-force? boolean | +--rw route-reflector-client? boolean | +--rw soft-reconfiguration? boolean | +--rw route-map-import? string | +--rw route-map-export? string +--rw ipv4-vpn | +--rw enable? boolean | +--rw default-enable? boolean | +--rw next-hop-self? boolean | +--rw next-hop-self-force? boolean +--rw ipv6-vpn +--rw enable? boolean +--rw default-enable? boolean +--rw next-hop-self? boolean +--rw next-hop-self-force? booleanTable of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| bgp | O |
Global
Section titled “Global”Tree Diagram
module: asternos-bgp +--rw bgpAggregate Route
Section titled “Aggregate Route”Tree Diagram
module: asternos-bgp +--rw bgpNetworks
Section titled “Networks”Tree Diagram
module: asternos-bgp +--rw bgpRedistribution
Section titled “Redistribution”Tree Diagram
module: asternos-bgp +--rw bgpVpn Config
Section titled “Vpn Config”Tree Diagram
module: asternos-bgp +--rw bgpAggregate Route
Section titled “Aggregate Route”Tree Diagram
module: asternos-bgp +--rw bgpNetworks
Section titled “Networks”Tree Diagram
module: asternos-bgp +--rw bgpRedistribution
Section titled “Redistribution”Tree Diagram
module: asternos-bgp +--rw bgpVpn Config
Section titled “Vpn Config”Tree Diagram
module: asternos-bgp +--rw bgpL2vpn Evpn
Section titled “L2vpn Evpn”Tree Diagram
module: asternos-bgp +--rw bgpSegment Routing Srv6
Section titled “Segment Routing Srv6”Tree Diagram
module: asternos-bgp +--rw bgpNeighbor
Section titled “Neighbor”Tree Diagram
module: asternos-bgp +--rw bgpPeer Group
Section titled “Peer Group”Tree Diagram
module: asternos-bgp +--rw bgpClear Bgp
Section titled “Clear Bgp”Tree Diagram
module: asternos-bgp-clear
rpcs: +---x clear-bgp +---w input | +---w vrf? vrf:vrf-ref | +---w afi? bgp-afi-type | +---w safi? bgp-safi-type | +---w prefix? inet:ipv6-prefix | +---w (target)? | | +--:(all-peers) | | | +---w all? empty | | +--:(peer-ipv4) | | | +---w peer-ipv4? inet:ipv4-address | | +--:(peer-ipv6) | | | +---w peer-ipv6? inet:ipv6-address | | +--:(peer-as) | | | +---w peer-as? uint32 | | +--:(external) | | | +---w external? empty | | +--:(peer-group) | | +---w peer-group? string | +---w clear-action? bgp-clear-action-type +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| clear-bgp | O | ||
| vrf | O | vrf:vrf-ref | VRF name. Corresponds to the ‘vrf’ / ‘view’ keyword. When not specified via NETCONF/RESTCONF, the system default VRF is used. |
| afi | O | ”ipv4" "ipv6" "l2vpn” | Address family. Optional — when omitted, the operation applies across all address families on the target. |
| safi | O | ”unicast" "vpn" "evpn” | Sub-address family. Optional — when afi is specified but safi is omitted, the operation applies across all SAFIs within the specified AFI. |
| prefix | O | inet:ipv6-prefix | IPv6 prefix for which to clear the bestpath and trigger re-advertisement. Only supported with afi=ipv6 and safi=unicast or safi=vpn. When this is specified, the target and action parameters are ignored. |
| all | O | empty | Clear all BGP peers. Corresponds to CLI ’*‘. |
| peer-ipv4 | O | inet:ipv4-address | IPv4 address of the BGP peer to clear. Corresponds to CLI ‘A.B.C.D’. |
| peer-ipv6 | O | inet:ipv6-address | IPv6 address of the BGP peer to clear. Corresponds to CLI ‘X:X::X:X’. |
| peer-as | O | 1..4294967295 | Autonomous system number. Clear all peers with this AS number. Corresponds to CLI ‘ASNUM’ (plain or dotted format). |
| external | O | empty | Clear all external (eBGP) peers. |
| peer-group | O | string | Clear all members of the specified peer-group. |
| clear-action | O | ”soft" "soft-in" "soft-out" "in" "in-prefix-filter" "out" "message-stats" "capabilities” | Type of clear action to perform. If not specified, a hard reset is performed. |
| data | O | Output data from the clear operation, such as command execution result or status information. The exact content and structure of this data may vary based on the input parameters. |
Show Bgp Community List Json
Section titled “Show Bgp Community List Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-community-list-json +---w input | +---w (community-list)? | +--:(number) | | +---w number? uint32 | +--:(name) | +---w name? string +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-community-list-json | O | ||
| number | O | integer | Community list number. |
| name | O | string | Community list name. |
| data | O | A json data that shows BGP community list information. |
Show Bgp L2vpn Evpn Json
Section titled “Show Bgp L2vpn Evpn Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-l2vpn-evpn-json +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-l2vpn-evpn-json | O | ||
| data | O | A json data that shows BGP l2vpn evpn information. |
Show Bgp Neighbors Json
Section titled “Show Bgp Neighbors Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-neighbors-json +---w input | +---w address? inet:ip-address | +---w (info-options)? | +--:(prefix-counts) | | +---w prefix-counts? empty | +--:(advertised-routes) | | +---w advertised-routes? empty | | +---w advertised-route-map? string | +--:(received-routes) | | +---w received-routes? empty | | +---w received-route-map? string | +--:(filtered-routes) | | +---w filtered-routes? empty | | +---w filtered-route-map? string | +--:(bestpath-routes) | | +---w bestpath-routes? empty | +--:(received-prefix-filter) | | +---w received-prefix-filter? empty | +--:(flap-statistics) | | +---w flap-statistics? empty | +--:(dampened-routes) | | +---w dampened-routes? empty | +--:(routes) | +---w routes? empty +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-neighbors-json | O | ||
| address | O | inet:ip-address | Neighbor’s address. |
| prefix-counts | O | empty | Display detailed prefix count information. |
| advertised-routes | O | empty | Display advertised routes. |
| advertised-route-map | O | string | Route-map to modify the attributes. |
| received-routes | O | empty | Display received routes. |
| received-route-map | O | string | Route-map to modify the attributes. |
| filtered-routes | O | empty | Display filtered routes. |
| filtered-route-map | O | string | Route-map to modify the attributes. |
| bestpath-routes | O | empty | Display bestpath routes. |
| received-prefix-filter | O | empty | Prefix filter to display. |
| flap-statistics | O | empty | Display flap statistics. |
| dampened-routes | O | empty | Display dampened routes. |
| routes | O | empty | Display routes. |
| data | O | A json data that shows BGP neighbors information. |
Show Bgp Peer Group Json
Section titled “Show Bgp Peer Group Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-peer-group-json +---w input | +---w name? string +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-peer-group-json | O | ||
| name | O | string | Peer group name. |
| data | O | A json data that shows BGP peer group information. |
Show Bgp Segment Routing Srv6
Section titled “Show Bgp Segment Routing Srv6”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-segment-routing-srv6 +--ro output +--ro data +--ro locator | +--ro name? string | +--ro prefix? string | +--ro block-length? uint8 | +--ro node-length? uint8 | +--ro func-length? uint8 | +--ro arg-length? uint8 +--ro locator-chunks* string +--ro functions* [sid] | +--ro sid string | +--ro locator? string +--ro bgps* [name] +--ro name string +--ro ipv4-tovpn-sid? string +--ro ipv6-tovpn-sid? string +--ro per-vrf-tovpn-sid? stringTable of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-segment-routing-srv6 | O | ||
| data | M | Path-only node, has no configurable value. BGP SRv6 information. | |
| locator | M | Path-only node, has no configurable value. SRv6 locator configuration. | |
| name | O | string | Locator name. |
| prefix | O | string | SRv6 locator prefix. |
| block-length | O | integer | Block length for SRv6 SID allocation. |
| node-length | O | integer | Node length for SRv6 SID allocation. |
| func-length | O | integer | Function length for SRv6 SID allocation. |
| arg-length | O | integer | Argument length for SRv6 SID allocation. |
| locator-chunks | O | string | Locator chunks allocation. |
| functions | M | Path-only node, has no configurable value. List of SRv6 functions. | |
| sid | O | string | SRv6 Segment ID. |
| locator | O | string | Locator name associated with this SID. |
| bgps | M | Path-only node, has no configurable value. List of BGP instances. | |
| name | O | string | BGP instance name. |
| ipv4-tovpn-sid | O | string | IPv4 SID for VPN traffic. |
| ipv6-tovpn-sid | O | string | IPv6 SID for VPN traffic. |
| per-vrf-tovpn-sid | O | string | Per-VRF SID for VPN traffic. |
Show Bgp Statistics Json
Section titled “Show Bgp Statistics Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-statistics-json +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-statistics-json | O | ||
| data | O | A json data that shows BGP statistics information. |
Show Bgp Summary Json
Section titled “Show Bgp Summary Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-summary-json +---w input | +---w (established-failed)? | +--:(established) | | +---w established? empty | +--:(failed) | +---w failed? empty +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-summary-json | O | ||
| established | O | empty | Display established neighbors. |
| failed | O | empty | Display failed neighbors. |
| data | O | A json data that shows BGP summary information. |
Show Bgp Vrf All Json
Section titled “Show Bgp Vrf All Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-bgp-vrf-all-json +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-bgp-vrf-all-json | O | ||
| data | O | A json data that shows BGP VRF information. |
Show Evpn Vni Json
Section titled “Show Evpn Vni Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-evpn-vni-json +---w input | +---w vni? uint32 +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-evpn-vni-json | O | ||
| vni | O | integer | VNI number. |
| data | O | A json data that shows BGP evpn vni information. |
Show Ip Bgp Json
Section titled “Show Ip Bgp Json”Tree Diagram
module: asternos-bgp
rpcs: +---x show-ip-bgp-json +---w input | +---w address? inet:ip-address | +---w (path-options)? | +--:(bestpath) | | +---w bestpath? empty | +--:(multipath) | +---w multipath? empty +--ro output +--ro data? <anydata>Table of Properties
| Name | Required | Type/Range | Description |
|---|---|---|---|
| show-ip-bgp-json | O | ||
| address | O | inet:ip-address | Neighbor’s address. |
| bestpath | O | empty | Display bestpath information. |
| multipath | O | empty | Display multipath information. |
| data | O | A json data that shows IP BGP information. |