API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create hardware module profile by module name

List of hardware module profiles.

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

The name of the profile for the hardware module.

Query Params
string

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

string

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

string

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

Body Params

hw-profilebody object

boolean
Defaults to true

Always-on PoE provides ability to continue power delivery during
a soft/warm reboot. On standalone devices this applies globally,
on VSF it applies to the 'Member' and in chassis devices this is
applicable to the 'Line Cards'.

string
length between 1 and 256

A module description, used to identify what is configured and how it is configured.

interface-group-speed-profile
array of objects
length ≤ 2147483647

Some switch models have a restriction that all transceivers installed in
a group of ports must have compatible speeds. All mismatched interfaces
in the group will be disabled.

interface-group-speed-profile
member-or-slot-ids
array of int32s
length ≤ 2147483647
member-or-slot-ids
string
length between 1 and 64

The name of the profile for the hardware module.

boolean
Defaults to false

Enable quick-poe configuration. quick-poe allows the PSE
to power up connected PDs soon after a cold reboot. On standalone
devices this applies globally, on VSF it applies to the 'Member' and
in chassis devices this is applicable to the 'Line Cards'.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json