mirror/checktheroads-hyperglass
1
0
Fork 0
mirror of https://github.com/checktheroads/hyperglass synced 2024-05-11 05:55:08 +00:00
Code Releases Activity

update does for #117 change

Browse Source
This commit is contained in:
checktheroads
2021-02-10 00:52:41 -07:00
parent 72269f38f5
commit 8c111d44dd
1 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/adding-devices.mdx
View File

@@ -20,7 +20,7 @@ To add, as an example, a Cisco router, add the following to your `devices.yaml`,
```yaml title="devices.yaml" ```yaml title="devices.yaml"
routers: routers:
- name: router01.pop01 - name: New York City, NY
address: 10.0.0.1 address: 10.0.0.1
network: network:
name: production name: production
@@ -28,7 +28,6 @@ routers:
credential: credential:
username: username username: username
password: password password: password
display_name: Phoenix, AZ
port: 22 port: 22
nos: cisco_ios nos: cisco_ios
vrfs: vrfs:
@@ -43,10 +42,9 @@ routers:
| Parameter | Type | Description | | Parameter | Type | Description |
| :------------------ | :-----: | :----------------------------------------------------------------------------------------------------------------- | | :------------------ | :-----: | :----------------------------------------------------------------------------------------------------------------- |
| <R/> `name` | String | Device hostname. This is not user-facing. | | <R/> `name` | String | Device's user-facing name. |
| <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/> `port` | Integer | TCP port used to connect to the device. `22` by default. | | <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. |
@@ -208,8 +206,7 @@ Below is a full example with nearly every available knob turned:
```yaml title="devices.yaml" ```yaml title="devices.yaml"
routers: routers:
# HTTP/hyperglass-agent device # HTTP/hyperglass-agent device
- name: router01 - name: HTTP Router
display_name: HTTP Router
address: 192.0.2.1 address: 192.0.2.1
network: network:
name: primary name: primary
@@ -242,7 +239,7 @@ routers:
proxy: null proxy: null
# SSH/netmiko device # SSH/netmiko device
- name: router02 - name: SSH Router
address: 10.0.0.1 address: 10.0.0.1
network: network:
name: primary name: primary
@@ -250,7 +247,6 @@ routers:
credential: credential:
username: user username: user
password: pass password: pass
display_name: SSH Router
port: 22 port: 22
nos: cisco_ios nos: cisco_ios
vrfs: vrfs: