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).
Configure an LLDP Interface

Configure an LLDP Interface

Query LLDP Interface Configurations

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface

Query LLDP interface configurations.

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

    Table 3-600 describes elements in requests.

    Table 3-600  Elements

    Element

    Description

    lldpAdminStatus

    Specifies the LLDP status.

    ifName

    Specifies an interface name.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpAdminStatus>txAndRx</lldpAdminStatus>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-601 describes elements in responses.

    Table 3-601  Elements

    Element

    Description

    lldpAdminStatus

    Specifies the LLDP status.

    ifName

    Specifies an interface name.

Modify LLDP Interface Configurations

Operation

URI

Description

PUT

/lldp/lldpInterfaces/lldpInterface

Modify LLDP interface configurations.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpInterface operation="merge"> 
        <ifName>10GE1/0/1</ifName> 
        <lldpAdminStatus>txAndRx</lldpAdminStatus> 
        <tlvTxEnable> 
            <manAddrTxEnable>true</manAddrTxEnable> 
            <portDescTxEnable>true</portDescTxEnable> 
            <sysCapTxEnable>true</sysCapTxEnable> 
            <sysDescTxEnable>true</sysDescTxEnable> 
            <sysNameTxEnable>true</sysNameTxEnable> 
            <portVlanTxEnable>true</portVlanTxEnable> 
            <protoVlanTxEnable>true</protoVlanTxEnable> 
            <vlanNameTxEnable>true</vlanNameTxEnable> 
            <macPhyTxEnable>true</macPhyTxEnable> 
            <linkAggreTxEnable>true</linkAggreTxEnable> 
            <maxFrameTxEnable>true</maxFrameTxEnable> 
        </tlvTxEnable> 
    </lldpInterface>

    Table 3-602 describes elements in requests.

    Table 3-602  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    lldpAdminStatus

    Specifies the LLDP status.

    manAddrTxEnable

    Enables or disables advertisement of the Management Address TLV.

    portDescTxEnable

    Enables or disables advertisement of the Port Description TLV.

    sysCapTxEnable

    Enables or disables advertisement of the System Capability TLV.

    sysDescTxEnable

    Enables or disables advertisement of the System Description TLV.

    sysNameTxEnable

    Enables or disables advertisement of the System Name TLV.

    portVlanTxEnable

    Enables or disables advertisement of the PVID TLV.

    protoVlanTxEnable

    Enables or disables advertisement of the Protocol VLAN TLV.

    vlanNameTxEnable

    Enables or disables advertisement of the VLAN Name TLV.

    macPhyTxEnable

    Enables or disables advertisement of the MAC/PHY TLV.

    linkAggreTxEnable

    Enables or disables advertisement of the link aggregation TLV.

    maxFrameTxEnable

    Enables or disables advertisement of the Maximum Frame TLV.

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

    Table 3-603 describes status codes in responses.

    Table 3-603  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 LLDP Interface Packet Statistics

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpStatistics

Query LLDP interface packet statistics.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <lldpStatistics>  
            <totalNeighbors></totalNeighbors>  
            <transmittedFrames></transmittedFrames>  
            <receivedFrames></receivedFrames>  
            <discardedFrames></discardedFrames>  
            <errorFrames></errorFrames>  
            <discardedTlvs></discardedTlvs>  
            <unrecognizedTlvs></unrecognizedTlvs>  
            <expiredNeighbors></expiredNeighbors>  
            <transmittedDcbxTlvs></transmittedDcbxTlvs>  
            <receivedDcbxTlvs></receivedDcbxTlvs>  
            <lastClearedTime></lastClearedTime>  
    </lldpStatistics>

    Table 3-604 describes elements in requests.

    Table 3-604  Elements

    Element

    Description

    transmittedFrames

    Specifies the number of LLDP packets sent.

    receivedFrames

    Specifies the number of LLDP packets received.

    discardedFrames

    Specifies the number of LLDP packets discarded.

    errorFrames

    Specifies the number of error LLDP packets received.

    discardedTlvs

    Specifies the number of LLDP TLVs discarded.

    unrecognizedTlvs

    Specifies the number of unrecognized TLVs received.

    expiredNeighbors

    Specifies the number of aged LLDP neighbors.

    transmittedDcbxTlvs

    Specifies the number of DCBX TLVs sent.

    receivedDcbxTlvs

    Specifies the number of DCBX TLVs. received

    totalNeighbors

    Specifies the total number of LLDP neighbors.

    lastClearedTime

    Specifies the time when LLDP statistics were last cleared.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpStatistics>
                <transmittedFrames>201</transmittedFrames>
                <receivedFrames>198</receivedFrames>
                <discardedFrames>0</discardedFrames>
                <errorFrames>0</errorFrames>
                <discardedTlvs>0</discardedTlvs>
                <unrecognizedTlvs>0</unrecognizedTlvs>
                <expiredNeighbors>0</expiredNeighbors>
                <transmittedDcbxTlvs>0</transmittedDcbxTlvs>
                <receivedDcbxTlvs>0</receivedDcbxTlvs>
                <totalNeighbors>1</totalNeighbors>
                <lastClearedTime>1970-01-01T00:00:00</lastClearedTime>
              </lldpStatistics>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-605 describes elements in responses.

    Table 3-605  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    transmittedFrames

    Specifies the number of LLDP packets sent.

    receivedFrames

    Specifies the number of LLDP packets received.

    discardedFrames

    Specifies the number of LLDP packets discarded.

    errorFrames

    Specifies the number of error LLDP packets received.

    discardedTlvs

    Specifies the number of LLDP TLVs discarded.

    unrecognizedTlvs

    Specifies the number of unrecognized TLVs received.

    expiredNeighbors

    Specifies the number of aged LLDP neighbors.

    transmittedDcbxTlvs

    Specifies the number of DCBX TLVs sent.

    receivedDcbxTlvs

    Specifies the number of DCBX TLVs. received

    totalNeighbors

    Specifies the total number of LLDP neighbors.

    lastClearedTime

    Specifies the time when LLDP statistics were last cleared.

Query LLDP Neighbor Configurations

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor

Query LLDP neighbor configurations.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <lldpNeighbor>  
           <nbIndex></nbIndex>  
           <chassisIdSubtype></chassisIdSubtype>  
           <chassisId></chassisId>  
           <portIdSubtype></portIdSubtype>  
           <portId></portId>  
           <portDescription></portDescription>  
           <systemName></systemName>  
           <systemDescription></systemDescription>  
           <systemCapabilitiesEnabled></systemCapabilitiesEnabled>  
           <systemCapabilitiesSupported></systemCapabilitiesSupported>  
           <expiredTime></expiredTime>  
           <portVlanId></portVlanId>  
           <protocolIdentity></protocolIdentity>  
           <autoNegSupported></autoNegSupported>  
           <autoNegEnabled></autoNegEnabled>  
           <autoNegAdvertisedCap></autoNegAdvertisedCap>  
           <operMauType></operMauType>  
           <linkAggregationSupported></linkAggregationSupported>  
           <linkAggregationEnabled></linkAggregationEnabled>  
           <aggregationPortId></aggregationPortId>  
           <maximumFrameSize></maximumFrameSize>  
           <discoveredTime></discoveredTime>  
    </lldpNeighbor> 

    Table 3-606 describes elements in requests.

    Table 3-606  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    chassisIdSubtype

    Specifies a neighbor device ID type.

    chassisId

    Specifies a neighbor device ID.

    portIdSubtype

    Specifies a port ID type.

    portId

    Specifies a port ID.

    portDescription

    Specifies a port description.

    systemName

    Specifies the system name.

    systemDescription

    Specifies the system description.

    systemCapabilitiesEnabled

    Specifies the supported system capability.

    systemCapabilitiesSupported

    Specifies the enabled system capability.

    expiredTime

    Specifies a neighbor aging time.

    portVlanId

    Specifies a port VLAN ID.

    protocolIdentity

    Specifies the protocol supported.

    autoNegSupported

    Indicates whether autonegotiation is supported on a port.

    autoNegEnabled

    Indicates whether autonegotiation is enabled on a port.

    autoNegAdvertisedCap

    Specifies the autonegotiation capability.

    operMauType

    Specifies an MAU type.

    linkAggregationSupported

    Indicates whether link aggregation is supported on a port.

    linkAggregationEnabled

    Indicates whether link aggregation is enabled on a port.

    aggregationPortId

    Specifies a link aggregation port ID. The value is 0 if link aggregation is disabled.

    maximumFrameSize

    Specifies the maximum frame size supported.

    discoveredTime

    Specifies the time when a neighbor was discovered.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpNeighbors>
                <lldpNeighbor>
                  <nbIndex>1</nbIndex>
                  <chassisIdSubtype>macAddress</chassisIdSubtype>
                  <chassisId>0000-0105-0961</chassisId>
                  <portIdSubtype>interfaceName</portIdSubtype>
                  <portId>10GE1/0/10</portId>
                  <portDescription></portDescription>
                  <systemName>39.5_fanyadong</systemName>
                  <systemDescription>Huawei Versatile Routing Platform Software&#13;
    VRP (R) software, Version 8.180 (CE6810EI V200R005C00)&#13;
    Copyright (C) 2012-2018 Huawei Technologies Co., Ltd.&#13;
    HUAWEI CE6810-48S4Q-EI&#13;
    </systemDescription>
                  <systemCapabilitiesEnabled>bridge router</systemCapabilitiesEnabled>
                  <systemCapabilitiesSupported>bridge router</systemCapabilitiesSupported>
                  <expiredTime>105</expiredTime>
                  <portVlanId>1</portVlanId>
                  <autoNegSupported>No</autoNegSupported>
                  <autoNegEnabled>No</autoNegEnabled>
                  <autoNegAdvertisedCap>0000</autoNegAdvertisedCap>
                  <operMauType>dot3MauType10GigBaseX</operMauType>
                  <linkAggregationSupported>Yes</linkAggregationSupported>
                  <linkAggregationEnabled>No</linkAggregationEnabled>
                  <aggregationPortId>0</aggregationPortId>
                  <maximumFrameSize>9216</maximumFrameSize>
                  <discoveredTime>2016-08-18T19:50:20</discoveredTime>
                  <protocolIdentity></protocolIdentity>
                </lldpNeighbor>
              </lldpNeighbors>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-607 describes elements in responses.

    Table 3-607  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    chassisIdSubtype

    Specifies a neighbor device ID type.

    chassisId

    Specifies a neighbor device ID.

    portIdSubtype

    Specifies a port ID type.

    portId

    Specifies a port ID.

    portDescription

    Specifies a port description.

    systemName

    Specifies the system name.

    systemDescription

    Specifies the system description.

    systemCapabilitiesEnabled

    Specifies the supported system capability.

    systemCapabilitiesSupported

    Specifies the enabled system capability.

    expiredTime

    Specifies a neighbor aging time.

    portVlanId

    Specifies a port VLAN ID.

    protocolIdentity

    Specifies the protocol supported.

    autoNegSupported

    Indicates whether autonegotiation is supported.

    autoNegEnabled

    Indicates whether autonegotiation is enabled.

    autoNegAdvertisedCap

    Specifies the autonegotiation capability.

    operMauType

    Specifies an MAU type.

    linkAggregationSupported

    Indicates whether a port supports link aggregation.

    linkAggregationEnabled

    Indicates whether link aggregation is enabled on a port.

    aggregationPortId

    Specifies a link aggregation port ID. The value is 0 if link aggregation is disabled.

    maximumFrameSize

    Specifies the maximum frame size supported.

    discoveredTime

    Specifies the time when a neighbor was discovered.

Query the Neighbor Management Address of an LLDP Interface

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor/managementAddresss/managementAddress

Query the neighbor management address of an LLDP interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <managementAddress> 
          <manAddrSubtype></manAddrSubtype> 
          <manAddr></manAddr> 
          <manAddrLen></manAddrLen> 
          <manAddrIfSubtype></manAddrIfSubtype> 
          <manAddrIfId></manAddrIfId> 
          <manAddrOid></manAddrOid>
    </managementAddress>

    Table 3-608 describes elements in requests.

    Table 3-608  Elements

    Element

    Description

    manAddrSubtype

    Specifies a management address type.

    manAddr

    Specifies a neighbor management address.

    manAddrLen

    Specifies the length of the neighbor management address.

    manAddrIfSubtype

    Specifies the interface type of the neighbor management address.

    manAddrIfId

    Specifies the interface ID of the neighbor management address.

    manAddrOid

    Specifies the OID of the neighbor management address.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpNeighbors>
                <lldpNeighbor>
                  <nbIndex>1</nbIndex>
                  <managementAddresss>
                    <managementAddress>
                      <manAddrSubtype>ipv4</manAddrSubtype>
                      <manAddr>2.2.2.2</manAddr>
                      <manAddrLen>5</manAddrLen>
                      <manAddrIfSubtype>ifIndex</manAddrIfSubtype>
                      <manAddrIfId>81</manAddrIfId>
                      <manAddrOid>1.3.6.1.4.1.2011.5.25.41.1.2.1.1.1</manAddrOid>
                    </managementAddress>
                  </managementAddresss>
                </lldpNeighbor>
              </lldpNeighbors>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-609 describes status codes in responses.

    Table 3-609  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    manAddrSubtype

    Specifies a management address type.

    manAddr

    Specifies a neighbor management address.

    manAddrLen

    Specifies the length of the neighbor management address.

    manAddrIfSubtype

    Specifies the interface type of the neighbor management address.

    manAddrIfId

    Specifies the interface ID of the neighbor management address.

    manAddrOid

    Specifies the OID of the neighbor management address.

Query Protocol VLAN Information About an LLDP Interface Neighbor

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor/protoVlans/protoVlan

Query protocol VLAN information about an LLDP interface neighbor.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <protoVlan> 
          <protoVlanSupported></protoVlanSupported> 
          <protoVlanEnabled></protoVlanEnabled> 
          <protoVlanId></protoVlanId>  
    </protoVlan> 

    Table 3-610 describes elements in requests.

    Table 3-610  Elements

    Element

    Description

    protoVlanSupported

    Indicates whether protocol VLAN is supported on a port.

    protoVlanEnabled

    Indicates whether protocol VLAN is enabled on a port.

    protoVlanId

    Specifies a protocol VLAN ID.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpNeighbors>
                <lldpNeighbor>
                  <nbIndex>1</nbIndex>
                  <protoVlans>
                    <protoVlan>
                      <protoVlanId>0</protoVlanId>
                      <protoVlanSupported>No</protoVlanSupported>
                      <protoVlanEnabled>No</protoVlanEnabled>
                    </protoVlan>
                  </protoVlans>
                </lldpNeighbor>
              </lldpNeighbors>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-611describes elements in responses.

    Table 3-611  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    protoVlanSupported

    Indicates whether protocol VLAN is supported on a port.

    protoVlanEnabled

    Indicates whether protocol VLAN is enabled on a port.

    protoVlanId

    Protocol VLAN

Query Unidentifiable Basic TLV Information About an LLDP Interface Neighbor

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor/unknownTlvs/unknownTlv

Query unidentifiable basic TLV information about an LLDP interface neighbor.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <unknownTlv>
         <unknownTlvType></unknownTlvType>
         <unknownTlvInfo></unknownTlvInfo>
    </unknownTlv>

    Table 3-612 describes elements in requests.

    Table 3-612  Elements

    Element

    Description

    unknownTlvType

    Specifies an unidentifiable TLV type.

    unknownTlvInfo

    Specifies unidentifiable TLV information.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface> 
               <ifName>10GE1/0/1</ifName> 
               <lldpNeighbors> 
                 <lldpNeighbor> 
                   <nbIndex>1</nbIndex> 
                   <unknownTlvs>
                     <unknownTlv>
                      <unknownTlvType>16</unknownTlvType>
                      <unknownTlvInfo>07 06 38 4b 7e 11 11 10 01 00 00 00 00 00</unknownTlvInfo>
                     </unknownTlv>
                   </unknownTlvs>
                 </lldpNeighbor> 
               </lldpNeighbors> 
             </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-613 describes elements in responses

    Table 3-613  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    unknownTlvType

    Specifies an unidentifiable TLV type.

    unknownTlvInfo

    Specifies unidentifiable TLV information.

Query Unidentifiable Organization-defined TLV Information About an LLDP Interface Neighbor

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor/unknownOrgDefTlvs/unknownOrgDefTlv

Query unidentifiable organization-defined TLV information about an LLDP interface neighbor.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <unknownOrgDefTlv>
          <unknownOrgDefInfoOui></unknownOrgDefInfoOui>
          <unknownOrgDefSubtype></unknownOrgDefSubtype>
          <unknownOrgDefInfoIndex></unknownOrgDefInfoIndex>
          <unknownOrgDefInfo></unknownOrgDefInfo>
    </unknownOrgDefTlv>

    Table 3-614 describes elements in requests.

    Table 3-614  Elements

    Element

    Description

    unknownOrgDefInfoOui

    Specifies the OUI of an unidentifiable organization-defined TLV.

    unknownOrgDefInfoIndex

    Specifies the index of an unidentifiable organization-defined TLV.

    unknownOrgDefSubtype

    Specifies the type of an unidentifiable organization-defined TLV.

    unknownOrgDefInfo

    Specifies information about an unidentifiable organization-defined TLV.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface> 
               <ifName>10GE1/0/1</ifName> 
               <lldpNeighbors> 
                 <lldpNeighbor> 
                   <nbIndex>1</nbIndex> 
                  <unknownOrgDefTlvs>
                   <unknownOrgDefTlv>
                        <unknownOrgDefInfoOui>60-31-32</unknownOrgDefInfoOui>
                        <unknownOrgDefSubtype>51</unknownOrgDefSubtype>
                        <unknownOrgDefInfoIndex>1</unknownOrgDefInfoIndex>
                        <unknownOrgDefInfo>34 35 36 37 38 39 30 2d 3d 7e 21 40 23 24 25 5e 26 2a 28 29 5f 2b 31 30 2e 31 33 38 2e 38 31 2e 31 37 34 3b 68 74 74 70 3a 2f 2f 68 75 61 77 65 69 2e 77 33 2e 63 6f 6d 60 31 32 33 34 35 36 37 38 39 30 2d 3d 7e 21 40 23 24 25 5e 26 2a 28 29 5f 2b 31 30 2e 31 33 38 2e 38 31 2e 31 37 34 3b 68 74 74 70 3a 2f 2f 68 75 61 77 65 69 2e 77 33 2e 63 6f 6d 60 31 32 33 34 35 36 37 38 39 30 2d 3d 7e 21 40 23 24 25 5e 26 2a 28 29 5f 2b 31 30 2e 31 33 38 2e 38 31 2e 31 37 34 3b 68 74 74 70 3a 2f 2f 68 75 61 77 65 69 2e 77 33 2e 63 6f 6d 60 31 32 33 34 35 36 37 38 39 30 2d 3d 7e 21 40 23 24 25 5e 26 2a 28 29 5f 2b 31 30 2e 31 33 38 2e 38 31 2e 31 37 34 3b 68 74 74 70 3a 2f 2f 68 75 61 77 65 69 2e 77 33 2e 63 6f 6d 6c 61 60 31 32 33 34 35 6c 61 60 31 32 33 34</unknownOrgDefInfo>
                    </unknownOrgDefTlv>
                  </unknownOrgDefTlvs>
                 </lldpNeighbor> 
               </lldpNeighbors> 
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-615 describes elements in responses.

    Table 3-615  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    unknownOrgDefInfoOui

    Specifies the OUI of an unidentifiable organization-defined TLV.

    unknownOrgDefInfoIndex

    Specifies the index of an unidentifiable organization-defined TLV.

    unknownOrgDefSubtype

    Specifies the type of an unidentifiable organization-defined TLV.

    unknownOrgDefInfo

    Specifies information about an unidentifiable organization-defined TLV.

Query the VLAN Name of an LLDP Interface Neighbor

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpNeighbors/lldpNeighbor/vlanNames/vlanName

Query the VLAN name of an LLDP interface neighbor.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vlanName>
         <vlanNameId></vlanNameId>
         <vlanName></vlanName>
    </vlanName>

    Table 3-616 describes elements in requests.

    Table 3-616  Elements

    Element

    Description

    vlanNameId

    Specifies a VLAN ID.

    vlanName

    Specifies a VLAN name.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface> 
               <ifName>10GE1/0/1</ifName> 
               <lldpNeighbors> 
                 <lldpNeighbor> 
                   <nbIndex>1</nbIndex> 
                  <vlanNames>
                    <vlanName>
                      <vlanNameId>2</vlanNameId>
                      <vlanName>vlan1</vlanName>
                    </vlanName>
                  </vlanNames> 
                 </lldpNeighbor> 
               </lldpNeighbors> 
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-617 describes elements in responses.

    Table 3-617  Elements

    Element

    Description

    nbIndex

    Specifies a neighbor index.

    ifName

    Specifies an interface name.

    vlanNameId

    Specifies a VLAN ID.

    vlanName

    Specifies a VLAN name.

Query Error Packet Information on an LLDP Interface

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpErrPkt

Query error packet information on an LLDP interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpErrPkt> 
          <errPktRecvTime></errPktRecvTime> 
          <errPktInfo></errPktInfo> 
    </lldpErrPkt> 

    Table 3-618 describes elements in requests.

    Table 3-618  Elements

    Element

    Description

    errPktRecvTime

    Specifies the time when error packets were received.

    errPktInfo

    Specifies the error LLDP packet content.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
           <lldpInterfaces>
            <lldpInterface>
              <ifName>10GE1/0/1</ifName>
              <lldpErrPkt>
                <errPktRecvTime>2016-08-18T19:50:20</errPktRecvTime>
                <errPktInfo>0180c200    000e485c    8f222221    88cc0207    04485c8f    22222104    0e054574    6865726e    6574332f    302f3006    02000508    ff603132    33343536    37383930    2d3d7e21    40232425    5e262a28    295f2b31    302e3133    382e3831    2e313734    3b687474    703a2f2f    68756177    65692e77    332e636f    6d603132    33343536    37383930    2d3d7e21    40232425    5e262a28    295f2b31    302e3133    382e3831    2e313734    3b687474    703a2f2f    68756177    65692e77    332e636f    6d603132    33343536    37383930    2d3d7e21    40232425    5e262a28    295f2b31    302e3133    382e3831    2e313734    3b687474    703a2f2f    68756177    65692e77    332e636f    6d603132    33343536    37383930    2d3d7e21    40232425    5e262a28    295f2b31    302e3133    382e3831    2e313734    3b687474    703a2f2f    68756177    65692e77    332e636f    6d6c6160    31323334    356c6160    31323334    0aff6874    74703a2f    2f687561    7765692e    77332e63    6f6d3132    33343536    37383930    31323334    35363738    39307e21    40232425    5e262a28    295f2b51    57455254    5955494f    507b7d7c    41534446    47484a4b    4c3a223e    3c4d4e42    5643585a    71776572    74797569    6f705b5d    5c617364    6667686a    6b6c3b27    2f2e2c6d    6e627663    787a6874    74703a2f    2f687561    7765692e    77332e63    6f6d3132    33343536    37383930    31323334    35363738    39307e21    40232425    5e262a28    295f2b51    57455254    5955494f    507b7d7c    41534446    47484a4b    4c3a223e    3c4d4e42    5643585a    71776572    74797569    6f705b5d    5c617364    6667686a    6b6c3b27    2f2e2c6d    6e627663    787a6c61    6c616161    68747470    3a2f2f68    750c3456    52502028    52292073    6f667477    6172652c    20566572    73696f6e    20382e33    30202856    52502056    38303052    30303543    30304230    3236290e    04007f00    7f100e07    06384b7e    11111001    00000000    00fe0600    80c201ff    fffe0700    80c20206    000afe27    0080c203    0ffe207e    21402324    255e262a    28295f2b    51574552    54595549    4f507b7d    7c415344    46477efe    0900120f    01030000    0000fe09    00120f03    030000ff    fffe0600    120f04ff    ff0000</errPktInfo>
              </lldpErrPkt>
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-619 describes elements in responses.

    Table 3-619  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    errPktRecvTime

    Specifies the time when error packets were received.

    errPktInfo

    Specifies the error LLDP packet content.

Query LLDP Interface Information

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/lldpIfInformation

Query LLDP interface information.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <lldpIfInformation> 
            <portIdSubtype></portIdSubtype> 
            <portId></portId> 
            <portDescription></portDescription> 
            <portVlanId></portVlanId> 
            <protoVlanSupported></protoVlanSupported> 
            <protoVlanEnabled></protoVlanEnabled> 
            <protoVlanId></protoVlanId> 
            <vlanNameId></vlanNameId> 
            <vlanName></vlanName> 
            <protocolIdentity></protocolIdentity> 
            <autoNegSupported></autoNegSupported> 
            <autoNegEnabled></autoNegEnabled> 
            <autoNegAdvertisedCap></autoNegAdvertisedCap> 
            <operMauType></operMauType> 
            <linkAggregationSupported></linkAggregationSupported> 
            <linkAggregationEnabled></linkAggregationEnabled> 
            <aggregationPortId></aggregationPortId> 
            <maximumFrameSize></maximumFrameSize> 
    </lldpIfInformation> 

    Table 3-620 describes elements in requests.

    Table 3-620  Elements

    Element

    Description

    portIdSubtype

    Specifies a port ID type.

    portId

    Port ID.

    portDescription

    Specifies a port description.

    portVlanId

    Specifies a port VLAN ID.

    protoVlanSupported

    Indicates whether protocol VLAN is supported on a port.

    protoVlanEnabled

    Indicates whether protocol VLAN is enabled on a port.

    protoVlanId

    Specifies a protocol VLAN ID.

    vlanNameId

    Specifies a VLAN ID.

    vlanName

    Specifies a VLAN name.

    protocolIdentity

    Specifies the protocol supported.

    autoNegSupported

    Indicates whether autonegotiation is supported on a port.

    autoNegEnabled

    Indicates whether autonegotiation is enabled on a port.

    autoNegAdvertisedCap

    Specifies the autonegotiation capability.

    operMauType

    Specifies an MAU type.

    linkAggregationSupported

    Indicates whether link aggregation is supported on a port.

    linkAggregationEnabled

    Indicates whether link aggregation is enabled on a port.

    aggregationPortId

    Specifies a link aggregation port ID. The value is 0 if link aggregation is disabled.

    maximumFrameSize

    Specifies the maximum frame size supported.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply>
     <data>
       <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
         <lldpInterfaces>
           <lldpInterface> 
             <ifName>10GE1/0/1</ifName> 
             <lldpIfInformation> 
               <portIdSubtype>interfaceName</portIdSubtype> 
               <portId>10GE</portId> 
               <portDescription></portDescription> 
               <portVlanId>1</portVlanId> 
               <protoVlanSupported>No</protoVlanSupported> 
               <protoVlanEnabled>No</protoVlanEnabled> 
               <protoVlanId>0</protoVlanId> 
               <vlanNameId>1</vlanNameId> 
               <vlanName>VLAN1</vlanName> 
               <autoNegSupported>Yes</autoNegSupported> 
               <autoNegEnabled>Yes</autoNegEnabled> 
               <autoNegAdvertisedCap>83a0(100baseTXFD 100baseT2FD FdxPause FdxAPause 1000baseTFD)</autoNegAdvertisedCap> 
               <operMauType>dot3MauType1000BaseXFD</operMauType> 
               <linkAggregationSupported>Yes</linkAggregationSupported> 
               <linkAggregationEnabled>Yes</linkAggregationEnabled> 
               <aggregationPortId>2</aggregationPortId> 
               <maximumFrameSize>9216</maximumFrameSize> 
               <protocolIdentity>STP RSTP/MSTP LACP</protocolIdentity> 
            </lldpIfInformation> 
           </lldpInterface>
         </lldpInterfaces>
       </lldp>
      </data>
    </rpc-reply>

    Table 3-621 describes elements in responses.

    Table 3-621  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    portIdSubtype

    Specifies a port ID type.

    portId

    Port ID.

    portDescription

    Specifies a port description.

    portVlanId

    Specifies a port VLAN ID.

    protoVlanSupported

    Indicates whether protocol VLAN is supported on a port.

    protoVlanEnabled

    Indicates whether protocol VLAN is enabled on a port.

    protoVlanId

    Specifies a protocol VLAN ID.

    vlanNameId

    Specifies a VLAN ID.

    vlanName

    Specifies a VLAN name.

    protocolIdentity

    Specifies the protocol supported.

    autoNegSupported

    Indicates whether autonegotiation is supported on a port.

    autoNegEnabled

    Indicates whether autonegotiation is enabled on a port.

    autoNegAdvertisedCap

    Specifies the autonegotiation capability.

    operMauType

    Specifies an MAU type.

    linkAggregationSupported

    Indicates whether link aggregation is supported on a port.

    linkAggregationEnabled

    Indicates whether link aggregation is enabled on a port.

    aggregationPortId

    Specifies a link aggregation port ID. The value is 0 if link aggregation is disabled.

    maximumFrameSize

    Specifies the maximum frame size supported.

Query LLDP TLV Configuration

Operation

URI

Description

GET

/lldp/lldpInterfaces/lldpInterface/tlvTxEnable

Query LLDP TLV configuration.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?> 
    <tlvTxEnable> 
            <manAddrTxEnable></manAddrTxEnable> 
            <portDescTxEnable></portDescTxEnable> 
            <sysCapTxEnable></sysCapTxEnable> 
            <sysDescTxEnable></sysDescTxEnable> 
            <sysNameTxEnable></sysNameTxEnable> 
            <portVlanTxEnable></portVlanTxEnable> 
            <protoVlanTxEnable></protoVlanTxEnable> 
            <txProtocolVlanId></txProtocolVlanId> 
            <vlanNameTxEnable></vlanNameTxEnable> 
            <txVlanNameId></txVlanNameId> 
            <protoIdTxEnable></protoIdTxEnable> 
            <macPhyTxEnable></macPhyTxEnable> 
            <linkAggreTxEnable></linkAggreTxEnable> 
            <maxFrameTxEnable></maxFrameTxEnable> 
    </tlvTxEnable> 

    Table 3-622 describes elements in requests.

    Table 3-622  Elements

    Element

    Description

    manAddrTxEnable

    Enables or disables advertisement of the Management Address TLV.

    portDescTxEnable

    Enables or disables advertisement of the Port Description TLV.

    sysCapTxEnable

    Enables or disables advertisement of the System Capability TLV.

    sysDescTxEnable

    Enables or disables advertisement of the System Description TLV.

    sysNameTxEnable

    Enables or disables advertisement of the System Name TLV.

    portVlanTxEnable

    Enables or disables advertisement of the PVID TLV.

    protoVlanTxEnable

    Enables or disables advertisement of the Protocol VLAN TLV.

    txProtocolVlanId

    Specifies a protocol VLAN ID.

    vlanNameTxEnable

    Enables or disables advertisement of the VLAN Name TLV.

    txVlanNameId

    Specifies the VLAN ID of the VLAN Name TLV.

    protoIdTxEnable

    Enables or disables advertisement of the Protocol Identity TLV.

    macPhyTxEnable

    Enables or disables advertisement of the MAC/PHY TLV.

    linkAggreTxEnable

    Enables or disables advertisement of the link aggregation TLV.

    maxFrameTxEnable

    Enables or disables advertisement of the Maximum Frame TLV.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <rpc-reply>
      <data>
        <lldp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <lldpInterfaces>
            <lldpInterface> 
               <ifName>10GE1/0/1</ifName> 
               <tlvTxEnable> 
                  <portDescTxEnable>true</portDescTxEnable> 
                  <sysNameTxEnable>true</sysNameTxEnable> 
                  <sysDescTxEnable>true</sysDescTxEnable> 
                  <sysCapTxEnable>true</sysCapTxEnable> 
                  <manAddrTxEnable>true</manAddrTxEnable> 
                  <portVlanTxEnable>true</portVlanTxEnable> 
                  <vlanNameTxEnable>true</vlanNameTxEnable> 
                  <protoVlanTxEnable>true</protoVlanTxEnable> 
                  <macPhyTxEnable>true</macPhyTxEnable> 
                  <linkAggreTxEnable>true</linkAggreTxEnable> 
                  <maxFrameTxEnable>true</maxFrameTxEnable> 
                  <txVlanNameId/> 
                  <txProtocolVlanId/> 
                  <protoIdTxEnable>false</protoIdTxEnable> 
              </tlvTxEnable> 
            </lldpInterface>
          </lldpInterfaces>
        </lldp>
      </data>
    </rpc-reply>

    Table 3-623 describes elements in responses.

    Table 3-623  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    manAddrTxEnable

    Enables or disables advertisement of the Management Address TLV.

    portDescTxEnable

    Enables or disables advertisement of the Port Description TLV.

    sysCapTxEnable

    Enables or disables advertisement of the System Capability TLV.

    sysDescTxEnable

    Enables or disables advertisement of the System Description TLV.

    sysNameTxEnable

    Enables or disables advertisement of the System Name TLV.

    portVlanTxEnable

    Enables or disables advertisement of the PVID TLV.

    protoVlanTxEnable

    Enables or disables advertisement of the Protocol VLAN TLV.

    txProtocolVlanId

    Specifies a protocol VLAN ID.

    vlanNameTxEnable

    Enables or disables advertisement of the VLAN Name TLV.

    txVlanNameId

    Specifies the VLAN ID of the VLAN Name TLV.

    protoIdTxEnable

    Enables or disables advertisement of the Protocol Identity TLV.

    macPhyTxEnable

    Enables or disables advertisement of the MAC/PHY TLV.

    linkAggreTxEnable

    Enables or disables advertisement of the link aggregation TLV.

    maxFrameTxEnable

    Enables or disables advertisement of the Maximum Frame TLV.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 27852

Downloads: 123

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