summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-11-27 19:46:51 +0100
committerChristian Poessinger <christian@poessinger.com>2021-11-27 19:46:51 +0100
commit8ff3e99af120d69084c4b682790d6f7a315b28e8 (patch)
tree9acc6e6fc5f665f452dc3580276b7d4398114d9c /docs/configuration/protocols
parented417b84d9c907e901b8526e5da3a62cb0e273df (diff)
downloadvyos-documentation-8ff3e99af120d69084c4b682790d6f7a315b28e8.tar.gz
vyos-documentation-8ff3e99af120d69084c4b682790d6f7a315b28e8.zip
ospfv3: rename intname -> interface on CLI examples
Diffstat (limited to 'docs/configuration/protocols')
-rw-r--r--docs/configuration/protocols/ospf.rst28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst
index ccddcd92..8c858ce1 100644
--- a/docs/configuration/protocols/ospf.rst
+++ b/docs/configuration/protocols/ospf.rst
@@ -37,12 +37,12 @@ starts when the first ospf enabled interface is configured.
This command is also used to enable the OSPF process. The area number can be
specified in decimal notation in the range from 0 to 4294967295. Or it
can be specified in dotted decimal notation similar to ip address.
-
+
Prefix length in interface must be equal or bigger (i.e. smaller network) than
prefix length in network statement. For example statement above doesn't enable
ospf on interface with address 192.168.1.1/23, but it does on interface with
address 192.168.1.129/25.
-
+
In some cases it may be more convenient to enable OSPF on a per interface/subnet
basis :cfgcmd:`set protocols ospf interface <interface> area <x.x.x.x | x>`
@@ -549,12 +549,12 @@ Operational Mode Commands
This command displays the neighbors information in a detailed form for a
neighbor whose IP address is specified.
-.. opcmd:: show ip ospf neighbor <intname>
+.. opcmd:: show ip ospf neighbor <interface>
This command displays the neighbors status for a neighbor on the specified
interface.
-.. opcmd:: show ip ospf interface [<intname>]
+.. opcmd:: show ip ospf interface [<interface>]
This command displays state and configuration of OSPF the specified
interface, or all interfaces if no interface is given.
@@ -826,20 +826,20 @@ Area Configuration
Interface Configuration
-----------------------
-.. cfgcmd:: set protocols ospfv3 interface <intname> ipv6 cost <number>
+.. cfgcmd:: set protocols ospfv3 interface <interface> ipv6 cost <number>
This command sets link cost for the specified interface. The cost value is
set to router-LSA’s metric field and used for SPF calculation. The cost
range is 1 to 65535.
-.. cfgcmd:: set protocols ospfv3 interface <intname> dead-interval <number>
+.. cfgcmd:: set protocols ospfv3 interface <interface> dead-interval <number>
Set number of seconds for router Dead Interval timer value used for Wait
Timer and Inactivity Timer. This value must be the same for all routers
attached to a common network. The default value is 40 seconds. The
interval range is 1 to 65535.
-.. cfgcmd:: set protocols ospfv3 interface <intname> hello-interval
+.. cfgcmd:: set protocols ospfv3 interface <interface> hello-interval
<number>
Set number of seconds for Hello Interval timer value. Setting this value,
@@ -848,14 +848,14 @@ Interface Configuration
common network. The default value is 10 seconds. The interval range is 1
to 65535.
-.. cfgcmd:: set protocols ospfv3 interface <intname> mtu-ignore
+.. cfgcmd:: set protocols ospfv3 interface <interface> mtu-ignore
This command disables check of the MTU value in the OSPF DBD packets.
Thus, use of this command allows the OSPF adjacency to reach the FULL
state even though there is an interface MTU mismatch between two OSPF
routers.
-.. cfgcmd:: set protocols ospfv3 interface <intname> network <type>
+.. cfgcmd:: set protocols ospfv3 interface <interface> network <type>
This command allows to specify the distribution type for the network
connected to this interface:
@@ -863,20 +863,20 @@ Interface Configuration
**broadcast** – broadcast IP addresses distribution.
**point-to-point** – address distribution in point-to-point networks.
-.. cfgcmd:: set protocols ospfv3 interface <intname> priority <number>
+.. cfgcmd:: set protocols ospfv3 interface <interface> priority <number>
This command sets Router Priority integer value. The router with the
highest priority will be more eligible to become Designated Router.
Setting the value to 0, makes the router ineligible to become Designated
Router. The default value is 1. The interval range is 0 to 255.
-.. cfgcmd:: set protocols ospfv3 interface <intname> passive
+.. cfgcmd:: set protocols ospfv3 interface <interface> passive
This command specifies interface as passive. Passive interface advertises
its address, but does not run the OSPF protocol (adjacencies are not formed
and hello packets are not generated).
-.. cfgcmd:: set protocols ospfv3 interface <intname> retransmit-interval
+.. cfgcmd:: set protocols ospfv3 interface <interface> retransmit-interval
<number>
This command sets number of seconds for RxmtInterval timer value. This
@@ -884,7 +884,7 @@ Interface Configuration
Request packets if acknowledge was not received. The default value is 5
seconds. The interval range is 3 to 65535.
-.. cfgcmd:: set protocols ospfv3 interface <intname> transmit-delay
+.. cfgcmd:: set protocols ospfv3 interface <interface> transmit-delay
<number>
This command sets number of seconds for InfTransDelay value. It allows to
@@ -927,7 +927,7 @@ Operational Mode Commands
This command displays the neighbor DR choice information.
-.. opcmd:: show ipv6 ospfv3 interface [prefix]|[<intname> [prefix]]
+.. opcmd:: show ipv6 ospfv3 interface [prefix]|[<interface> [prefix]]
This command displays state and configuration of OSPF the specified
interface, or all interfaces if no interface is given. Whith the argument