Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Create Off-box Agent

Make sure that:

  • Devices have login credentials.
  • The management network has IP connectivity between the Apstra server and devices.
  • Required packages have been uploaded.
  • On Juniper devices, add Junos license configuration. (This is not the preferred method for adding license configuration. For more information, see Juniper Device Agent.)

Before creating/installing off-box device agents on Juniper Junos, Cisco NX-OS and Arista EOS, configure the following minimum configuration on them as shown below.

Juniper Junos Off-box Agent Minimum Configuration

For more information, see Juniper Device Agent.

Cisco NX-OS Off-box Agent Minimum Configuration

Arista EOS Off-box Agent Minimum Configuration

Make sure the following configuration is not on the device:

  • VLANs other than VLAN 1
  • VRFs other than "management"
  • Interface IP addresses other than "management"
  • Loopback interfaces
  • VLAN interfaces
  • VXLAN interfaces
  • AS-Path access-lists
  • IP prefix-lists
  • Route maps or policies
  • BGP configuration

During the agent install process, device configuration is validated, and if the device contains configuration that could prevent the deployment of service configuration, the agent install process raises an error (as of Apstra 4.0.1).

In this case, manually remove conflicting configuration and start the agent installation process again.

If you must complete the agent installation with configuration validation errors, you can disable pristine configuration validation. To do this, from Devices > Managed Devices, click Advanced Settings (top-right), select Skip Pristine Configuration Validation, then click Update.

For information about retaining pre-existing configuration when bringing devices under Apstra management, see Device Configuration Lifecycle.

Note:

On some platforms (Junos for example) you can configure rate-limiting for management traffic (SSH for example). When the Apstra server interacts directly with devices it can be more bursty than when it interacts with a user. Rate-limiting configurations that are used for hardening security can impact device management, and lead to deployment failures and other agent-related issues.

Off-box agents include the following parameters:
Parameter Description
Device addresses Management IP(s) of the device(s)
Operation Mode
  • Full Control - deploys configuration and collects telemetry
  • Telemetry Only - configuration is not deployed
Platform (off-box only) For off-box agents only: drop-down list includes supported platforms.
Username / Password If you're not using an agent profile with credentials, check these boxes and add credentials.
Agent Profile If you don't want to manually enter credentials and packages, use agent profiles that you previously defined.
Job to run after creation
  • Install (default) - installs the agent on the device
  • Check - creates the agent, but does not install it. It appears in the list view where you can install it later.
Install Requirements (servers only) For servers only: If servers don't have Internet connectivity, uncheck the box.
Packages Before creating the agent, install required packages so they are available. Packages associated with selected agent profiles are listed here as well.
Open Options (off-box only) Passes configured parameters to off-box agents. For example, to use HTTPS as the API connection from off-box agents to devices, use the key-value pair: proto-https - port-443. The following default values can be overridden with open options:
  • commit_timeout - 60 (integer: seconds)
  • telemetry_timeout - 100 (integer: seconds)
  • probe_timeout: 5 (integer: seconds)
  • log_config_diff - True (boolean)
  1. Confirm that you've installed the minimum configuration as described above, and that the device doesn't contain configuration that would raise validation errors.
  2. From the left navigation menu, navigate to Devices > Managed Devices and click Create Offbox Agent(s).
  3. Specify agent details as described in the parameters table above.
  4. Click Create. While the task is active you can view its progress at the bottom of the screen in the Active Jobs section. The job status changes from Initialized to In Progress to Succeeded.