summaryrefslogtreecommitdiff
path: root/interface-definitions/igmp-proxy.xml.in
blob: 91c912d8be38e2b8dedb8f636bbfe2956190a5f4 (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
<?xml version="1.0"?>
<!-- IGMP Proxy  configuration -->
<interfaceDefinition>
  <node name="protocols">
    <children>
      <node name="igmp-proxy" owner="${vyos_conf_scripts_dir}/igmp_proxy.py">
        <properties>
          <help>Internet Group Management Protocol (IGMP) proxy parameters</help>
          <priority>740</priority>
        </properties>
        <children>
          #include <include/generic-disable-node.xml.i>
          <leafNode name="disable-quickleave">
            <properties>
              <help>Option to disable "quickleave"</help>
              <valueless/>
            </properties>
          </leafNode>
          <tagNode name="interface">
            <properties>
              <help>Interface for IGMP proxy [REQUIRED]</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
            </properties>
            <children>
              <leafNode name="alt-subnet">
                <properties>
                  <help>Unicast source networks allowed for multicast traffic to be proxyed</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>IPv4 network</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="role">
                <properties>
                  <help>IGMP interface role (default: downstream)</help>
                  <completionHelp>
                    <list>upstream downstream disabled</list>
                  </completionHelp>
                  <valueHelp>
                    <format>upstream</format>
                    <description>Upstream interface (only 1 allowed)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>downstream</format>
                    <description>Downstream interface(s) (default)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>disabled</format>
                    <description>Disabled interface</description>
                  </valueHelp>
                  <constraint>
                    <regex>^(upstream|downstream|disabled)$</regex>
                  </constraint>
                </properties>
                <defaultValue>downstream</defaultValue>
              </leafNode>
              <leafNode name="threshold">
                <properties>
                  <help>TTL threshold (default: 1)</help>
                  <valueHelp>
                    <format>u32:1-255</format>
                    <description>TTL threshold for the interfaces (default: 1)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-255"/>
                  </constraint>
                  <constraintErrorMessage>Threshold must be between 1 and 255</constraintErrorMessage>
                </properties>
                <defaultValue>1</defaultValue>
              </leafNode>
              <leafNode name="whitelist">
                <properties>
                  <help>Group to whitelist</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>IPv4 network</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>