API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update existing STP configurations for given name.

List of Profiles for STP.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

STP profile name.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

int64
0 to 65535

To re-enable timeout after receiving an unauthorized
BPDU(Bridge Protocol Data Units)

int32
64 to 256

BPDU(Bridge Protocol Data Units) throttle value in packets per second.

string
length between 1 and 32

Multiple Spanning Tree (MST) region configuration name

int64
0 to 65535

Multiple Spanning Tree (MST) region configuration revision number

boolean
Defaults to false

Enable log state-transitions for the instance (CST).

string
length between 1 and 256

STP profile description.

boolean

To enable Spanning Tree globally.

boolean

Enables the extended system-id functionality

string
enum

Spanning Tree protocol compatibility mode.

Show Details
MSTP_OPERATIONThe protocol operates as Multiple STP on all ports where compatibility to the old STP protocol versions is not required.
RSTP_OPERATIONThe protocol operates as Rapid STP on all ports except those ports where a system that is using 802.1d Spanning Tree has been detected.
STP_COMPATIBLEThe protocol operates as STP on all ports.
Allowed:
int32
4 to 30

The wait time for device while transitioning from listening to learning
and from learning to forwarding states.

int32
1 to 10

Time between messages transmission when the switch is root.

boolean

Ignore PVID (Port VLAN ID) inconsistencies and allow RPVST(Rapid Per VLAN Spanning Tree)
to run on mismatched links.

int32
6 to 40

Maximum age of received STP information before it is discarded.

int32
1 to 40

Max hops value for the Multiple spanning tree.

string
enum

Mode of operation for spanning tree protocol.

Show Details
MSTPMultiple spanning tree mode.
RPVSTRapid per VLAN spanning tree mode.
RSTPRapid spanning tree mode.
Allowed:
mstp
array of objects
length ≤ 2147483647

List of STP parameters applicable per MSTP instance.

mstp
string
enum
Defaults to 8021T

Standard to use when calculating the default pathcost for MSTP mode.

Show Details
8021DCalculate default path cost for ports based on IEEE 802.1d.
8021TCalculate default path cost for ports based on IEEE 802.1t.
PROPRIETARYCalculate default path cost for ports based on a private standard.
Allowed:
string
length between 1 and 256

STP profile name.

string
enum

Path cost type.

Show Details
COST_TYPE_LONGPathcost as long.
COST_TYPE_SHORTPathcost as short.
Allowed:
int32
0 to 15
Defaults to 8

Device priority. For CX and PVOS this value will be multiplied by 4096.

string
enum

Root for the PVST(Per VLAN Spanning Tree) instance.

Show Details
PRIMARYPrimary root for Spanning Tree.
SECONDARYSecondary root for Spanning Tree.
Allowed:
rpvst
array of objects
length ≤ 2147483647

List of STP parameters applicable per PVST(Per VLAN Spanning Tree) instance.

rpvst
boolean

This command enables/disables the RPVST Auto VLAN feature.
Default priority of 8*4096 will be assigned to the VLANs being auto created.
In 'auto-vlan-enable' RPVST mode, the maximum number of RPVST instances that
can be activated for VLANs within the switch is determined by the switch's
capacity in terms of both the maximum number of supported VLANs and the vport limits.

int32
0 to 15

The priority value configured for the RPVST Auto VLANs.
Set the priority value as a multiplier of 4096. Default is 8.

int32
1 to 4094

RPVST-MSTP(Rapid Per VLAN Spanning Tree - Multiple Spanning Tree Protocol)
interconnect VLAN.

string
enum
Defaults to 8021T

Standard to use when calculating the default pathcost for RPVST mode.

Show Details
8021DCalculate default path cost for ports based on IEEE 802.1d.
8021TCalculate default path cost for ports based on IEEE 802.1t.
PROPRIETARYCalculate default path cost for ports based on a private standard.
Allowed:
boolean

Enable topology change notification for the MST(Multiple Spanning Tree)
instance 0 (CST)(Common Spanning Tree).

int32
1 to 10

To set the maximum number of BPDUs(Bridge Protocol Data Unit)
per second that the switch can send from an interface

traps
array of strings
length ≤ 2147483647
Show Details
ERRANT_BPDUEnable notifications which are sent when an errant bpdu is received.
LOOP_GUARDEnable notifications which are sent when loop guard inconsistency occurs.
NEW_ROOTEnable notifications which are sent when a new root is elected.
ROOT_GUARDEnable notifications which are sent when root guard inconsistency occurs.
traps
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json