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

Update profile by name

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/dot1xsupp/

List of 802.1X supplicant profiles.

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

802.1X supplicant profile description.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

boolean
Defaults to false

Configure the device to accept an EAP success without going through
the complete authentication cycle.

int32
0 to 300

Time period (in seconds) to wait for a potential 802.1X authenticator
on the other end before considering the link to be non 802.1X capable
and opening the interface on the data-plane.
On a timeout, the device will not use the authentication result to
determine the forwarding behavior of the interface until a link flap.
If not configured, the device will wait for the 802.1X authentication
cycle to complete before determining the forwarding state of the
interface.

string
length between 1 and 64

EAP identity used for authentication.

eap-password
object

Password information.

boolean
Defaults to false

Force the device to send only multicast EAPoL packets irrespective of
receiving unicast EAPoL packets from the authenticator.

string
enum

EAP method to use for authentication.

Show Details
EAP_MD5MD5 hash function to generate hashed password
EAP_PEAPProtected EAP
EAP_TLSTransport Layer Security Protocol
Allowed:
int32
2 to 3
Defaults to 3

EAPoL protocol version to use in EAPoL frames transmitted by the
device.

string
enum
Defaults to INTERFACE_MAC

The MAC address to use as source MAC in EAPoL frames.

Show Details
INTERFACE_MACUse the MAC address of the interface on which 802.1X is running as the source MAC in EAPoL frames.
SYSTEM_MACUse the MAC address of the device on which 802.1X is running as the source MAC in EAPoL frames.
Allowed:
int32
1 to 65535
Defaults to 30

Time period (in seconds) to wait for a response from an authenticator
before reattempting authentication.

boolean
Defaults to false

Enable 802.1X supplicant.

string
enum
Defaults to FAIL_OPEN

Forwarding behavior of the interface when the 802.1X authentication
fails.

Show Details
FAIL_CLOSEDBlock the interface on the data-plane if the authentication fails.
FAIL_OPENOpen the interface on the data-plane even if the authentication fails.
Allowed:
int32
0 to 65535
Defaults to 60

Time period (in seconds) to wait after a failed
authentication attempt before another attempt is permitted.

macsec
object

MAC security (MACsec)

int32
1 to 10

Maximum number of authentication attempts before authentication
fails.

string
enum
Defaults to START_OPEN

Forwarding behavior of the interface when the 802.1X supplicant starts
operation.

Show Details
START_CLOSEDBlock the interface on the data-plane until the authentication is successful.
START_OPENOpen the interface on the data-plane before the authentication is successful.
Allowed:
string
length between 1 and 256

802.1X supplicant profile description.

string
length between 1 and 256

802.1X supplicant profile description.

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