infrastructure_association

Infrastructure Association

There are various modes of operation. The Infrastructure Mode defines the communication happens between peers when they are connected to an AP.

JSON Table

Parameter Data Type Description
apMac String The MAC address of the AP related to this infrastructure association.
apProtocol String The 802.11 protocol of the AP. The applicable values are:

  • A
  • B
  • BG
ssid String SSID or the network name of the infrastructure association.
clientMacAddresses List of String List of the client MAC addresses from the infrastructure association.

Copy Sample JSON
Sample JSON
[{
	"apMac":"00:22:22:33:44:55",
	"apProtocol":"BG",
	"ssid":null,
	"clientMacAddresses":["00:11:22:33:44:55","11:55:22:33:34:21"]
}]
API Calls

/V5/associations/infrastructure/{SSID}

Get Infrastructure Associations Reported by a Reporting Entity

Description This API is used to fetch infrastructure associations reported by a reporting entity and for a specified SSID from Mojo Server or Arista Cloud Services. The reporting entity-id must be registered before calling this API. For registering the reporting entity-id See Register Reporting Entity API call from Reporting Entity object.

Users with the following roles can call this API: superuser, administrator, operator, and viewer.

Syntax
GET /associations/infrastructure?ssid=<value>&reporter=<value>

Here,

  • ssid – The value for the ssid parameter is a string value representing an SSID profile. For example, CorporateSSID. To fetch the list of ssids you can use Get SSIDs Configured on a Managed Device call.
  • reporter – The value for the reporter parameter is a string value representing the reporting entity ID. For example, id-1. You can specify either of the parameters or both.
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/associations/infrastructure?ssid=”CorporateSSID”&reporter=”id-1″
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the infrastructure association details. The response is in the application/json format. Refer the above Infrastructure Association JSON along with the sample output for the complete details .

Get Infrastructure Associations by SSID

Description This API is used to fetch infrastructure associations for a specified SSID from Mojo Server or Arista Cloud Services.
Users with the following roles an call this API: superuser, administrator, operator, and viewer.
Syntax
GET /associations/infrastructure/{SSID}

Here,

Sample code
GET https://training.mojonetworks.com/new/webservice/v5/associations/infrastructure
/CorporateSSID
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the infrastructure association details. The response is in the application/json format. Refer the above Infrastructure Association JSON along with the sample output for the complete details .

Import Infrastructure Association

Description This API is used to add an infrastructure association between a client and an AP in the Mojo Server or the Arista Cloud Services.

Note: The AP and the client must be imported by using the same reporting entity ID, and the reporting entity ID must be registered before calling this API. See Register Reporting Entity API call from Reporting Entity object for more details.

Users with the following roles can call this API: superuser, administrator, and operator.

Syntax
PUT /associations/infrastructure/{reporting-entity-id}

Here,

  • reporting-entity-id – is a string value representing the reporting entity ID. For example, id-1.
Sample code PUT https://training.mojonetworks.com/new/webservice/v2/associations/infrastructure/id-1
Request Body This API call requires the infrastructure association information, which is passed as parameters in the request body. The parameters are passed in the application/json format. Refer the above Infrastructure Association JSON to view the complete details of the JSON along with sample values. All fields in the JSON are mandatory. You must provide the appropriate values for all the attributes.
Response Body If the API call is successful, the HTTP response status is 204. The response body does not contain any other information.

Delete Infrastructure Association

Description This API is used to delete an infrastructure association for a specified reporting entity.

Users with the following roles can call this API: superuser, administrator, and operator.

Syntax
DELETE /associations/infrastructure/{reporting-entity-id}

Here,

  • reporting-entity-id – is a string value representing the reporting entity ID. For example, id-1.
Sample code DELETE https://training.mojonetworks.com/new/webservice/v2/associations/infrastructure/id-1
Request Body This API call requires the infrastructure association information, which is passed as parameters in the request body. The parameters are passed in the application/json format.  Refer the above Infrastructure Association JSON to view the complete details of the JSON along with sample values. All fields in the JSON are mandatory. You must provide the appropriate values for all the attributes.
Response Body If the API call is successful, the HTTP response status is 204. The response body does not contain any other information.