diff --git a/docs/docs/adding-devices.mdx b/docs/docs/adding-devices.mdx
index 41829b7..212c27e 100644
--- a/docs/docs/adding-devices.mdx
+++ b/docs/docs/adding-devices.mdx
@@ -20,7 +20,7 @@ To add, as an example, a Cisco router, add the following to your `devices.yaml`,
```yaml title="devices.yaml"
routers:
- - name: router01.pop01
+ - name: New York City, NY
address: 10.0.0.1
network:
name: production
@@ -28,7 +28,6 @@ routers:
credential:
username: username
password: password
- display_name: Phoenix, AZ
port: 22
nos: cisco_ios
vrfs:
@@ -43,10 +42,9 @@ routers:
| Parameter | Type | Description |
| :------------------ | :-----: | :----------------------------------------------------------------------------------------------------------------- |
-| `name` | String | Device hostname. This is not user-facing. |
+| `name` | String | Device's user-facing name. |
| `address` | String | Device management hostname or IP address. |
| `network` | String | [Network Configuration](#network) |
-| `display_name` | String | Device's user-facing name. |
| `port` | Integer | TCP port used to connect to the device. `22` by default. |
| `nos` | String | Network Operating System. Must be a supported platform. |
| `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"
routers:
# HTTP/hyperglass-agent device
- - name: router01
- display_name: HTTP Router
+ - name: HTTP Router
address: 192.0.2.1
network:
name: primary
@@ -242,7 +239,7 @@ routers:
proxy: null
# SSH/netmiko device
- - name: router02
+ - name: SSH Router
address: 10.0.0.1
network:
name: primary
@@ -250,7 +247,6 @@ routers:
credential:
username: user
password: pass
- display_name: SSH Router
port: 22
nos: cisco_ios
vrfs: