HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/mka_policies

Body Params
string

Secure Connectivity Assocation Key (CAK) associated with this policy. This is only applicable when the mode is set to PSK.

string
length between 1 and 64

Connectivity Association Key Name (CKN) associated with this policy. This is only applicable when the mode is set to PSK.

string
length between 17 and 17

The destination MAC address to use in EAPoL packets for MKA. If not set, the default EAPoL multicast MAC 01:80:c2:00:00:03 is used.

boolean

Transmit the EAPoL frames for MKA with a 802.1q tag. The VLAN used for the 802.1q tag is picked from the Port Table.

string
length between 4 and 4

The Ether-Type to be used in EAPoL packets for MKA. When not configured, the default Ether-Type 0x888e is used.

integer
0 to 255

MKA participant priority used to determine which participant is elected as the key server. A value of 255 indicates that this participant will not become the key server.

string

Reference Resource: Keychain
The keychain from which the CKN and CAK are derived for this policy. This is only applicable when the mode is set to PSK.

string
enum

The MKA policy mode. psk: Policy mode is Pre-Shared Key. In this mode the CAK and CKN of the MKA policy are statically configured by the user. eap-tls: Policy mode is EAP over Transport layer Security Protocol(TLS). In this mode, the CAK and CKN of the MKA policy are derived from EAP MSK (Master Session Key).

Allowed:
string
required
length between 1 and 32

Reference Resource: MKA_Policy
Name of the MKA policy.

string
enum

Origin of the MKA policy, i.e., how the policy is provisioned: static: policy is provisioned by the administrator via CLI or REST. dynamic: policy is provisioned based on attributes provided by the RADIUS server.

Allowed:
integer
2 to 6

MKA transmit interval in seconds.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!