device-discovery

Orb device discovery backend

Config RFC

discovery:
  config:
    target: grpc://localhost:8080/diode
    api_key: ${DIODE_API_KEY}
    host: 0.0.0.0
    port: 8072

Policy RFC

discovery:
  policies:
    discovery_1:
      config:
        schedule: "* * * * *" #Cron expression
        defaults:
          site: New York NY
      scope:
        - hostname: 192.168.0.32
          username: ${USER}
          password: admin
        - driver: eos
          hostname: 127.0.0.1
          username: admin
          password: ${ARISTA_PASSWORD}
          optional_args:
            enable_password: ${ARISTA_PASSWORD}
    discover_once: # will run only once
      scope:
        - hostname: 192.168.0.34
          username: ${USER}
          password: ${PASSWORD}

Run device-discovery

device-discovery can be run by installing it with pip

git clone https://github.com/netboxlabs/orb-discovery.git
cd orb-discovery/
pip install --no-cache-dir ./device-discovery/
device-discovery -c config.yaml

Docker Image

device-discovery can be build and run using docker:

docker build --no-cache -t device-discovery:develop -f device-discovery/docker/Dockerfile .
docker run -v /local/orb:/usr/local/orb/ -p 8072:8072 device-discovery:develop device-discovery -c /usr/local/orb/config.yaml

Routes (v1)

Get runtime and capabilities information

Policies Management