Skip to main content

Supported Platforms

SSH#

The following platforms use Netmiko or Scrapli for connection handling. When configuring the nos property of a device, use the value in the Key column.

Platforms in green are natively supported, which means hyperglass has predefined commands built in. Other platforms should also work, you'll just need to add a custom command profile.

If needed, for troubleshooting purposes or otherwise, the driver for a given device can be overridden with the driver parameter. Generally, Netmiko is more stable, supports more platforms, but is slower; while Scrapli can be less reliable, supports fewer platforms, but is significantly faster.

NameKeyDefault Driver
A10a10Netmiko
AccedianaccedianNetmiko
Alcatel AOSalcatel_aosNetmiko
Alcatel SROSalcatel_srosNetmiko
Apresia Systems AEOSapresia_aeosNetmiko
Arista vEOSarista_eosNetmiko
Arubaaruba_osNetmiko
Avaya ERSavaya_ersNetmiko
Avaya VSPavaya_vspNetmiko
BIRDbirdScrapli
Calix B6calix_b6Netmiko
Check Point GAiAcheckpoint_gaiaNetmiko
Ciena SAOSciena_saosNetmiko
Cisco ASAcisco_asaNetmiko
Cisco IOScisco_iosScrapli
Cisco NX-OScisco_nxosScrapli
Cisco SG-300cisco_s300Netmiko
Cisco IOS-XEcisco_xeScrapli
Cisco IOS-XRcisco_xrScrapli
Citrix NetscalernetscalerNetmiko
CloudGenix IONcloudgenix_ionNetmiko
CoriantcoriantNetmiko
Dell OS6dell_os6Netmiko
Dell OS9dell_os9Netmiko
Dell OS10dell_os10Netmiko
Dell PowerConnectdell_powerconnectNetmiko
EndaceendaceNetmiko
EltexeltexNetmiko
Eltex ESReltex_esrNetmiko
EnterasysenterasysNetmiko
ExtremeextremeNetmiko
Extreme ERSextreme_ersNetmiko
Extreme EXOSextreme_exosNetmiko
Extreme/Brocade NetIronextreme_netironNetmiko
Extreme NOSextreme_nosNetmiko
Extreme/Brocade SLXextreme_slxNetmiko
Extreme/Brocade VDXextreme_vdxNetmiko
Extreme VSPextreme_vspNetmiko
Extreme Wingextreme_wingNetmiko
F5 LTMf5_ltmNetmiko
F5 TMSHf5_tmshNetmiko
F5 Linuxf5_linuxNetmiko
Flex VNFflexvnfNetmiko
FortinetfortinetNetmiko
FRRoutingfrrScrapli
Generic Terminal Servergeneric_termserverNetmiko
HPE/3COM Comwarehp_comwareNetmiko
HPE ProCurvehp_procurveNetmiko
HuaweihuaweiNetmiko
Huawei VRPv8huawei_vrpv8Netmiko
IPInfusion OcNOSipinfusion_ocnosNetmiko
JuniperjuniperScrapli
Juniper JunOSjuniper_junosScrapli
Juniper ScreenOSjuniper_screenosNetmiko
KeymilekeymileNetmiko
Keymile NOSkeymile_nosNetmiko
LinuxlinuxNetmiko
Mikrotik RouterOSmikrotik_routerosNetmiko
Mikrotik SwitchOSmikrotik_switchosNetmiko
MellanoxmellanoxNetmiko
Mellanox MLNX-OSmellanox_mlnxosNetmiko
MRV LXmrv_lxNetmiko
MRV Optiswitchmrv_optiswitchNetmiko
Nokia SROSnokia_srosNetmiko
OneAccess OneOSoneaccess_oneosNetmiko
OVS Linuxovs_linuxNetmiko
Palo Alto Networks PAN-OSpaloalto_panosNetmiko
PluribuspluribusNetmiko
Quanta Meshquanta_meshNetmiko
RAD ETXrad_etxNetmiko
Ruckus/Brocade FastIronruckus_fastironNetmiko
Ruijie OSruijie_osNetmiko
TNSRtnsrScrapli
Ubuiquiti EdgeRouterubiquiti_edgeNetmiko
Ubuiquiti EdgeSwitchubiquiti_edgeswitchNetmiko
Vyatta VyOSvyatta_vyosNetmiko
VyOSvyosNetmiko

HTTP#

The following platforms use hyperglass-agent for connection handling. When configuring the nos property of a device, use the value in the Key column.

hyperglass agent is being deprecated

While hyperglass-agent was a cool idea, maintaining the two codebases and protocol sets has proven cumbersome, with very little benefit. As of v1.0.0, frr_legacy and bird_legacy are temporarily available to mimic previous behavior with hyperglass-agent.

NameKey
BIRDbird_legacy
FRRoutingfrr_legacy

Caveats#

BIRD#

If using BIRD, more specifically bird_ssh, you'll more than likely need to provide hyperglass with credentials that have root privileges. This is because, to my knowledge, the socket birdc uses is created by root. Therefore, if hyperglass runs the birdc commands as an unprivileged user, they will fail with a permissions error.

FRRouting#

The user account you provide hyperglass in the credential field needs to be a member of the frrvty group. See the FRR docs for more detail.

VyOS#

As of vyos-1.3-rolling-202007050117 which is the latest release VyOS has been tested with hyperglass, VyOS does not support BGP or other dynamic routing protocols in a VRF. As such, the default BGP commands for VyOS omit the VRF from the command.