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).
VRRP Backup Group

VRRP Backup Group

Configure a VRRP Backup Group

Query a VRRP Backup Group

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a VRRP backup group, including the ID of the VRRP backup group and the name of the interface on which the VRRP backup group resides.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId></vrrpId> 
          <ifName></ifName> 
          <vrrpType></vrrpType> 
          <adminIgnoreIfDown></adminIgnoreIfDown> 
          <unflowdown></unflowdown> 
          <adminVrrpId></adminVrrpId> 
          <adminIfName></adminIfName> 
          <lbrgVrrpId></lbrgVrrpId> 
          <state></state> 
          <priority></priority> 
          <runPriority></runPriority> 
          <masterPriority></masterPriority> 
          <masterIp></masterIp> 
          <createTime></createTime> 
          <lchangeTime></lchangeTime> 
          <advertiseInterval></advertiseInterval> 
          <runAdvertiseInterval></runAdvertiseInterval> 
          <preemptMode></preemptMode> 
          <delayTime></delayTime> 
          <remainTime></remainTime> 
          <authenticationMode></authenticationMode> 
          <isPlain></isPlain> 
          <authenticationKey></authenticationKey> 
          <linkBfdDownNum></linkBfdDownNum> 
          <virtualMac></virtualMac> 
          <fastResume></fastResume> 
          <v3SendMode></v3SendMode> 
    </vrrpGroup>

    Table 3-662 describes elements in requests.

    Table 3-662  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    unflowdown

    Specifies that the Flowdown function is disabled for a service VRRP backup group.

    adminVrrpId

    Specifies the ID of a bound mVRRP backup group.

    adminIfName

    Specifies the name of the interface on which a bound mVRRP backup group resides.

    lbrgVrrpId

    Specifies the ID of an LBRG.

    state

    Specifies the status of a VRRP backup group. When a VRRP backup group works properly, it has the following values:

    • Master
    • Backup
    • Initialize

    priority

    Specifies the priority configured for the router in the VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    runPriority

    Specifies the running priority (that is, the current priority) of the router in the VRRP backup group. If the router is an IP address owner, its running priority is displayed as 255.

    masterPriority

    Specifies the priority of the master router in the VRRP backup group.

    masterIp

    Specifies the IP address of the master router in the VRRP backup group.

    createTime

    Specifies the time when the VRRP backup group was created.

    lchangeTime

    Specifies the time when the status of the VRRP backup group last changed.

    advertiseInterval

    Specifies the configured interval at which VRRP packets are sent, in milliseconds.

    runAdvertiseInterval

    Specifies the running interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    isPlain

    Specifies whether the authentication key of the VRRP backup group is displayed as a plaintext. By default, the authentication key of the VRRP backup group is displayed as a ciphertext.

    authenticationKey

    Specifies the authentication key.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    virtualMac

    Specifies the virtual MAC address of the VRRP backup group.

    fastResume

    Specifies the fast switching mode of an mVRRP backup group.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpId>1</vrrpId> 
        <state>master</state> 
        <priority>100</priority> 
        <runPriority>100</runPriority> 
        <masterPriority>100</masterPriority> 
        <advertiseInterval>1000</advertiseInterval> 
        <runAdvertiseInterval>1000</runAdvertiseInterval> 
        <preemptMode>true</preemptMode> 
        <delayTime>0</delayTime> 
        <virtualMac>0000-5e00-0101</virtualMac> 
        <authenticationMode>none</authenticationMode> 
        <authenticationKey/> 
        <vrrpType>normal</vrrpType> 
        <adminVrrpId/> 
        <lbrgVrrpId/> 
        <adminIfName></adminIfName> 
        <adminIgnoreIfDown>false</adminIgnoreIfDown> 
        <linkBfdDownNum>0</linkBfdDownNum> 
        <isPlain>false</isPlain> 
        <unflowdown>false</unflowdown> 
        <masterIp>1.1.1.1</masterIp> 
        <remainTime>0</remainTime> 
        <createTime>2014-11-13T10:15:39</createTime> 
        <lchangeTime>2014-11-13T10:15:45</lchangeTime> 
        <fastResume>false</fastResume> 
        <v3SendMode>v2-only</v3SendMode> 
    </vrrpGroup>

    Table 3-663 describes elements in responses.

    Table 3-663  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    unflowdown

    Specifies that the Flowdown function is disabled for a service VRRP backup group.

    adminVrrpId

    Specifies the ID of a bound mVRRP backup group.

    adminIfName

    Specifies the name of the interface on which a bound mVRRP backup group resides.

    lbrgVrrpId

    Specifies the ID of an LBRG.

    state

    Specifies the status of a VRRP backup group. When a VRRP backup group works properly, it has the following values:

    • Master
    • Backup
    • Initialize

    priority

    Specifies the priority configured for the router in the VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    runPriority

    Specifies the running priority (that is, the current priority) of the router in the VRRP backup group. If the router is an IP address owner, its running priority is displayed as 255.

    masterPriority

    Specifies the priority of the master router in the VRRP backup group.

    masterIp

    Specifies the IP address of the master router in the VRRP backup group.

    createTime

    Specifies the time when the VRRP backup group was created.

    lchangeTime

    Specifies the time when the status of the VRRP backup group last changed.

    advertiseInterval

    Specifies the configured interval at which VRRP packets are sent, in milliseconds.

    runAdvertiseInterval

    Specifies the running interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    isPlain

    Specifies whether the authentication key of the VRRP backup group is displayed as a plaintext. By default, the authentication key of the VRRP backup group is displayed as a ciphertext.

    authenticationKey

    Specifies the authentication key.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    virtualMac

    Specifies the virtual MAC address of the VRRP backup group.

    fastResume

    Specifies the fast switching mode of an mVRRP backup group.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

Create a VRRP Backup Group

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Create a VRRP backup group, including the ID of the VRRP backup group and the name of the interface on which the VRRP backup group resides.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="create" > 
    <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpType>normal</vrrpType> 
        <priority>100</priority> 
        <advertiseInterval>1000</advertiseInterval> 
        <preemptMode>true</preemptMode> 
        <delayTime>0</delayTime> 
        <authenticationMode>none</authenticationMode> 
    <linkBfdDownNum>1</linkBfdDownNum>
        <v3SendMode>v2v3-both</v3SendMode> 
        <virtualIps> 
             <virtualIp operation="merge" > 
                  <virtualIpAddress>2.2.2.100</virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
    </vrrpGroup>

    Table 3-664 describes elements in requests.

    Table 3-664  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    priority

    Specifies a priority for a router in a VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    advertiseInterval

    Specifies an interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

    virtualIpAddress

    Specifies a virtual IP address.

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

    Table 3-665 describes status codes in responses.

    Table 3-665  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.

Modify a VRRP Backup Group

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify information about a VRRP backup group, including the type of the VRRP backup group and configured priority.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge" > 
        <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpType>admin</vrrpType> 
        <adminIgnoreIfDown>true</adminIgnoreIfDown> 
        <priority>130</priority> 
        <advertiseInterval>3000</advertiseInterval> 
        <delayTime>3</delayTime> 
        <linkBfdDownNum>1</linkBfdDownNum> 
        <v3SendMode>v3-only</v3SendMode> 
    </vrrpGroup>

    Table 3-666 describes elements in requests.

    Table 3-666  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    priority

    Specifies a priority for a router in a VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    advertiseInterval

    Specifies an interval at which VRRP packets are sent, in milliseconds.

    delayTime

    Specifies a preemption delay, in seconds.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

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

    Table 3-667 describes status codes in responses.

    Table 3-667  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.

Delete a VRRP Backup Group

Operation

URI

Description

DELETE

/vrrp/vrrpGroups/vrrpGroup

Delete a VRRP backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="delete"> 
        <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
    </vrrpGroup>

    Table 3-668 describes elements in requests.

    Table 3-668  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

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

    Table 3-669 describes status codes in responses.

    Table 3-669  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.

Virtual IP Address Configurations for a VRRP Backup Group

Query the Virtual IP Address of a VRRP Backup Group

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query configurations for a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <virtualIps> 
            <virtualIp> 
                <virtualIpAddress></virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
    </vrrpGroup>

    Table 3-670 Describes elements in requests.

    Table 3-670  Describes elements in requests.

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    virtualIpAddress

    Virtual Ip address.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <virtualIps> 
            <virtualIp> 
                <virtualIpAddress>1.1.1.100</virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
     </vrrpGroup>

    Table 3-671 Describes status codes in responses.

    Table 3-671  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    virtualIpAddress

    Virtual Ip address.

Assign a Virtual IP Address to a VRRP Backup Group

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge" > 
        <vrrpId>1</vrrpId> 
         <ifName>10GE1/0/1</ifName> 
         <virtualIps> 
            <virtualIp operation="create" > 
                <virtualIpAddress>1.1.1.100</virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
    </vrrpGroup>

    Table 3-672 Describes elements in requests.

    Table 3-672  Describes elements in requests.

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    virtualIpAddress

    Virtual Ip address.

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

    Table 3-673 Describes status codes in responses.

    Table 3-673  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.

Delete the Virtual IP Address of a VRRP Backup Group

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete configurations for a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <virtualIps> 
            <virtualIp operation="delete"> 
                <virtualIpAddress>1.1.1.100</virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
    </vrrpGroup>

    Table 3-674 Describes elements in requests.

    Table 3-674  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    virtualIpAddress

    Virtual Ip address.

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

    Table 3-675 Describes status codes in responses.

    Table 3-675  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.

Configurations for a VRRP Backup Group to Track an Interface

Query Configurations for a VRRP Backup Group to Track an Interface

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query configurations for a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIntfs> 
            <vrrpTrackIntf> 
                <trackIfName></trackIfName> 
                <trackMode></trackMode> 
                <priorityChange></priorityChange> 
            </vrrpTrackIntf> 
        </vrrpTrackIntfs> 
     </vrrpGroup>

    Table 3-676 describes elements in requests.

    Table 3-676  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    trackIfName

    Specifies the name of an interface tracked by a VRRP backup group.

    trackMode

    Specifies the tracking mode.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <vrrpTrackIntfs> 
            <vrrpTrackIntf> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange> 
                <trackIfName>10GE1/0/2</trackIfName> 
            </vrrpTrackIntf> 
        </vrrpTrackIntfs> 
     </vrrpGroup>     

    Table 3-677 describes elements in responses.

    Table 3-677  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    trackIfName

    Specifies the name of an interface tracked by a VRRP backup group.

    trackMode

    Specifies the tracking mode.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

Configure a VRRP Backup Group to Track an Interface

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIntfs> 
            <vrrpTrackIntf operation="create"> 
                <trackIfName>10GE1/0/2</trackIfName> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange>  
            </vrrpTrackIntf>        
        </vrrpTrackIntfs> 
     </vrrpGroup>

    Table 3-678 describes elements in requests.

    Table 3-678  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    trackIfName

    Specifies the name of an interface tracked by a VRRP backup group.

    trackMode

    Specifies the tracking mode.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-679 describes status codes in responses.

    Table 3-679  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.

Modify Configurations for a VRRP Backup Group to Track an Interface

Operation

URL

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify configurations for a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIntfs> 
            <vrrpTrackIntf operation="merge"> 
                <trackIfName>10GE1/0/2</trackIfName> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange>  
            </vrrpTrackIntf>        
        </vrrpTrackIntfs> 
    </vrrpGroup>

    Table 3-680 describes elements in requests.

    Table 3-680  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    trackIfName

    Specifies the name of an interface tracked by a VRRP backup group.

    trackMode

    Specifies the tracking mode.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-681 describes status codes in responses.

    Table 3-681  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.

Delete Configurations for a VRRP Backup Group to Track an Interface

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete configurations for a VRRP backup group to track an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup>
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIntfs> 
            <vrrpTrackIntf operation="delete"> 
                <trackIfName>10GE1/0/2</trackIfName> 
            </vrrpTrackIntf>        
        </vrrpTrackIntfs> 
    </vrrpGroup>

    Table 3-682 describes elements in requests.

    Table 3-682  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    trackIfName

    Specifies the name of an interface tracked by a VRRP backup group.

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

    Table 3-683 describes status codes in responses.

    Table 3-683  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.

Querying a Service VRRP Backup Group

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a service VRRP backup group bound to an mVRRP backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <memberVrrps> 
            <memberVrrp> 
                <vrrpId></vrrpId> 
                <ifName></ifName> 
                <state></state> 
            </memberVrrp> 
            </memberVrrps> 
    </vrrpGroup>

    Table 3-684 describes elements in requests.

    Table 3-684  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    state

    Specifies the status of a VRRP backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <memberVrrps> 
            <memberVrrp> 
                <ifName>10GE1/0/2</ifName> 
                <vrrpId>2</vrrpId> 
                <state>initialize</state> 
            </memberVrrp> 
        </memberVrrps> 
    </vrrpGroup>

    Table 3-685 describes elements in responses.

    Table 3-685  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    state

    Specifies the status of a VRRP backup group.

Querying a Member VRRP Backup Group Bound to an LBRG

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a member VRRP backup group bound to an LBRG.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <lbrgmemVrrps> 
            <lbrgmemVrrp> 
                <vrrpId></vrrpId> 
                <state></state> 
            </lbrgmemVrrp> 
        </lbrgmemVrrps> 
    </vrrpGroup>

    Table 3-686 describes elements in requests.

    Table 3-686  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    state

    Specifies the status of a VRRP backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <lbrgmemVrrps> 
            <lbrgmemVrrp> 
                <vrrpId>2</vrrpId> 
                <state>initialize</state> 
            </lbrgmemVrrp> 
        </lbrgmemVrrps> 
    </vrrpGroup>

    Table 3-687 describes elements in responses.

    Table 3-687  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    state

    Specifies the status of a VRRP backup group.

Configurations for a VRRP Backup Group to Track an IP Route

Query Configurations for a VRRP Backup Group to Track an IP Route

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query configurations for a VRRP backup group to track an IP route.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIpRoutings> 
            <vrrpTrackIpRouting> 
                <vpnName></vpnName> 
                <ipAddress></ipAddress> 
                <ipMask></ipMask> 
                <priorityChange></priorityChange> 
            </vrrpTrackIpRouting> 
        </vrrpTrackIpRoutings> 
     </vrrpGroup>     

    Table 3-688 describes elements in requests.

    Table 3-688  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vpnName

    Specifies the name of the VPN instance to which a tracked IP route belongs.

    ipAddress

    Specifies the IP address of a tracked IP route.

    ipMask

    Specifies the IP address mask of a tracked IP route.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <vrrpTrackIpRoutings> 
            <vrrpTrackIpRouting> 
                <ipAddress>1.1.1.100</ipAddress> 
                <ipMask>255.0.0.0</ipMask> 
                <vpnName>_public_</vpnName> 
                <priorityChange>20</priorityChange> 
            </vrrpTrackIpRouting> 
        </vrrpTrackIpRoutings> 
     </vrrpGroup>

    Table 3-689 describes elements in responses.

    Table 3-689  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vpnName

    Specifies the name of the VPN instance to which a tracked IP route belongs.

    ipAddress

    Specifies the IP address of a tracked IP route.

    ipMask

    Specifies the IP address mask of a tracked IP route.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

Configure a VRRP Backup Group to Track an IP Route

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track an IP route.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIpRoutings> 
            <vrrpTrackIpRouting operation="create"> 
                <vpnName>_public_</vpnName> 
                <ipAddress>1.1.1.100</ipAddress> 
                <ipMask>255.0.0.0</ipMask> 
                <priorityChange>20</priorityChange> 
            </vrrpTrackIpRouting> 
        </vrrpTrackIpRoutings> 
    </vrrpGroup>

    Table 3-690 describes elements in requests.

    Table 3-690  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vpnName

    Specifies the name of the VPN instance to which a tracked IP route belongs.

    ipAddress

    Specifies the IP address of a tracked IP route.

    ipMask

    Specifies the IP address mask of a tracked IP route.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-691 describes status codes in responses.

    Table 3-691  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.

Modify Configurations for a VRRP Backup Group to Track an IP Route

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify configurations for a VRRP backup group to track an IP route.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIpRoutings> 
            <vrrpTrackIpRouting operation="merge"> 
                <vpnName>_public_</vpnName> 
                <ipAddress>1.1.1.100</ipAddress> 
                <ipMask>255.0.0.0</ipMask> 
                <priorityChange>30</priorityChange> 
            </vrrpTrackIpRouting> 
        </vrrpTrackIpRoutings> 
    </vrrpGroup>

    Table 3-692 describes elements in requests.

    Table 3-692  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vpnName

    Specifies the name of the VPN instance to which a tracked IP route belongs.

    ipAddress

    Specifies the IP address of a tracked IP route.

    ipMask

    Specifies the IP address mask of a tracked IP route.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-693 describes status codes in responses.

    Table 3-693  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.

Delete Configurations for a VRRP Backup Group to Track an IP Route

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete configurations for a VRRP backup group to track an IP route.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackIpRoutings> 
            <vrrpTrackIpRouting operation="delete"> 
                <vpnName>_public_</vpnName> 
                <ipAddress>1.1.1.100</ipAddress> 
                <ipMask>255.0.0.0</ipMask> 
            </vrrpTrackIpRouting> 
        </vrrpTrackIpRoutings> 
    </vrrpGroup>

    Table 3-694 describes elements in requests.

    Table 3-694  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    vpnName

    Specifies the name of the VPN instance to which a tracked IP route belongs.

    ipAddress

    Specifies the IP address of a tracked IP route.

    ipMask

    Specifies the IP address mask of a tracked IP route.

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

    Table 3-695 describes status codes in responses.

    Table 3-695  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.

Configurations for a VRRP Backup Group to Track a Dynamic BFD Session

Configurations for a VRRP Backup Group to Track a Dynamic BFD Session

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query configurations for a VRRP backup group to track a dynamic BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
          <vrrpId>1</vrrpId> 
          <ifName>10GE1/0/1</ifName> 
          <vrrpBfds> 
                <vrrpBfd> 
                      <destAddr></destAddr> 
                      <minTxInterval></minTxInterval> 
                      <minRxInterval></minRxInterval> 
                      <detectMultiplier></detectMultiplier> 
                </vrrpBfd> 
          </vrrpBfds> 
     </vrrpGroup>

    Table 3-696 describes elements in requests.

    Table 3-696  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    destAddr

    Specifies the destination IP address of a tracked dynamic BFD session.

    minTxInterval

    Specifies the minimum interval at which the local device sends BFD control packets.

    minRxInterval

    Specifies the minimum interval at which the local device receives BFD control packets.

    detectMultiplier

    Specifies the detection multiplier of a tracked dynamic BFD session.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
          <vrrpId>1</vrrpId> 
          <vrrpBfds> 
                <vrrpBfd> 
                      <destAddr>100.1.1.2</destAddr> 
                      <minTxInterval>300</minTxInterval> 
                      <minRxInterval>300</minRxInterval> 
                      <detectMultiplier>3</detectMultiplier> 
                </vrrpBfd> 
          </vrrpBfds> 
     </vrrpGroup>

    Table 3-697 describes elements in responses.

    Table 3-697  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    destAddr

    Specifies the destination IP address of a tracked dynamic BFD session.

    minTxInterval

    Specifies the minimum interval at which the local device sends BFD control packets.

    minRxInterval

    Specifies the minimum interval at which the local device receives BFD control packets.

    detectMultiplier

    Specifies the detection multiplier of a tracked dynamic BFD session.

Configure for a VRRP Backup Group to Track a Dynamic BFD Session

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track a dynamic BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup operation="merge"> 
          <vrrpId>1</vrrpId> 
          <ifName>10GE1/0/1</ifName> 
          <vrrpBfds> 
                <vrrpBfd operation="create"> 
                      <destAddr>100.1.1.2</destAddr> 
                      <minTxInterval>300</minTxInterval> 
                      <minRxInterval>300</minRxInterval> 
                      <detectMultiplier>3</detectMultiplier> 
                </vrrpBfd> 
          </vrrpBfds> 
     </vrrpGroup>

    Table 3-698 describes elements in requests.

    Table 3-698  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    destAddr

    Specifies the destination IP address of a tracked dynamic BFD session.

    minTxInterval

    Specifies the minimum interval at which the local device sends BFD control packets.

    minRxInterval

    Specifies the minimum interval at which the local device receives BFD control packets.

    detectMultiplier

    Specifies the detection multiplier of a tracked dynamic BFD session.

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

    Table 3-699 describes status codes in responses.

    Table 3-699  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.

Modify Configurations for a VRRP Backup Group to Track a Dynamic BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify configurations for a VRRP backup group to track a dynamic BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
          <vrrpId>1</vrrpId> 
          <ifName>10GE1/0/1</ifName> 
          <vrrpBfds> 
                <vrrpBfd operation="merge"> 
                      <destAddr>100.1.1.2</destAddr> 
                      <minTxInterval>400</minTxInterval> 
                      <minRxInterval>400</minRxInterval> 
                      <detectMultiplier>4</detectMultiplier> 
                </vrrpBfd> 
          </vrrpBfds> 
     </vrrpGroup>

    Table 3-700 describes elements in requests.

    Table 3-700  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    destAddr

    Specifies the destination IP address of a tracked dynamic BFD session.

    minTxInterval

    Specifies the minimum interval at which the local device sends BFD control packets.

    minRxInterval

    Specifies the minimum interval at which the local device receives BFD control packets.

    detectMultiplier

    Specifies the detection multiplier of a tracked dynamic BFD session.

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

    Table 3-701 describes status codes in responses.

    Table 3-701  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.

Delete Configurations for a VRRP Backup Group to Track a Dynamic BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete configurations for a VRRP backup group to track a dynamic BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
          <vrrpId>1</vrrpId> 
          <ifName>10GE1/0/1</ifName> 
          <vrrpBfds> 
                <vrrpBfd operation="delete"> 
                      <destAddr>100.1.1.2</destAddr> 
                </vrrpBfd> 
          </vrrpBfds> 
     </vrrpGroup>

    Table 3-702 describes elements in requests.

    Table 3-702  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    destAddr

    Specifies the destination IP address of a tracked dynamic BFD session.

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

    Table 3-703 describes status codes in responses.

    Table 3-703  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.

Configurations for a VRRP Backup Group to Track NQA

Query Configurations for a VRRP Backup Group to Track NQA

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query configurations for a VRRP backup group to track NQA.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
            <vrrpId>1</vrrpId> 
            <ifName>10GE1/0/1</ifName> 
            <vrrpTrackNqas> 
                   <vrrpTrackNqa> 
                         <adminName></adminName> 
                         <testName></testName> 
                         <priorityChange></priorityChange> 
                   </vrrpTrackNqa> 
            </vrrpTrackNqas> 
     </vrrpGroup>

    Table 3-704 describes elements in requests.

    Table 3-704  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    adminName

    Specifies the name of a tracked NQA management group.

    testName

    Specifies the name of a tracked NQA test instance.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
            <vrrpId>1</vrrpId> 
            <vrrpTrackNqas> 
                   <vrrpTrackNqa> 
                         <adminName>admin</adminName> 
                         <testName>test1</testName> 
                         <priorityChange>20</priorityChange> 
                   </vrrpTrackNqa> 
            </vrrpTrackNqas> 
     </vrrpGroup>

    Table 3-705 describes elements in responses.

    Table 3-705  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    adminName

    Specifies the name of a tracked NQA management group.

    testName

    Specifies the name of a tracked NQA test instance.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

Configure a VRRP Backup Group to Track NQA

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track NQA.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup operation="merge"> 
            <vrrpId>1</vrrpId> 
            <ifName>10GE1/0/1</ifName> 
            <vrrpTrackNqas> 
                   <vrrpTrackNqa operation="create"> 
                         <adminName>admin</adminName> 
                         <testName>test1</testName> 
                         <priorityChange>20</priorityChange> 
                   </vrrpTrackNqa> 
            </vrrpTrackNqas> 
     </vrrpGroup>

    Table 3-706 describes elements in requests.

    Table 3-706  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    adminName

    Specifies the name of a tracked NQA management group.

    testName

    Specifies the name of a tracked NQA test instance.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-707 describes status codes in responses.

    Table 3-707  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.

Modify Configurations for a VRRP Backup Group to Track NQA

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify configurations for a VRRP backup group to track NQA.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
            <vrrpId>1</vrrpId> 
            <ifName>10GE1/0/1</ifName> 
            <vrrpTrackNqas> 
                   <vrrpTrackNqa operation="merge"> 
                         <adminName>admin</adminName> 
                         <testName>test1</testName> 
                         <priorityChange>20</priorityChange> 
                   </vrrpTrackNqa> 
            </vrrpTrackNqas> 
     </vrrpGroup>

    Table 3-708 describes elements in requests.

    Table 3-708  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    adminName

    Specifies the name of a tracked NQA management group.

    testName

    Specifies the name of a tracked NQA test instance.

    priorityChange

    Specifies the number by which the priority is increased or decreased.

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

    Table 3-709 describes status codes in responses.

    Table 3-709  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.

Delete Configurations for a VRRP Backup Group to Track NQA

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete configurations for a VRRP backup group to track NQA.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
            <vrrpId>1</vrrpId> 
            <ifName>10GE1/0/1</ifName> 
            <vrrpTrackNqas> 
                   <vrrpTrackNqa operation="delete"> 
                         <adminName>admin</adminName> 
                         <testName>test1</testName> 
                   </vrrpTrackNqa> 
            </vrrpTrackNqas> 
     </vrrpGroup>

    Table 3-710 describes elements in requests.

    Table 3-710  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    adminName

    Specifies the name of a tracked NQA management group.

    testName

    Specifies the name of a tracked NQA test instance.

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

    Table 3-711 describes status codes in responses.

    Table 3-711  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.

Querying the Status Change Track of a VRRP Backup Group

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query the status change track of a VRRP backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
             <vrrpId>1</vrrpId> 
             <ifName>10GE1/0/1</ifName> 
             <stateChanges> 
                  <stateChange> 
                         <index></index> 
                         <sourceState></sourceState> 
                         <destState></destState> 
                         <changeReason></changeReason> 
                         <changeTime></changeTime> 
                  </stateChange> 
             </stateChanges> 
     </vrrpGroup>

    Table 3-712 describes elements in requests.

    Table 3-712  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    index

    Specifies the sequence number.

    sourceState

    Specifies the source status.

    destState

    Specifies the destination status.

    changeReason

    Specifies the status change reason.

    changeTime

    Specifies the status change time.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
           <vrrpId>1</vrrpId> 
           <stateChanges> 
                 <stateChange> 
                     <sourceState>Backup</sourceState> 
                     <destState>Master</destState> 
                     <changeReason>Protocol timer expired</changeReason> 
                     <changeTime>2014-11-13T19:35:25</changeTime> 
                     <index>1</index> 
                 </stateChange> 
     </stateChanges> 
     </vrrpGroup>

    Table 3-713 describes elements in responses.

    Table 3-713  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    index

    Specifies the sequence number.

    sourceState

    Specifies the source status.

    destState

    Specifies the destination status.

    changeReason

    Specifies the status change reason.

    changeTime

    Specifies the status change time.

Query VRRP Packet Statistics

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query VRRP packet statistics.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
           <vrrpId>1</vrrpId> 
           <ifName>10GE1/0/1</ifName> 
           <vrrpStatistics> 
                     <brcomeMaster></brcomeMaster> 
                     <sendAdvertisement></sendAdvertisement> 
                     <receiveAdvertisement></receiveAdvertisement> 
                     <advertiseIntervalErrors></advertiseIntervalErrors> 
                     <authenticationFailures></authenticationFailures> 
                     <ipTtlErrors></ipTtlErrors> 
                     <receivePriorityZero></receivePriorityZero> 
                     <sendPriorityZero></sendPriorityZero> 
                     <invalidTypePackets></invalidTypePackets> 
                     <addressListErrors></addressListErrors> 
                     <invalidAuthenticationType></invalidAuthenticationType> 
                     <authenticationTypeMismatch></authenticationTypeMismatch> 
                     <packetLengthErrors></packetLengthErrors> 
                     <receiveSelfSend></receiveSelfSend> 
            </vrrpStatistics> 
     </vrrpGroup>

    Table 3-714 describes elements in requests.

    Table 3-714  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    brcomeMaster

    Specifies the number of times that a router switches to the Master state.

    sendAdvertisement

    Specifies the number of sent VRRP advertisement packets.

    receiveAdvertisement

    Specifies the number of received VRRP advertisement packets.

    advertiseIntervalErrors

    Specifies the number of VRRP Advertisement packets with an incorrect interval.

    authenticationFailures

    Specifies the number of VRRP Advertisement packets that fail to be authenticated.

    ipTtlErrors

    Specifies the number of VRRP Advertisement packets with a TTL value that is not equal to 255.

    receivePriorityZero

    Specifies the number of received VRRP Advertisement packets with a priority of 0.

    sendPriorityZero

    Specifies the number of sent VRRP Advertisement packets with a priority of 0.

    invalidTypePackets

    Specifies the number of VRRP Advertisement packets with an invalid Type field.

    addressListErrors

    Specifies the number of VRRP Advertisement packets with an incorrect address list.

    invalidAuthenticationType

    Specifies the number of VRRP Advertisement packets with an invalid authentication type.

    authenticationTypeMismatch

    Specifies the number of VRRP Advertisement packets with a mismatching authentication type.

    packetLengthErrors

    Specifies the number of VRRP Advertisement packets with incorrect length.

    receiveSelfSend

    Specifies the number of VRRP Advertisement packets received from itself.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <vrrpGroup> 
           <ifName>10GE1/0/1</ifName> 
           <vrrpId>1</vrrpId> 
           <vrrpStatistics> 
                 <brcomeMaster>2</brcomeMaster> 
                 <sendAdvertisement>42317</sendAdvertisement> 
                 <receiveAdvertisement>42315</receiveAdvertisement> 
                 <advertiseIntervalErrors>0</advertiseIntervalErrors> 
                 <packetLengthErrors>0</packetLengthErrors> 
                 <ipTtlErrors>0</ipTtlErrors> 
                 <invalidTypePackets>0</invalidTypePackets> 
                 <addressListErrors>0</addressListErrors> 
                 <authenticationTypeMismatch>0</authenticationTypeMismatch> 
                 <invalidAuthenticationType>0</invalidAuthenticationType> 
                 <authenticationFailures>0</authenticationFailures> 
                 <receivePriorityZero>0</receivePriorityZero> 
                 <sendPriorityZero>2</sendPriorityZero> 
                 <receiveSelfSend>42315</receiveSelfSend> 
           </vrrpStatistics> 
     </vrrpGroup>

    Table 3-715 describes elements in responses.

    Table 3-715  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group resides.

    brcomeMaster

    Specifies the number of times that a router switches to the Master state.

    sendAdvertisement

    Specifies the number of sent VRRP advertisement packets.

    receiveAdvertisement

    Specifies the number of received VRRP advertisement packets.

    advertiseIntervalErrors

    Specifies the number of VRRP Advertisement packets with an incorrect interval.

    authenticationFailures

    Specifies the number of VRRP Advertisement packets that fail to be authenticated.

    ipTtlErrors

    Specifies the number of VRRP Advertisement packets with a TTL value that is not equal to 255.

    receivePriorityZero

    Specifies the number of received VRRP Advertisement packets with a priority of 0.

    sendPriorityZero

    Specifies the number of sent VRRP Advertisement packets with a priority of 0.

    invalidTypePackets

    Specifies the number of VRRP Advertisement packets with an invalid Type field.

    addressListErrors

    Specifies the number of VRRP Advertisement packets with an incorrect address list.

    invalidAuthenticationType

    Specifies the number of VRRP Advertisement packets with an invalid authentication type.

    authenticationTypeMismatch

    Specifies the number of VRRP Advertisement packets with a mismatching authentication type.

    packetLengthErrors

    Specifies the number of VRRP Advertisement packets with incorrect length.

    receiveSelfSend

    Specifies the number of VRRP Advertisement packets received from itself.

Configurations for a VRRP Backup Group to Track a BFD Session

Query Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdSessionId></bfdSessionId> 
                <bfdType>normal</bfdType> 
                <trackMode></trackMode> 
                <priorityChange></priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 1 describes elements in requests.

    Table 3-716  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdSessionId

    Specifies the ID of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session..

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd> 
                <bfdSessionId>1</bfdSessionId> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange> 
                <bfdType>normal</bfdType> 
                <bfdSessionName>trackbfd</bfdSessionName> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 2 describes elements in responses.

    Table 3-717  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdSessionId

    Specifies the ID of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

Configure a VRRP Backup Group to Track a BFD Session

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="create"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 3 describes elements in requests.

    Table 3-718  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

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

    Table 4 describes status codes in responses.

    Table 3-719  Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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.

Modify Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="merge"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
                <trackMode>increase</trackMode> 
                <priorityChange>20</priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 5 describes elements in requests.

    Table 3-720  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

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

    Table 6 describes status codes in responses.

    Table 3-721  Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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.

Delete Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="delete"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 7 describes elements in requests.

    Table 3-722  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

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

    Table 8 describes status codes in responses.

    Table 3-723  Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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: 30131

Downloads: 127

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