summaryrefslogtreecommitdiff
path: root/interface-definitions/protocols-nhrp.xml.in
blob: 32aef40e75aaa895c91a8dd43c62ebcbc7bd4d82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?xml version="1.0" encoding="UTF-8"?>
<interfaceDefinition>
  <node name="protocols">
    <children>
      <node name="nhrp" owner="${vyos_conf_scripts_dir}/protocols_nhrp.py">
        <properties>
          <help>Next Hop Resolution Protocol (NHRP) parameters</help>
          <priority>680</priority>
        </properties>
        <children>
          <tagNode name="tunnel">
            <properties>
              <help>Tunnel for NHRP [REQUIRED]</help>
              <constraint>
                <regex>tun[0-9]+</regex>
              </constraint>
              <valueHelp>
                <format>tunN</format>
                <description>NHRP tunnel name</description>
              </valueHelp>
            </properties>
            <children>
              <leafNode name="cisco-authentication">
                <properties>
                  <help>Pass phrase for cisco authentication</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Pass phrase for cisco authentication</description>
                  </valueHelp>
                  <constraint>
                    <regex>[^[:space:]]{1,8}</regex>
                </constraint>
                <constraintErrorMessage>Password must be 8 characters or less and not null</constraintErrorMessage>
                </properties>
              </leafNode>
              <tagNode name="dynamic-map">
                <properties>
                  <help>Set an HUB tunnel address</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>Set the IP address and prefix length</description>
                  </valueHelp>
                </properties>
                <children>
                  <leafNode name="nbma-domain-name">
                    <properties>
                      <help>Set HUB fqdn (nbma-address - fqdn) [REQUIRED]</help>
                      <valueHelp>
                        <format>&lt;fqdn&gt;</format>
                        <description>Set the external HUB fqdn</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="holding-time">
                <properties>
                  <help>Holding time in seconds</help>
                </properties>
              </leafNode>
              <tagNode name="map">
                <properties>
                  <help>Set an HUB tunnel address</help>
                </properties>
                <children>
                  <leafNode name="cisco">
                    <properties>
                      <help>If the statically mapped peer is running Cisco IOS, specify this</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="nbma-address">
                    <properties>
                      <help>Set HUB address (nbma-address - external hub address or fqdn) [REQUIRED]</help>
                    </properties>
                  </leafNode>
                  <leafNode name="register">
                    <properties>
                      <help>Specifies that Registration Request should be sent to this peer on startup</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="multicast">
                <properties>
                  <help>Set multicast for NHRP</help>
                  <completionHelp>
                    <list>dynamic nhs</list>
                  </completionHelp>
                  <constraint>
                    <regex>(dynamic|nhs)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="non-caching">
                <properties>
                  <help>This can be used to reduce memory consumption on big NBMA subnets</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="redirect">
                <properties>
                  <help>Enable sending of Cisco style NHRP Traffic Indication packets</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="shortcut-destination">
                <properties>
                  <help>This instructs opennhrp to reply with authorative answers on NHRP Resolution Requests destined to addresses in this interface</help>
                  <valueless/>
                </properties>
              </leafNode>
              <tagNode name="shortcut-target">
                <properties>
                  <help>Defines an off-NBMA network prefix for which the GRE interface will act as a gateway</help>
                </properties>
                <children>
                  <leafNode name="holding-time">
                    <properties>
                      <help>Holding time in seconds</help>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="shortcut">
                <properties>
                  <help>Enable creation of shortcut routes. A received NHRP Traffic Indication will trigger the resolution and establishment of a shortcut route</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>