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).
Global LLDP Attributes

Global LLDP Attributes

Query Global LLDP Attributes

Operation

URI

Description

GET

/lldp/lldpSys

Query global LLDP attributes.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1024">
     <get>
      <filter type="subtree">
       <lldp xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
        <lldpSys>
         <lldpEnable></lldpEnable>
         <mdnStatus></mdnStatus>
         <lldpSysInformation></lldpSysInformation>
         <lldpSysParameter></lldpSysParameter>
         <mdnSysStatistics></mdnSysStatistics>
         <lldpSysStatistics></lldpSysStatistics>
        </lldpSys>
       </lldp>
      </filter>
     </get>
    </rpc> 

    Table 3-587 describes elements in requests.

    Table 3-587  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    lldpSysInformation

    Specifies global dynamic LLDP information.

    lldpSysParameter

    Specifies global LLDP configurations.

    mdnSysStatistics

    Specifies global MDN statistics.

    lldpSysStatistics

    Specifies global LLDP statistics.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1024">
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
          <lldpSys>
            <lldpEnable>enabled</lldpEnable>
            <mdnStatus>disabled</mdnStatus>
          </lldpSys>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-588 describes elements in responses.

    Table 3-588  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

Operation

URI

Description

PUT

/lldp/lldpSys

Modify global LLDP parameters.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="801">
      <edit-config>
        <target>
          <running/>
        </target>
        <default-operation>merge</default-operation>
        <error-option>rollback-on-error</error-option>
        <config>
          <lldp xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
            <lldpSys operation="merge">
              <lldpEnable>enabled</lldpEnable>
              <mdnStatus>disabled</mdnStatus>
            </lldpSys>
          </lldp>
        </config>
      </edit-config>
    </rpc>

    Table 3-589 describes elements in requests.

    Table 3-589  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply message-id="801" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" flow-id="98">
    ? <ok/>
    </rpc-reply>

Query Global Dynamic LLDP Information

Operation

URI

Description

GET

/lldp/lldpSys/lldpSysInformation

Query global dynamic LLDP parameters.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
        <lldpEnable></lldpEnable> 
        <mdnStatus></mdnStatus> 
        <lldpSysInformation> 
            <chassisIdSubtype></chassisIdSubtype> 
            <chassisId></chassisId> 
            <sysName></sysName> 
            <sysDesc></sysDesc> 
            <sysCapEnabled></sysCapEnabled> 
            <sysCapSupported></sysCapSupported> 
            <manAddrSubtype></manAddrSubtype> 
            <manAddr></manAddr> 
            <manAddrLen></manAddrLen> 
            <manAddrIfSubtype></manAddrIfSubtype> 
            <manAddrIfId></manAddrIfId> 
            <manAddrOid></manAddrOid> 
            <lldpUpTime></lldpUpTime> 
        </lldpSysInformation> 
    </lldpSys> 

    Table 3-590 describes elements in requests.

    Table 3-590  Elements

    Elemen

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    chassisIdSubtype

    Specifies the device ID sub-type.

    chassisId

    Specifies the device ID.

    sysName

    Specifies the system name.

    sysDesc

    Specifies the system description.

    sysCapEnabled

    Specifies the enabled system capability

    sysCapSupported

    Specifies the supported system capability.

    manAddrSubtype

    Specifies the management address sub-type.

    manAddr

    Specifies the management address.

    manAddrLen

    Specifies the management address length.

    manAddrIfSubtype

    Specifies the port sub-type of the management address.

    manAddrIfId

    Specifies the port ID of the management address.

    manAddrOid

    Specifies the OID of the management address.

    lldpUpTime

    Specifies the time when LLDP was enabled.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
             <lldpEnable>enabled</lldpEnable> 
             <mdnStatus>disabled</mdnStatus> 
             <lldpSysInformation> 
               <chassisIdSubtype>macAddress</chassisIdSubtype> 
               <chassisId>38ba-ced9-5202</chassisId> 
               <sysName>HUAWEI</sysName> 
               <sysDesc>Huawei Versatile Routing Platform Software 
      
     VRP (R) software, Version 8.90 (CE6850 V800R009C10B060) 
      
     Copyright (C) 2012-2014 Huawei Technologies Co., Ltd. 
      
     HUAWEI CE6850 
      
     </sysDesc> 
               <sysCapEnabled>bridge router</sysCapEnabled> 
               <sysCapSupported>bridge router</sysCapSupported> 
               <manAddrSubtype>ipv4</manAddrSubtype> 
               <manAddr>10.137.211.28</manAddr> 
               <manAddrLen>5</manAddrLen> 
               <manAddrIfSubtype>ifIndex</manAddrIfSubtype> 
               <manAddrIfId>3</manAddrIfId> 
               <manAddrOid>1.3.6.1.4.1.2011.5.25.41.1.2.1.1.1</manAddrOid> 
               <lldpUpTime>2015-05-02T18:04:22</lldpUpTime> 
             </lldpSysInformation> 
    </lldpSys>

    Table 3-591 describes elements in responses

    Table 3-591  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    chassisIdSubtype

    Specifies the device ID sub-type.

    chassisId

    Specifies the device ID.

    sysName

    Specifies the system name.

    sysDesc

    Specifies the system description.

    sysCapEnabled

    Specifies the enabled system capability.

    sysCapSupported

    Specifies the supported system capability.

    manAddrSubtype

    Specifies the port sub-type of the management address.

    manAddr

    Specifies the management address.

    manAddrLen

    Specifies the management address length.

    manAddrIfSubtype

    Specifies the port sub-type of the management address.

    manAddrIfId

    Specifies the port ID of the management address.

    manAddrOid

    Specifies the OID of the management address.

    lldpUpTime

    Specifies the time when LLDP was enabled.

Query Global LLDP Configurations

Operation

URI

Description

GET

/lldp/lldpSys/lldpSysParameter

Query global LLDP configurations.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
        <lldpEnable></lldpEnable> 
        <mdnStatus></mdnStatus> 
        <lldpSysParameter> 
            <messageTxInterval></messageTxInterval> 
            <messageTxHoldMultiplier></messageTxHoldMultiplier> 
            <reinitDelay></reinitDelay> 
            <txDelay></txDelay> 
            <notificationInterval></notificationInterval> 
            <notificationEnable></notificationEnable> 
            <fastMessageCount></fastMessageCount> 
            <mdnNotificationInterval></mdnNotificationInterval> 
            <mdnNotificationEnable></mdnNotificationEnable> 
            <configManAddr></configManAddr> 
            <bindifName></bindifName> 
        </lldpSysParameter> 
    </lldpSys> 

    Table 3-592 describes elements in requests.

    Table 3-592  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    messageTxInterval

    Specifies the interval at which LLDP messages are sent, in seconds. The default value is 30.

    messageTxHoldMultiplier

    Specifies the multiplier for the LLDP message holding time. The default value is 4.

    reinitDelay

    Specifies the delay after which the LLDP module of a port is re-enabled, in seconds. The default value is 2.

    txDelay

    Specifies the delay after which LLDP messages are sent, in seconds. The default value is 2.

    notificationInterval

    Specifies the suppression time after which LLDP alarms are sent, in seconds. The default value is 5.

    notificationEnable

    Specifies whether to enable LLDP neighbor change alarms.

    fastMessageCount

    Specifies the number of rapidly sent LLDP messages. The default value is 4.

    mdnNotificationInterval

    Specifies the suppression time after which MDN alarms are sent, in seconds. The default value is 5.

    mdnNotificationEnable

    Specifies whether to enable MDN neighbor change alarms.

    configManAddr

    Specifies the management address of a device. The management address, which must actually exist, facilitates network management.

    bindifName

    Specifies the name of a bound interface.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
             <lldpEnable>enabled</lldpEnable> 
             <mdnStatus>disabled</mdnStatus> 
             <lldpSysParameter> 
               <configManAddr/> 
               <messageTxInterval>30</messageTxInterval> 
               <messageTxHoldMultiplier>4</messageTxHoldMultiplier> 
               <reinitDelay>2</reinitDelay> 
               <txDelay>2</txDelay> 
               <notificationInterval>5</notificationInterval> 
               <notificationEnable>enabled</notificationEnable> 
               <fastMessageCount>4</fastMessageCount> 
               <mdnNotificationInterval>5</mdnNotificationInterval> 
               <mdnNotificationEnable>disabled</mdnNotificationEnable>
               <bindifName></bindifName> 
             </lldpSysParameter> 
    </lldpSys>

    Table 3-593 describes elements in responses.

    Table 3-593  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    messageTxInterval

    Specifies the interval at which LLDP messages are sent, in seconds. The default value is 30.

    messageTxHoldMultiplier

    Specifies the multiplier for the LLDP message holding time. The default value is 4.

    reinitDelay

    Specifies the delay after which the LLDP module of a port is re-enabled, in seconds. The default value is 2.

    txDelay

    Specifies the delay after which LLDP messages are sent, in seconds. The default value is 2.

    notificationInterval

    Specifies the suppression time after which LLDP alarms are sent, in seconds. The default value is 5.

    notificationEnable

    Specifies whether to enable LLDP neighbor change alarms.

    fastMessageCount

    Specifies the number of rapidly sent LLDP packets. The default value is 4.

    mdnNotificationInterval

    Specifies the suppression time after which MDN alarms are sent, in seconds. The default value is 5.

    mdnNotificationEnable

    Specifies whether to enable MDN neighbor change alarms.

    configManAddr

    Specifies the management address of a device. The management address, which must actually exist, facilitates network management.

    bindifName

    Specifies the name of a bound interface.

Query Global LLDP Statistics

Operation

URI

Description

GET

/lldp/lldpSys/lldpSysStatistics

Query global LLDP statistics.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
        <lldpEnable></lldpEnable> 
        <mdnStatus></mdnStatus> 
        <lldpSysStatistics> 
            <remTablesLastChangeTime></remTablesLastChangeTime> 
            <remTablesInserts></remTablesInserts> 
            <remTablesDeletes></remTablesDeletes> 
            <remTablesDrops></remTablesDrops> 
            <remTablesAgeouts></remTablesAgeouts> 
            <totalNeighbors></totalNeighbors> 
        </lldpSysStatistics> 
    </lldpSys> 

    Table 3-594 describes elements in requests.

    Table 3-594  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    remTablesLastChangeTime

    Specifies the latest time when the LLDP neighbor table was updated.

    remTablesInserts

    Specifies the number of new LLDP neighbors.

    remTablesDeletes

    Specifies the number of deleted LLDP neighbors.

    remTablesDrops

    Specifies the number of dropped LLDP neighbors.

    remTablesAgeouts

    Specifies the number of aged LLDP neighbors.

    totalNeighbors

    Specifies the total number of LLDP neighbors.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
             <lldpEnable>enabled</lldpEnable> 
             <mdnStatus>disabled</mdnStatus>  
             <lldpSysStatistics> 
               <remTablesLastChangeTime>0 days, 0 hours, 0 minutes, 0 seconds</remTablesLastChangeTime> 
               <remTablesInserts>0</remTablesInserts> 
               <remTablesDeletes>0</remTablesDeletes> 
               <remTablesDrops>0</remTablesDrops> 
               <remTablesAgeouts>0</remTablesAgeouts> 
               <totalNeighbors>0</totalNeighbors> 
             </lldpSysStatistics> 
    </lldpSys>

    Table 3-595 describes elements in responses.

    Table 3-595  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    remTablesLastChangeTime

    Specifies the number of new LLDP neighbors.

    remTablesInserts

    Specifies the number of new LLDP neighbors.

    remTablesDeletes

    Specifies the number of deleted LLDP neighbors.

    remTablesDrops

    Specifies the number of dropped LLDP neighbors

    remTablesAgeouts

    Specifies the number of aged LLDP neighbors.

    totalNeighbors

    Specifies the total number of LLDP neighbors.

Query Global LLDP MDN Statistics

PUT

URI

Description

GET

/lldp/lldpSys/mdnSysStatistics

Query global LLDP MDN statistics.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
        <lldpEnable></lldpEnable> 
        <mdnStatus></mdnStatus> 
        <mdnSysStatistics> 
            <remTablesLastChangeTime></remTablesLastChangeTime> 
            <remTablesInserts></remTablesInserts> 
            <remTablesDeletes></remTablesDeletes> 
            <remTablesDrops></remTablesDrops> 
            <remTablesAgeouts></remTablesAgeouts> 
            <totalNeighbors></totalNeighbors> 
        </mdnSysStatistics>  
    </lldpSys> 

    Table 3-596 describes elements in requests.

    Table 3-596  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    remTablesLastChangeTime

    Specifies the latest time when the MDN neighbor table was updated.

    remTablesInserts

    Specifies the number of new MDN neighbors.

    remTablesDeletes

    Specifies the number of deleted MDN neighbors.

    remTablesDrops

    Specifies the number of dropped MDN neighbors.

    remTablesAgeouts

    Specifies the number of aged MDN neighbors.

    totalNeighbors

    Specifies the total number of MDN neighbors.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpSys> 
             <lldpEnable>enabled</lldpEnable> 
             <mdnStatus>disabled</mdnStatus> 
             <mdnSysStatistics> 
               <remTablesLastChangeTime>0 days, 0 hours, 0 minutes, 0 seconds</remTablesLastChangeTime> 
               <remTablesInserts>0</remTablesInserts> 
               <remTablesDeletes>0</remTablesDeletes> 
               <remTablesDrops>0</remTablesDrops> 
               <remTablesAgeouts>0</remTablesAgeouts> 
               <totalNeighbors>0</totalNeighbors> 
             </mdnSysStatistics> 
    </lldpSys>

    Table 3-597 describes elements in responses.

    Table 3-597  Elements

    Element

    Description

    lldpEnable

    Specifies whether LLDP is globally enabled.

    mdnStatus

    Specifies whether MDN is globally enabled.

    remTablesLastChangeTime

    Specifies the latest time when the MDN neighbor table was updated.

    remTablesInserts

    Specifies the number of new MDN neighbors.

    remTablesDeletes

    Specifies the number of deleted MDN neighbors.

    remTablesDrops

    Specifies the number of dropped MDN neighbors.

    remTablesAgeouts

    Specifies the number of aged MDN neighbors.

    totalNeighbors

    Specifies the total number of LLDP neighbors.

Modify Global LLDP Attributes

Operation

URI

Description

PUT

/lldp/lldpSys/lldpSysParameter

Modify global LLDP attributes.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?> 
    <lldpSys> 
        <lldpSysParameter> 
           <messageTxInterval>30</messageTxInterval> 
        </lldpSysParameter> 
    </lldpSys>

    Table 3-598 scribes elements in requests.

    Table 3-598  Elements

    Element

    Description

    messageTxInterval

    Specifies the interval at which LLDP messages are sent, in seconds. The value ranges from 5 to 32768. The default value is 30.

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

    Table 3-599 describes status codes in responses.

    Table 3-599  Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

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

    500 Internal Server Error

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

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 28176

Downloads: 123

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