No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

RESTful API Reference

CloudEngine 12800 and 12800E V200R005C10

This document describes the OPS APIs supported by the device, including OPS-supported operations, request examples, elements in the requests, response examples, elements in the responses, and response status codes.
Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Configurations on a TRILL Interface

Configurations on a TRILL Interface

Create a TRILL Interface

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillPorts/trillPort

Create a TRILL interface.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillPorts> 
                 <trillPort> 
                   <ifName>Ethernet3/0/0</ifName> 
                   <portMode>p2p</portMode> 
                   <cost>20</cost> 
                   <drbPriority>127</drbPriority> 
                   <csnpIntervals> 
                       <csnpInterval>65535</csnpInterval> 
                   </csnpIntervals> 
                   <helloIntervals> 
                       <helloInterval>3</helloInterval> 
                       <holdMultiplier>1000</holdMultiplier> 
                   </helloIntervals> 
                   <lspRetranIntervals> 
                       <retranInterval>5</retranInterval> 
                       <throttInterval>1</throttInterval> 
                       <throttCount>1</throttCount> 
                   </lspRetranIntervals> 
                   <trillHelloAuths> 
                       <trillHelloAuth operation='create'> 
                         <authenticationType>Simple</authenticationType> 
                         <authenticationSimple>1</authenticationSimple> 
                         <authenticationMD5></authenticationMD5> 
                         <sendOnly>true</sendOnly> 
                         <keyId></keyId> 
                       </trillHelloAuth> 
                   </trillHelloAuths> 
                 </trillPort> 
               </trillPorts> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

ifName

Specifies the name of an interface. This element is the primary key in the table.

The value is a string of 1 to 63 characters.

Mandatory

portMode

Specifies an interface type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

Optional

cost

Specifies a cost on the TRILL interface.

The value is an integer ranging from 0 to 16777215. The default value is 0.

Optional

desiredDVlan

Specifies a desired designated VLAN (DVLAN).

The value is an integer ranging from 1 to 4090.

Optional

drbPriority

Specifies a DRB priority.

The value is an integer ranging from 0 to 127.

Optional

csnpInterval

Specifies an interval at which CSNPs are sent.

The value is an integer ranging from 1 to 65535. The default value is 10.

Optional

helloInterval

Specifies an interval at which Hello packets are sent.

The value is an integer ranging from 3 to 255. The default value is 10.

Optional

holdMultiplier

Specifies the number of consecutive Hello packets that an RB sends to a neighbor before the RB considers the neighbor Down.

The value is an integer ranging from 3 to 1000. The default value is 3.

Optional

retranInterval

Specifies an interval at which Level-1 LSPs are retransmitted over a P2P link.

The value is an integer ranging from 1 to 300. The default value is 5.

Optional

throttInterval

Specifies the minimum interval at which LSPs are sent.

The value is an integer ranging from 1 to 10000, in milliseconds. The default value is 50.

Optional

throttCount

Specifies the maximum number of LSPs that are sent during the throttle interval.

The value is an integer ranging from 1 to 1000. The default value is 10.

Optional

authenticationType

Specifies the authentication type for TRILL Hello packets. This element is the primary key of trillHelloAuths.

The values are as follows:

  • Simple
  • Md5
  • KEYCHAIN
  • hmac_sha256

Mandatory

authenticationSimple

Specifies a password for simple authentication.

The value is a string of 1 to 16 characters.

Optional

authenticationMD5

Specifies a password for MD5 or SHA256 authentication.

The value is a string of 1 to 255 characters.

Optional

sendOnly

Specifies whether the system authenticates only the packets to be sent.

The value is a Boolean data type. The default value is FALSE.

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535. The default value is 0.

Optional

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

Status codes in responses

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 Configurations on a TRILL Interface

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillPorts/trillPort

Query configurations on a TRILL interface.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>  
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillPorts> 
                 <trillPort> 
                     <ifName></ifName> 
                     <portMode></portMode> 
                     <cost></cost> 
                     <circuitId></circuitId> 
                     <circuitMTU></circuitMTU> 
                     <drbStatus></drbStatus> 
                     <trillStatus></trillStatus> 
                     <dVlan></dVlan> 
                     <drbPriority></drbPriority> 
                     <csnpIntervals> 
                         <csnpInterval></csnpInterval> 
                     </csnpIntervals> 
                     <helloIntervals> 
                         <helloInterval></helloInterval> 
                         <holdMultiplier></holdMultiplier> 
                     </helloIntervals> 
                     <lspRetranIntervals> 
                         <retranInterval></retranInterval> 
                         <throttInterval></throttInterval> 
                         <throttCount></throttCount> 
                     </lspRetranIntervals> 
                 </trillPort> 
             </trillPorts> 
         </trillSite>     

Elements

Element

Description

Value Range

Mandatory/Optional

ifName

Specifies the name of an interface. This element is the primary key in the table.

The value is a string of 1 to 63 characters.

Mandatory

portMode

Specifies an interface type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

Optional

cost

Specifies a cost on the TRILL interface.

The value is an integer ranging from 0 to 16777215. The default value is 0.

Optional

desiredDVlan

Specifies a desired DVLAN.

The value is an integer ranging from 1 to 4090.

Optional

drbPriority

Specifies a DRB priority.

The value is an integer ranging from 0 to 127.

Optional

csnpInterval

Specifies an interval at which CSNPs are sent.

The value is an integer ranging from 1 to 65535. The default value is 10.

Optional

helloInterval

Specifies an interval at which Hello packets are sent.

The value is an integer ranging from 3 to 255. The default value is 10.

Optional

holdMultiplier

Specifies the number of consecutive Hello packets that an RB sends to a neighbor before the RB considers the neighbor Down.

The value is an integer ranging from 3 to 1000. The default value is 3.

Optional

retranInterval

Specifies an interval at which Level-1 LSPs are retransmitted over a P2P link.

The value is an integer ranging from 1 to 300. The default value is 5.

Optional

throttInterval

Specifies the minimum interval at which LSPs are sent.

The value is an integer ranging from 1 to 10000, in milliseconds. The default value is 50.

Optional

throttCount

Specifies the maximum number of LSPs that are sent during the throttle interval.

The value is an integer ranging from 1 to 1000. The default value is 10.

Optional

authenticationType

Specifies the authentication type for TRILL Hello packets. This element is the primary key of trillHelloAuths.

The values are as follows:

  • Simple
  • Md5
  • KEYCHAIN
  • hmac_sha256

Mandatory

authenticationSimple

Specifies a password for simple authentication.

The value is a string of 1 to 16 characters.

Optional

authenticationMD5

Specifies a password for MD5 or SHA256 authentication.

The value is a string of 1 to 255 characters.

Optional

sendOnly

Specifies whether the system authenticates only the packets to be sent.

The value is a Boolean data type. The default value is FALSE.

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535. The default value is 0.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillPorts> 
             <trillPort> 
               <ifName>Ethernet3/0/0</ifName> 
               <cost>20</cost> 
               <portMode>access</portMode> 
               <circuitId>1</circuitId> 
               <circuitMTU>1497</circuitMTU> 
               <drbStatus>Down</drbStatus> 
               <trillStatus>Mtu:Up/Lnk:Dn</trillStatus> 
               <dVlan>0</dVlan> 
               <drbPriority>50</drbPriority> 
               <csnpIntervals> 
                 <csnpInterval>400</csnpInterval> 
               </csnpIntervals> 
               <helloIntervals> 
                 <helloInterval>60</helloInterval> 
                 <holdMultiplier>5</holdMultiplier> 
               </helloIntervals> 
               <lspRetranIntervals> 
                 <retranInterval>5</retranInterval> 
                 <throttInterval>500</throttInterval> 
                 <throttCount>10</throttCount> 
               </lspRetranIntervals> 
             </trillPort> 
           </trillPorts> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

ifName

Specifies the name of an interface. This element is the primary key in the table.

The value is a string of 1 to 63 characters.

Mandatory

portMode

Specifies an interface type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

Optional

cost

Specifies a cost on the TRILL interface.

The value is an integer ranging from 0 to 16777215. The default value is 0.

Optional

desiredDVlan

Specifies a desired DVLAN.

The value is an integer ranging from 1 to 4090.

Optional

drbPriority

Specifies a DRB priority.

The value is an integer ranging from 0 to 127.

Optional

csnpInterval

Specifies an interval at which CSNPs are sent.

The value is an integer ranging from 1 to 65535. The default value is 10.

Optional

helloInterval

Specifies an interval at which Hello packets are sent.

The value is an integer ranging from 3 to 255. The default value is 10.

Optional

holdMultiplier

Specifies the number of consecutive Hello packets that an RB sends to a neighbor before the RB considers the neighbor Down.

The value is an integer ranging from 3 to 1000. The default value is 3.

Optional

retranInterval

Specifies an interval at which Level-1 LSPs are retransmitted over a P2P link.

The value is an integer ranging from 1 to 300. The default value is 5.

Optional

throttInterval

Specifies the minimum interval at which LSPs are sent.

The value is an integer ranging from 1 to 10000, in milliseconds. The default value is 50.

Optional

throttCount

Specifies the maximum number of LSPs that are sent during the throttle interval.

The value is an integer ranging from 1 to 1000. The default value is 10.

Optional

authenticationType

Specifies the authentication type for TRILL Hello packets. This element is the primary key of trillHelloAuths.

The values are as follows:

  • Simple
  • Md5
  • KEYCHAIN
  • hmac_sha256

Mandatory

authenticationSimple

Specifies a password for simple authentication.

The value is a string of 1 to 16 characters.

Optional

authenticationMD5

Specifies a password for MD5 or SHA256 authentication.

The value is a string of 1 to 255 characters.

Optional

sendOnly

Specifies whether the system authenticates only the packets to be sent.

The value is a Boolean data type. The default value is FALSE.

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535. The default value is 0.

Optional

Status codes in responses

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 TRILL Interface

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillPorts/trillPort

Delete a TRILL interface.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillPorts> 
                 <trillPort operation='delete'> 
                   <ifName>Ethernet3/0/0</ifName> 
                 </trillPort> 
               </trillPorts> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

ifName

Specifies the name of an interface. This element is the primary key in the table.

The value is a string of 1 to 63 characters.

Mandatory

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

Status codes in responses

Status Code

Description

200 OK

The operation succeeded.

400 Bad Request

The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

The request operation failed because of internal errors in services or unidentified processing errors.

Translation
Download
Updated: 2019-04-03

Document ID: EDOC1100075372

Views: 10691

Downloads: 16

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