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).
MSTP Process

MSTP Process

Create an MSTP Process

Operation

URI

Description

POST

/mstp/processs/process

Create an MSTP process.

  • Request example
    <mstp xmlns='http://www.huawei.com/netconf/vrp' content-version='1.0' format-version='1.0'>
        <processs>
            <process operation='create'>
                <processId>1</processId>
                <enable>false</enable>
                <bpduProtection>false</bpduProtection>
                <flushCapability>false</flushCapability>
                <maxHops>20</maxHops>
                <mode>Mstp</mode>
                <pathCostStandard>Dot1T</pathCostStandard>
                <tcNotify>false</tcNotify>
                <tcProtection>false</tcProtection>
                <tcProtectionThreshold>1</tcProtectionThreshold>
                <interval/>
                <timerFactor>3</timerFactor>
                <linkShareProtect>false</linkShareProtect>
                <regionName/>
                <revisionLevel>0</revisionLevel>
                <modulo/>
                <instVlanMode>false</instVlanMode>
                <forwardDelay>1500</forwardDelay>
                <helloTime>200</helloTime>
                <maxAge>2000</maxAge>
                <timerParaMode>false</timerParaMode>
               <convergeMode>Normal</convergeMode>
            /process>
        </processs>
    </mstp>

    Table 3-540 describes elements in requests.

    Table 3-540  Elements

    Element

    Description

    processId

    Specifies a process ID.

    enable

    Enables or disables STP/RSTP/MSTP on a switch.

    bpduProtection

    Enables or disables BPDU protection on the edge port to prevent network flapping in the case of attacks.

    flushCapability

    Enables or disables the flush function.

    mode

    Specifies a working mode for an MSTP process. The value can be STP, RSTP, or MSTP.

    pathCostStandard

    Specifies a method for calculating the path cost. The value can be dot1d-1998, dot1t, or legacy. The default value is dot1t.

    tcNotify

    Enables TC notification for an MSTP process. By default, TC notification is disabled.

    tcProtection

    Enables protection for TC BPDUs of an MSTP process. By default, protection for TC BPDUs of an MSTP process is disabled, meaning that the MSTP process updates entries upon receipt of a TC BPDU.

    tcProtectionThreshold

    Specifies the maximum number of TC BPDUs that an MSTP process can process in a specified period of time. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    interval

    Specifies a period of time during which an MSTP process can process received TC BPDUs. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    timerFactor

    Specifies a multiplier of HelloTime to obtain the timeout period. The value is an integer ranging from 1 to 10. The default value is 3.

    linkShareProtect

    Enables shared link protection for an MSTP process.

    regionName

    Specifies an MSTP region name. By default, the MSTP region name is the MAC address of the switch's main control board.

    revisionLevel

    Specifies an MSTP revision level. The default value is 0.

    modulo

    Specifies an instance-VLAN mapping mode.

    instVlanMode

    Indicates whether to use the instance-VLAN mapping mode.

    forwardDelay

    Specifies a Forward Delay time. The value is an integer ranging from 400 to 3000, in centiseconds. The step is 100. The default value is 1500 centiseconds.

    helloTime

    Specifies a Hello time. The value is an integer ranging from 100 to 1000, in centiseconds. The step is 100. The default value is 200 centiseconds.

    maxAge

    Specifies an aging time of BPDUs on interfaces. The value is an integer ranging from 600 to 4000, in centiseconds. The step is 100. The default value is 2000 centiseconds.

    timerParaMode

    Indicates whether to use the network diameter of the bridge to configure timers.

    convergeMode

    Specifies an MSTP convergence mode. By default, the value is normal.

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

    Table 3-541 describes status codes in responses.

    Table 3-541  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 an MSTP Process

Operation

URI

Description

GET

/mstp/processs/process

Query an MSTP process.

  • Request example
    <mstp xmlns='http://www.huawei.com/netconf/vrp' content-version='1.0' format-version='1.0'>
        <processs>
            <process>
                <processId>0</processId>
                <enable/>
                <bpduProtection/>
                <flushCapability/>
                <maxHops/>
                <mode/>
                <pathCostStandard/>
                <tcNotify/>
                <tcProtection/>
                <tcProtectionThreshold/>
                <interval/>
                <timerFactor/>
                <linkShareProtect/>
                <regionName/>
                <revisionLevel/>
                <modulo/>
                <instVlanMode/>
                <forwardDelay/>
                <helloTime/>
                <maxAge/>
                <bridgeDiameter/>
                <timerParaMode/>
                <convergeMode/>
                <syncFlag/>
            </process>
        </processs>
    </mstp>

    Table 3-542 describes elements in requests.

    Table 3-542  Elements

    Element

    Description

    processId

    Specifies a process ID.

    enable

    Enables or disables STP/RSTP/MSTP on a switch.

    bpduProtection

    Enables or disables BPDU protection on the edge port to prevent network flapping in the case of attacks.

    flushCapability

    Enables or disables the flush function.

    mode

    Specifies a working mode for an MSTP process. The value can be STP, RSTP, or MSTP.

    pathCostStandard

    Specifies a method for calculating the path cost. The value can be dot1d-1998, dot1t, or legacy. The default value is dot1t.

    tcNotify

    Enables TC notification for an MSTP process. By default, TC notification is disabled.

    tcProtection

    Enables protection for TC BPDUs of an MSTP process. By default, protection for TC BPDUs of an MSTP process is disabled, meaning that the MSTP process updates entries upon receipt of a TC BPDU.

    tcProtectionThreshold

    Specifies the maximum number of TC BPDUs that an MSTP process can process in a specified period of time. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    interval

    Specifies a period of time during which an MSTP process can process received TC BPDUs. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    timerFactor

    Specifies a multiplier of HelloTime to obtain the timeout period. The value is an integer ranging from 1 to 10. The default value is 3.

    linkShareProtect

    Enables shared link protection for an MSTP process.

    regionName

    Specifies an MSTP region name. By default, the MSTP region name is the MAC address of the switch's main control board.

    revisionLevel

    Specifies an MSTP revision level. The default value is 0.

    modulo

    Specifies an instance-VLAN mapping mode.

    instVlanMode

    Indicates whether to use the instance-VLAN mapping mode.

    forwardDelay

    Specifies a Forward Delay time. The value is an integer ranging from 400 to 3000, in centiseconds. The step is 100. The default value is 1500 centiseconds.

    helloTime

    Specifies a Hello time. The value is an integer ranging from 100 to 1000, in centiseconds. The step is 100. The default value is 200 centiseconds.

    maxAge

    Specifies an aging time of BPDUs on interfaces. The value is an integer ranging from 600 to 4000, in centiseconds. The step is 100. The default value is 2000 centiseconds.

    timerParaMode

    Indicates whether to use the network diameter of the bridge to configure timers.

    convergeMode

    Specifies an MSTP convergence mode. The default value is normal.

    syncFlag

    Specifies the process synchronization status.

  • Response example (XML format)
    <mstp xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
        <processs>
            <process>
                <processId>0</processId>
                <enable>false</enable>
                <bpduProtection>false</bpduProtection>
                <maxHops>20</maxHops>
                <mode>Mstp</mode>
                <pathCostStandard>Dot1T</pathCostStandard>
                <tcNotify>false</tcNotify>
                <tcProtection>true</tcProtection>
                <tcProtectionThreshold>1</tcProtectionThreshold>
                <interval>2</interval>
                <timerFactor>3</timerFactor>
                <linkShareProtect>false</linkShareProtect>
                <regionName>389a04111200</regionName>
                <revisionLevel>0</revisionLevel>
                <modulo/>
                <instVlanMode>false</instVlanMode>
                <forwardDelay>1500</forwardDelay>
                <helloTime>200</helloTime>
                <maxAge>2000</maxAge>
                <bridgeDiameter>7</bridgeDiameter>
                <timerParaMode>false</timerParaMode>
                <convergeMode>Normal</convergeMode>
                <syncFlag>true</syncFlag>
                <flushCapability>false</flushCapability>
            </process>
        </processs>
    </mstp>

    Table 3-543 describes elements in responses.

    Table 3-543  Elements

    Element

    Description

    processId

    Specifies a process ID.

    enable

    Enables or disables STP/RSTP/MSTP on a switch.

    bpduProtection

    Enables or disables BPDU protection on the edge port to prevent network flapping in the case of attacks.

    flushCapability

    Enables or disables the flush function.

    mode

    Specifies a working mode for an MSTP process. The value can be STP, RSTP, or MSTP.

    pathCostStandard

    Specifies a method for calculating the path cost. The value can be dot1d-1998, dot1t, or legacy. The default value is dot1t.

    tcNotify

    Enables TC notification for an MSTP process. By default, TC notification is disabled.

    tcProtection

    Enables protection for TC BPDUs of an MSTP process. By default, protection for TC BPDUs of an MSTP process is disabled, meaning that the MSTP process updates entries upon receipt of a TC BPDU.

    tcProtectionThreshold

    Specifies the maximum number of TC BPDUs that an MSTP process can process in a specified period of time. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    interval

    Specifies a period of time during which an MSTP process can process received TC BPDUs. By default, an MSTP process can process only one TC BPDU in a specified period of time.

    timerFactor

    Specifies a multiplier of HelloTime to obtain the timeout period. The value is an integer ranging from 1 to 10. The default value is 3.

    linkShareProtect

    Enables shared link protection for an MSTP process.

    regionName

    Specifies an MSTP region name. By default, the MSTP region name is the MAC address of the switch's main control board.

    revisionLevel

    Specifies an MSTP revision level. The default value is 0.

    modulo

    Specifies an instance-VLAN mapping mode.

    instVlanMode

    Indicates whether to use the instance-VLAN mapping mode.

    forwardDelay

    Specifies a Forward Delay time. The value is an integer ranging from 400 to 3000, in centiseconds. The step is 100. The default value is 1500 centiseconds.

    helloTime

    Specifies a Hello time. The value is an integer ranging from 100 to 1000, in centiseconds. The default step is 100. The default value is 200 centiseconds.

    maxAge

    Specifies an aging time of BPDUs on interfaces. The value is an integer ranging from 600 to 4000, in centiseconds. The step is 100. The default value is 2000 centiseconds.

    timerParaMode

    Indicates whether to use the network diameter of the bridge to configure timers.

    convergeMode

    Specifies an MSTP convergence mode. The default value is normal.

    syncFlag

    Specifies the process synchronization status.

Table 3-544 describes status codes in responses.

Table 3-544  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 MSTP Process

Operation

URI

Description

DELETE

/mstp/processs/process

Delete an MSTP process.

  • Request example
    <mstp xmlns='http://www.huawei.com/netconf/vrp' content-version='1.0' format-version='1.0'>
        <processs>
            <process operation='delete'>
                <processId>1</processId>
            </process>
        </processs>
    </mstp>

    Table 3-545 describes elements in requests.

    Table 3-545  Elements

    Element

    Description

    processId

    Specifies a process ID.

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

    Table 3-546 describes status codes in responses.

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

Modify MSTP Process Attributes

Operation

URI

Description

PUT

/mstp/processs/process

Modify MSTP process attributes.

  • Request example
    <mstp xmlns='http://www.huawei.com/netconf/vrp' content-version='1.0' format-version='1.0'>
        <processs>
            <process operation='merge'>
                <processId>0</processId>
                <timerFactor>10</timerFactor>
            </process>
        </processs>
    </mstp>

    Table 3-547 describes elements in requests.

Table 3-547  Elements

Element

Description

processId

Specifies a process ID.

timerFactor

Specifies a multiplier of HelloTime to obtain the timeout period. The value is an integer ranging from 1 to 10. The default value is 3.

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

    Table 3-548 describes status codes in responses.

    Table 3-548  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: 28066

Downloads: 123

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