No relevant resource is found in the selected language.
Enterprise
Worldwide
Search
Support Documentation
S7700 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).
IPv4 Static Route Management

IPv4 Static Route Management

This section describes the configuration model of IPv4 static route management and provides XML packet examples.

Data Model

The configuration model files matching IPv4 static route management are ietf-routing.yang, ietf-ipv4-unicast-routing, and huawei-ipv4-static-route.

Table 2-275 IPv4 static route management

Object

Description

Value

Remarks

/ietf-routing:routing/routing-instance/name

Indicates a routing instance name.

The value is a string of 1 to 31 case-sensitive characters without spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.

  • When a static route is configured on a public network, the value can only be default-routing-instance.
  • When a static route is configured in a VPN instance, the value must be an existing VPN instance name.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/type

Indicates a route type.

Currently, only static routes are supported.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/name

Indicates a routing protocol instance name.

The value is a string of 1 to 31 case-sensitive characters without spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route /destination-prefix

Indicates the destination IPv4 address and mask length.

The value is in the ipv4-address/mask-length format:

  • ipv4-address: indicates the destination IPv4 address, which is in dotted decimal notation.
  • mask-length: indicates the mask length, which is an integer in the range from 0 to 32.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route /description

Indicates the description of an IPv4 static route.

The value is a string of 1 to 80 case-sensitive characters without question marks (?). It can contain spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route /next-hop/next-hop-address

Indicates a next-hop IPv4 address.

The value is in dotted decimal notation.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route /next-hop/outgoing-interface

Indicates a next-hop outbound interface.

The value is a character string in the interface-typeinterface-number format, where interface-type indicates the interface type and interface-number indicates the interface number.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route /next-hop/special-next-hop

Indicates a special next hop.

Currently, only a blackhole next hop is supported.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/egress-interface-nexthop
Indicates the next-hop outbound interface information of an IPv4 static route, which is configured through the following child objects:
  • outgoing-interface: indicates a next-hop outbound interface.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: Specifies the administrator name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: Specifies the test instance name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: Specifies the name of an route monitoring group bound to a static route.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: Specifies a BFD session bound to a static route.
The value ranges of the child objects are as follows:
  • outgoing-interface: is a character string in the interface-typeinterface-number format, where interface-type indicates the interface type and interface-number indicates the interface number.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: is a string of 1 to 31 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: is a string of 1 to 15 case-sensitive characters without spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/ipv4-address-nexthop
Indicates the next-hop IPv4 address information of an IPv4 static route, which is configured through the following child objects:
  • next-hop-address: indicates a next-hop IPv4 address.
  • preference: indicates the priority of an IPv4 static route.
  • description: indicates the description of an IPv4 static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: Specifies the administrator name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: Specifies the test instance name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: Specifies the name of an route monitoring group bound to a static route.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: Specifies a BFD session bound to a static route.
The value ranges of the child objects are as follows:
  • next-hop-address: is in dotted decimal notation.
  • preference: is an integer in the range from 1 to 255. The default value is 60.
  • description: is a string of 1 to 80 characters that can contain spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: is a string of 1 to 31 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: is a string of 1 to 15 case-sensitive characters without spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/egress-interface-ipv4-nexthop
Indicates the next-hop outbound interface and next-hop IPv4 address information of an IPv4 static route, which is configured through the following child objects:
  • outgoing-interface: indicates a next-hop outbound interface.
  • next-hop-address: indicates a next-hop IPv4 address.
  • preference: indicates the priority of an IPv4 static route.
  • description: indicates the description of an IPv4 static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: Specifies the administrator name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: Specifies the test instance name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: Specifies the name of an route monitoring group bound to a static route.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: Specifies a BFD session bound to a static route.
The value ranges of the child objects are as follows:
  • outgoing-interface: is a character string in the interface-typeinterface-number format, where interface-type indicates the interface type and interface-number indicates the interface number.
  • next-hop-address: is in dotted decimal notation.
  • preference: is an integer in the range from 1 to 255. The default value is 60.
  • description: is a string of 1 to 80 characters that can contain spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: is a string of 1 to 31 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: is a string of 1 to 15 case-sensitive characters without spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/egress-routing-instance-ipv4-nexthop
Indicates the destination VPN and next-hop IPv4 address information of an IPv4 static route, which is configured through the following child objects:
  • dest-routing-instance: indicates the destination VPN instance.
  • next-hop-address: indicates a next-hop IPv4 address.
  • preference: indicates the priority of an IPv4 static route.
  • description: indicates the description of an IPv4 static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: Specifies the administrator name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: Specifies the test instance name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: Specifies the name of an route monitoring group bound to a static route.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: Specifies a BFD session bound to a static route.
The value ranges of the child objects are as follows:
  • dest-routing-instance: is a string of 1 to 31 case-sensitive characters with spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.
  • next-hop-address: is in dotted decimal notation.
  • preference: is an integer in the range from 1 to 255. The default value is 60.
  • description: is a string of 1 to 80 characters that can contain spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: is a string of 1 to 31 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/hw-route-protection:track-bfd/session-name: is a string of 1 to 15 case-sensitive characters without spaces.

N/A

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/egress-routing-instance-nexthop
Indicates the destination VPN information of an IPv4 static route, with no next-hop IPv4 address specified. This object is configured through the following child objects:
  • dest-routing-instance: indicates the destination VPN instance.
  • preference: indicates the priority of an IPv4 static route.
  • tag: indicates the tag value of an IPv4 static route.
  • description: indicates the description of an IPv4 static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: Specifies the administrator name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: Specifies the test instance name of an NQA test instance bound to a static route.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: Specifies the name of an route monitoring group bound to a static route.
The value ranges of the child objects are as follows:
  • dest-routing-instance: is a string of 1 to 31 case-sensitive characters with spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.
  • preference: is an integer in the range from 1 to 255. The default value is 60.
  • tag: is an integer in the range from 1 to 4294967295. The default value is 0.
  • description: is a string of 1 to 80 characters that can contain spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-admin-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-nqa/nqa-test-name: is a string of 1 to 32 case-sensitive characters without spaces.
  • /route-track-parameters/route-track-type/huawei-route-protection:track-route-monitor-group/group-name: is a string of 1 to 31 case-sensitive characters without spaces.

N/A

Configuring IPv4 Static Routes

This section describes how to configure IPv4 static routes using edit-config.

Table 2-276 Configuring an IPv4 static route

Operation

XPATH

edit-config

/ietf-routing:routing/routing-instance/name

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/type

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/name

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/destination-prefix

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/ipv4-address-nexthop/next-hop-address

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/ipv4-address-nexthop/preference

/ietf-routing:routing/routing-instance/routing-protocols/routing-protocol/static-routes/ietf-ipv4-unicast-routing:ipv4/route/next-hop/next-hop-options/huawei-ipv4-static-route:multiple-path/ipv4-address-nexthop/description

Data Requirements

Item

Data

 Description

Routing instance name

default-routing-instance

A static route is configured on a public network.

Route type

static

-

Routing protocol instance name

default-routing-instance

-

Destination IPv4 address and prefix length

10.1.1.1/24

-

Next-hop IPv4 address

192.168.10.1

-

Priority of an IPv4 static route

100

-

Description of an IPv4 static route

default-routing-instance

-
Request Example
<?xml version='1.0' encoding='UTF-8'?>
<rpc message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
  <rt:routing xmlns:rt="urn:ietf:params:xml:ns:yang:ietf-routing">
        <rt:routing-instance>
          <rt:name>default-routing-instance</rt:name>
          <rt:routing-protocols>
            <rt:routing-protocol>
              <rt:type>static</rt:type>
              <rt:name>default-routing-instance</rt:name>
              <rt:static-routes>
                <v4ur:ipv4 xmlns:v4ur="urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing">
                  <v4ur:route>
                    <v4ur:destination-prefix>10.1.1.1/24</v4ur:destination-prefix>
                    <v4ur:next-hop>
                      <hw-v4sr:ipv4-address-nexthop xmlns:hw-v4sr="urn:huawei:params:xml:ns:yang:hw-ipv4-static-route">
                        <hw-v4sr:next-hop-address>192.168.10.1</hw-v4sr:next-hop-address>
                        <hw-v4sr:preference>100</hw-v4sr:preference>
                        <hw-v4sr:description>default-routing-instance</hw-v4sr:description>
                      </hw-v4sr:ipv4-address-nexthop>
                    </v4ur:next-hop>
                  </v4ur:route>
                </v4ur:ipv4>
              </rt:static-routes>
            </rt:routing-protocol>
          </rt:routing-protocols>
        </rt:routing-instance>
      </rt:routing>
	</config>
  </edit-config>
</rpc>

Deletion Example

<?xml version='1.0' encoding='UTF-8'?>
<rpc message-id="1" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
  <rt:routing xmlns:rt="urn:ietf:params:xml:ns:yang:ietf-routing">
        <rt:routing-instance xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0" xc:operation="delete">
          <rt:name>default-routing-instance</rt:name>
          <rt:routing-protocols>
            <rt:routing-protocol>
              <rt:type>static</rt:type>
              <rt:name>default-routing-instance</rt:name>
              <rt:static-routes>
                <v4ur:ipv4 xmlns:v4ur="urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing">
                  <v4ur:route>
                    <v4ur:destination-prefix>10.1.1.1/24</v4ur:destination-prefix>
                    <v4ur:next-hop>
                      <hw-v4sr:ipv4-address-nexthop xmlns:hw-v4sr="urn:huawei:params:xml:ns:yang:hw-ipv4-static-route">
                        <hw-v4sr:next-hop-address>192.168.10.1</hw-v4sr:next-hop-address>
                        <hw-v4sr:preference>100</hw-v4sr:preference>
                        <hw-v4sr:description>default-routing-instance</hw-v4sr:description>
                      </hw-v4sr:ipv4-address-nexthop>
                    </v4ur:next-hop>
                  </v4ur:route>
                </v4ur:ipv4>
              </rt:static-routes>
            </rt:routing-protocol>
          </rt:routing-protocols>
        </rt:routing-instance>
      </rt:routing>
	</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="1">
  <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="1">
  <rpc-error>
    <error-app-tag>1</error-app-tag>
    <error-message>Service process failed.</error-message>
    <error-info>Error on node /ietf-routing:routing/routing-instance[name="default-routing-instance"]/routing-protocols/routing-protocol[type="static",name="default-routing-instance"]/static-routes/ietf-ipv4-unicast-routing:ipv4/route[destination-prefix="10.1.1.1/24"]/next-hop/huawei-ipv4-static-route:ipv4-address-nexthop[next-hop-address="192.168.10.1"]</error-info>
  </rpc-error>
</rpc-reply>
Translation
简体中文
Download
Updated: 2022-05-25

Document ID: EDOC1100126887

Views: 58042

Downloads: 27

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 :