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).
Query a BFD Bundle Session

Query a BFD Bundle Session

Operation

URI

Description

GET

/bfd/bfdBundleSessions/bfdBundleSession

Query a BFD bundle session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <bfdBundleSession> 
         <sessName></sessName> 
         <localDiscr></localDiscr> 
         <remoteDiscr></remoteDiscr> 
         <mainSubRole></mainSubRole> 
         <sessState></sessState> 
         <detectMode></detectMode> 
         <createType></createType> 
         <linkType></linkType> 
         <destAddr></destAddr> 
         <srcAddr></srcAddr> 
         <fsmBoardStr></fsmBoardStr> 
         <tosExp></tosExp> 
         <minTxInt></minTxInt> 
         <minRxInt></minRxInt> 
         <detectMul></detectMul> 
         <actTxInt></actTxInt> 
         <actRxInt></actRxInt> 
         <actDetectMul></actDetectMul> 
         <detectTime></detectTime> 
         <destPort></destPort> 
         <wtrTimerInt></wtrTimerInt> 
         <localDiag></localDiag> 
         <bindApps></bindApps> 
         <subSessCount></subSessCount> 
         <outIfName></outIfName> 
         <bundleMode></bundleMode> 
         <vrfName></vrfName> 
         <dispSessType></dispSessType>  
    </bfdBundleSession>

    Table 3-648 describes elements in requests.

    Table 3-648  Elements

    Element

    Description

    sessName

    Specifies a BFD session name.

    createType

    Specifies the creation mode of a BFD session.

    localDiscr

    Specifies the local identifier of a BFD session.

    remoteDiscr

    Specifies the remote identifier of a BFD session.

    linkType

    Specifies the link type of a BFD session.

    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.

    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.

    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.

    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.

    detectMult

    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, in milliseconds. If the WTR time is 0, the system does not wait for a BFD session to restore.

    tosExp

    Specifies the packet priority. The value is an integer ranging from 0 to 7. The default value is 7, indicating the highest priority.

    bindApps

    Specifies information about an application bound to a BFD session.

    fsmBoardStr

    Specifies the number of a selected board.

    mainSubRole

    Specifies the session role.

    sessState

    Specifies the session status.

    destPort

    Specifies the destination port number of UDP packets for a BFD session.

    detectMode

    Specifies the actual detection mode of a BFD session.

    actTxInt

    Specifies the actual interval at which BFD packets are sent.

    actRxInt

    Specifies the actual interval at which BFD packets are received.

    actDetectMul

    Specifies the actual detection multiplier of a BFD session.

    detectTime

    Specifies the detection interval in asynchronous mode.

    localDiag

    Specifies the reason that a BFD session last went Down.

    subSessCount

    Specifies the number of sub-sessions.

    bundleMode

    Specifies the link-bundle session mode.

    dispSessType

    Specifies the session type.

    mainSessName

    Specifies the main session name.

  • Response example (XML format)
    <bfdBundleSession> 
        <sessName><A/sessName> 
        <localDiscr>1048576</localDiscr> 
        <remoteDiscr>0</remoteDiscr> 
        <destAddr>2.2.2.1</destAddr> 
        <srcAddr>2.2.2.1</srcAddr> 
        <detectMode>ASYNC_WITHOUT_ECHO</detectMode> 
        <sessState>DOWN</sessState> 
        <createType>SESS_AUTO</createType> 
        <linkType>IP</linkType> 
        <fsmBoardStr>-</fsmBoardStr> 
        <tosExp>7</tosExp> 
        <minTxInt>1000</minTxInt> 
        <minRxInt>1000</minRxInt> 
        <detectMul>3</detectMul> 
        <actTxInt>0</actTxInt> 
        <actRxInt>0</actRxInt> 
        <actDetectMul>0</actDetectMul> 
        <detectTime>0</detectTime> 
        <destPort>6784</destPort> 
        <wtrTimerInt>0</wtrTimerInt> 
        <localDiag>NONE</localDiag> 
        <bindApps>AUTO</bindApps> 
        <subSessCount>0</subSessCount> 
        <outIfName>Eth-Trunk1</outIfName> 
        <mainSubRole>Bundle_Main</mainSubRole> 
        <bundleMode>Bundle_Standard</bundleMode> 
        <vrfName>-</vrfName> 
        <dispSessType>Link_Bundle</dispSessType> 
    </bfdBundleSession> 

    Table 3-649 describes elements in responses.

    Table 3-649  Elements

    Element

    Description

    sessName

    Specifies a BFD session name.

    createType

    Specifies the creation mode of a BFD session.

    localDiscr

    Specifies the local identifier of a BFD session.

    remoteDiscr

    Specifies the remote identifier of a BFD session.

    linkType

    Specifies the link type of a BFD session.

    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.

    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.

    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.

    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.

    detectMult

    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, in milliseconds. If the WTR time is 0, the system does not wait for a BFD session to restore.

    tosExp

    Specifies the packet priority. The value is an integer ranging from 0 to 7. The default value is 7, indicating the highest priority.

    bindApps

    Specifies information about an application bound to a BFD session.

    fsmBoardStr

    Specifies the number of a selected board.

    mainSubRole

    Specifies the session role.

    sessState

    Specifies the session status.

    destPort

    Specifies the destination port number of UDP packets for a BFD session.

    detectMode

    Specifies the actual detection mode of a BFD session.

    actTxInt

    Specifies the actual interval at which BFD packets are sent.

    actRxInt

    Specifies the actual interval at which BFD packets are received.

    actDetectMul

    Specifies the actual detection multiplier of a BFD session.

    detectTime

    Specifies the detection interval in asynchronous mode.

    localDiag

    Specifies the reason that a BFD session last went Down.

    subSessCount

    Specifies the number of sub-sessions.

    bundleMode

    Specifies the link-bundle session mode.

    dispSessType

    Specifies the session type.

    mainSessName

    Specifies the main session name.

    Table 3-650 describes status codes in responses.

    Table 3-650  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: 27773

Downloads: 123

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