API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new gateway port profile by unique name

Port profile list.

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

Port 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

policy-vlan-config
object

Container for Policy vlan references.

switchport
object

Switchport configuration. This configuration is valid only on a layer2 interface.

app-aaa-contract
object

Application contracts

app-category-aaa-contract
object

Application category contracts

exclude-app-contract
object

Exclude applications from Bandwidth contracts

exclude-app-cat-contract
object

Exclude application categories from Bandwidth contracts

aaa-bw-contract
object

Bandwidth contracts

qos
object

Rate-limit a specific traffic-type on this port.

boolean
Defaults to false

Enable dac alternate link.

string
length between 1 and 128

User-defined description or comment for the Port Profile.

string
enum

Duplex mode.

Show Details
AUTO_DUPLEXAuto-duplex.
FULL_DUPLEXFull-duplex.
HALF_DUPLEXHalf-duplex.
Allowed:
boolean
Defaults to false

Enable interface.

igmp
object

Internet Group Management Protocol(IGMP).

boolean
Defaults to false

Enable or disable IGMP Proxy on the interface.

ip
object

IP configuration.

ipv4
object

IPv4 configuration

ipv6
object

IPv6 configurations

boolean
Defaults to false

Enable Jumbo frame MTU.

lldp
object

LLDP configuration.

mld
object

Multicast Listener Discovery(MLD) protocol.

boolean
Defaults to false

Enable MLD Proxy on the interface.

pim-bidir
object

PIM-Bidir protocol related configuration.

pim-dense
object

PIM Dense Mode protocol.

pim6-sparse
object

IPv6 PIM Sparse Mode protocol.

poe
object

Container for PoE configuration

policy
object

Container for Policy references.

string
enum

Port works in WAN or LAN.

Show Details
LANPort type LAN.
WANPort type WAN.
Allowed:
string
length between 1 and 64

Port profile name.

string
enum
Defaults to SPEED_AUTO

Ethernet speed.

Show Details
SPEED_1000GB1000 Gb/sec Ethernet.
SPEED_100GB100 Gb/sec Ethernet.
SPEED_100MB100 Mb/sec Ethernet.
SPEED_10GB10 Gb/sec Ethernet.
SPEED_10MB10 Mb/sec Ethernet.
SPEED_1GB1 Gb/sec Ethernet.
SPEED_2_5GB2.5 Gb/sec Ethernet.
SPEED_40GB40 Gb/sec Ethernet.
SPEED_5GB5 Gb/sec Ethernet.
SPEED_AUTOAuto negotiation Ethernet.
stp
object

Container for spanning-tree configuration.

string
length between 1 and 256

Alias reference for switchport container

boolean

Mark as a trusted interface.

trusted-vlans
array of strings
length ≤ 2147483647
trusted-vlans
boolean
Defaults to false

Enable tunneled node functionality on the port.

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