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).
Interface IPv6 Address

Interface IPv6 Address

Enable IPv6 on an Interface

Operation

URI

Description

PUT

/ifm/interfaces/interface/ifmAm6

Enable IPv6 on an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface operation="merge">
                <ifName>10GE1/0/1</ifName>
                <ifmAm6>
                    <enableFlag>true</enableFlag>
                </ifmAm6>
          </interface>
    </interfaces>

    Table 3-67 describes elements in requests.

    Table 3-67  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

    enableFlag

    Specifies whether IPv6 is enabled on a control interface.

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

    Table 3-68 describes status codes in responses.

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

Configure Automatic Link-Local Address Generation for IPv6

Operation

URI

Description

PUT

/ifm/interfaces/interface/ifmAm6

Configure automatic link-local address generation for IPv6.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface operation="merge">
                <ifName>10GE1/0/1</ifName>
                <ifmAm6>
                    <autoLinkLocal>true</autoLinkLocal>
                </ifmAm6>
          </interface>
    </interfaces>

    Table 3-69 describes elements in requests.

    Table 3-69  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

    autoLinkLocal

    Specifies whether the automatic link-local address generation function is enabled on a control interface.

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

    Table 3-70 describes status codes in responses.

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

Configure an IPv6 Address for an Interface

Operation

URI

Description

POST

/ifm/interfaces/interface/ifmAm6/am6CfgAddrs

Configure an IPv6 address for an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface operation="merge">
                <ifName>10GE1/0/1</ifName>
                <ifmAm6>
                  <am6CfgAddrs>
                    <am6CfgAddr operation="create">
                      <ifIp6Addr>1:1::1:1</ifIp6Addr>
                      <addrPrefixLen>64</addrPrefixLen>
                      <addrType6>global</addrType6>
                      <ifIDGenType>none</ifIDGenType>
                    </am6CfgAddr>
                  </am6CfgAddrs>
                </ifmAm6>
          </interface>
    </interfaces>

    Table 3-71 describes elements in requests.

    Table 3-71  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

    am6CfgAddrs

    Specifies an IPv6 address list.

    am6CfgAddr

    Specifies an IPv6 address configuration.

    ifIp6Addr

    Specifies an IPv6 address.

    addrPrefixLen

    Specifies the length of an IPv6 prefix.

    addrType6

    Specifies an IPv6 address type.

    ifIDGenType

    Specifies an IPv6 address algorithm.

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

    Table 3-72 describes status codes in responses.

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

Query the IPv6 Address of an Interface

Operation

URI

Description

GET

/ifm/interfaces/interface/ifmAm6

Query the IPv6 address of an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
        <interface>
            <ifName>10GE1/0/1</ifName>
            <ifmAm6/>
        </interface>
    </interfaces>

    Table 3-73 describes elements in requests.

    Table 3-73  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
           <interface>
              <ifName>10GE1/0/1</ifName>
              <ifmAm6>
                <enableFlag>true</enableFlag>
                <ifMtu6>1500</ifMtu6>
                <autoLinkLocal>true</autoLinkLocal>
                <am6CfgAddrs>
                  <am6CfgAddr>
                    <ifIp6Addr>100::</ifIp6Addr>
                    <addrPrefixLen>64</addrPrefixLen>
                    <addrType6>global</addrType6>
                    <ifIDGenType>cga</ifIDGenType>
                    <collisionCount>0</collisionCount>
                  </am6CfgAddr>
                  <am6CfgAddr>
                    <ifIp6Addr>FE80::3ABA:4C00:654:4102</ifIp6Addr>
                    <addrPrefixLen>10</addrPrefixLen>
                    <addrType6>linkLocal</addrType6>
                    <ifIDGenType>none</ifIDGenType>
                    <collisionCount>0</collisionCount>
                  </am6CfgAddr>
                </am6CfgAddrs>
                <am6CgaInfos>
                  <am6CgaInfo>
                    <rsaKeyLabel>rsa</rsaKeyLabel>
                    <secLevel>1</secLevel>
                    <modifier>::</modifier>
                  </am6CgaInfo>
                </am6CgaInfos>
              </ifmAm6>
          </interface> 
    </interfaces>

    Table 3-74 describes elements in responses.

    Table 3-74  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

    enableFlag

    Specifies whether IPv6 is enabled on a control interface.

    ifMtu6

    Specifies the MTU of an IPv6 interface.

    autoLinkLocal

    Specifies whether the automatic link-local address generation function is enabled on a control interface.

    am6CfgAddrs

    Specifies an IPv6 address list.

    am6CfgAddr

    Specifies an IPv6 address configuration.

    ifIp6Addr

    Specifies an IPv6 address.

    addrPrefixLen

    Specifies the length of an IPv6 prefix.

    addrType6

    Specifies an IPv6 address type.

    ifIDGenType

    Specifies an IPv6 address algorithm.

    collisionCount

    Specifies the number of times that IPv6 addresses conflict.

    am6CgaInfos

    Specifies a CGA address container.

    am6CgaInfo

    Specifies a CGA address instance.

    rsaKeyLabel

    Specifies an RSA key.

    secLevel

    Specifies a security level.

    modifier

    Specifies a CGA address modifier.

    Table 3-75 describes status codes in responses.

    Table 3-75  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 an IPv6 Address from an Interface

Operation

URI

Description

DELETE

/ifm/interfaces/interface/ifmAm6/am6CfgAddrs

Delete an IPv6 address from an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface>
                <ifName>10GE1/0/1</ifName>
                <ifmAm6>
                  <am6CfgAddrs>
                    <am6CfgAddr operation="delete">
                      <ifIp6Addr>1:1::1:1</ifIp6Addr>
                    </am6CfgAddr>
                  </am6CfgAddrs>
                </ifmAm6>
          </interface>
    </interfaces>

    Table 3-76 describes elements in requests.

    Table 3-76  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm6

    Specifies IPv6 configurations.

    am6CfgAddrs

    Specifies an IPv6 address list.

    am6CfgAddr

    Specifies an IPv6 address configuration.

    ifIp6Addr

    Specifies an IPv6 address.

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

    Table 3-77 describes status codes in responses.

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

Configure CGA Attributes for an Interface

Operation

URI

Description

POST

/ifm/interfaces/interface/ifmAm6/am6CgaInfos

Configure CGA attributes for an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
     <interface> 
          <ifName>10GE1/0/1</ifName> 
          <ifmAm6> 
             <am6CgaInfos> 
                <am6CgaInfo operation="create"> 
                   <rsaKeyLabel>abc</rsaKeyLabel> 
                   <secLevel>0</secLevel> 
                   <modifier>2001:db8::</modifier> 
                </am6CgaInfo> 
             </am6CgaInfos> 
          </ifmAm6> 
     </interface> 
    </interfaces>

    Table 3-78 describes elements in requests.

Table 3-78  Elements in requests

Element

Description

ifName

Specifies an interface name. The value is a string of 1 to 63 characters.

ifmAm6

Specifies IPv6 configurations.

am6CgaInfos

Specifies the CGA address container information.

am6CgaInfo

Specifies a CGA address instance.

rsaKeyLabel

Specifies an RSA key. The value is a string of 1 to 35 characters.

secLevel

Specifies a security level. The value can be 0 or 1. The default value is 0.

modifier

Specifies a corrected value for the CGA address. The value is a string of 0 to 255 characters. The value is in the IPv6 address format (X:X:X:X:X:X:X:X) and has a total number of 128 bits. It is generally divided into 8 groups, each of which has four hexadecimal digits. The value can be abbreviated.

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

    Table 3-79 describes status codes in responses.

Table 3-79  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Query the CGA Attributes of an Interface

Operation

URI

Description

GET

/ifm/interfaces/interface/ifmAm6/am6CgaInfos

Query the CGA attributes of an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
      <interface> 
        <ifName>10GE1/0/1</ifName> 
        <ifmAm6> 
           <am6CgaInfos/> 
         </ifmAm6> 
     </interface> 
    </interfaces>

    Table 3-80 describes elements in requests.

Table 3-80  Elements in requests

Element

Description

ifName

Specifies an interface name.

ifmAm6

Specifies IPv6 configurations.

am6CgaInfos

Specifies the CGA address container information.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
           <interface> 
              <ifName>10GE1/0/1</ifName> 
              <ifmAm6> 
                <am6CgaInfos> 
                  <am6CgaInfo> 
                    <rsaKeyLabel>abc</rsaKeyLabel> 
                    <secLevel>0</secLevel> 
                    <modifier>2001:db8::</modifier> 
                  </am6CgaInfo> 
                </am6CgaInfos> 
              </ifmAm6> 
          </interface>  
    </interfaces>

    Table 3-81 describes elements in responses.

Table 3-81  Elements in responses

Element

Description

ifName

Specifies an interface name.

ifmAm6

Specifies IPv6 configurations.

am6CgaInfos

Specifies the CGA address container information.

am6CgaInfo

Specifies a CGA address instance.

rsaKeyLabel

Specifies an RSA key. The value is a string of 1 to 35 characters.

secLevel

Specifies a security level. The value can be 0 or 1. The default value is 0.

modifier

Specifies a corrected value for the CGA address. The value is a string of 0 to 255 characters. The value is in the IPv6 address format (X:X:X:X:X:X:X:X) and has a total number of 128 bits. It is generally divided into 8 groups, each of which has four hexadecimal digits. The value can be abbreviated.

Table 3-82 describes status codes in responses.

Table 3-82  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Delete the CGA Attributes of an Interface

Operation

URI

Description

DELETE

/ifm/interfaces/interface/ifmAm6/am6CgaInfos

Delete the CGA attributes of an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?><interfaces> 
     <interface> 
          <ifName>10GE1/0/1</ifName> 
          <ifmAm6> 
             <am6CgaInfos> 
                <am6CgaInfo operation="delete"> 
                   <rsaKeyLabel>abc</rsaKeyLabel> 
                   <secLevel>0</secLevel> 
                   <modifier>2001:db8::</modifier> 
                </am6CgaInfo> 
             </am6CgaInfos> 
          </ifmAm6> 
     </interface> 
    </interfaces>

    Table 3-83 describes elements in requests.

Table 3-83  Elements in requests

Element

Description

ifName

Specifies an interface name. The value is a string of 1 to 63 characters.

ifmAm6

Specifies IPv6 configurations.

am6CgaInfos

Specifies the CGA address container information.

am6CgaInfo

Specifies a CGA address instance.

rsaKeyLabel

Specifies an RSA key. The value is a string of 1 to 35 characters.

secLevel

Specifies a security level. The value can be 0 or 1. The default value is 0.

modifier

Specifies a corrected value for the CGA address. The value is a string of 0 to 255 characters. The value is in the IPv6 address format (X:X:X:X:X:X:X:X) and has a total number of 128 bits. It is generally divided into 8 groups, each of which has four hexadecimal digits. The value can be abbreviated.

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

    Table 2 describes status codes in responses.

Table 3-84  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 30723

Downloads: 127

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