mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
update docs with frr/bird information
This commit is contained in:
@@ -47,7 +47,7 @@ routers:
|
|||||||
| <R/> `address` | String | Device management hostname or IP address. |
|
| <R/> `address` | String | Device management hostname or IP address. |
|
||||||
| <R/> `network` | String | [Network Configuration](#network) |
|
| <R/> `network` | String | [Network Configuration](#network) |
|
||||||
| <R/> `display_name` | String | Device's user-facing name. |
|
| <R/> `display_name` | String | Device's user-facing name. |
|
||||||
| <R/> `port` | Integer | TCP port used to connect to the device. |
|
| <R/> `port` | Integer | TCP port used to connect to the device. `22` by default. |
|
||||||
| <R/> `nos` | String | Network Operating System. <MiniNote>Must be a <Link to="platforms">supported platform</Link>.</MiniNote> |
|
| <R/> `nos` | String | Network Operating System. <MiniNote>Must be a <Link to="platforms">supported platform</Link>.</MiniNote> |
|
||||||
| `structured_output` | Boolean | Disabled output parsing to structured data. |
|
| `structured_output` | Boolean | Disabled output parsing to structured data. |
|
||||||
| <R/>`credential` | | [Device Credential Configuration](#credential) |
|
| <R/>`credential` | | [Device Credential Configuration](#credential) |
|
||||||
|
@@ -30,7 +30,7 @@ hyperglass comes with built in support for the following platforms:
|
|||||||
- Huawei VRP
|
- Huawei VRP
|
||||||
- VyOS
|
- VyOS
|
||||||
|
|
||||||
:::warning VyOS & VRFs
|
:::caution VyOS & VRFs
|
||||||
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**.
|
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**.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
@@ -11,8 +11,12 @@ description: Platforms supported by hyperglass
|
|||||||
|
|
||||||
The following platforms use [hyperglass-agent](agent/installation.mdx) for connection handling. When configuring the `nos` property of a device, use the value in the **Key** column.
|
The following platforms use [hyperglass-agent](agent/installation.mdx) for connection handling. When configuring the `nos` property of a device, use the value in the **Key** column.
|
||||||
|
|
||||||
|
:::caution 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-beta.76**, `frr_ssh` and `bird_ssh` are available for use as replacements.
|
||||||
|
:::
|
||||||
|
|
||||||
| Name | Key |
|
| Name | Key |
|
||||||
| --------- | ------ |
|
| :-------- | :----- |
|
||||||
| BIRD | `bird` |
|
| BIRD | `bird` |
|
||||||
| FRRouting | `frr` |
|
| FRRouting | `frr` |
|
||||||
|
|
||||||
@@ -21,7 +25,7 @@ The following platforms use [hyperglass-agent](agent/installation.mdx) for conne
|
|||||||
The following platforms use [Netmiko](https://github.com/ktbyers/netmiko) or [Scrapli](https://github.com/carlmontanari/scrapli) for connection handling. When configuring the `nos` property of a device, use the value in the **Key** column.
|
The following platforms use [Netmiko](https://github.com/ktbyers/netmiko) or [Scrapli](https://github.com/carlmontanari/scrapli) for connection handling. When configuring the `nos` property of a device, use the value in the **Key** column.
|
||||||
|
|
||||||
| Name | Key |
|
| Name | Key |
|
||||||
| ------------------------- | --------------------- |
|
| :------------------------ | :-------------------- |
|
||||||
| A10 | `a10` |
|
| A10 | `a10` |
|
||||||
| Accedian | `accedian` |
|
| Accedian | `accedian` |
|
||||||
| Alcatel AOS | `alcatel_aos` |
|
| Alcatel AOS | `alcatel_aos` |
|
||||||
@@ -31,6 +35,7 @@ The following platforms use [Netmiko](https://github.com/ktbyers/netmiko) or [Sc
|
|||||||
| Aruba | `aruba_os` |
|
| Aruba | `aruba_os` |
|
||||||
| Avaya ERS | `avaya_ers` |
|
| Avaya ERS | `avaya_ers` |
|
||||||
| Avaya VSP | `avaya_vsp` |
|
| Avaya VSP | `avaya_vsp` |
|
||||||
|
| BIRD | `bird_ssh` |
|
||||||
| Calix B6 | `calix_b6` |
|
| Calix B6 | `calix_b6` |
|
||||||
| Check Point GAiA | `checkpoint_gaia` |
|
| Check Point GAiA | `checkpoint_gaia` |
|
||||||
| Ciena SAOS | `ciena_saos` |
|
| Ciena SAOS | `ciena_saos` |
|
||||||
@@ -65,6 +70,7 @@ The following platforms use [Netmiko](https://github.com/ktbyers/netmiko) or [Sc
|
|||||||
| F5 Linux | `f5_linux` |
|
| F5 Linux | `f5_linux` |
|
||||||
| Flex VNF | `flexvnf` |
|
| Flex VNF | `flexvnf` |
|
||||||
| Fortinet | `fortinet` |
|
| Fortinet | `fortinet` |
|
||||||
|
| FRRouting | `frr_ssh` |
|
||||||
| Generic Terminal Server | `generic_termserver` |
|
| Generic Terminal Server | `generic_termserver` |
|
||||||
| HPE/3COM Comware | `hp_comware` |
|
| HPE/3COM Comware | `hp_comware` |
|
||||||
| HPE ProCurve | `hp_procurve` |
|
| HPE ProCurve | `hp_procurve` |
|
||||||
@@ -97,3 +103,17 @@ The following platforms use [Netmiko](https://github.com/ktbyers/netmiko) or [Sc
|
|||||||
| Ubuiquiti EdgeSwitch | `ubiquiti_edgeswitch` |
|
| Ubuiquiti EdgeSwitch | `ubiquiti_edgeswitch` |
|
||||||
| Vyatta VyOS | `vyatta_vyos` |
|
| Vyatta VyOS | `vyatta_vyos` |
|
||||||
| VyOS | `vyos` |
|
| VyOS | `vyos` |
|
||||||
|
|
||||||
|
## Caveats
|
||||||
|
|
||||||
|
### BIRD
|
||||||
|
|
||||||
|
If using BIRD, more specifically [`bird_ssh`](platforms.mdx), 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](http://docs.frrouting.org/en/latest/vtysh.html) 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**.
|
||||||
|
Reference in New Issue
Block a user