API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read configured stacks

Configure and Manage switch stacks.
Switch Stack OR Virtual Switching Framework(VSF), defines a virtual switch,
comprising multiple individual physical switches, inter-connected through
standard Ethernet links. These physical switches will operate with one
control plane, thereby visible to the peers as a virtual switch stack.

Within the stack, one switch is the Conductor switch, which runs all the
control plane software and manages the ASICs of all the stack members.
A second switch can be configured as the Standby switch, which will
take over as Conductor if the conductor fails.

It is strongly recommended to configure a secondary member in the stack,
since a stack with a standby offers resiliency and high-availability.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

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