HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/subsystems/{Subsystem.type},{Subsystem.name}

Path Params
string
enum
required

Reference Resource: Subsystem

string
required

Reference Resource: Subsystem

Body Params
string
enum

User configurable admin state of the subsystem. Valid values are: + diagnostic: Put the subsystem into diagnostic mode. + down: Disable/power down the subsystem. + up: Enable/power on the subsystem.

Allowed:
boolean

Specify true to disable and false to enable periodic diagnostics for the respective sub system

interface_group_speed
object

The allowed link speeds configuration for each interface group of a subsystem. Interface groups are blocks of ports for which only a subset of link speeds are usable at the same time due to hardware limitations. For example, a group of ports might support 10 Gbps and 25 Gbps transceivers, but not at the same time. When configured for 25g, any ports in the group with a 10 Gbps transceiver inserted cannot link. Groups are configured with a name describing a subset of link speeds. The speeds allowed by each name are defined by interface_group_info. Groups with no configuration default to the name defined in interface_group_default_speed. The currently applied name is available in interface_group_applied_speed. Note that not all defined group and speed names are available on all subsystems. Only groups and speeds listed in interface_group_info are used on a given subsystem. Any configured groups not listed are not used by the subsystem and are ignored. Groups configured with a speed setting that is not valid for the subsystem use the default instead.

string
length ≤ 64

User configurable part number for the subsystem. When this column is empty: + The subsystem is not explicitly configured yet and any compatible, supported subsystem is allowed to boot. + If an existing subsystem is physically replaced with a subsystem of a different part number, the interfaces associated with the existing subsystem will be removed prior to adding interfaces of the newly inserted subsystem. When this column is configured with a part number: + The subsystem is explicitly configured to only allow a subsystem with that specific part number to boot. + Physically replacing the existing subsystem with a subsystem of a different part number will require adjusting this column to match the new subsystem. Otherwise subsystem won't boot. + To configure the device for a new subsystem, the user can change this column with a different part number. The interfaces associated with the existing subsystem will be removed and the interfaces of the specified subsystem part number will be created.

boolean

PoE persistency configuration for this subsystem. Persistent PoE provides the ability to continue power delivery during a soft reboot of the switch. This feature is applicable to subsystems of type chassis in non-modular switches, and to subsystems of type line-card in modular switches. This configuration is ignored on a non-PoE capable subsystems.

integer
60 to 3600

The sampling period for average consumed power in seconds.

boolean

Quick PoE configuration for this subsystem. Quick PoE provides the ability for the switch (PSE) to power up connected PDs soon after a cold reboot. This feature is applicable to subsystems of type chassis in non-modular switches, and to subsystems of type line-card in modular switches. This configuration is ignored on non-PoE capable subsystems.

boolean

Resets the subsystem when set to true.

boolean

Specify true to disable and false to enable for the respective sub system

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!