11 - Channel (multicast flow) configuration and deploying information management.
15 - Common YANG models collection.
19 - South-bound NETCONF interface for BIER, it has implemented standard interface (ietf-bier).
20 If your BFR's NETCONF interface is Non-standard, you should add your own interface for driver.
24 - Adapter for different BIER south-bound NETCONF interfaces.
28 - Major processor function for BIER.
32 - BIER topology management, and BIER information (BIER, BIER-TE, lable info) configuration.
36 - Path computation element for BIER-TE.
40 - BIER UI, show topology and configure BIER/BIER-TE and channel.
46 The sections below give details about the configuration settings for
47 the components that can be configured.
49 BIER Information Manager
50 ~~~~~~~~~~~~~~~~~~~~~~~~
55 - bier/bierman/api/src/main/yang/bier-topology-api.yang
59 - Load BIER topology, and list all topo-name in all BIER topologies.
61 - **configure-domain**
63 - Configure domain in given BIER topology.
65 - **configure-subdomain**
67 - Configure sub-domain in given BIER domain and topology.
71 - Delete given domain in given topology.
73 - **delete-subdomain**
75 - Delete given sub-domain in given domain and topology.
79 - Query given topology in BIER topology, and then display this
80 topology's detail, such as information of node and link.
84 - Query given nodes in given topology, and then display these nodes'
85 detail, such as information of node-name, router-id,
86 termination-point list, BIER domain and sub-domain list, etc.
90 - Query given link in given topology, and then display this link's detail.
94 - Query domain in given BIER topology, and then display the domain-id list.
98 - Query sub-domain in given domain and given topology, and then display
99 the sub-domain-id list.
101 - **query-subdomain-node**
103 - Query nodes which have been assigned to given sub-domain and domain in given
104 topology, and then display these nodes' details.
106 - **query-subdomain-link**
108 - Query links which have been assigned to given sub-domain and domain in given
109 topology, and then display these links' details.
111 - **query-te-subdomain-node**
113 - Query te-nodes which have been assigned to given sub-domain and domain in given
114 topology, and then display these te-nodes' details.
116 - **query-te-subdomain-link**
118 - Query te-links which have been assigned to given sub-domain and domain in given
119 topology, and then display these te-links' details.
122 - bier/bierman/api/src/main/yang/bier-config-api.yang
126 - Configure node information in given topology, which defined in ietf-bier,
127 such as domains, sub-domains, bitstringlength, bfr-id, encapsulation-type, etc.
131 - Delete given node which be assigned to given sub-domain and domain in
136 - Delete bier mapping entry of ipv4.
140 - Delete bier mapping entry of ipv6.
143 - bier/bierman/api/src/main/yang/bier-te-config-api.yang
145 - **configure-te-node**
147 - Configure adjancency information for node, such as domains, sub-domains, si,
148 bitstringlength, tpid, bitposition, etc.
150 - **configure-te-label**
152 - Configure BIER-TE label range for node.
154 - **delete-te-babel**
156 - Delete BIER-TE label range of node.
160 - Delete BIER-TE bitstringlength, including all SIs which belongs to this bitstringlenght.
164 - Delete BIER-TE SI, including all bitpositions which belongs to this SI.
168 - Delete BIER-TE bitposition of an adjancency.
170 Parameters Description
171 ^^^^^^^^^^^^^^^^^^^^^^
175 - BIER topology identifier.
179 - Node identifier in network topology.
183 - Node’s latitude, default value is 0.
187 - Node’s longitude, default value is 0.
191 - Termination point identifier.
195 - BIER domain identifier.
197 - **encapsulation-type**
199 - Base identity for BIER encapsulation. Default value is "bier-encapsulation-mpls".
201 - **bitstringlength**
203 - The bitstringlength type for imposition mode. It's value can be chosen from 64,
204 128, 256, 512, 1024, 2048, and 4096.
206 - The BitStringLength ("Imposition BitStringLength") and sub-domain ("Imposition
207 sub-domain") to use when it imposes (as a BFIR) a BIER encapsulation on a
208 particular set of packets.
212 - BIER bfr identifier. BFR-id is a number in the range [1, 65535].
214 - Bfr-id is unique within the sub-domain. A BFR-id is a small unstructured positive
215 integer. For instance, if a particular BIER sub-domain contains 1, 374 BFRs, each
216 one could be given a BFR-id in the range 1-1374.
218 - If a given BFR belongs to more than one sub-domain, it may (though it need not)
219 have a different BFR-id for each sub-domain.
221 - **ipv4-bfr-prefix**
223 - BIER BFR IPv4 prefix.
225 - A BFR's BFR-Prefix MUST be an IP address (either IPv4 or IPv6) of the BFR, and MUST be
226 unique and routable within the BIER domain. It is RECOMMENDED that the BFR-prefix be a
227 loopback address of the BFR. Two BFRs in the same BIER domain MUST NOT be assigned the
228 same BFR-Prefix. Note that a BFR in a given BIER domain has the same BFR-prefix in all
229 the sub-domains of that BIER domain.
231 - **ipv6-bfr-prefix**
233 - BIER BFR IPv6 prefix.
237 - Sub-domain identifier. Each sub-domain is identified by a sub-domain-id in the range [0, 255].
239 - A BIER domain may contain one or more sub-domains. Each BIER domain MUST contain at least one
240 sub-domain, the "default sub-domain" (also denoted "sub-domain zero"). If a BIER domain
241 contains more than one sub-domain, each BFR in the domain MUST be provisioned to know the set
242 of sub-domains to which it belongs.
246 - The IGP type. Enum type contains OSPF and ISIS.
250 - Multi-topology associated with BIER sub-domain.
252 - **bitstringlength**
254 - Disposition bitstringlength.
256 - The BitStringLengths ("Disposition BitStringLengths") that it will process when
257 (as a BFR or BFER) it receives packets from a particular sub-domain.
259 - **bier-mpls-label-base**
261 - BIER mpls-label, range in [0, 1048575].
263 - **bier-mpls-label-range-size**
265 - BIER mpls-label range size.
269 - The identifier of a link in the topology.
271 - A link is specific to a topology to which it belongs.
276 - Source node identifier, must be in same topology.
280 - Termination point within source node that terminates the link.
284 - Destination node identifier and must be in same topology.
288 - Termination point within destination node that terminates the link.
292 - The link delay, default value is 0.
296 - The number of packet loss on the link and default value is 0.
304 - bier/channel/api/src/main/yang/bier-channel-api.yang
308 - Display all channel's names in given BIER topology.
312 - Query specific channel in given topology and display this channel's information (multicast
313 flow information and related BFIR,BFER information).
317 - Create channel with multicast information in given BIER topology.
321 - Modify the channel's information which created above.
325 - Remove given channel in given topology.
329 - Deploy channel, and configure BFIR and BFERs about this multicast flow in given topology.
331 Parameters Description
332 ^^^^^^^^^^^^^^^^^^^^^^
336 - BIER topology identifier.
340 - BIER channel (multicast flow information) name.
344 - The IPv4 of multicast source. The value set to zero means that the receiver interests in
345 all source that relevant to one group.
349 - The IPv4 of multicast group.
353 - BIER domain identifier.
357 - BIER sub-domain identifier.
359 - **source-wildcard**
361 - The wildcard information of source, in the range [1, 32].
365 - The wildcard information of multi-cast group, in the range [1, 32].
369 - BFIR (Bit-Forwarding Ingress Router).
373 - The bfr-id of BRIR.
377 - BFER (Bit-Forwarding Egress Router).
381 - The bfr-id of BRER.
383 - **bier-forwarding-type**
385 - The forwarding type, enum type contains BIER and BIER-TE.
387 .. note:: For more information about BIER terminology, see `YANG Data Model for BIER Protocol <https://datatracker.ietf.org/doc/draft-ietf-bier-bier-yang/?include_text=1>`_.
390 Sample Configurations
391 ---------------------
393 1. Configure Domain And Sub-domain
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
396 1.1. Configure Domain
397 ^^^^^^^^^^^^^^^^^^^^^
399 **REST API** : *POST /restconf/operations/bier-topology-api:configure-domain*
407 "topo-id": " bier-topo" ,
419 1.2. Configure Sub-domain
420 ^^^^^^^^^^^^^^^^^^^^^^^^^
422 **REST API** : *POST /restconf/operations/bier-topology-api:configure-subdomain*
430 "topo-id": " bier-topo" ,
434 "sub-domain-id":" 0",
446 2.1. Configure BIER Parameters
447 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
449 **REST API** : *POST /restconf/operations/bier-config-api:configure-node*
457 "topology-id": "bier-topo",
465 "sub-domain-id": "0",
469 "bitstringlength": "64-bit",
473 "bitstringlength": "64",
474 "bier-mpls-label-base": "56",
475 "bier-mpls-label-range-size": "100"
481 "encapsulation-type": "bier-encapsulation-mpls",
482 "bitstringlength": "64-bit",
484 "ipv4-bfr-prefix": "192.168.1.1/24",
485 "ipv6-bfr-prefix": "1030:0:0:0:C9B4:FF12:48AA:1A2B/60"
492 2.2. Configure BIER-TE label
493 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
495 **REST API** : *POST /restconf/operations/bier-te-config-api:configure-te-label*
503 "topology-id": "bier-topo",
506 "label-range-size": "20"
510 2.3. Configure BIER-TE Parameters
511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
513 **REST API** : *POST /restconf/operations/bier-te-config-api:configure-te-node*
521 "topology-id": "bier-topo",
528 "sub-domain-id": "0",
531 "bitstringlength": "64-bit",
552 3. Query BIER Topology Information
553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
558 **REST API** : *POST /restconf/operations/bier-topology-api:load-topology*
565 **REST API** : *POST /restconf/operations/bier-topology-api:query-topology*
573 "topo-id": "bier-topo"
580 **REST API** : *POST /restconf/operations/bier-topology-api:query-node*
588 "topo-id": "bier-topo",
596 **REST API** : *POST /restconf/operations/bier-topology-api:query-link*
604 "topo-id": "bier-topo",
612 **REST API** : *POST /restconf/operations/bier-topology-api:query-domain*
620 "topo-id": "bier-topo"
624 3.6. Query Sub-domain
625 ^^^^^^^^^^^^^^^^^^^^^
627 **REST API** : *POST /restconf/operations/bier-topology-api:query-subdomain*
635 "topo-id": "bier-topo",
640 3.7. Query Sub-domain Node
641 ^^^^^^^^^^^^^^^^^^^^^^^^^^
643 **REST API** : *POST /restconf/operations/bier-topology-api:query-subdomain-node*
651 "topology-id": "bier-topo",
657 3.8. Query Sub-domain Link
658 ^^^^^^^^^^^^^^^^^^^^^^^^^^
660 **REST API** : *POST /restconf/operations/bier-topology-api:query-subdomain-link*
668 "topology-id": "bier-topo",
674 3.9. Query BIER-TE Sub-domain Node
675 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677 **REST API** : *POST /restconf/operations/bier-topology-api:query-te-subdomain-node*
685 "topology-id": "bier-topo",
691 3.10. Query BIER-TE Sub-domain Link
692 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
694 **REST API** : *POST /restconf/operations/bier-topology-api:query-te-subdomain-link*
702 "topology-id": "bier-topo",
708 4. BIER Channel Configuration
709 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
711 4.1. Configure Channel
712 ^^^^^^^^^^^^^^^^^^^^^^
714 **REST API** : *POST /restconf/operations/bier-channel-api:add-channel*
722 "topology-id": "bier-topo",
725 "dst-group": "224.1.1.1",
727 "sub-domain-id": "11",
728 "source-wildcard": "24",
729 "group-wildcard": "30"
736 **REST API** : *POST /restconf/operations/bier-channel-api:modify-channel*
744 "topology-id": "bier-topo",
747 "dst-group": "225.1.1.1",
749 "sub-domain-id": "11",
750 "source-wildcard": "24",
751 "group-wildcard": "30"
758 **REST API** : *POST /restconf/operations/bier-channel-api:deploy-channel*
766 "topology-id": "bier-topo",
767 "channel-name": "channel-1",
768 "bier-forwarding-type":"bier-te"
769 "ingress-node": "node1",
781 6. Query Channel Information
782 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
787 **REST API** : *POST /restconf/operations/bier-channel-api:get-channel*
795 "topology-id": "bier-topo"
802 **REST API** : *POST /restconf/operations/bier-channel-api:query-channel*
810 "topology-id": "bier-topo",
821 **REST API** : *POST /restconf/operations/bier-channel-api:remove-channel*
829 "topology-id": "bier-topo",
830 "channel-name": "channel-1"
834 8. Delete BIER and BIER-TE Configuration
835 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
837 8.1. Delete BIER Node
838 ^^^^^^^^^^^^^^^^^^^^^
840 **REST API** : *POST /restconf/operations/bier-config-api:delete-node*
848 "topo-id": "bier-topo",
855 8.2. Delete IPv4 of BIER Node
856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
858 **REST API** : *POST /restconf/operations/bier-config-api:delete-ipv4*
866 "topology-id": "bier-topo",
868 "sub-domain-id": "0",
871 "bier-mpls-label-base": "10",
872 "bier-mpls-label-range-size": "16",
873 "bitstringlength": "64"
878 8.3. Delete IPv6 of BIER Node
879 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
881 **REST API** : *POST /restconf/operations/bier-config-api:delete-ipv6*
889 "topology-id": "bier-topo",
891 "sub-domain-id": "0",
894 "bier-mpls-label-base": "10",
895 "bier-mpls-label-range-size": "16",
896 "bitstringlength": "64"
901 8.4. Delete BIER-TE BSL
902 ^^^^^^^^^^^^^^^^^^^^^^^
904 **REST API** : *POST /restconf/operations/bier-te-config-api:delete-te-bsl*
912 "topology-id": "bier-topo",
915 "sub-domain-id": "0",
916 "bitstringlength": "64-bit"
920 8.5. Delete BIER-TE SI
921 ^^^^^^^^^^^^^^^^^^^^^^
923 **REST API** : *POST /restconf/operations/bier-te-config-api:delete-te-si*
931 "topology-id": "bier-topo",
934 "sub-domain-id": "0",
935 "bitstringlength": "64-bit",
940 8.6. Delete BIER-TE BP
941 ^^^^^^^^^^^^^^^^^^^^^^
943 **REST API** : *POST /restconf/operations/bier-te-config-api:delete-te-bp*
951 "topology-id": "bier-topo",
954 "sub-domain-id": "0",
955 "bitstringlength": "64-bit",
961 8.7. Delete BIER-TE Label
962 ^^^^^^^^^^^^^^^^^^^^^^^^^
964 **REST API** : *POST /restconf/operations/bier-te-config-api:delete-te-label*
972 "topo-id": "bier-topo",
977 8.8. Delete Sub-domain
978 ^^^^^^^^^^^^^^^^^^^^^^
980 **REST API** : *POST /restconf/operations/bier-topology-api:delete-subdomian*
988 "topo-id": "bier-topo",
997 **REST API** : *POST /restconf/operations/bier-topology-api:delete-domian*
1005 "topo-id": "bier-topo",