diff --git a/docs/docs/adding-devices.mdx b/docs/docs/adding-devices.mdx index 5048032..1bf1def 100644 --- a/docs/docs/adding-devices.mdx +++ b/docs/docs/adding-devices.mdx @@ -45,7 +45,7 @@ routers: | :------------------ | :-----: | :----------------------------------------------------------------------------------------------------------------- | | `name` | String | Device hostname. This is not user-facing. | | `address` | String | Device management hostname or IP address. | -| `network` | String | Primary network this device is a member of. Used for device grouping. Usually something like 'AS65000'. | +| `network` | String | [Network Configuration](#network) | | `display_name` | String | Device's user-facing name. | | `port` | Integer | TCP port used to connect to the device. | | `nos` | String | Network Operating System. Must be a supported platform. | @@ -55,6 +55,15 @@ routers: | `proxy` | | [SSH Proxy Configuration](#proxy) | | `ssl` | | [SSL Configuration](#ssl) for devices using [hyperglass-agent](https://github.com/checktheroads/hyperglass-agent). | +### `network` + +A network is only used for grouping. For example, if your network contains more than one ASN, you might want to group each device separately. Currently, you must define a network on each device. + +| Parameter | Type | Description | +| :------------------ | :----: | :------------------------------------------------------------------- | +| `name` | String | The network's name. This name is only used by hyperglass internally. | +| `display_name` | String | The network's use-facing name. | + ### `proxy` Any device that uses SSH (see [platforms](platforms) for breakdown) can be accessed through an intermediary SSH "proxy". The process is nearly identical to using local SSH tunneling, e.g. `ssh -L local_port:remote_device:remote_port username@proxy_server -p proxy_port`.