Groups
Groups facilitate faster customization of Arista APs by allowing you to apply custom configuration (e.g., SSIDs, Radio Settings, and Device Settings) to APs located across different branches of a hierarchical location tree. Using groups API you can create a new group, update the existing one, fetch details of an existing group or delete the group.
JSON Table
Attribute | Data Type | Description |
---|---|---|
groups | application/json | |
groups/createdAtLocationId | application/json | Specifies the location at which the group is created. |
groups/deviceTemplateId | int | Specifies the device template id used in the group. |
groups/mnctemplate | boolean | A true or false value indicating if the group was created on cluster parent or not. |
groups/id | int | Specifies the system generated unique identifier of the group. |
groups/name | String | Specifies the name of the group. |
groups/mncId | int | |
previousLink | String | Link for the previous page of results. |
nextLink | String | Link for the next page of results. |
totalCount | int | The total number of groups retrieved based on the filter criteria. |
Copy Sample JSON
Sample JSON
{ "previousLink": null, "nextLink": null, "totalCount": 0, "groups": [{ "createdAtLocationId": { "type": "remotelocationid", "id": 0, "childId": 2 }, "deviceTemplateId": null, "mnctemplate": false, "id": 2, "name": "Test 1_1", "mncId": 0 }, { "createdAtLocationId": { "type": "remotelocationid", "id": 0, "childId": 2 }, "deviceTemplateId": 44, "mnctemplate": false, "id": 3, "name": "Test 2", "mncId": 0 }, { "createdAtLocationId": { "type": "remotelocationid", "id": 0, "childId": 2 }, "deviceTemplateId": null, "mnctemplate": false, "id": 4, "name": "Training", "mncId": 0 }, { "createdAtLocationId": { "type": "remotelocationid", "id": 0, "childId": 2 }, "deviceTemplateId": null, "mnctemplate": false, "id": 5, "name": "Training s", "mncId": 0 }, { "createdAtLocationId": { "type": "remotelocationid", "id": 0, "childId": 2 }, "deviceTemplateId": 52, "mnctemplate": false, "id": 6, "name": "Root Location Template_O-70_C-55_C-60", "mncId": 0 }, { "createdAtLocationId": { "type": "locallocationid", "id": 0 }, "deviceTemplateId": null, "mnctemplate": false, "id": 2, "name": "Test_Group", "mncId": 0 }, { "createdAtLocationId": { "type": "locallocationid", "id": 0 }, "deviceTemplateId": null, "mnctemplate": false, "id": 3, "name": "test", "mncId": 0 }, { "createdAtLocationId": { "type": "locallocationid", "id": 0 }, "deviceTemplateId": 38, "mnctemplate": false, "id": 4, "name": "Test manoj", "mncId": 0 }, { "createdAtLocationId": { "type": "locallocationid", "id": 45 }, "deviceTemplateId": null, "mnctemplate": false, "id": 1, "name": "Test Network Switch", "mncId": 0 }, { "createdAtLocationId": { "type": "remotelocationid", "id": 14, "childId": 2 }, "deviceTemplateId": 31, "mnctemplate": false, "id": 1, "name": "Russia Template_Universal Configuration_C-100", "mncId": 0 }] }
API Calls
/V6/groups
/V6/groups
/V6/groups
/V6/groups