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).
TRILL Administrative VLAN

TRILL Administrative VLAN

TRILL Administrative VLAN

Create a TRILL Administrative VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillAdminVlans/trillAdminVlan

Create a TRILL administrative VLAN.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
 <trillSite operation='merge'> 
      <instanceId>0</instanceId> 
      <trillAdminVlans> 
         <trillAdminVlan operation='create'> 
         <vlanId>1</vlanId> 
         </trillAdminVlan> 
      </trillAdminVlans> 
 </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID.

The value is an integer ranging from 1 to 4094.

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.

Query a TRILL Administrative VLAN

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillAdminVlans/trillAdminVlan

Query a TRILL administrative VLAN.

  • Request example
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillAdminVlans> 
                 <trillAdminVlan> 
                     <vlanId></vlanId> 
                 </trillAdminVlan> 
             </trillAdminVlans> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID.

The value is an integer ranging from 1 to 4094.

Mandatory

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillAdminVlans> 
             <trillAdminVlan> 
               <vlanId>1</vlanId> 
             </trillAdminVlan> 
           </trillAdminVlans> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID.

The value is an integer ranging from 1 to 4094.

Mandatory

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 Administrative VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillAdminVlans/trillAdminVlan

Delete a TRILL administrative VLAN.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?> 
    <trillSite operation='merge'> 
         <instanceId>0</instanceId> 
            <trillAdminVlans> <trillAdminVlan operation='delete'>
              <vlanId>1</vlanId> 
              </trillAdminVlan> 
            </trillAdminVlans> 
    </trillSite>

    Elements

    Element

    Description

    Value Range

    Mandatory/Optional

    vlanId

    Specifies a TRILL VLAN ID.

    The value is an integer ranging from 1 to 4094.

    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.

AF Selection Mode on a TRILL Network

Set the AF Selection Mode to Load Balancing

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Set the AF selection mode to load balancing. The configuration can be performed only after a TRILL process is created.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <trillSite operation='merge'>
    <instanceId>0</instanceId>
    <afSelectMode>load-balance</afSelectMode>
    </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

afSelectMode

Specifies the AF selection mode on a TRILL network.

The values are as follows:

  • default
  • load-balance
  • select-switch

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.

Query the AF Selection Mode

Operation

URI

Description

GET

/trill/trillSites/trillSite

Query the AF selection mode.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <afSelectMode></afSelectMode> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

afSelectMode

Specifies the AF selection mode on a TRILL network.

The values are as follows:

  • default
  • load-balance
  • select-switch

Mandatory

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
           <instanceId>0</instanceId> 
           <afSelectMode>load-balance</afSelectMode> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

afSelectMode

Specifies the AF selection mode on a TRILL network.

The values are as follows:

  • default
  • load-balance
  • select-switch

Mandatory

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.

Restore the Default AF Selection Mode

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Restore the default AF selection mode.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <afSelectMode>default</afSelectMode> 
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

afSelectMode

Specifies the AF selection mode on a TRILL network.

The values are as follows:

  • default
  • load-balance
  • select-switch

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.

LSP Authentication

Set an LSP Authentication Type

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillLspAuths/trillLspAuth

Set the LSP authentication type to simple. The LSP authentication type can also be MD5 or HMAC-SHA256.

  • Request example (simple authentication)
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillLspAuths> 
                 <trillLspAuth operation='create'> 
                   <authenticationType>Simple</authenticationType> 
                   <authenticationSimple>1111111111111111</authenticationSimple> 
                   <authenticationMD5></authenticationMD5> 
                   <usageType>usage_default</usageType> 
                 </trillLspAuth> 
               </trillLspAuths> 
             </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

trillLspAuth

Specifies an authentication type. This element is the primary key in the table.

The values are as follows:

  • Simple
  • Md5
  • 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

usageType

Specifies an authentication usage scenario.

The values are as follows:

  • usage_default
  • authentication_avoid
  • send_only
  • all_send_only

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535.

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 the LSP Authentication Type

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillLspAuths/trillLspAuth

Query the LSP authentication type.

  • Request example
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillLspAuths> 
                 <trillLspAuth> 
                     <authenticationType></authenticationType> 
                     <authenticationSimple></authenticationSimple> 
                     <authenticationMD5></authenticationMD5> 
                     <usageType></usageType> 
                     <keyId></keyId> 
                 </trillLspAuth> 
             </trillLspAuths> 
         </trillSite>     

Element

Description

Value Range

Mandatory/Optional

trillLspAuth

Specifies an authentication type. This element is the primary key in the table.

The values are as follows:

  • Simple
  • Md5
  • 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

usageType

Specifies an authentication usage scenario.

The values are as follows:

  • usage_default
  • authentication_avoid
  • send_only
  • all_send_only

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535.

Optional

  • Response example (XML format)
 <?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillLspAuths> 
             <trillLspAuth> 
               <authenticationType>Simple</authenticationType> 
               <authenticationSimple></authenticationSimple> 
               <authenticationMD5></authenticationMD5> 
               <usageType>usage_default</usageType> 
               <keyId>0</keyId> 
             </trillLspAuth> 
           </trillLspAuths> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

trillLspAuth

Specifies an authentication type. This element is the primary key in the table.

The values are as follows:

  • Simple
  • Md5
  • 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

usageType

Specifies an authentication usage scenario.

The values are as follows:

  • usage_default
  • authentication_avoid
  • send_only
  • all_send_only

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535.

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 an LSP Authentication Configuration

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillLspAuths/trillLspAuth

Delete an LSP authentication configuration.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillLspAuths> 
                 <trillLspAuth operation='delete'> 
                   <authenticationType>Simple</authenticationType> 
                 </trillLspAuth> 
               </trillLspAuths> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

trillLspAuth

Specifies an authentication type. This element is the primary key in the table.

The values are as follows:

  • Simple
  • Md5
  • 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

usageType

Specifies an authentication usage scenario.

The values are as follows:

  • usage_default
  • authentication_avoid
  • send_only
  • all_send_only

Optional

keyId

Specifies a key ID.

The value is an integer ranging from 0 to 65535.

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.

Bandwidth Reference Value Used in Automatic Interface Cost Calculation

Configure the Bandwidth Reference Value

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Configure the bandwidth reference value, in Mbit/s. The configuration can be performed only after a TRILL process is created.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <bandWidth>20000</bandWidth> 
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

instanceId

Specifies a process ID. This element is the primary key in the table.

The value is an integer ranging from 0 to 4294967295.

Mandatory

bandWidth

Specifies a bandwidth reference value, in Mbit/s.

The value is an integer ranging from 1 to 2147483648. The default value (20000000) is used after a TRILL process is configured.

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 the Bandwidth Reference Value

Operation

URI

Description

GET

/trill/trillSites/trillSite

Query the bandwidth reference value.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <bandWidth></bandWidth> 
         </trillSite>     

Elements

Element

Description

Value Range

Mandatory/Optional

instanceId

Specifies a process ID. This element is the primary key in the table.

The value is an integer ranging from 0 to 4294967295.

Mandatory

bandWidth

Specifies a bandwidth reference value, in Mbit/s.

The value is an integer ranging from 1 to 2147483648. The default value (20000000) is used after a TRILL process is configured.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <bandWidth>30000000</bandWidth> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

instanceId

Specifies a process ID. This element is the primary key in the table.

The value is an integer ranging from 0 to 4294967295.

Mandatory

bandWidth

Specifies a bandwidth reference value, in Mbit/s.

The value is an integer ranging from 1 to 2147483648. The default value (20000000) is used after a TRILL process is configured.

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.

Restore the Default Bandwidth Reference Value

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Restore the default bandwidth reference value.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <bandWidth>20000000</bandWidth> 
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

instanceId

Specifies a process ID. This element is the primary key in the table.

The value is an integer ranging from 0 to 4294967295.

Mandatory

bandWidth

Specifies a bandwidth reference value, in Mbit/s.

The value is an integer ranging from 1 to 2147483648. The default value (20000000) is used after a TRILL process is configured.

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.

Carrier VLAN

Create a Carrier VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillVlans/trillVlan

Create a carrier VLAN.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillVlans> 
                 <trillVlan operation='create'> 
                   <vlanId>10</vlanId> 
                 </trillVlan> 
               </trillVlans> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID. This element is the primary key in the table.

The value is an integer ranging from 1 to 4090.

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.

Query a Carrier VLAN

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillVlans/trillVlan

Query a carrier VLAN.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillVlans> 
                 <trillVlan> 
                     <vlanId></vlanId> 
                 </trillVlan> 
             </trillVlans> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID. This element is the primary key in the table.

The value is an integer ranging from 1 to 4090.

Mandatory

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillVlans> 
             <trillVlan> 
               <vlanId>100</vlanId> 
             </trillVlan> 
           </trillVlans> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID. This element is the primary key in the table.

The value is an integer ranging from 1 to 4090.

Mandatory

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 Carrier VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillVlans/trillVlan

Delete a carrier VLAN.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillVlans> 
                 <trillVlan operation='delete'> 
                   <vlanId>10</vlanId> 
                 </trillVlan> 
               </trillVlans> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

vlanId

Specifies a TRILL VLAN ID. This element is the primary key in the table.

The value is an integer ranging from 1 to 4090.

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.

TRILL CE VLAN

Create a TRILL CE VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillCeVlans/trillCeVlan

Create a TRILL CE VLAN.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
            <instanceId>0</instanceId> 
              <trillCeVlans> 
                <trillCeVlan operation="create">
                    <ceVlanBitmap>0020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000:0020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</ceVlanBitmap>
                </trillCeVlan> 
              </trillCeVlans> 
            </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

ceVlanBitmap

Specifies a CE VLAN ID.

The value is an integer ranging from 1 to 4094.

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.

Query a TRILL CE VLAN

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillCeVlans/trillCeVlan

Query a TRILL CE VLAN.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillCeVlans> 
                 <trillCeVlan> 
                     <ceVlanBitmap></ceVlanBitmap> 
                 </trillCeVlan> 
             </trillCeVlans> 
         </trillSite>     

Elements

Element

Description

Value Range

Mandatory/Optional

ceVlanBitmap

Specifies a CE VLAN ID.

The value is an integer ranging from 1 to 4094.

Mandatory

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillCeVlans> 
             <trillCeVlan> 
               <ceVlanBitmap>0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</ceVlanBitmap> 
             </trillCeVlan> 
           </trillCeVlans> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

ceVlanBitmap

Specifies a CE VLAN ID.

The value is an integer ranging from 1 to 4094.

Mandatory

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 CE VLAN

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillCeVlans/trillCeVlan

Delete a TRILL CE VLAN.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation="merge">
            <instanceId>0</instanceId>
            <trillCeVlans>
                <trillCeVlan operation="delete">
                    <ceVlanBitmap>0020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000:0020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000</ceVlanBitmap>
                </trillCeVlan>
            </trillCeVlans>
        </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

ceVlanBitmap

Specifies a CE VLAN ID.

The value is an integer ranging from 1 to 4094.

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.

Global TRILL Cost

Configure a TRILL Cost Globally

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillCost

Configure a TRILL cost globally.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillCost operation='create'> 
                 <cost>16777214</cost> 
               </trillCost> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

cost

Specifies an interface cost.

The value is an integer ranging from 0 to 16777215.

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 the Global TRILL Cost

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillCost

Query the global TRILL cost.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
                 <trillCost> 
                     <cost></cost> 
                 </trillCost> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

cost

Specifies an interface cost.

The value is an integer ranging from 0 to 16777215.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillCost> 
               <cost>20</cost> 
            </trillCost> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

cost

Specifies an interface cost.

The value is an integer ranging from 0 to 16777215.

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.

Restore the Default Global TRILL Cost

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillCost

Restore the default global TRILL cost.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillCost operation='create'> 
                 <cost>0</cost> 
               </trillCost> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

cost

Specifies an interface cost.

The value is an integer ranging from 0 to 16777215.

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.

Maximum Number of Equal-Cost Routes for Load Balancing

Configure the Maximum Number of Equal-Cost Routes for Load Balancing

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillMaxLoad

Configure the maximum number of equal-cost routes for load balancing.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillMaxLoad> 
                 <maxLoadNumber>1</maxLoadNumber> 
               </trillMaxLoad> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

maxLoadNumber

Specifies the maximum number of equal-cost routes for load balancing.

The value is an integer ranging from 1 to 16. The default value is 16.

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 the Maximum Number of Equal-Cost Routes for Load Balancing

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillMaxLoad

Query the maximum number of equal-cost routes for load balancing.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite> 
             <instanceId>0</instanceId> 
                    <trillMaxLoad> 
                       <maxLoadNumber></maxLoadNumber> 
                   </trillMaxLoad> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

maxLoadNumber

Specifies the maximum number of equal-cost routes for load balancing.

The value is an integer ranging from 1 to 16. The default value is 16.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
                  <trillMaxLoad> 
                      <maxLoadNumber>16</maxLoadNumber> 
                   </trillMaxLoad> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

maxLoadNumber

Specifies the maximum number of equal-cost routes for load balancing.

The value is an integer ranging from 1 to 16. The default value is 16.

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.

Restore the Default Maximum Number of Equal-Cost Routes for Load Balancing

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillMaxLoad

Restore the default maximum number of equal-cost routes for load balancing.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillMaxLoad> 
                 <maxLoadNumber>16</maxLoadNumber> 
               </trillMaxLoad> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

maxLoadNumber

Specifies the maximum number of equal-cost routes for load balancing.

The value is an integer ranging from 1 to 16. The default value is 16.

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.

TRILL MDT Quantity

Configure the TRILL MDT Quantity

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillTreeNumber

Set the TRILL MDT quantity.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <trillTreeNumber> 
                <computeNumber>1</computeNumber>
             </trillTreeNumber>               
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

computeNumber

Specifies the number of computable MDTs.

The value is 1 or 2, and the default value is 2.

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 the Configuration of the TRILL MDT Quantity

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillTreeNumber

Query the configuration of the TRILL MDT quantity.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite> 
             <instanceId>0</instanceId> 
                    <trillTreeNumber> 
                       <computeNumber></computeNumber> 
                   </trillTreeNumber> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

computeNumber

Specifies the number of computable MDTs.

The value is 1 or 2, and the default value is 2.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
                  <trillTreeNumber> 
                      <computeNumber>2</computeNumber> 
                  </trillTreeNumber> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

computeNumber

Specifies the number of computable MDTs.

The value is 1 or 2, and the default value is 2.

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.

Restore the Default Quantity of TRILL MDTs

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillTreeNumber

Restore the default quantity of TRILL MDTs.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <trillTreeNumber> 
                <computeNumber>2</computeNumber>
             </trillTreeNumber>
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

computeNumber

Specifies the number of computable MDTs.

The value is 1 or 2, and the default value is 2.

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.

TRILL Multicast Group-based Pruning

Enable TRILL Multicast Group-based Pruning

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Enable TRILL multicast group-based pruning.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <multicastGroupPruningEnable>true</multicastGroupPruningEnable> 
           </trillSite> 

Element

Element

Description

Value Range

Mandatory/Optional

multicastGroupPruningEnable

Specifies whether TRILL multicast group-based pruning is enabled.

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

Optional

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

Status Code 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 Whether TRILL Multicast Group-based Pruning Is Enabled

Operation

URI

Description

GET

/trill/trillSites/trillSite/multicastGroupPruningEnable

Query whether TRILL multicast group-based pruning is enabled.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
                 <multicastGroupPruningEnable> </multicastGroupPruningEnable> 
         </trillSite> 

Element

Element

Description

Value Range

Mandatory/Optional

multicastGroupPruningEnable

Specifies whether TRILL multicast group-based pruning is enabled.

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

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <multicastGroupPruningEnable>false </multicastGroupPruningEnable> 
         </trillSite>

Element

Element

Description

Value Range

Mandatory/Optional

multicastGroupPruningEnable

Specifies whether TRILL multicast group-based pruning is enabled.

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

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.

Disable TRILL Multicast Group-based Pruning

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Disable TRILL multicast group-based pruning.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <multicastGroupPruningEnable>false
</multicastGroupPruningEnable> 
           </trillSite> 

Element

Element

Description

Value Range

Mandatory/Optional

multicastGroupPruningEnable

Specifies whether TRILL multicast group-based pruning is enabled.

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

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.

TRILL Network

Configure a TRILL Network Address

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillNetEntitys/trillNetEntity

Configure a TRILL NET.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillNetEntitys> 
                 <trillNetEntity operation='create'> 
                   <netEntity>000000.0000.000100</netEntity> 
                 </trillNetEntity> 
               </trillNetEntitys> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

netEntity

Specifies a TRILL NET. This element is the primary key in the table.

The value is a string of a maximum of 49 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.

Query the TRILL Network Address

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillNetEntitys/trillNetEntity

Query the TRILL NET.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillNetEntitys> 
                 <trillNetEntity> 
                     <netEntity></netEntity> 
                 </trillNetEntity> 
             </trillNetEntitys> 
         </trillSite>     

Elements

Element

Description

Value Range

Mandatory/Optional

netEntity

Specifies a TRILL NET. This element is the primary key in the table.

The value is a string of a maximum of 49 characters.

Mandatory

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>  
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillNetEntitys> 
             <trillNetEntity> 
               <netEntity>00.0000.0000.0001.00</netEntity> 
             </trillNetEntity> 
           </trillNetEntitys> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

netEntity

Specifies a TRILL NET. This element is the primary key in the table.

The value is a string of a maximum of 49 characters.

Mandatory

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 Network Address

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillNetEntitys/trillNetEntity

Delete a TRILL NET.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillNetEntitys> 
                 <trillNetEntity operation='delete'> 
                   <netEntity>000000.0000.000100</netEntity> 
                 </trillNetEntity> 
               </trillNetEntitys> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

netEntity

Specifies a TRILL NET. This element is the primary key in the table.

The value is a string of a maximum of 49 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.

Global TRILL Port Type

Set the Global TRILL Port Type

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Set the global TRILL port type.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <portMode>access</portMode> 
           </trillSite>     

Elements

Element

Description

Value Range

Mandatory/Optional

portMode

Specifies a TRILL port type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

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 the Global TRILL Port Type

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillOverload

Query the global TRILL port type.

  • Request example
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
             <instanceId>0</instanceId> 
             <portMode></portMode> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

portMode

Specifies a TRILL port type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           < portMode > access </ portMode > 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

portMode

Specifies a TRILL port type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

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.

Restore the Default Global TRILL Port Type

Operation

URI

Description

PUT

/trill/trillSites/trillSite

Restore the default global TRILL port type.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
             <portMode>p2p</portMode> 
           </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

portMode

Specifies a TRILL port type.

The values are as follows:

  • Access
  • Trunk
  • Hybrid
  • P2P

The default value is P2P.

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.

TRILL Overload State

Set the TRILL Overload State

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillOverload

Set the TRILL overload state.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>  
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillOverload> 
                 <overloadEnableType>on_startup</overloadEnableType> 
                 <overloadWaitTime>86400</overloadWaitTime> 
                 <overloadSendSaBit>true</overloadSendSaBit> 
                 <overloadSendSaTime>120</overloadSendSaTime> 
               </trillOverload> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

overloadEnableType

Specifies the TRILL overload state.

The values are as follows:

  • no_set
  • on_startup
  • manual

The default value is no_set.

Optional

overloadWaitTime

Specifies the overload time.

The value is an integer ranging from 5 to 86400.

Optional

overloadSendSaBit

Specifies whether Hello packets carry the SA bit.

The value is TRUE or FALSE.

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 the TRILL Overload State

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillOverload

Query the TRILL overload state.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillOverload> 
                <overloadEnableType></overloadEnableType> 
             </trillOverload> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

overloadEnableType

Specifies the TRILL overload state.

The values are as follows:

  • no_set
  • on_startup
  • manual

The default value is no_set.

Optional

overloadWaitTime

Specifies the overload time.

The value is an integer ranging from 5 to 86400.

Optional

overloadSendSaBit

Specifies whether Hello packets carry the SA bit.

The value is TRUE or FALSE.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillOverload> 
               <overloadEnableType> on_startup </overloadEnableType> 
            </trillOverload> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

overloadEnableType

Specifies the TRILL overload state.

The values are as follows:

  • no_PUT
  • on_startup
  • manual

The default value is no_set.

Optional

overloadWaitTime

Specifies the overload time.

The value is an integer ranging from 5 to 86400.

Optional

overloadSendSaBit

Specifies whether Hello packets carry the SA bit.

The value is TRUE or FALSE.

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 the TRILL Overload State

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillOverload

Delete the TRILL overload state.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillOverload> 
                 <overloadEnableType>no_set</overloadEnableType> 
               </trillOverload> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

overloadEnableType

Specifies the TRILL overload state.

The values are as follows:

  • no_set
  • on_startup
  • manual

The default value is no_set.

Optional

overloadWaitTime

Specifies the overload time.

The value is an integer ranging from 5 to 86400.

Optional

overloadSendSaBit

Specifies whether Hello packets carry the SA bit.

The value is TRUE or FALSE.

Optional

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

TRILL LSP Timer

Set the TRILL LSP Timer

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillLspTimer

Set the TRILL LSP timer.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillLspTimer> 
                 <lspGenMaxTime>120</lspGenMaxTime> 
                 <lspGenInitTime>60000</lspGenInitTime> 
                 <lspGenIncrTime>60000</lspGenIncrTime> 
                 <lspMaxAge>1200</lspMaxAge> 
                 <lspRefreshTime>1</lspRefreshTime> 
               </trillLspTimer> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

lspGenMaxTime

Specifies the maximum interval at which LSPs are generated.

The value is an integer ranging from 1 to 120, in seconds. The default value is 2.

Optional

lspGenInitTime

Specifies the initial interval for generating the same LSP fragment.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

Optional

lspGenIncrTime

Specifies the incremental interval for generating the same LSP fragment.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

Optional

lspMaxAge

Specifies the maximum age of LSPs.

The value is an integer ranging from 2 to 65535. The default value is 1200.

Optional

lspRefreshTime

Specifies the LSP update interval.

The value is an integer ranging from 1 to 65534, in seconds. The default value is 900.

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 the TRILL LSP Timer

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillLspTimer

Query the TRILL LSP timer.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
             <trillSite> 
               <instanceId>0</instanceId>
               <trillLspTimer>
                     <lspGenMaxTime></lspGenMaxTime>
                     <lspGenInitTime></lspGenInitTime>
                     <lspGenIncrTime></lspGenIncrTime>
     <lspMaxAge></lspMaxAge>
     <lspRefreshTime></lspRefreshTime>
                   </trillLspTimer> 
             </trillSite> 

    Elements

    Element

    Description

    Value Range

    Mandatory/Optional

    lspGenMaxTime

    Specifies the maximum interval at which LSPs are generated.

    The value is an integer ranging from 1 to 120, in seconds. The default value is 2.

    Optional

    lspGenInitTime

    Specifies the initial interval for generating the same LSP fragment.

    The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

    Optional

    lspGenIncrTime

    Specifies the incremental interval for generating the same LSP fragment.

    The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

    Optional

    lspMaxAge

    Specifies the maximum age of LSPs.

    The value is an integer ranging from 2 to 65535, in seconds. The default value is 1200.

    Optional

    lspRefreshTime

    Specifies the LSP update interval.

    The value is an integer ranging from 1 to 65534, in seconds. The default value is 900.

    Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>  
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillLspTimer> 
                 <lspGenMaxTime>2</lspGenMaxTime> 
                 <lspGenInitTime>0</lspGenInitTime> 
                 <lspGenIncrTime>0</lspGenIncrTime> 
 <lspMaxAge>1200</lspMaxAge> 
 <lspRefreshTime>900</lspRefreshTime> 
            </trillLspTimer> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

lspGenMaxTime

Specifies the maximum interval at which LSPs are generated, in seconds.

The value is an integer ranging from 1 to 120. The default value is 2.

Optional

lspGenInitTime

Specifies the initial interval for generating the same LSP fragment, in milliseconds.

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

Optional

lspGenIncrTime

Specifies the incremental interval for generating the same LSP fragment, in milliseconds.

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

Optional

lspMaxAge

Specifies the maximum age of LSPs, in seconds.

The value is an integer ranging from 2 to 65535. The default value is 1200.

Optional

lspRefreshTime

Specifies the LSP update interval, in seconds.

The value is an integer ranging from 1 to 65534. The default value is 900.

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.

Restore the Default TRILL LSP Timer

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillLspTimer

Restore the default TRILL LSP timer.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillLspTimer> 
                 <lspGenMaxTime>2</lspGenMaxTime> 
                 <lspGenInitTime>0</lspGenInitTime> 
                 <lspGenIncrTime>0</lspGenIncrTime> 
 <lspMaxAge>1200</lspMaxAge> 
 <lspRefreshTime>900</lspRefreshTime> 
               </trillLspTimer> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

lspGenMaxTime

Specifies the maximum interval at which LSPs are generated.

The value is an integer ranging from 1 to 120, in seconds. The default value is 2.

Optional

lspGenInitTime

Specifies the initial interval for generating the same LSP fragment.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

Optional

lspGenIncrTime

Specifies the incremental interval for generating the same LSP fragment.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 0.

Optional

lspMaxAge

Specifies the maximum age of LSPs.

The value is an integer ranging from 2 to 65535, in seconds. The default value is 1200.

Optional

lspRefreshTime

Specifies the LSP update interval.

The value is an integer ranging from 1 to 65534, in seconds. The default value is 900.

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.

TRILL SPF Intelligent Timer

Set the TRILL SPF Intelligent Timer

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillSpfTimer

Set the TRILL SPF intelligent timer.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillSpfTimer> 
                 <spfMaxInterval>1</spfMaxInterval> 
                 <spfInitInterval>1</spfInitInterval> 
                 <spfIncrInterval>1</spfIncrInterval> 
               </trillSpfTimer> 
             </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

spfMaxInterval

Specifies the maximum delay in route calculation.

The value is an integer ranging from 1 to 120, in seconds. The default value is 5.

Optional

spfInitInterval

Specifies the initial delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 50.

Optional

spfIncrInterval

Specifies the incremental delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 200.

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 the TRILL SPF Intelligent Timer

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSpfTimer

Query the TRILL SPF intelligent timer.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>
         <trillSite> 
             <instanceId>0</instanceId> 
             <trillSpfTimer> 
                 <spfMaxInterval></spfMaxInterval> 
                 <spfInitInterval></spfInitInterval> 
                 <spfIncrInterval></spfIncrInterval> 
              </trillSpfTimer> 
         </trillSite>      

Elements

Element

Description

Value Range

Mandatory/Optional

spfMaxInterval

Specifies the maximum delay in route calculation.

The value is an integer ranging from 1 to 120, in seconds. The default value is 5.

Optional

spfInitInterval

Specifies the initial delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 50.

Optional

spfIncrInterval

Specifies the incremental delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 200.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?> 
         <trillSite> 
           <instanceId>0</instanceId> 
           <trillSpfTimer> 
                 <spfMaxInterval>5</spfMaxInterval> 
                 <spfInitInterval>50</spfInitInterval> 
                 <spfIncrInterval>200</spfIncrInterval> 
           </trillSpfTimer> 
         </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

spfMaxInterval

Specifies the maximum delay in route calculation.

The value is an integer ranging from 1 to 120, in seconds. The default value is 5.

Optional

spfInitInterval

Specifies the initial delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 50.

Optional

spfIncrInterval

Specifies the incremental delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 200.

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.

Restore the Default TRILL SPF Intelligent Timer

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillSpfTimer

Restore the default TRILL SPF intelligent timer.

  • Request example
<?xml version='1.0' encoding='UTF-8'?> 
           <trillSite operation='merge'> 
             <instanceId>0</instanceId> 
               <trillSpfTimer> 
                 <spfMaxInterval>5</spfMaxInterval> 
                 <spfInitInterval>50</spfInitInterval> 
                 <spfIncrInterval>200</spfIncrInterval> 
               </trillSpfTimer> 
             </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

spfMaxInterval

Specifies the maximum delay in route calculation.

The value is an integer ranging from 1 to 120, in seconds. The default value is 5.

Optional

spfInitInterval

Specifies the initial delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 50.

Optional

spfIncrInterval

Specifies the incremental delay in route calculation.

The value is an integer ranging from 0 to 60000, in milliseconds. The default value is 200.

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.

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.

TRILL Nickname Instance

Create a TRILL NickName Instance

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillNicknames/trillNickname

Create a TRILL nickname instance.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>      
      <trillSite operation="merge">
            <instanceId>0</instanceId>
            <trillNicknames>
                <trillNickname operation="create">
                    <nickName>100</nickName>
                    <priority>192</priority>
                    <rootPriority>32768</rootPriority>
                </trillNickname>
            </trillNicknames>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

nickName

Set a nickname instance.

The value is an integer ranging from 1 to 65471.

Optional

priority

Set a priority value for a nickname.

The value is an integer ranging from 128 to 255. The default value is 192.

Optional

rootPriority

Set a tree root priority value for a nickname.

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

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 a TRILL NickName Instance

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillNicknames/trillNickname

Query configurations on a TRILL nickname instance.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>         
       <trillSite>
            <instanceId>0</instanceId>
            <trillNicknames>
                <trillNickname>
                    <nickName></nickName>
                    <priority></priority>
                    <rootPriority></rootPriority>
                </trillNickname>
            </trillNicknames>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

nickName

Set a nickname instance.

The value is an integer ranging from 1 to 65471.

Optional

priority

Set a priority value for a nickname.

The value is an integer ranging from 128 to 255. The default value is 192.

Optional

rootPriority

Set a tree root priority value for a nickname.

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

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>           
       <trillSite operation="merge">
            <instanceId>0</instanceId>
            <trillNicknames>
                <trillNickname operation="create">
                    <nickName>100</nickName>
                    <priority>192</priority>
                    <rootPriority>32768</rootPriority>
                </trillNickname>
            </trillNicknames>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

nickName

Set a nickname instance.

The value is an integer ranging from 1 to 65471.

Optional

priority

Set a priority value for a nickname.

The value is an integer ranging from 128 to 255. The default value is 192.

Optional

rootPriority

Set a tree root priority value for a nickname.

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

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 NickName Instance

Operation

URI

Description

PUT

/trill/trillSites/trillSite/trillNicknames/trillNickname

Delete a TRILL nickname instance.

  • Request example
<?xml version='1.0' encoding='UTF-8'?>       
      <trillSite operation="merge">
            <instanceId>0</instanceId>
            <trillNicknames>
                <trillNickname operation="delete">
                    <nickName>100</nickName>
                    <priority>192</priority>
                    <rootPriority>32768</rootPriority>
                </trillNickname>
            </trillNicknames>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

nickName

Set a nickname instance.

The value is an integer ranging from 1 to 65471.

Optional

priority

Set a priority value for a nickname.

The value is an integer ranging from 128 to 255. The default value is 192.

Optional

rootPriority

Set a tree root priority value for a nickname.

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

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.

TRILL LSP Database Information

Query the TRILL LSP Database Information

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillLsdbInfos/trillLsdbInfo

Query the TRILL LSP database information.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>         
       <trillSite>
            <instanceId>0</instanceId>
            <trillLsdbInfos>
                <trillLsdbInfo>
                    <lspId></lspId>
                    <seqenceNumber></seqenceNumber>
                    <checkSum></checkSum>
                    <lspLength></lspLength>
                    <attBit></attBit>
                    <partitionBit></partitionBit>
                    <overloadBit></overloadBit>
                    <holdTime></holdTime>
                    <localLsp></localLsp>
                </trillLsdbInfo>
            </trillLsdbInfos>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

lspId

LSP ID.

The value is a string.

Mandatory

seqenceNumber

Serial number of an LSP.

The value is a string .

Optional

checkSum

Set a tree root priority value for a nickname.

The value is a string.

Optional

lspLength

Length of an LSP.

The value is an integer.

Optional

attBit

ATT flag of an LSP.

The value is an integer.

Optional

partitionBit

Split flag of an LSP.

The value is an integer.

Optional

overloadBit

Overload flag of an LSP.

The value is an integer.

Optional

holdTime

Holdoff time of an LSP.

The value is a string.

Optional

localLsp

Local flag of an LSP.

The value is a Boolean data type.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>      
       <trillSite>
          <instanceId>0</instanceId>
          <trillLsdbInfos>
            <trillLsdbInfo>
              <lspId>380e.a811.1200.00-00*</lspId>
              <seqenceNumber>0x0000004a</seqenceNumber>
              <checkSum>0xe380</checkSum>
              <lspLength>70</lspLength>
              <attBit>0</attBit>
              <partitionBit>0</partitionBit>
              <overloadBit>0</overloadBit>
              <holdTime>755</holdTime>
              <localLsp>true</localLsp>
            </trillLsdbInfo>
          </trillLsdbInfos>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

lspId

LSP ID.

The value is a string.

Mandatory

seqenceNumber

Serial number of an LSP.

The value is a string .

Optional

checkSum

Set a tree root priority value for a nickname.

The value is a string.

Optional

lspLength

Length of an LSP.

The value is an integer.

Optional

attBit

ATT flag of an LSP.

The value is an integer.

Optional

partitionBit

Split flag of an LSP.

The value is an integer.

Optional

overloadBit

Overload flag of an LSP.

The value is an integer.

Optional

holdTime

Holdoff time of an LSP.

The value is a string.

Optional

localLsp

Local flag of an LSP.

The value is a Boolean data type.

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.

TRILL Neighbor Information

Query the TRILL neighbor information

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillPeerInfos/trillPeerInfo

Query the TRILL neighbor information.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>      
       <trillSite>
            <instanceId>0</instanceId>
            <trillPeerInfos>
                <trillPeerInfo>
                    <hostName></hostName>
                    <interfaceName></interfaceName>
                    <circuitId></circuitId>
                    <status></status>
                    <holdTime></holdTime>
                    <priority></priority>
                </trillPeerInfo>
            </trillPeerInfos>
        </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

hostName

System name of a neighbor.

The value is a string.

Mandatory

interfaceName

Name of a neighboring interface.

The value is a string .

Optional

circuitId

Circuit ID of a neighbor.

The value is a string.

Optional

status

Status of a neighbor.

The value is an ENUM type.

Optional

holdTime

Holdoff time of a neighbor.

The value is an integer.

Optional

priority

Priority value of a neighbor.

The value is a string.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>      
      <trillSite>
          <instanceId>0</instanceId>
          <trillPeerInfos>
            <trillPeerInfo>
              <hostName>380e.a821.1200</hostName>
              <interfaceName>Eth3/0/0</interfaceName>
              <circuitId>0000000006</circuitId>
              <status>report</status>
              <holdTime>27</holdTime>
              <priority>--</priority>
            </trillPeerInfo>
          </trillPeerInfos>
        </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

hostName

System name of a neighbor.

The value is a string.

Mandatory

interfaceName

Name of a neighboring interface.

The value is a string .

Optional

circuitId

Circuit ID of a neighbor.

The value is a string.

Optional

status

Status of a neighbor.