API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create profile by name

List containing system profile attributes.

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

User defined system 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

profilebody object

redundant-management
object

Redundant management configuration

icmp
object

ICMP Configurations.
The Internet Control Message Protocol (ICMP) is used
by network devices, including routers, to send error
messages and operational information indicating,
for example, that a requested service is not available
or that a host or router could not be reached.

tcp
object

TCP Configurations.
In TCP 3-way handshake, the switch may respond back with
SYN-ACK which might never reach the intended destination.
These unestablished connections queue up, they can prevent
new, legitimate requests from being handled. Hence there
is a need to handle these half-open requests with a timeout
threshold which can be user tunable.

aaa
object

Group for configuring username and password combination of ClearPass which
is used to login to ClearPass to download user roles

access-list
object

Grouping for global access-list configurations

boolean
Defaults to false

Enable the Captive Portal profile.

string
length between 1 and 255

Device contact information, often an email.

default-device-type-associations
array of objects
length ≤ 2147483647

List of supported device types configuration for switch system

default-device-type-associations
string
length between 1 and 256

Description of the user defined system profile.

int32
60 to 300
Defaults to 120

Configures the timer for AOS-S switch to send the client data to ClearPass.

boolean
Defaults to false

Prevent the manual hard reset to factory default by pressing down
and holding the reset button.

dynamic-arp-inspection
object

Configuration of Dynamic ARP Inspection.
Dynamic ARP Inspection is defense mechanism can be put in place on a switch to protect
against various possible attacks using ARP. This can limit the amount of ARP activity
allowed from a host or on a port and can also ensure all ARP packets are consistent
with one or more binding database which can be created via various means.
It can also enforce integrity checks on the ARP packets to check against using
different MAC or IP in the Ethernet or IP header and the ARP header.

boolean

Allow or Disallow transceivers that are recognized as unsupported to be operational.

boolean

Enable/Disable fastboot for the system. When fastboot is enabled,
Most of the test under POST will be skipped. POST (Power On Self Test)
verifies the hardware functionality of various modules (subsystem/
line modules/ fabric module / interfaces) during boot-up.

fault-monitor
object

Fault-monitor switch system config

gbp
object

GBP configuration container.

string
length ≤ 9999

Specifies the starting and ending VLAN number for the range.

boolean
Defaults to false

Enable/disable IP multicast routing.

boolean
Defaults to false

Enable IP routing

boolean
Defaults to false

Enable unicast IPv6 routing

jumbo
object

Grouping for jumbo frame configurations

string
length between 1 and 255

Device location information.

loop-protect
object

Loop protect configuration.Loop protection can find loops in
untagged layer 2 links as well as tagged VLAN.

string
enum

The character used to separate the digits of the MAC address.

Show Details
COLON XX:XX:XX:XX:XX:XX
COMMAXX,XX,XX,XX,XX,XX
DASHXX-XX-XX-XX-XX-XX
NONEXXXXXXXXXXXX
OUI_NICXXXXXX-XXXXXX
PERCENTXX%XX%XX%XX%XX%XX
SLASHXX/XX/XX/XX/XX/XX
Allowed:
int64
60 to 999960

MAC age time or how long the MAC address remains in the MAC table.

macsec
object

Grouping for system level MACsec configurations.

int32
1 to 4094

Configure the management VLAN.

int32
16 to 4094

Configure the maximum number of VLANs allowed on the device.

string
length between 1 and 256

User defined system profile name.

string
length between 1 and 144

The policy name for inbound (Ingress) traffic.

port-security
object

Port security policy configurations.

int32
1 to 4094

Configure the primary VLAN.

private-vlan
object

Private VLAN related global configurations

qinq
object

Global level configuration for QinQ

timezone
object

Grouping for daylight time commands

boolean

Indicates if dynamically learned VLANs from MVRP and port-access should
be included or excluded on ports configured with vlan trunk allowed all.
By default, dynamic VLANs are not included in trunk allowed list.

boolean

Enable or Disable unsupported transceiver logging.

int32
1440 to 10080
Defaults to 1440

Configure the logging interval for allowed unsupported transceivers feature.

boolean
Defaults to false

Disable the USB port.

string
length ≤ 9999

Global virtual MAC configuration. An example usage would be EVPN
Symmetric IRB where EVPN advertises this MAC as the Router's
MAC for all the EVPN Symmetric Routes.

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