Birch
  • Getting Started
  • Deploy Birch Probe
  • Softpanels
  • Trunking
  • Favorites
  • User Management
  • Supported Routers
  • Probe API
    • Configuration
    • HTTP Requests
Powered by GitBook
On this page
  • Organization Setup
  • Deploying Birch Probe
  • Connect to a Device
  • Making a route
  • Multi-level Routing

Was this helpful?

Getting Started

NextDeploy Birch Probe

Last updated 3 years ago

Was this helpful?

Birch allows decentralized management of multiple routing systems with a cloud-based infrastructure. It is designed to provide a unified experience regardless of the routing platform you are using and gives the user the ability to intelligently manage physical connections between multiple routers.

Birch utilizes a small application locally to connect our cloud infrastructure to your locally deployed routing systems. The rest of the infrastructure is available to any device that has an internet connection, allowing you to manage your infrastructure from anywhere, at any time.

Organization Setup

Once your Organization has been created, you will receive an email with a temporary password. Navigate to to log in for the first time and set your password.

Once you log in navigate to Settings > Organization (available for Admins only). The Organization Settings will allow an Admin to update the name of the account, administer users and create access control lists.

Make note of the Organization ID, the UUID displayed at the top of Organization Settings. It will be necessary for configuring your Birch Probe.

Deploying Birch Probe

Prior to connecting to a Device, you must have a Birch Probe deployed. If your environment requires, you can have multiple Birch Probes deployed to connect to different Devices that may not be accessible from the same network.

Connect to a Device

Once a new Probe is deployed, you are able to add a new Device for that Probe to communicate with.

Field

Use

Name

Device Long Name

Short Name

Device Short Name

Protocol

Routing System's communication protocol

IP Address

Local IP Address of the Routing System

Adding a Device will restart the Birch Probe and may cause an interruption to routing from the Birch system. It will not affect the routing system you adding in any way.

Once enabled, the Device should be connected.

Making a route

Once you have a Probe and Device setup, you will be able to make routes. Birch will automatically connect to your router and sync its source and destination names and current state to the system. Additional, Birch will stay in-sync with the routing system if changes are made from another source, such as a physical router control panel.

You may either search for your source or destination, or use the filters to drill-down to the desired source or destination. Birch routing is very simple, choose a Destination, choose a Source, and Take the route. You can also Lock or Unlock a Destination to verify

Multi-level Routing

If your routing system supports multi-level routing, the Levels button will reveal the levels that were detected when the Birch Probe connected to the Device.

You can select any combination of Levels to create a breakaway route and simply Take the route as normal. Destinations that currently have a Breakaway route, will have the BR indicator.

Multi-level Routing is only supported within a single device.

Once added, the Birch Probe will restart and attempt to connect to your routing Device. After the initial creating, the Device routing capability will be inhibited. Click the to enable routing.

⚠️
Deploy Birch Probe
https://birch.whitebark.net