HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/device_profiles/{Device_Profile.name}

Path Params
string
required

Reference Resource: Device_Profile
The name of the profile.

Body Params
cdp_groups
array of strings
length ≤ 2

Reference Resource: Port_Access_CDP_Group
Administrator can specify the CDP group to use for matching criteria. CDP TLVs advertise sysgroup, sysdescr, chassis_id etc., to indicate the device type. The CDP group allows grouping based on such criteria and specifying that CDP group here, links the role assignment accordingly.

cdp_groups
boolean

Enables the profile.

lldp_groups
array of strings
length ≤ 2

Reference Resource: Port_Access_LLDP_Group
Administrator can specify the LLDP group to use for matching criteria. LLDP TLVs advertise sysgroup, sysdescr, chassis_id etc., to indicate the device type. The LLDP group allows grouping based on such criteria and specifying that LLDP group here, links the role assignment accordingly.

lldp_groups
mac_groups
array of strings
length ≤ 2

Reference Resource: MAC_Group
Administrator can specify the MAC group to use for matching criteria. MAC signature can be specified via OUI/mask or complete MAC address.

mac_groups
string

Reference Resource: Port_Access_Role
Role to be applied when a device is identified based on LLDP match criteria specified in this profile.

Responses
204

No Content

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!