HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

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

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

Reference Resource: Subsystem

string
required

Reference Resource: Subsystem

Body Params
interface_group_speed
object

The configured speed for each interface group of this subsystem. Interface groups are blocks of ports where all transceivers are limited to a subset of available speeds and any mismatched transceivers will be disabled. The configured value for each group selects the subset of speeds that are allowed for all ports in the group. For example, a interface that belongs to a group configured for 25g will be disabled when it has a 10 Gbps transceiver inserted. See interface_group_info for the hardware speeds allowed by each confguration setting. See interface_group_default_speed for the default configuration of each group. The emptyValue property for each group is deprecated and replaced by the interface_group_default_speed column.

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

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.

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

string
enum

Power supply redundancy configured for the chassis: 'none': power supply redundancy is not configured. 'n+1': N+1 power supply redundancy is configured. One power supply is redundant. 'n+n': N+N power supply redundancy is configured. The number of redundant power supplies is the same as the number of active power supplies.

Allowed:
boolean

Resets the subsystem when set to true.

integer
60 to 3600

The sampling period for average consumed power in seconds.

boolean

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

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.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here!