API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Configure Interface Profile by unique name.

Interface Profile configuration. It is a bundle of interface configuration
for devices with specific sku/model. Defined for set of uplink/downlink ports, or can
be for custom set of ports for given models. Interface Profile can be defined for stacks/chassis for
fixed/automatic set of members/LineCards. Interface Profile can be defined for custom stack/chassis size.
One Interface Profile can have port-profile config for uplink + downlink + custom ports for given
model/device type. In case of stacks, Interface Profile will not be applied VSF link ports, if they
are part of automatic/custom Interface Profile model+ports.

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

Interface Profile 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

interface-profilebody object

ap
object

AP uplink-port-profile and downlink-port-profile. This grouping establishes
the relationship their port configurations, allowing for differentiated
treatment of downlink and uplink ports. It enables the application of specific profiles
to different port types based on their role in the network topology.

string
length between 1 and 128

Description for the Interface Profile config.

string
enum

Interface Profile device type. Device type can be for STANDALONE, STACK, MODULAR. With custom/automatic
specifications. This field cannot be edited once created.

Show Details
APAP.
BRIDGEBRIDGE.
GWGW.
PVOS_SWITCH_BPSInterface Profile for AOSS Back Plane Stacking switches such as 3810M and 2930M stacks.
PVOS_SWITCH_CHASSISInterface Profile for AOSS Standalone chassis switches such as 5406R and 5412R.
PVOS_SWITCH_CHASSIS_VSFInterface Profile for AOSS VSF stack chassis switches made using 5406R and 5412R.
PVOS_SWITCH_FLEXMODULESInterface Profile for AOSS flexible modules for modular switchs.
PVOS_SWITCH_LINECARDSInterface Profile for AOSS linecards for chassis switchs.
PVOS_SWITCH_MODULARInterface Profile for AOSS standalone modular switches such as 3810M and 2930M.
PVOS_SWITCH_STANDALONEInterface Profile for AOSS Standalone switches such as 2530YA, 2530YB, 2540 and 2930F.
PVOS_SWITCH_VSFInterface Profile for AOSS VSF switches made using 2930F.
SWITCH_LINECARDLine card interface profile used for Modular custom/automatic
SWITCH_MODULAR_AUTOMATICIncludes profiles added to line-card module supported switches
SWITCH_MODULAR_CUSTOMIncludes custom interface profiles added to line-card module supported switches
SWITCH_STACK_AUTOMATICIncludes stack profiles applied for all members
SWITCH_STACK_CUSTOMIncludes custom profiles applied to each stack member
SWITCH_STANDALONEIncludes standalone
SWITCH_VSX_MODULARInterface Profile for Modular VSX supported switches.
SWITCH_VSX_STANDALONEInterface Profile for Standalone VSX supported switches.
gateway-standalone
object

Gateway models and port-profile. This grouping establishes the relationship between
gateway hardware models and their port configurations. It enables the application of specific profiles
to different port types based on their role in the network topology.

string
length between 1 and 256

Interface Profile name.

pvos-switch-standalone
object

Switch models and port-profile. This grouping establishes the relationship between
switch hardware models and their port configurations, allowing for differentiated
treatment of uplink and downlink ports. It enables the application of specific profiles
to different port types based on their role in the network topology.

switch-linecard
object

Switch models and port-profile. This grouping establishes the relationship between
switch hardware models and their port configurations, allowing for differentiated
treatment of uplink and downlink ports. It enables the application of specific profiles
to different port types based on their role in the network topology.

switch-modular-automatic
object

A grouping for switch model. This grouping defines the hardware model identifier
used for associating specific Interface Profile configurations with compatible hardware platforms.
It enables targeting of configuration sets to switches with the same model type,
ensuring consistent interface settings across identical hardware.

switch-modular-custom
object

A grouping for switch model. This grouping defines the hardware model identifier
used for associating specific Interface Profile configurations with compatible hardware platforms.
It enables targeting of configuration sets to switches with the same model type,
ensuring consistent interface settings across identical hardware.

switch-stack-automatic
object

A grouping for switch model. This grouping defines the hardware model identifier
used for associating specific Interface Profile configurations with compatible hardware platforms.
It enables targeting of configuration sets to switches with the same model type,
ensuring consistent interface settings across identical hardware.

switch-stack-custom
object

A grouping for switch model. This grouping defines the hardware model identifier
used for associating specific Interface Profile configurations with compatible hardware platforms.
It enables targeting of configuration sets to switches with the same model type,
ensuring consistent interface settings across identical hardware.

switch-standalone
object

Switch models and port-profile. This grouping establishes the relationship between
switch hardware models and their port configurations, allowing for differentiated
treatment of uplink and downlink ports. It enables the application of specific profiles
to different port types based on their role in the network topology.

switch-vsx-modular
object

VSX Modular Interface Profile configuration. This container enables configuration
of VSX pairs with chassis/modular switches, providing redundancy and high availability
with full line-card support. Both Peer1 and Peer2 must use matching VSX-supported
chassis models (5420, 6405, 6410, 8400). Exception: 6405 and 6410 models can be paired
together. Each peer can have independent line-card configurations while maintaining
compatible hardware models.

switch-vsx-standalone
object

VSX Standalone Interface Profile configuration. This container enables configuration
of VSX pairs with standalone switches, providing redundancy and high availability.
Both Peer1 and Peer2 must use matching VSX-supported standalone models (6300, 8100,
8320, 8325, 8360, 8400, 9300, 10000). Each peer can have independent port profiles
while maintaining consistent hardware models.

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