No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

RESTful API Reference

CloudEngine 8800, 7800, 6800, and 5800 V200R002C50

This document describes the OPS APIs supported by the device, including OPS-supported operations, request examples, elements in the requests, response examples, elements in the responses, and response status codes.
Rate and give feedback:
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).
Create a BFD Session

Create a BFD Session

Operation

URI

Description

POST

/bfd/bfdCfgSessions/bfdCfgSession

Create a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <bfdCfgSession operation="create"> 
    <sessName>2</sessName> 
    	<localDiscr>20</localDiscr>
    	<remoteDiscr>20</remoteDiscr>
    	<minTxInt>10</minTxInt>
    	<minRxInt>10</minRxInt>
    	<detectMulti>3</detectMulti>
    	<tosExp>7</tosExp>
    	<adminDown>false</adminDown>
    	<destAddr>10.1.1.2</destAddr>
    	<linkType>IP</linkType>
    	<createType>SESS_STATIC</createType>
    	<teBackup>false</teBackup>
    	<outIfName></outIfName>
    	<processPst>false</processPst>
    	<pis>false</pis>
    	<pisSubIf>false</pisSubIf>
    	<useDefaultIp>false</useDefaultIp>
    	<addrType>IPV4</addrType>
    	<pwSecondary>false</pwSecondary>
    	<isSetTrackIf>false</isSetTrackIf>
    	<oneArmEcho>false</oneArmEcho>
    	<bundleMode>-</bundleMode>
    	<pisNoImpact>false</pisNoImpact>
    	<isGroup>false</isGroup> 
     </bfdCfgSession>

    Table 3-639 describes elements in requests.

    Table 3-639  Elements

    Element

    Description

    sessName

    Specifies a BFD session name, which uniquely identifies a session.

    createType

    Specifies a BFD session creation mode. Only static BFD sessions or static BFD sessions with automatically negotiated discriminators can be manually created.

    localDiscr

    Specifies the local discriminator of a BFD session. This element does not need to be configured when static BFD sessions with automatically negotiated discriminators are created.

    NOTE:

    The local discriminator at the local end must be the same as the remote discriminator at the remote end.

    remoteDiscr

    Specifies the remote discriminator of a BFD session. This element does not need to be configured when static BFD sessions with automatically negotiated discriminators are created.

    NOTE:

    The remote discriminator at the local end must be the same as the local discriminator at the remote end.

    linkType

    Type of a link detected by a BFD session. Select a correct link type as required. For example, if the BFD session is used to detect a TE tunnel, set Detected Link Type to TE Tunnel.

    addrType

    Specifies the type of an IP address.

    outIfName

    Specifies the name of an outbound interface for a BFD session. This element is configured when the link type is IP or LDP LSP. If only a destination IP address is specified, a multi-hop link is monitored. If both a destination IP address and outbound interface name are specified, a single-hop link is monitored. That is, a BFD session monitors a specific route in which the outbound interface is the specified interface and the next-hop address is the specified destination IP address.

    /destAddr

    Specifies the destination IP address of a BFD session. This element must be configured when the link type is IP or LDP LSP.

    srcAddr

    Specifies the source IP address of a BFD session. This element must be configured for static BFD sessions with automatically negotiated discriminators or can be configured when the link type is IP.

    NOTE:

    If the source IP address is specified and URPF is enabled, BFD packets can be correctly forwarded. The source IP address must be configured correctly because the system checks only the validity of the source IP address format. A multicast or broadcast address is invalid. After a BFD session is created, changing the IP address of the outbound interface for BFD packets does not change the source IP address carried in the BFD packets.

    vrfName

    Specifies the name of a VPN instance to which a BFD session belongs. If no VPN instance is specified, the destination IP address is regarded as a public IP address.

    tunnelName

    Specifies the name of a TE tunnel. This element must be configured when the link type is TE LSP or TE Tunnel.

    teBackup

    Specifies whether the LSP is the primary LSP. By default, the LSP is the primary LSP. This element can be configured when the link type is TE LSP.

    minTxInt

    Specifies the minimum interval at which BFD packets are sent, in milliseconds.

    minRxInt

    Specifies the minimum interval at which BFD packets are received, in milliseconds.

    detectMulti

    Specifies the number of times that the system fails to be responded after which the BFD session is considered Down. The detection multiplier is configured on the local and remote devices, and no negotiation is required.

    wtrTimerInt

    Specifies the WTR time. The configured unit is minutes, and the query unit is milliseconds. By default, the system does not wait for a BFD session to restore. After the WTR time is configured, the system reports an Up event to the application only after the specified WTR time elapses. Setting the WTR time prevents applications from switching between the master and backup devices if the BFD session flaps. If bidirectional BFD sessions are configured, set the same WTR time for the two BFD sessions.

    tosExp

    Specifies the packet priority. The value is an integer ranging from 0 to 7. The default value is 7, indicating the highest priority. The system preferentially transmits BFD packets with high priorities during congestion.

    adminDown

    Specifies whether a BFD session enters the administratively Down state. By default, this element is disabled. To terminate a BFD session, enable this element.

    NOTE:

    Setting the administratively Down state disables the BFD mechanism, which is a risky operation.

    Description

    Specifies the description of a BFD session.

    processPst

    Specifies whether session status changes trigger PST operations. This element can be configured for only one BFD session on each interface.

    Pis

    Specifies whether session status changes trigger PIS operations. This element can be configured for only one BFD session on each interface.

    pisSubIf

    Specifies whether BFD session status changes trigger PIS operations on an associated sub-interface. This element can be configured for only one BFD session on each interface.

    useDefaultIp

    Specifies that a BFD session uses a multicast address as the destination address of a sent packet. An outbound interface must be specified.

    perLink

    Specifies each member link.

    oneArmEcho

    Specifies one-arm echo.

    bundleMode

    Specifies the link-bundle session mode. "-" indicates a non-bundle mode; "standard bundle mode" indicates the RFC 7310 mode; "compatible bundle mode" indicates the vendor interworking mode.

    pisNoImpact

    Is or No impact on reboot.

    isGroup

    Session Group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply> 
        <ok/> 
    </rpc-reply>

    Table 3-640 describes status codes in responses.

    Table 3-640  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 31030

Downloads: 127

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next