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 12800 and 12800E V200R005C10

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).
Global VRRP Attributes

Global VRRP Attributes

Query Global VRRP Attributes

Operation

URI

Description

GET

/vrrp/vrrpGlobalCfg

Query global VRRP attributes, including the VRRP version and packet transmission mode.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGlobalCfg> 
        <gratuitousArpFlag></gratuitousArpFlag> 
        <gratuitousArpTimeOut></gratuitousArpTimeOut> 
        <advTimeLearnFlag></advTimeLearnFlag> 
        <pingEnable></pingEnable> 
        <recoverDelay></recoverDelay> 
        <vipRtAdvEnable></vipRtAdvEnable> 
        <vipOspfEnable></vipOspfEnable> 
        <vipIsisEnable></vipIsisEnable> 
        <vipRipEnable></vipRipEnable> 
        <version></version> 
        <v3SendMode></v3SendMode> 
        <v6CksmMode></v6CksmMode> 
        
    </vrrpGlobalCfg>

    Table 27-1 describes elements in requests.

    Table 27-1 Elements

    Element

    Description

    gratuitousArpFlag

    Specifies whether a device is enabled to send gratuitous ARP packets periodically. By default, a device is enabled to send gratuitous ARP packets periodically.

    gratuitousArpTimeOut

    Specifies the timeout period of gratuitous ARP packets, in seconds.

    advTimeLearnFlag

    Specifies whether packet interval learning is enabled.

    pingEnable

    Specifies whether the ping function for virtual IP addresses is enabled. By default, the ping function is enabled.

    recoverDelay

    Specifies the recovery delay, in seconds.

    vipRtAdvEnable

    Specifies whether a device is enabled to advertise dynamic routes with virtual IP addresses. By default, a device is enabled to advertise dynamic routes with virtual IP addresses.

    vipOspfEnable

    Specifies whether OSPF is enabled to advertise dynamic routes with virtual IP addresses. By default, OSPF is enabled to advertise dynamic routes with virtual IP addresses.

    vipIsisEnable

    Specifies whether IS-IS is enabled to advertise dynamic routes with virtual IP addresses. By default, IS-IS is enabled to advertise dynamic routes with virtual IP addresses.

    vipRipEnable

    Specifies whether RIP is enabled to advertise dynamic routes with virtual IP addresses. By default, RIP is enabled to advertise dynamic routes with virtual IP addresses.

    version

    Specifies the VRRP version. The default VRRP version is v2.

    v3SendMode

    Specifies the mode in which VRRP packets are sent globally.

    v6CksmMode

    Specifies the VRRP6 checksum mode.

    memberLbrgTimerHello

    Specifies the interval at which the master device in a load-balance redundancy group (LBRG) configured using a service VRRP backup group sends VRRP Advertisement packets, in seconds.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGlobalCfg> 
        <gratuitousArpTimeOut>120</gratuitousArpTimeOut> 
        <gratuitousArpFlag>true</gratuitousArpFlag> 
        <advTimeLearnFlag>true</advTimeLearnFlag> 
        <pingEnable>true</pingEnable> 
        <recoverDelay>0</recoverDelay> 
        <vipRtAdvEnable>true</vipRtAdvEnable> 
        <vipOspfEnable>true</vipOspfEnable> 
        <vipIsisEnable>true</vipIsisEnable> 
        <vipRipEnable>true</vipRipEnable> 
        <version>v3</version> 
        <v3SendMode>v3-only</v3SendMode> 
        <v6CksmMode>include-pseudo-header</v6CksmMode>
         
    </vrrpGlobalCfg>

    Table 27-2 describes elements in responses.

    Table 27-2 Elements

    Element

    Description

    gratuitousArpFlag

    Specifies whether a device is enabled to send gratuitous ARP packets periodically. By default, a device is enabled to send gratuitous ARP packets periodically.

    gratuitousArpTimeOut

    Specifies the timeout period of gratuitous ARP packets, in seconds.

    advTimeLearnFlag

    Specifies whether packet interval learning is enabled.

    pingEnable

    Specifies whether the ping function for virtual IP addresses is enabled. By default, the ping function is enabled.

    recoverDelay

    Specifies the recovery delay, in seconds.

    vipRtAdvEnable

    Specifies whether a device is enabled to advertise dynamic routes with virtual IP addresses. By default, a device is enabled to advertise dynamic routes with virtual IP addresses.

    vipOspfEnable

    Specifies whether OSPF is enabled to advertise dynamic routes with virtual IP addresses. By default, OSPF is enabled to advertise dynamic routes with virtual IP addresses.

    vipIsisEnable

    Specifies whether IS-IS is enabled to advertise dynamic routes with virtual IP addresses. By default, IS-IS is enabled to advertise dynamic routes with virtual IP addresses.

    vipRipEnable

    Specifies whether RIP is enabled to advertise dynamic routes with virtual IP addresses. By default, RIP is enabled to advertise dynamic routes with virtual IP addresses.

    version

    Specifies the VRRP version. The default VRRP version is v2.

    v3SendMode

    Specifies the mode in which VRRP packets are sent globally.

    v6CksmMode

    Specifies the VRRP6 checksum mode.

    memberLbrgTimerHello

    Specifies the interval at which the master device in a load-balance redundancy group (LBRG) configured using a service VRRP backup group sends VRRP Advertisement packets, in seconds.

Modify Global VRRP Attributes

Operation

URI

Description

PUT

/vrrp/vrrpGlobalCfg

Modify global VRRP attributes, including the VRRP version and packet transmission mode.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGlobalCfg> 
        <gratuitousArpFlag>true</gratuitousArpFlag> 
        <gratuitousArpTimeOut>130</gratuitousArpTimeOut> 
        <advTimeLearnFlag>true</advTimeLearnFlag> 
        <pingEnable>true</pingEnable> 
        <recoverDelay>2</recoverDelay> 
        <vipRtAdvEnable>false</vipRtAdvEnable> 
        <vipOspfEnable>false</vipOspfEnable> 
        <vipIsisEnable>false</vipIsisEnable> 
        <vipRipEnable>false</vipRipEnable> 
        <naFlag>true</naFlag> 
        <naTimeOut>130</naTimeOut> 
        <v3SendMode>v2v3-both</v3SendMode> 
        <v6CksmMode>exclude-pseudo-header</v6CksmMode> 
        <memberLbrgTimerHello>100</memberLbrgTimerHello> 
     </vrrpGlobalCfg>     

    Table 27-3 describes elements in requests.

    Table 27-3 Elements

    Element

    Description

    gratuitousArpFlag

    Specifies whether a device is enabled to send gratuitous ARP packets periodically. By default, a device is enabled to send gratuitous ARP packets periodically.

    gratuitousArpTimeOut

    Specifies the timeout period of gratuitous ARP packets, in seconds.

    advTimeLearnFlag

    Specifies whether packet interval learning is enabled.

    pingEnable

    Specifies whether the ping function for virtual IP addresses is enabled. By default, the ping function is enabled.

    recoverDelay

    Specifies the recovery delay, in seconds.

    vipRtAdvEnable

    Specifies whether a device is enabled to advertise dynamic routes with virtual IP addresses. By default, a device is enabled to advertise dynamic routes with virtual IP addresses.

    vipOspfEnable

    Specifies whether OSPF is enabled to advertise dynamic routes with virtual IP addresses. By default, OSPF is enabled to advertise dynamic routes with virtual IP addresses.

    vipIsisEnable

    Specifies whether IS-IS is enabled to advertise dynamic routes with virtual IP addresses. By default, IS-IS is enabled to advertise dynamic routes with virtual IP addresses.

    vipRipEnable

    Specifies whether RIP is enabled to advertise dynamic routes with virtual IP addresses. By default, RIP is enabled to advertise dynamic routes with virtual IP addresses.

    naFlag

    Specifies whether a device is enabled to periodically send unsolicited NA packets.

    naTimeOut

    Specifies the timeout period of unsolicited NA packets, in seconds.

    v3SendMode

    Specifies the mode in which VRRP packets are sent globally.

    v6CksmMode

    Specifies the VRRP6 checksum mode.

    memberLbrgTimerHello

    Specifies the interval at which the master device in a load-balance redundancy group (LBRG) configured using a service VRRP backup group sends VRRP Advertisement packets, in seconds.

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

    Table 27-4 describes status codes in responses.

    Table 27-4 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-04-03

Document ID: EDOC1100075372

Views: 10415

Downloads: 16

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