summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/developer/logging.rst45
-rw-r--r--doc/user/bgp.rst11
-rw-r--r--doc/user/isisd.rst4
-rw-r--r--doc/user/mgmtd.rst11
-rw-r--r--doc/user/ospfd.rst38
-rw-r--r--doc/user/overview.rst2
-rw-r--r--doc/user/pim.rst9
7 files changed, 107 insertions, 13 deletions
diff --git a/doc/developer/logging.rst b/doc/developer/logging.rst
index b7021b69a1..2fe0a5989b 100644
--- a/doc/developer/logging.rst
+++ b/doc/developer/logging.rst
@@ -502,6 +502,51 @@ General utility formats
representation for a hexdump. Non-printable characters are replaced with
a dot.
+.. frrfmt:: %pIS (struct iso_address *)
+
+ ([IS]o Network address) - Format ISO Network Address
+
+ ``%pIS``: :frrfmtout:`01.0203.04O5`
+ ISO Network address is printed as separated byte. The number of byte of the
+ address is embeded in the `iso_net` structure.
+
+ ``%pISl``: :frrfmtout:`01.0203.04O5.0607.0809.1011.1213.14` - long format to
+ print the long version of the ISO Network address which include the System
+ ID and the PSEUDO-ID of the IS-IS system
+
+ Note that the `ISO_ADDR_STRLEN` define gives the total size of the string
+ that could be used in conjunction to snprintfrr. Use like::
+
+ char buf[ISO_ADDR_STRLEN];
+ struct iso_net addr = {.len = 4, .addr = {1, 2, 3, 4}};
+ snprintfrr(buf, ISO_ADDR_STRLEN, "%pIS", &addr);
+
+.. frrfmt:: %pSY (uint8_t *)
+
+ (IS-IS [SY]stem ID) - Format IS-IS System ID
+
+ ``%pSY``: :frrfmtout:`0102.0304.0506`
+
+.. frrfmt:: %pPN (uint8_t *)
+
+ (IS-IS [P]seudo [N]ode System ID) - Format IS-IS Pseudo Node System ID
+
+ ``%pPN``: :frrfmtout:`0102.0304.0506.07`
+
+.. frrfmt:: %pLS (uint8_t *)
+
+ (IS-IS [L]sp fragment [S]ystem ID) - Format IS-IS Pseudo System ID
+
+ ``%pLS``: :frrfmtout:`0102.0304.0506.07-08`
+
+ Note that the `ISO_SYSID_STRLEN` define gives the total size of the string
+ that could be used in conjunction to snprintfrr. Use like::
+
+ char buf[ISO_SYSID_STRLEN];
+ uint8_t id[8] = {1, 2, 3, 4 , 5 , 6 , 7, 8};
+ snprintfrr(buf, SYS_ID_SIZE, "%pSY", id);
+
+
Integer formats
^^^^^^^^^^^^^^^
diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index 946f0699f2..97d7ce6b75 100644
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -2767,6 +2767,17 @@ happened automatically if local-role is set.
value of his role (by setting local-role on his side). Otherwise, a Role
Mismatch Notification will be sent.
+Labeled unicast
+---------------
+
+*bgpd* supports labeled information, as per :rfc:`3107`.
+
+.. clicmd:: bgp labeled-unicast explicit-null
+
+By default, locally advertised prefixes use the `implicit-null` label to
+encode in the outgoing NLRI. The following command uses the `explicit-null`
+label value for all the BGP instances.
+
.. _bgp-l3vpn-vrfs:
L3VPN VRFs
diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst
index 90c13d4f93..88fa78ddfa 100644
--- a/doc/user/isisd.rst
+++ b/doc/user/isisd.rst
@@ -68,6 +68,10 @@ writing, *isisd* does not support multiple ISIS processes.
Log changes in adjacency state.
+.. clicmd:: log-pdu-drops
+
+ Log any dropped PDUs.
+
.. clicmd:: metric-style [narrow | transition | wide]
Set old-style (ISO 10589) or new-style packet formats:
diff --git a/doc/user/mgmtd.rst b/doc/user/mgmtd.rst
index 6ea7e7891a..6614a568f8 100644
--- a/doc/user/mgmtd.rst
+++ b/doc/user/mgmtd.rst
@@ -70,14 +70,6 @@ Frontend Interface and MGMTd:
database.
- Data can be retrieved anytime using GET_CONFIG/GET_DATA API.
- - Startup Database:
-
- - Consists of configuration data items only.
- - This is a copy of Running database that is stored in persistent
- storage and is used to load configurations on Running database during
- MGMT daemon startup.
- - Data cannot be edited/retrieved directly via Frontend interface.
-
- Operational Database:
- Consists of non-configurational data items.
@@ -313,8 +305,7 @@ MGMT Configuration commands
.. clicmd:: mgmt commit apply
This command commits any uncommited changes in the Candidate DB to the
- Running DB. It also dumps a copy of the tree in JSON format into
- frr_startup.json.
+ Running DB.
.. clicmd:: mgmt commit check
diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst
index 30d55f34a7..5171832604 100644
--- a/doc/user/ospfd.rst
+++ b/doc/user/ospfd.rst
@@ -310,6 +310,18 @@ To start OSPF process you have to specify the OSPF router.
of packets to process before returning. The defult value of this parameter
is 20.
+.. clicmd:: socket buffer <send | recv | all> (1-4000000000)
+
+ This command controls the ospf instance's socket buffer sizes. The
+ 'no' form resets one or both values to the default.
+
+.. clicmd:: no socket-per-interface
+
+ Ordinarily, ospfd uses a socket per interface for sending
+ packets. This command disables those per-interface sockets, and
+ causes ospfd to use a single socket per ospf instance for sending
+ and receiving packets.
+
.. _ospf-area:
Areas
@@ -325,7 +337,6 @@ Areas
announced to other areas. This command can be used only in ABR and ONLY
router-LSAs (Type-1) and network-LSAs (Type-2) (i.e. LSAs with scope area) can
be summarized. Type-5 AS-external-LSAs can't be summarized - their scope is AS.
- Summarizing Type-7 AS-external-LSAs isn't supported yet by FRR.
.. code-block:: frr
@@ -431,6 +442,31 @@ Areas
configured not to advertise forwarding addresses into the backbone to direct
forwarded traffic to the NSSA ABR translator.
+.. clicmd:: area A.B.C.D nssa default-information-originate [metric-type (1-2)] [metric (0-16777214)]
+
+.. clicmd:: area (0-4294967295) nssa default-information-originate [metric-type (1-2)] [metric (0-16777214)]
+
+ NSSA ABRs and ASBRs can be configured with the `default-information-originate`
+ option to originate a Type-7 default route into the NSSA area. In the case
+ of NSSA ASBRs, the origination of the default route is conditioned to the
+ existence of a default route in the RIB that wasn't learned via the OSPF
+ protocol.
+
+.. clicmd:: area A.B.C.D nssa range A.B.C.D/M [<not-advertise|cost (0-16777215)>]
+
+.. clicmd:: area (0-4294967295) nssa range A.B.C.D/M [<not-advertise|cost (0-16777215)>]
+
+ Summarize a group of external subnets into a single Type-7 LSA, which is
+ then translated to a Type-5 LSA and avertised to the backbone.
+ This command can only be used at the area boundary (NSSA ABR router).
+
+ By default, the metric of the summary route is calculated as the highest
+ metric among the summarized routes. The `cost` option, however, can be used
+ to set an explicit metric.
+
+ The `not-advertise` option, when present, prevents the summary route from
+ being advertised, effectively filtering the summarized routes.
+
.. clicmd:: area A.B.C.D default-cost (0-16777215)
diff --git a/doc/user/overview.rst b/doc/user/overview.rst
index 4a24fa52be..5ea33d62c9 100644
--- a/doc/user/overview.rst
+++ b/doc/user/overview.rst
@@ -424,6 +424,8 @@ BGP
:t:`Extended Optional Parameters Length for BGP OPEN Message. E. Chen, J. Scudder. July 2021.`
- :rfc:`9234`
:t:`Route Leak Prevention and Detection Using Roles in UPDATE and OPEN Messages. A. Azimov, E. Bogomazov, R. Bush, K. Patel, K. Sriram. May 2022.`
+- :rfc:`9384`
+ :t:`A BGP Cease NOTIFICATION Subcode for Bidirectional Forwarding Detection (BFD). J. Haas. March 2023.`
OSPF
----
diff --git a/doc/user/pim.rst b/doc/user/pim.rst
index 72471d7af0..d70c3c0e64 100644
--- a/doc/user/pim.rst
+++ b/doc/user/pim.rst
@@ -387,9 +387,14 @@ cause great confusion.
.. clicmd:: show ip igmp [vrf NAME] join [json]
Display IGMP static join information for a specific vrf.
- If "vrf all" is provided, it displays information for all the vrfs present.
+
+.. index:: show ip igmp [vrf NAME$vrf_name] groups [INTERFACE$ifname [GROUP$grp_str]] [detail] [json$json]
+.. clicmd:: show ip igmp [vrf NAME$vrf_name] groups [INTERFACE$ifname [GROUP$grp_str]] [detail] [json$json]
-.. clicmd:: show ip igmp groups
+ Display IGMP static join information for all the vrfs present.
+
+.. index:: show ip igmp vrf all groups [GROUP$grp_str] [detail$detail] [json$json]
+.. clicmd:: show ip igmp vrf all groups [GROUP$grp_str] [detail$detail] [json$json]
Display IGMP groups information.