Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Add a Device to Routing Director

You must be a superuser or network administrator to adopt or onboard a device (router, switch, or firewall).

A superuser or network administrator can adopt a device [both new devices (greenfield) and devices that are already a part of the network (brownfield device)], and manage the device by using Routing Director. When you adopt a device that is not associated with a network implementation plan, you (superuser or network administrator) must manually update configurations by using configuration templates, apply licenses, and upgrade software. However, if you use a network implementation plan to onboard devices, you can make the changes to the network implementation plan and publish the network implementation plan for the changes to take effect on the devices included in the plan. You also obtain the granular metrics about the device’s health and performance by using the network implementation plan to onboard a device.

The status of a device that is already installed and connected to the network, but is not managed by the Routing Director appears as Disconnected on the Inventory page (Inventory > Devices > Network Inventory). When you adopt a device, the device connects with Routing Director and the status of the device changes to Connected, indicating that the device is managed by Routing Director.

You can add a device to Routing Director by using any of the following methods:

Before you adopt a device, ensure that:

  • The device can reach the gateway.

    Note:

    If a firewall exists between Routing Director and the device, configure the firewall to allow outbound access on TCP ports 443, 2200, 6800, 4189, and 32,767 from the management port of the device.

  • The device can connect to Routing Director.

Adopt a Juniper Device

To adopt a device:
  1. Navigate to Inventory > Devices > Network Inventory.

    The Inventory page appears.

  2. On the device-type tab, click Add Device.

    The Add Devices page appears.

  3. To add a Juniper Router, click Adopt Router.
  4. (Optional) Click Select Site to select the site where the device is installed or to be installed.
  5. In the Select IP Version drop-down list, select:

    • IPv4 (default) to use IPv4 address for connecting with Routing Director.

    • IPv6 to use IPv6 address for connecting with Routing Director.

    Note:

    If Routing Director cluster uses IPv6 address, the outbound SSH command always uses IPv6 address irrespective of the IP version you select.

  6. (Optional) If you are using RADIUS for device authentication, enter the IP address of the RADIUS server in the RADIUS Source Address field.
    Note:

    Ensure that the version of the device IP address that you enter here matches with the version of the RADIUS server IP address that you have configured in Routing Director.

  7. Click Copy Cli Commands to copy the CLI commands under Apply the following CLI commands to adopt a Juniper Device if meets the requirements and click OK.

    The outbound SSH command listed depends on the IP version that you select in step 5.

    Note:

    Include the below statement to the outbound SSH commands if the device needs a routing instance to reach the virtual IP (VIP) address for gNMI connections on Routing Director:

    where, routing-instance-name is the name of the routing instance on the device configured for reaching gNMI VIP on Routing Director.
  8. Access the device by using Telnet or SSH and log in to the device in configuration mode.
  9. Paste the contents of the clipboard and commit the configuration on the device.
    The device connects to and is managed by Routing Director.
  10. After you adopt a device, you can verify the connectivity status by running the following command on the device:

    An output similar to the following indicates that the device is connected to Routing Director:

What's Next

Connect to the Routing Director GUI and view the status of device onboarding. After the device status changes to Connected on the Inventory page (Inventory > Devices > Network Inventory), you can start managing the device. See Device Management Workflow.

Adopt a Juniper Device Using ZTP

Prerequisites:

  • A network implementation plan should be configured for the device.

  • The device should be returned to zero or in its factory-default settings.

  • A TFTP server reachable from the device

  • A DHCP server reachable from the device, with the ability to respond to the device with the TFTP server and configuration file (script) name

Figure shows the workflow for adopting device using ZTP.

Figure 1: Workflow for Adopting a Device Using ZTP Network device onboarding process showing flow of configuration: user initiates with script hostname-site.py, TFTP and DHCP servers assign parameters, device retrieves and applies configuration, and completes onboarding.

The steps for the workflow are as follows:

  1. Create an onboarding script (Python or SLAX) with the required SSH configuration by:

    • Connecting to Routing Director GUI and copying the onboarding configuration statements. To copy the onboarding configuration from the Routing Director GUI:

      1. Navigate to Inventory > Network Inventory.

      2. On the device-type tab, click Add Device.

      3. On the Adopt Router tab of the Add Devices page,

        1. (Optional) Click Select site to select the site where the device is installed.

      4. Click the Copy Cli Commands link to copy the outbound SSH configuration displayed in the Apply the following CLI commands to adopt a Juniper Device if meets the requirements text field to clipboard and click OK.

      5. Paste the CLI commands in the onboarding script.

    • Adding the SSH configuration statements to the onboarding script.

    See Sample Onboarding Script for Committing SSH Configuration on a Device for a sample of the onboarding script.

  2. Upload the onboarding script to the TFTP server.
  3. Configure the DHCP server with the onboarding script filename and path to the onboarding script in the TFTP server.
  4. Install the device, connect it to the network, and power on the device.

    For information about installing the device, see the respective installation guide on the Product Documentation website.

  5. After the device is powered on, the factory-default settings in the device trigger a built-in script (ztp.py). The script obtains the following from the DHCP server:

    • IP address for the management interface

    • IP address of the default gateway

    • IP address of the DNS server and TFTP server

    • Path to the onboarding script on the TFTP server

  6. The device configures its management IP address, static default route, and the DNS server address, based on the values from the DHCP server.
  7. The device downloads the onboarding script, based on the values from the DHCP server, and executes it, resulting in the onboarding configuration statements to be committed.
  8. The device opens an outbound SSH session with Routing Director based on the committed onboarding configuration.
  9. Routing Director configures management and telemetry parameters including gNMI by using NETCONF. Routing Director also configures the interfaces and protocols based on the configurations defined in the network implementation plan associated with the device, by using NETCONF.

Sample Onboarding Script for Committing SSH Configuration on a Device

The following is a sample of the onboarding script that is downloaded from the TFTP server to the device:

What's Next

Connect to the Routing Director GUI and view the status of device onboarding on the Inventory page (Inventory > Devices > Network Inventory). After the device status changes to Connected , you can start managing the device. See Device Management Workflow.

Add a Non-Juniper Device

Note:

In this release, among non-Juniper devices, Nokia and Cisco devices are supported. For a list of supported Nokia and Cisco devices, see Supported Junos OS Releases, Devices, and Browsers.

To add a non-Juniper device to Routing Director:
  1. Navigate to Inventory > Devices > Network Inventory.

    The Inventory page appears.

  2. On the Router tab, click Add Device.
    The Add Devices page appears.
  3. On the Add a Device tab, enter values referring to table Table 1.

    Fields marked with * are mandatory.

  4. Click + Add Device to add more devices.
  5. Repeat steps 3 and 4 to add more non-Juniper devices.
  6. Click OK.
    The device connects to Routing Director. You can now manage the device by using Routing Director.
  7. (Optional) View the status of device onboarding on the Inventory page (Inventory > Devices > Network Inventory). After the device status changes to Connected, you can start managing the device. See Device Management Workflow.
Table 1: Add a Non-Juniper Device

Field

Description

Device Name

Enter the device hostname.

Address/GRPC Port*

Enter the IPv4 address and gRPC port configured on the device.

MAC*

Enter the MAC address of the device.

Site

Click the drop-down list to select a site where the device is deployed.

Selecting a site to onboard a device is optional.

Vendor*

Click the drop-down list to select the vendor of the device—Cisco or Nokia.

Model*

Enter the device model. For example, Cisco NCS-57C3

Operating System Name*

Enter the name of the operating system (OS) deployed on the device. For example, IOS XR.

Version*

Enter the version of the operating system. For example 7.10.1.

For a list of software versions supported on the Cisco and Nokia devices, see Supported Junos OS Releases, Devices, and Browsers .

Timeout (in minutes)

Enter the time (in minutes) of inactivity after which the device disconnects with Routing Director.

Retry Delay (in minutes)

If Routing Director is unable to connect with a device, enter the time (in minutes) after which Routing Director retries to connect with the device.

Authorization

Insecure*

This option is disabled by default and the connection between the device and Routing Director is secure (encrypted and/or authenticated).

Enable this option when TLS is disabled on the device so that the connection between Routing Director and the device is established without any encryption.

The insecure connection is vulnerable to man-in-the-middle attacks and other security threats. We recommend that you use an insecure connection between the Routing Director and the device only during local development and in testing environments where security is not a concern.

Skip Verify*

This option is disabled by default and the device verifies the identity of Routing Director when Routing Director establishes a connection with the device.

Enable this option when TLS is enabled on the device and the device should skip verifying Routing Director's identity when Routing Director establishes a connection. This option is useful when you have a self-signed certificate that cannot be verified against a certificate authority, so that the device skips the verification process.

When you skip verifying Routing Director's identity, the connection is vulnerable to man-in-the-middle attacks. Therefore, this option should be enabled only during development or testing the connection between the device and Routing Director.

Certificates—Use this option to enter the username and password for the device to authenticate Routing Director.

Certificate*

Click Browse to upload the TLS certificate for the device.

Key Certificate

Click Browse to upload the TLS certificate key for the device.

Certificate Authority

Certificate Authority: Click Browse to upload the TLS root certificate from the certificate authority.

Credentials—Use this option to enter the username and password for the device to authenticate Routing Director.

Username

Enter a username of the device for Routing Director to connect with the device.

Password

Enter the password for the username.

NETCONF Enabled

Click to enable or disable (default) NETCONF on Routing Director to establish SSH connections with the device.

If you enable NETCONF, enter the SSH port for establishing connection with the device.

Port

Type the port number that Routing Director can use NETCONF for SSH connections with Routing Director.

Range: 1 through 65,535.

Key

Click Browse to upload the key that Routing Director can use NETCONF for the SSH connections.

If you do not assign a key, Routing Director uses the username and password in the device configuration to establish connection with the device.

See Also