No relevant resource is found in the selected language.
Enterprise
Worldwide
Search
Support Documentation
S12700 and S12700E V200R019C10 NETCONF YANG API Reference

This document describes the NETCONF YANG API functions supported by the switch, including the data model and samples.

Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Multicast Management

Multicast Management

This section describes the configuration model of multicast route management and provides examples of XML packets.

Enabling Multicast Routing

This section describes the configuration model for enabling multicast routing and provides examples of XML packets.

Data Model

The configuration model file for enabling multicast routing is huawei-mcastbase.yang.

Table 2-294 Data model for enabling multicast routing

Object

Description

 Value Remarks

/huawei-mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/vrfName

Indicates the name of the VPN instance.

The value must be an existing VPN instance name.

NA

/huawei-mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/vrfName/addrFamily

Indicates the VPN instance address family.

-

NA

Enabling Multicast Routing

This section provides a sample of enabling multicast routing using the edit-config method.

Table 2-295 Enabling multicast routing

Operation

XPATH

edit-config
  • /huawei-mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/vrfName
  • /huawei-mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/vrfName/addrFamily

Data Requirement

Item

Data

 Description

VPN instance name

ddd

-

VPN instance address family

ipv4unicast

-

Request Example

Enable multicast routing.

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <mcastbase:mcastbase xmlns:mcastbase="http://www.huawei.com/netconf/vrp/huawei-mcastbase">
        <mcastbase:mcastAfsEnables>
          <mcastbase:mcastAfsEnable>
            <mcastbase:vrfName>ddd</mcastbase:vrfName>
            <mcastbase:addressFamily>ipv4unicast</mcastbase:addressFamily>
          </mcastbase:mcastAfsEnable>
        </mcastbase:mcastAfsEnables>
      </mcastbase:mcastbase>
    </config>
  </edit-config>
</rpc>

Response Example

Sample of successful response

<?xml version="1.0" encoding="utf-8"?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <ok/>
</rpc-reply>

Sample of failed response

<?xml version="1.0" encoding="utf-8"?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="14">
  <rpc-error>
    <error-type>application</error-type>
    <error-tag>operation-failed</error-tag>
    <error-severity>error</error-severity>
    <error-path>/huawei-mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable[vrfName='ddd'][addressFamily='ipv4uni cast']/addressFamily</error-path>
    <error-message>parse rpc config error.(Invalid value in "addressFamily" element.).</error-message>
  </rpc-error>
</rpc-reply>

Configuring IGMP User Access

This section describes the configuration model of IGMP user access and provides examples of XML packets.

Data Model

The configuration model file matching IGMP user access is huawei-dgmp.yang.

Table 2-296 Data model for IGMP user access

Object

Description

 Value Remarks

/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/vrfName

Indicates the name of the VPN instance.

The value must be an existing VPN instance name.

NA

/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/addrFamily

Indicates the VPN instance address family.

-

NA

/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/ifName

Indicates the interface on which IGMP is configured.

The value is a string of characters in the format interface-typeinterface-number, in which:
  • interface-type: specifies the interface type.
  • interface-number: specifies the interface number.
The interface must exist on the switch.

NA

/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/gmpEnable

Indicates whether to enable IGMP.

The value is of the Boolean type:

  • true: IGMP is enabled.
  • false: IGMP is disabled.

The default value is false.

NA

/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/version

Indicates the IGMP version running on the interface.

The value is an integer that ranges from 1 to 3.

NA

Configuring IGMP User Access

This section provides a sample of configuring IGMP user access using the edit-config method.

Table 2-297 Configuring IGMP user access

Operation

XPATH

edit-config
  • /mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/vrfName
  • /mcastbase:mcastbase/mcastAfsEnables/mcastAfsEnable/addressFamily
  • /huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/vrfName
  • /huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/addrFamily
  • /huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/ifName
  • /huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/gmpEnable
  • /huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg/version

Data Requirements

Item

Data

 Description

VPN instance name

ddd

-

VPN instance address family

ipv4unicast

-

Interface on which IGMP is configured

Vlanif10

-

Whether to enable IGMP

false

-

IGMP version running on the interface

3

-

Request Example

Configure IGMP user access.

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <dgmp:dgmp xmlns:dgmp="http://www.huawei.com/netconf/vrp/huawei-dgmp">
        <dgmp:dgmpIfCfgs>
          <dgmp:dgmpIfCfg>
            <dgmp:addrFamily>ipv4unicast</dgmp:addrFamily>
            <dgmp:ifName>Vlanif10</dgmp:ifName>
            <dgmp:gmpEnable>false</dgmp:gmpEnable>
            <dgmp:version>3</dgmp:version>
          </dgmp:dgmpIfCfg>
        </dgmp:dgmpIfCfgs>
      </dgmp:dgmp>
      <mcastbase:mcastbase xmlns:mcastbase="http://www.huawei.com/netconf/vrp/huawei-mcastbase">
        <mcastbase:mcastAfsEnables>
          <mcastbase:mcastAfsEnable>
            <mcastbase:vrfName>ddd</mcastbase:vrfName>
            <mcastbase:addressFamily>ipv4unicast</mcastbase:addressFamily>
          </mcastbase:mcastAfsEnable>
        </mcastbase:mcastAfsEnables>
      </mcastbase:mcastbase>
    </config>
  </edit-config>
</rpc>

Response Example

Sample of successful response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <ok/>
</rpc-reply>

Sample of failed response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <rpc-error>
    <error-type>application</error-type>
    <error-tag>invalid-value</error-tag>
    <error-severity>error</error-severity>
    <error-path>/huawei-dgmp:dgmp/dgmpIfCfgs/dgmpIfCfg[addrFamily='ipv4unicast'][ifName='Vlanif10']/ifName</error-path>
    <error-message>validation failed(Leafref "/ietf-interfaces:interfaces/ietf-interfaces:interface/ietf-interfaces:name" of value "Vlanif10" points to a non-existing leaf.).</error-message>
  </rpc-error>
</rpc-reply>

Configuring PIM-DM/PIM-SM Multicast Routing

This section describes the configuration model of PIM-DM/PIM-SM multicast routing and provides examples of XML packets.

Data Model

The configuration model file matching PIM-DM/PIM-SM multicast routing is huawei-pim.yang.

Table 2-298 Data model for PIM-DM/PIM-SM multicast routing

Object

Description

Value

Remarks

/huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/vrfName

Indicates the name of the VPN instance.

The value must be an existing VPN instance name.

NA

/huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/addressFamily

Indicates the address family.

-

NA

/huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/cBsrIfName

C-BSR

-

NA

/huawei-pim:pim/bsrafspro/bsrAf4CrpCfgs/bsrAf4CrpCfg/cRpIfName

C-RP

-

NA

/huawei-pim:pim/bsrafspro/bsrAf4CrpCfgs/bsrAf4CrpCfg/vrfName

Indicates the name of the VPN instance.

The value must be an existing VPN instance name.

NA

/huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/vrfName

Indicates the name of the VPN instance.

The value must be an existing VPN instance name.

NA

/huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/addressFamily

Indicates the address family.

-

NA

/huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/ifName

Indicates the interface on which C-BSR or C-RP is configured.
The value is a string of characters in the format interface-typeinterface-number, in which:
  • interface-type: specifies the interface type.
  • interface-number: specifies the interface number.
The interface must exist on the switch.

NA

/huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/pimMode

Indicates the work mode of a PIM router.
The value is of the enumerated type:
  • Sparse: specifies the PIM-Sparse Mode.
  • Dense: specifies the PIM-Dense Mode.

NA

Configuring PIM-DM/PIM-SM Multicast Routing

This section provides a sample of configuring PIM-DM/PIM-SM multicast routing using the edit-config method.

Table 2-299 Configuring PIM-DM/PIM-SM multicast routing

Operation

XPATH

edit-config
  • /huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/vrfName
  • /huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/addressFamily
  • /huawei-pim:pim/bsrafspro/bsrAfsSiteCfgs/bsrAfsSiteCfg/cBsrIfName
  • /huawei-pim:pim/bsrafspro/bsrAf4CrpCfgs/bsrAf4CrpCfg/cRpIfName
  • /huawei-pim:pim/bsrafspro/bsrAf4CrpCfgs/bsrAf4CrpCfg/vrfName
  • /huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/vrfName
  • /huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/addressFamily
  • /huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/ifName
  • /huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg/pimMode

Data Requirements

Item

Data

 Description

VPN instance name

ddd

-

VPN instance address family

ipv4unicast

-

Route Distinguisher (RD) for the VPN instance address family

100:2

-

Interface on which C-BSR or C-RP is configured

Vlanif10

-

PIM work mode

Sparse

-

Request Example

Configure PIM-DM/PIM-SM multicast routing.

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <if:interfaces xmlns:if="urn:ietf:params:xml:ns:yang:ietf-interfaces">
        <if:interface>
          <if:name>Vlanif10</if:name>
          <if:type xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">ianaift:propVirtual</if:type>
        </if:interface>
      </if:interfaces>
      <mcastbase:mcastbase xmlns:mcastbase="http://www.huawei.com/netconf/vrp/huawei-mcastbase">
        <mcastbase:mcastAfsEnables>
          <mcastbase:mcastAfsEnable>
            <mcastbase:vrfName>ddd</mcastbase:vrfName>
            <mcastbase:addressFamily>ipv4unicast</mcastbase:addressFamily>
          </mcastbase:mcastAfsEnable>
        </mcastbase:mcastAfsEnables>
      </mcastbase:mcastbase>
      <pim:pim xmlns:pim="http://www.huawei.com/netconf/vrp/huawei-pim">
        <pim:bsrafspro>
          <pim:bsrAfsSiteCfgs>
            <pim:bsrAfsSiteCfg>
              <pim:vrfName>ddd</pim:vrfName>
              <pim:addressFamily>ipv4unicast</pim:addressFamily>
              <pim:cBsrIfName>Vlanif10</pim:cBsrIfName>
            </pim:bsrAfsSiteCfg>
          </pim:bsrAfsSiteCfgs>
          <pim:bsrAf4CrpCfgs>
            <pim:bsrAf4CrpCfg>
              <pim:cRpIfName>Vlanif10</pim:cRpIfName>
              <pim:vrfName>ddd</pim:vrfName>
            </pim:bsrAf4CrpCfg>
          </pim:bsrAf4CrpCfgs>
        </pim:bsrafspro>
        <pim:pimafspro>
          <pim:pimAfsIfCfgs>
            <pim:pimAfsIfCfg>
              <pim:vrfName>ddd</pim:vrfName>
              <pim:addressFamily>ipv4unicast</pim:addressFamily>
              <pim:ifName>Vlanif10</pim:ifName>
              <pim:pimMode>Sparse</pim:pimMode>
            </pim:pimAfsIfCfg>
          </pim:pimAfsIfCfgs>
        </pim:pimafspro>
      </pim:pim>
      <hw-l3vpn:vpn-instances xmlns:hw-l3vpn="urn:huawei:params:xml:ns:yang:huawei-l3vpn">
        <hw-l3vpn:vpn-instance>
          <hw-l3vpn:vpn-instance-name>ddd</hw-l3vpn:vpn-instance-name>
          <hw-bgp-vpn:ipv4-family xmlns:hw-bgp-vpn="urn:huawei:params:xml:ns:yang:huawei-bgp-l3vpn">
            <hw-bgp-vpn:route-distinguisher>100:2</hw-bgp-vpn:route-distinguisher>
          </hw-bgp-vpn:ipv4-family>
        </hw-l3vpn:vpn-instance>
      </hw-l3vpn:vpn-instances>
    </config>
  </edit-config>
</rpc>

Response Example

Sample of successful response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <ok/>
</rpc-reply>

Sample of failed response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="10">
  <rpc-error>
    <error-app-tag>1</error-app-tag>
    <error-message>Service process failed.</error-message>
  </rpc-error>
  <rpc-error>
    <error-app-tag>-1</error-app-tag>
    <error-message> Please disable IGMP Snooping in the VLAN view first.</error-message>
    <error-info>Error on node /huawei-pim:pim/pimafspro/pimAfsIfCfgs/pimAfsIfCfg[vrfName="ddd",addressFamily="ipv4unicast",ifName="Vlanif10"]</error-info>
  </rpc-error>
</rpc-reply>

Configuring IGMP Snooping

This section describes the configuration model of IGMP snooping and provides examples of XML packets.

Data Model

The configuration model file matching IGMP snooping is huawei-l2mc.yang

Table 2-300 Data model for IGMP snooping

Object

Description

Value

Remarks

/huawei-l2mc:l2mc/l2McSnpgEnables/l2McSnpgEnable/addrFamily

Indicates a VPN instance address family.

-

N/A

/huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/addrFamily

Indicates a VPN instance address family.

-

N/A

/huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/vlanId

Specifies the ID of a VLAN in which IGMP snooping is enabled.

The value is an integer in the range from 1 to 4094.

N/A

/huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/version

Specifies the version of IGMP messages that can be processed.
The value is an integer in the range from 1 to 3.
  • 1: indicates that IGMP snooping processes only IGMPv1 messages.
  • 2: indicates that IGMP snooping processes IGMPv1 and IGMPv2 messages.
  • 3: indicates that IGMP snooping processes IGMPv1, IGMPv2, and IGMPv3 messages.

N/A

/huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/vlanId

Specifies a multicast VLAN ID.

The value is an integer in the range from 1 to 4094.

N/A

/huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/mcastVlanEnable

Indicates whether to enable the multicast VLAN.

The value is of the Boolean type:

  • true: The multicast VLAN is enabled.
  • false: The multicast VLAN is not enabled.

The default value is false.

N/A

/huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/userVlans

Specifies a user VLAN ID.

The value is an integer in the range from 1 to 4094.

N/A

/huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/fwdMode

Specifies the multicast data forwarding mode in a VLAN.

The value is of the enumerated type:

  • ip: Multicast data is forwarded based on IP addresses.
  • mac: Multicast data is forwarded based on MAC addresses.

The default value is ip.

N/A

Configuring IGMP Snooping-based Layer 2 Multicast

This section provides a sample of configuring IGMP snooping-based Layer 2 multicast using the edit-config method.

Table 2-301 Configuring IGMP snooping-based Layer 2 multicast

Operation

XPATH

edit-config
  • /huawei-l2mc:l2mc/l2McSnpgEnables/l2McSnpgEnable/addrFamily
  • /huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/addrFamily
  • /huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/vlanId
  • /huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/version
  • /huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/vlanId
  • /huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/mcastVlanEnable
  • /huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg/userVlans
  • /huawei-l2mc:l2mc/vlan/l2McVlanCfgs/l2McVlanCfg/fwdMode

Data Requirements

Item

Data

 Description

VPN instance address family

ipv4unicast

-

VLAN ID for which IGMP snooping is enabled

10

-

Version of IGMP messages that can be processed

1

-

Multicast data forwarding mode in a VLAN

ip

-

Multicast VLAN ID

10

-

Whether to enable the multicast VLAN

true

-

User VLAN ID

15,20-30

-

Request Example

Configure IGMP snooping-based Layer 2 multicast.

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <l2mc:l2mc xmlns:l2mc="http://www.huawei.com/netconf/vrp/huawei-l2mc">
        <l2mc:l2McSnpgEnables>
          <l2mc:l2McSnpgEnable>
            <l2mc:addrFamily>ipv4unicast</l2mc:addrFamily>
          </l2mc:l2McSnpgEnable>
        </l2mc:l2McSnpgEnables>
        <l2mc:vlan>
          <l2mc:l2McVlanCfgs>
            <l2mc:l2McVlanCfg>
              <l2mc:addrFamily>ipv4unicast</l2mc:addrFamily>
              <l2mc:vlanId>10</l2mc:vlanId>
              <l2mc:version>1</l2mc:version>
              <l2mc:fwdMode>ip</l2mc:fwdMode>
            </l2mc:l2McVlanCfg>
          </l2mc:l2McVlanCfgs>
          <l2mc:l2McMVlanCfgs>
            <l2mc:l2McMVlanCfg>
              <l2mc:vlanId>10</l2mc:vlanId>
              <l2mc:mcastVlanEnable>true</l2mc:mcastVlanEnable>
              <l2mc:userVlans>15,20-30</l2mc:userVlans>
            </l2mc:l2McMVlanCfg>
          </l2mc:l2McMVlanCfgs>
        </l2mc:vlan>
      </l2mc:l2mc>
    </config>
  </edit-config>
</rpc>

Response Example

Sample of successful response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="">
  <ok/>
</rpc-reply>

Sample of failed response

<?xml version='1.0' encoding='UTF-8'?>
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="">
  <rpc-error>
    <error-app-tag>-1</error-app-tag>
    <error-message> This VLAN 10 is not a multicast VLAN. </error-message>
  </rpc-error>
  <rpc-error>
    <error-app-tag>-1</error-app-tag>
    <error-message> This VLAN 10 is not a multicast VLAN. </error-message>
    <error-info>Error on node /huawei-l2mc:l2mc/vlan/l2McMVlanCfgs/l2McMVlanCfg[vlanId="10"]</error-info>
  </rpc-error>
</rpc-reply>
Translation
简体中文
Download
Updated: 2022-05-25

Document ID: EDOC1100126933

Views: 64991

Downloads: 82

Average rating:
This Document Applies to these Products

Related Version

Related Documents

Digital Signature File

Digital Signature Authentication Mode
Share
Previous Next

Copyright © 2023 Huawei Technologies Co., Ltd. All rights reserved.

You are going to visit :