# README #

NetFoundry registration script for "Edge-routers".

### What is this repository for? ###

* Registration script that will accept a single one time use key & will use it to configure an "Edge Router" according to configuraiton from MOP.

### Where to I get the latest build? ###

https://netfoundry.jfrog.io/ui/repos/tree/General/router-registration/release

### How do I get set up? ###

Usage: router-registration [-h] [-d] [-s] [-v]
                           [-i IP_OVERRIDE | -n DNS_OVERRIDE]
                           registration_key

positional arguments:
  registration_key      One time registration key

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           enable debug log in log file output
  -s, --salt            Setup saltstack
  -v, --version         show program's version number and exit
  -i IP_OVERRIDE, --ip_override IP_OVERRIDE
                        specify and IP Address
  -n DNS_OVERRIDE, --dns_override DNS_OVERRIDE
                        specify a DNS Name


* Example of default execution:   ./router-registration ASAU8NQHIHA54
* Example of dns override:        ./router-registration -n this.way.to.me.com ASAU8NQHIHA54
* Example of debug:               ./router-registration -d ASAU8NQHIHA54

### Who do I talk to if I need help? ###

* Cloud Engineering Development Slack: #cloud-eng-dev

### Requirements ###

* Must have the ziti-router binaries installed in the following directories:
  * /opt/netfoundry/ziti/ziti-router/

* Must have the ziti-router.service defined in systemd