API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create a role by unique name

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/roles/

Role Name.

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

Role 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

rolebody object

session-parameters
object

Session parameters.

vlan-parameters
object

VLAN parameters.

qos-parameters
object

QoS parameters.

classification-parameters
object

Classification parameters.

miscellaneous-parameters
object

Miscellaneous parameters.

ipfix-flow-monitor
object

Configuration to apply a Flow Monitor on a role. The flow monitors will monitor traffic.

app-aaa-contract
object

Application contracts

app-category-aaa-contract
object

Application category contracts

web-category-aaa-contract
object

WebCC category contracts

web-reputation-aaa-contract
object

WebCC Reputation 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

int32
1 to 4094

Access VLAN ID for gateway.

string
length between 1 and 32

Access VLAN name for gateway.

airslice-application-list
array of strings
length ≤ 2147483647
Show Details
DPI_APP_ALG_WIFI_CALLINGALG WIFI calling.
DPI_APP_AMAZON_AWSAmazon aws.
DPI_APP_AMAZON_CHIMEAmazon chime.
DPI_APP_DROPBOXDropbox.
DPI_APP_EXCEL_ONLINEExcel online.
DPI_APP_GITHUBGithub.
DPI_APP_GOTOMEETINGGotomeeting.
DPI_APP_LYNC_ONLINELync online.
DPI_APP_MS_PLANNERMS planner.
DPI_APP_MS_SWAYMS sway.
DPI_APP_MS_TEAMSMS teams.
DPI_APP_OFFICE365Office365.
DPI_APP_ONEDRIVEOnedrive.
DPI_APP_OUTLOOKOutlook.
DPI_APP_POWERPOINT_ONLINEPowerpoint online.
DPI_APP_SHAREPOINT_ONLINESharepoint online.
DPI_APP_SKYPESkype.
DPI_APP_SLACKSlack.
DPI_APP_WEBEXWebex.
DPI_APP_WORD_ONLINEWord online.
DPI_APP_YAMMERYammer.
DPI_APP_ZOOMZoom.
airslice-application-list
boolean
Defaults to false

Enables download of the role to the devices without reference or policy.

boolean

Enable CALEA.

dap-application-uuid
array of strings
length ≤ 2147483647
Show Details
AMAZON_AWSApplication amazon-aws.
AZURE_MSApplication azure-ms.
CISCO_WEBEXApplication cisco-webex.
DROPBOXApplication dropbox.
FACETIME_AUDIOApplication facetime-audio.
FACETIME_VIDEOApplication facetime-video.
GITHUBApplication github.
GLCPApplication glcp.
GOOGLE_GCPApplication google-gcp.
GOOGLE_MEETApplication google-meet.
GOTOMEETINGApplication gotomeeting.
JABBER_AUDIOApplication jabber-audio.
JABBER_DESKTOP_SHARINGApplication jabber-desktop-sharing.
JABBER_MCApplication jabber-mc.
JABBER_VIDEOApplication jabber-video.
MICROSOFT_ONEDRIVEApplication microsoft-onedrive.
MICROSOFT_SHAREPOINTApplication microsoft-sharepoint.
OFFICE365Application office365.
SIP_AUDIOApplication sip-audio.
SIP_VIDEOApplication sip-video.
SKYPE_AUDIOApplication skype-audio.
SKYPE_DESKTOP_SHARINGApplication skype-desktop-sharing.
SKYPE_VIDEOApplication skype-video.
SLACKApplication slack.
TEAMS_AUDIOApplication teams-audio.
TEAMS_VIDEOApplication teams-video.
VOCERAApplication vocera.
WEBRTC_AUDIOApplication webrtc-audio.
WEBRTC_VIDEOApplication webrtc-video.
WHATSAPPApplication whatsapp.
WIFI_CALLINGApplication wifi-calling.
ZOOM_AUDIOApplication zoom-audio.
ZOOM_DSApplication zoom-ds.
ZOOM_VIDEOApplication zoom-video.
dap-application-uuid
string
length between 1 and 256

Description, or comment, for the Role.

boolean
Defaults to true

Enable DAP policy for the current role. This is a per-role DAP switch, must configure
both of this switch and global DAP switch to make DAP policy work.

int64
0 to 7

Reference to DPI error page URL.

string
length between 1 and 128

MACsec policy to use for EAP MACsec.

monitoring-application-list
array of strings
length ≤ 2147483647
Show Details
DPI_APP_ALG_WIFI_CALLINGALG WIFI calling.
DPI_APP_AMAZON_AWSAmazon aws.
DPI_APP_AMAZON_CHIMEAmazon chime.
DPI_APP_DROPBOXDropbox.
DPI_APP_EXCEL_ONLINEExcel online.
DPI_APP_GITHUBGithub.
DPI_APP_GOTOMEETINGGotomeeting.
DPI_APP_LYNC_ONLINELync online.
DPI_APP_MS_PLANNERMS planner.
DPI_APP_MS_SWAYMS sway.
DPI_APP_MS_TEAMSMS teams.
DPI_APP_OFFICE365Office365.
DPI_APP_ONEDRIVEOnedrive.
DPI_APP_OUTLOOKOutlook.
DPI_APP_POWERPOINT_ONLINEPowerpoint online.
DPI_APP_SHAREPOINT_ONLINESharepoint online.
DPI_APP_SKYPESkype.
DPI_APP_SLACKSlack.
DPI_APP_WEBEXWebex.
DPI_APP_WORD_ONLINEWord online.
DPI_APP_YAMMERYammer.
DPI_APP_ZOOMZoom.
monitoring-application-list
string
length between 1 and 63

Role name.

string
length between 1 and 63

GBP role mapping to ipv4 object group.

string
length between 1 and 63

GBP role mapping to ipv6 object group.

boolean
Defaults to false

Redirect blocked HTTP URL.

boolean

Enable UTF8 encoding.

string
length between 1 and 63

VIA Connection profile.

string
enum

Type of vlan.

Show Details
VLAN_IDVLAN(s) using ID
VLAN_NAMEVLAN(s) using a name
Allowed:
Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago