API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create vsx by name

Single list of VSX config.

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

VSX configuration name.

Query Params
string

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

string

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

string

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

Body Params

vsxbody object

VSX common configuration grouping, applicable to both primary and secondary

string
enum

Specifies whether the device will act as primary or secondary for VSX.
VSX operation requires one peer switch to be primary and the other secondary.
If not configured, then the device will not participate in VSX role election.

Show Details
VSX_PRIMARYPrimary vsx role.
VSX_SECONDARYSecondary vsx role.
Allowed:
int64
0 to 600
Defaults to 180

Number of seconds that multi-chassis LAGs should be held down after the ISL is
considered to be fully established and VSX switches are synchronized. Comes into
effect on new ISL deployments, ISL flaps or full device reboot.

boolean
Defaults to false

Disables split brain recovery.
By default, split-recovery mode is enabled. When ISL goes out-of-sync and if
Keep-alive is established then secondary vsx lags will be brought down.
Subsequently if Keep-alive also fails it causes split condition. In this case
if split-recovery mode is enabled secondary will make its vsx lags up else
secondary will continue to keep its vsx lags down.

string
length ≤ 9999

System MAC address to be used by L2 control plane protocols.
A pair of VSX switches must have the same system MAC.
If system MAC is not configured, L2 control plane protocols
will use the VSX Primary device MAC address as their
Bridge Identifier. MAC address will be in
[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5} format.

string
length between 1 and 256

VSX configuration description.

string
length between 1 and 64

VSX intent config profile name.

inter-switch-link
object
interface-vlan-ref
array of int32s
length ≤ 2147483647
interface-vlan-ref
keepalive
object

VSX keepalive timer configuration grouping, applicable to both primary and secondary

linkup-delay-timer-exclude
array of strings
length ≤ 2147483647
linkup-delay-timer-exclude
string
length between 1 and 64

VSX configuration name.

string
length between 1 and 10

Serial number of the corresponding VSX peer device

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