forked from mirrors/thatmattlove-hyperglass
32 lines
996 B
Text
32 lines
996 B
Text
---
|
|
title: Basic Configuration
|
|
description: Get started with a basic hyperglass configuration
|
|
---
|
|
|
|
import { Callout } from "nextra-theme-docs";
|
|
|
|
To get started, hyperglass only needs to know about your devices.
|
|
|
|
<Callout>
|
|
**Devices** are your routers, switches, or whatever else you want to call the endpoints
|
|
hyperglass will query for information.
|
|
</Callout>
|
|
|
|
## Simple Device Configuration
|
|
|
|
Create a file called `devices.yaml` in the directory `/etc/hyperglass`.
|
|
|
|
```yaml filename="devices.yaml"
|
|
devices:
|
|
- name: NYC Router 1
|
|
address: <IP address hyperglass will use to log into the router>
|
|
credential:
|
|
username: <Username hyperglass will use to log into the router>
|
|
password: <Password hyperglass will use to log into the router>
|
|
platform: cisco_ios
|
|
attrs:
|
|
source4: <IPv4 address from which to source ping & traceroute commands>
|
|
source6: <IPv4 address from which to source ping & traceroute commands>
|
|
```
|
|
|
|
That's it!
|