<?xml version="1.0"?>
<!-- Protocol Independent Multicast (PIM) configuration -->
<interfaceDefinition>
  <node name="protocols">
    <children>
      <node name="pim" owner="${vyos_conf_scripts_dir}/protocols_pim.py">
        <properties>
          <help>Protocol Independent Multicast (PIM) and IGMP</help>
          <priority>400</priority>
        </properties>
        <children>
          <tagNode name="interface">
            <properties>
              <help>PIM interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
              <constraint>
                #include <include/constraint/interface-name.xml.i>
              </constraint>
            </properties>
            <children>
            #include <include/bfd/bfd.xml.i>
            #include <include/pim/bsm.xml.i>
            #include <include/pim/dr-priority.xml.i>
            #include <include/pim/hello.xml.i>
            #include <include/pim/passive.xml.i>
            #include <include/source-address-ipv4.xml.i>
            <node name="igmp">
              <properties>
                <help>Internet Group Management Protocol (IGMP) options</help>
              </properties>
              <children>
                #include <include/generic-disable-node.xml.i>
                <tagNode name="join">
                  <properties>
                    <help>IGMP join multicast group</help>
                    <valueHelp>
                      <format>ipv4</format>
                      <description>Multicast group address</description>
                    </valueHelp>
                    <constraint>
                      <validator name="ipv4-address"/>
                    </constraint>
                  </properties>
                  <children>
                    #include <include/source-address-ipv4-multi.xml.i>
                  </children>
                </tagNode>
                <leafNode name="query-interval">
                  <properties>
                    <help>IGMP host query interval</help>
                    <valueHelp>
                      <format>u32:1-1800</format>
                      <description>Query interval in seconds</description>
                    </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 1-1800"/>
                    </constraint>
                  </properties>
                </leafNode>
                <leafNode name="query-max-response-time">
                  <properties>
                    <help>IGMP max query response time</help>
                    <valueHelp>
                      <format>u32:10-250</format>
                      <description>Query response value in deci-seconds</description>
                    </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 10-250"/>
                    </constraint>
                  </properties>
                </leafNode>
                <leafNode name="version">
                  <properties>
                    <help>Interface IGMP version</help>
                    <completionHelp>
                      <list>2 3</list>
                    </completionHelp>
                    <valueHelp>
                      <format>2</format>
                      <description>IGMP version 2</description>
                    </valueHelp>
                    <valueHelp>
                      <format>3</format>
                      <description>IGMP version 3</description>
                    </valueHelp>
                    <constraint>
                      <validator name="numeric" argument="--range 2-3"/>
                    </constraint>
                  </properties>
                  <defaultValue>3</defaultValue>
                  </leafNode>
                </children>
              </node>
            </children>
          </tagNode>
          <node name="ecmp">
            <properties>
              <help>Enable PIM ECMP</help>
            </properties>
            <children>
              <leafNode name="rebalance">
                <properties>
                  <help>Enable PIM ECMP Rebalance</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="igmp">
            <properties>
              <help>Internet Group Management Protocol (IGMP) options</help>
            </properties>
            <children>
              <leafNode name="watermark-warning">
                <properties>
                  <help>Configure group limit for watermark warning</help>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Group count to generate watermark warning</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          #include <include/pim/join-prune-interval.xml.i>
          #include <include/pim/keep-alive-timer.xml.i>
          #include <include/pim/packets.xml.i>
          #include <include/pim/register-suppress-time.xml.i>
          <node name="register-accept-list">
            <properties>
              <help>Only accept registers from a specific source prefix list</help>
            </properties>
            <children>
              #include <include/policy/prefix-list.xml.i>
            </children>
          </node>
          <node name="rp">
            <properties>
              <help>Rendezvous Point</help>
            </properties>
            <children>
              <tagNode name="address">
                <properties>
                  <help>Rendezvous Point address</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Rendezvous Point address</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="group">
                    <properties>
                      <help>Group Address range</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>Group Address range RFC 3171</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ip-prefix"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              #include <include/pim/keep-alive-timer.xml.i>
            </children>
          </node>
          <leafNode name="no-v6-secondary">
            <properties>
              <help>Disable IPv6 secondary address in hello packets</help>
              <valueless/>
            </properties>
          </leafNode>
          <node name="spt-switchover">
            <properties>
              <help>Shortest-path tree (SPT) switchover</help>
            </properties>
            <children>
              <node name="infinity-and-beyond">
                <properties>
                  <help>Never switch to SPT Tree</help>
                </properties>
                <children>
                  #include <include/policy/prefix-list.xml.i>
                </children>
              </node>
            </children>
          </node>
          <node name="ssm">
            <properties>
              <help>Source-Specific Multicast</help>
            </properties>
            <children>
              #include <include/policy/prefix-list.xml.i>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>