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

VRRP6 Backup Group

VRRP6 Backup Group Configurations

Query a VRRP6 Backup Group

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query information about a VRRP6 backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
                <vrrpId></vrrpId>
                <ifName></ifName>
                <vrrp6Type></vrrp6Type>
                <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>
                <virtualMac></virtualMac>
    </vrrp6Group>

    Table 3-732 describes elements in requests.

    Table 3-732  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    vrrp6Type

    Specifies the type of a VRRP6 backup group.

    adminIgnoreIfDown

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

    unflowdown

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

    adminVrrpId

    Specifies the ID of a bound mVRRP6 backup group.

    adminIfName

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

    lbrgVrrpId

    Specifies the ID of a VRRP6 LBRG.

    state

    Specifies the status of a VRRP6 backup group.

    priority

    Specifies the configured priority of the VRRP6 backup group.

    runPriority

    Specifies the running priority of the VRRP6 backup group.

    masterPriority

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

    masterIp

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

    createTime

    Specifies the time when the VRRP6 backup group was created.

    lchangeTime

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

    advertiseInterval

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

    runAdvertiseInterval

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

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay.

    virtualMac

    Specifies the virtual MAC address of the VRRP6 backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
              <ifName>10GE1/0/1</ifName>
              <vrrpId>1</vrrpId>
              <state>initialize</state>
              <priority>100</priority>
              <runPriority>100</runPriority>
              <masterPriority>0</masterPriority>
              <advertiseInterval>1000</advertiseInterval>
              <runAdvertiseInterval>1000</runAdvertiseInterval>
              <preemptMode>true</preemptMode>
              <delayTime>0</delayTime>
              <virtualMac>0000-5e00-0201</virtualMac>
              <vrrp6Type>normal</vrrp6Type>
              <adminVrrpId/>
              <lbrgVrrpId/>
              <adminIfName></adminIfName>
              <adminIgnoreIfDown>false</adminIgnoreIfDown>
              <unflowdown>false</unflowdown>
              <masterIp>::</masterIp>
              <remainTime>0</remainTime>
              <createTime>2014-11-14T11:00:23</createTime>
              <lchangeTime/>
    </vrrp6Group>

    Table 3-733 describes elements in responses.

    Table 3-733  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    vrrp6Type

    Specifies the type of a VRRP6 backup group.

    adminIgnoreIfDown

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

    unflowdown

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

    adminVrrpId

    Specifies the ID of a bound mVRRP6 backup group.

    adminIfName

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

    lbrgVrrpId

    Specifies the ID of a VRRP6 LBRG.

    state

    Specifies the status of a VRRP6 backup group.

    priority

    Specifies the configured priority of the VRRP6 backup group.

    runPriority

    Specifies the running priority of the VRRP6 backup group.

    masterPriority

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

    masterIp

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

    createTime

    Specifies the time when the VRRP6 backup group was created.

    lchangeTime

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

    advertiseInterval

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

    runAdvertiseInterval

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

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay.

    virtualMac

    Specifies the virtual MAC address of the VRRP6 backup group.

Create a VRRP6 Backup Group

Operation

URI

Description

POST

/vrrp/vrrp6Groups/vrrp6Group

Create a VRRP6 backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group operation="create">
                <vrrpId>3</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <vrrp6Type>normal</vrrp6Type>
                <priority>100</priority>
                <advertiseInterval>1000</advertiseInterval>
                <preemptMode>true</preemptMode>
                <delayTime>0</delayTime>
    </vrrp6Group>

    Table 3-734 describes elements in requests.

    Table 3-734  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    vrrp6Type

    Specifies the type of a VRRP6 backup group.

    priority

    Specifies a priority for a VRRP6 backup group.

    advertiseInterval

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

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

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

    Table 3-735 describes elements in responses.

    Table 3-735  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 VRRP6 Backup Group

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

Modify a VRRP6 backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group operation="merge">
                <vrrpId>1</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <vrrp6Type>admin</vrrp6Type>
                <adminIgnoreIfDown>true</adminIgnoreIfDown>
                <priority>120</priority>
                <advertiseInterval>2000</advertiseInterval>
                <delayTime>10</delayTime>
    </vrrp6Group>

    Table 3-736 describes elements in requests.

    Table 3-736  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    vrrp6Type

    Specifies the type of a VRRP6 backup group.

    adminIgnoreIfDown

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

    priority

    Specifies a priority for a VRRP6 backup group.

    advertiseInterval

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

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

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

    Table 3-737 describes status codes in responses.

    Table 3-737  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 VRRP6 Backup Group

Operation

URI

Description

DELETE

/vrrp/vrrp6Groups/vrrp6Group

Delete a VRRP6 backup group.

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

    Table 3-738 describes elements in requests.

    Table 3-738  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

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

    Table 3-739 describes status codes in responses.

    Table 3-739  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 VRRP6 Backup Group

Query the Virtual IP Address of a VRRP6 Backup Group

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query the virtual IP address of a VRRP6 backup group.

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

    Table 3-740 describes elements in requests.

    Table 3-740  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    virtualIpAddress

    Specifies the virtual IP address of a VRRP6 backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
           <ifName>10GE1/0/1</ifName>
           <vrrpId>1</vrrpId>
           <virtualIps>
              <virtualIp>
                   <virtualIpAddress>100:1::1:100</virtualIpAddress>
              </virtualIp>
              <virtualIp>
                   <virtualIpAddress>FE80::1</virtualIpAddress>
              </virtualIp>
           </virtualIps>
    </vrrp6Group>

    Table 3-741 describes elements in responses.

    Table 3-741  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    virtualIpAddress

    Specifies the virtual IP address of a VRRP6 backup group.

Assign a Virtual IP Address to a VRRP6 Backup Group

Operation

URI

Description

POST

/vrrp/vrrp6Groups/vrrp6Group

Assign a virtual IP address to a VRRP6 backup group.

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

    Table 3-742 describes elements in requests.

    Table 3-742  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    virtualIpAddress

    Specifies the virtual IP address of a VRRP6 backup group.

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

    Table 3-743 describes status codes in responses.

    Table 3-743  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 VRRP6 Backup Group

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

Delete the virtual IP address of a VRRP6 backup group.

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

    Table 3-744 describes elements in requests.

    Table 3-744  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    virtualIpAddress

    Specifies the virtual IP address of a VRRP6 backup group.

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

    Table 3-745 describes status codes in responses.

    Table 3-745  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 VRRP6 Backup Group to Track an Interface

Query Configurations for a VRRP6 Backup Group to Track an Interface

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

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

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

    Table 3-746 describes elements in requests.

    Table 3-746  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    trackIfName

    Specifies the name of a tracked interface.

    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"?>
    <vrrp6Group>
           <vrrpId>1</vrrpId>
           <ifName>10GE1/0/1</ifName>
           <vrrp6TrackIntfs>
                  <vrrp6TrackIntf>
                        <trackIfName>10GE1/0/2</trackIfName>
                        <trackMode>reduce</trackMode>
                        <priorityChange>10</priorityChange>
                  </vrrp6TrackIntf>
           </vrrp6TrackIntfs>
    </vrrp6Group>

    Table 3-747 describes elements in responses.

    Table 3-747  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    trackIfName

    Specifies the name of a tracked interface.

    trackMode

    Specifies the tracking mode.

    priorityChange

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

Configure a VRRP6 Backup Group to Track an Interface

Operation

URI

Description

POST

/vrrp/vrrp6Groups/vrrp6Group

Configure a VRRP6 backup group to track an interface.

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

    Table 3-748 describes elements in requests.

    Table 3-748  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    trackIfName

    Specifies the name of a tracked interface.

    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-749 describes status codes in responses.

    Table 3-749  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 VRRP6 Backup Group to Track an Interface

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

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

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

    Table 3-750 describes elements in requests.

    Table 3-750  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    trackIfName

    Specifies the name of a tracked interface.

    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-751 describes status codes in responses.

    Table 3-751  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 VRRP6 Backup Group to Track an Interface

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

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

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

    Table 3-752 describes elements in requests.

    Table 3-752  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    trackIfName

    Specifies the name of a tracked interface.

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

    Table 3-753 describes status codes in responses.

    Table 3-753  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 VRRP6 Backup Group

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query a service VRRP6 backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
                <vrrpId>1</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <memberVrrp6s>
                    <memberVrrp6>
                        <vrrpId></vrrpId>
                        <ifName></ifName>
                        <state></state>
                    </memberVrrp6>
                </memberVrrp6s>
    </vrrp6Group>

    Table 3-754 describes elements in requests.

    Table 3-754  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    state

    Specifies the status of a VRRP6 backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
                <vrrpId>1</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <memberVrrp6s>
                    <memberVrrp6>
                        <vrrpId>3</vrrpId>
                        <ifName>10GE1/0/2</ifName>
                        <state>master</state>
                    </memberVrrp6>
                </memberVrrp6s>
    </vrrp6Group>

    Table 3-755 describes elements in responses.

    Table 3-755  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    state

    Specifies the status of a VRRP6 backup group.

Querying a Member VRRP6 Backup Group Bound to an VRRP6 LBRG

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

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

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
                <vrrpId>1</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <lbrgmemVrrp6s>
                    <lbrgmemVrrp6>
                        <vrrpId></vrrpId>
                        <state></state>
                    </lbrgmemVrrp6>
                </lbrgmemVrrp6s>
    </vrrp6Group>

    Table 3-756 describes elements in requests.

    Table 3-756  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    state

    Specifies the status of a VRRP6 backup group.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
                <vrrpId>1</vrrpId>
                <ifName>10GE1/0/1</ifName>
                <lbrgmemVrrp6s>
                    <lbrgmemVrrp6>
                        <vrrpId>3</vrrpId>
                        <state>master</state>
                    </lbrgmemVrrp6>
                </lbrgmemVrrp6s>
    </vrrp6Group>

    Table 3-757 describes elements in responses.

    Table 3-757  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    state

    Specifies the status of a VRRP6 backup group.

Configurations for a VRRP6 Backup Group to Track a BFD Session

Query Configurations for a VRRP6 Backup Group to Track a BFD Session

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query configurations for a VRRP6 backup group to track a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
           <vrrpId>1</vrrpId>
           <ifName>10GE1/0/1</ifName>
           <vrrp6TrackBfds>
                <vrrp6TrackBfd>
                        <bfdSessionName></bfdSessionName>
                        <bfdSessionId></bfdSessionId>
                        <bfdType></bfdType>
                        <trackMode></trackMode>
                        <priorityChange></priorityChange>     
        </vrrp6TrackBfd>
           </vrrp6TrackBfds>
    </vrrp6Group>

    Table 3-758 describes elements in requests.

    Table 3-758  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    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 the mode in which a BFD session is tracked.

    priorityChange

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

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
           <ifName>10GE1/0/1</ifName>
           <vrrpId>1</vrrpId>
           <vrrp6TrackBfds>
                <vrrp6TrackBfd>
                    <bfdSessionId>1</bfdSessionId>
                    <trackMode>reduce</trackMode>
                    <priorityChange>10</priorityChange>
                    <bfdType>normal</bfdType>
                    <bfdSessionName>trackbfd</bfdSessionName>
                </vrrp6TrackBfd>
           </vrrp6TrackBfds>
    </vrrp6Group>

    Table 3-759 describes elements in responses.

    Table 3-759  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    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 the mode in which a BFD session is tracked.

    priorityChange

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

Configure a VRRP6 Backup Group to Track a BFD Session

Operation

URI

Description

POST

/vrrp/vrrp6Groups/vrrp6Group

Configure a VRRP6 backup group to track a BFD session.

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

    Table 3-760 describes elements in requests.

    Table 3-760  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies the mode in which a BFD session is tracked.

    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-761 describes status codes in responses.

    Table 3-761  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 VRRP6 Backup Group to Track a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

Modify configurations for a VRRP6 backup group to track a BFD session.

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

    Table 3-762 describes elements in requests.

    Table 3-762  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies the mode in which a BFD session is tracked.

    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-763 describes status codes in responses.

    Table 3-763  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 VRRP6 Backup Group to Track a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrp6Groups/vrrp6Group

Delete configurations for a VRRP6 backup group to track a BFD session.

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

    Table 3-764 describes elements in requests.

    Table 3-764  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    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 3-765 describes status codes in responses.

    Table 3-765  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 VRRP6 Backup Group

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query the status change track of a VRRP6 backup group.

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

    Table 3-766 describes elements in requests.

    Table 3-766  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

    Specifies the name of the interface on which a VRRP6 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"?>
    <vrrp6Group>
          <ifName>10GE1/0/1</ifName>
          <vrrpId>1</vrrpId>
           <stateChanges>
                <stateChange>
                    <sourceState>Backup</sourceState>
                    <destState>Master</destState>
                    <changeReason>Protocol timer expired</changeReason>
                    <changeTime>2014-11-14T13:45:32</changeTime>
                    <index>1</index>
                </stateChange>
                <stateChange>
                    <sourceState>Initialize</sourceState>
                    <destState>Backup</destState>
                    <changeReason>Interface up</changeReason>
                    <changeTime>2014-11-14T13:45:29</changeTime>
                    <index>2</index>
                </stateChange>
           </stateChanges>
    </vrrp6Group>

    Table 3-767 describes elements in responses.

    Table 3-767  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

    Specifies the name of the interface on which a VRRP6 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.

Querying VRRP6 Packet Statistics

Operation

URI

Description

GET

/vrrp/vrrp6Groups/vrrp6Group

Query VRRP6 packet statistics.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
           <vrrpId>1</vrrpId>
           <ifName>10GE1/0/1</ifName>
           <vrrp6Statistics>
                    <becomeMaster></becomeMaster>
                    <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>
            </vrrp6Statistics>
    </vrrp6Group>

    Table 3-768 describes elements in requests.

    Table 3-768  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    brcomeMaster

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

    sendAdvertisement

    Specifies the number of sent VRRP6 advertisement packets.

    receiveAdvertisement

    Specifies the number of received VRRP6 advertisement packets.

    advertiseIntervalErrors

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

    authenticationFailures

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

    ipTtlErrors

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

    receivePriorityZero

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

    sendPriorityZero

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

    invalidTypePackets

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

    addressListErrors

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

    invalidAuthenticationType

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

    authenticationTypeMismatch

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

    packetLengthErrors

    Specifies the number of VRRP6 Advertisement packets with incorrect length.

    receiveSelfSend

    Specifies the number of VRRP6 Advertisement packets received from itself.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6Group>
           <ifName>10GE1/0/1</ifName>
           <vrrpId>1</vrrpId>
           <vrrp6Statistics>
                <becomeMaster>1</becomeMaster>
                <sendAdvertisement>3904</sendAdvertisement>
                <receiveAdvertisement>3904</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>0</sendPriorityZero>
                <receiveSelfSend>3904</receiveSelfSend>
            </vrrp6Statistics>
    </vrrp6Group>

    Table 3-769 describes elements in responses.

    Table 3-769  Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP6 backup group.

    ifName

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

    brcomeMaster

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

    sendAdvertisement

    Specifies the number of sent VRRP6 advertisement packets.

    receiveAdvertisement

    Specifies the number of received VRRP6 advertisement packets.

    advertiseIntervalErrors

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

    authenticationFailures

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

    ipTtlErrors

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

    receivePriorityZero

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

    sendPriorityZero

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

    invalidTypePackets

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

    addressListErrors

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

    invalidAuthenticationType

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

    authenticationTypeMismatch

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

    packetLengthErrors

    Specifies the number of VRRP6 Advertisement packets with incorrect length.

    receiveSelfSend

    Specifies the number of VRRP6 Advertisement packets received from itself.

Querying VRRP6 Error Packets

Operation

URI

Description

GET

/vrrp/vrrp6ErrorPackets/vrrp6ErrorPacket

Query VRRP6 error packets.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6ErrorPacket>
                <index></index>
                <ifName></ifName>
                <receiveTime></receiveTime>
                <reason></reason>
                <buffer></buffer>
    </vrrp6ErrorPacket>

    Table 3-770 describes elements in requests.

    Table 3-770  Elements

    Element

    Description

    index

    Specifies the sequence number.

    ifName

    Specifies an interface name.

    receiveTime

    Specifies the receive time.

    reason

    Specifies the error reason.

    buffer

    Specifies the packet data.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <vrrp6ErrorPacket>
              <ifName>10GE1/0/1</ifName>
              <receiveTime>2014-11-14T16:22:06</receiveTime>
              <reason>Checksum error</reason>
              <buffer>6c000000    001870ff    fe800000    00000000    3a13d0ff&#13;
    fe210300    ff020000    00000000    00000000    00000012&#13;
    31016401    006461c3    fe800000    00000000    00000000&#13;
    00000002    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000&#13;
    00000000    00000000    00000000    00000000    00000000
    </buffer>
              <index>1</index>
    </vrrp6ErrorPacket>

    Table 3-771 describes elements in responses.

    Table 3-771  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ipProtocolErrors

    Specifies the number of packets with an incorrect IP protocol number.

    destinationIpErrors

    Specifies the number of packets with an incorrect destination IP address.

    checksumErrors

    Specifies the number of packets with an invalid checksum.

    versionErrors

    Specifies the number of packets with an unknown or unsupported version number.

    vrrpIdErrors

    Specifies the number of packets with an invalid VRRP backup group ID.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 21377

Downloads: 116

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