Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Agent Configuration File (Devices)

Controller Section


Agent Server Discovery is a client-server model. The Apstra Device agent registers directly to the Apstra server via the metadb connection. The Apstra server can be discovered from static IP or DNS.

Dynamic DNS - By default, Apstra device agents point to the DNS entry aos-server, relying on dhcp-provided DNS resolution and hostname resolution. On the Apstra server, if the metadb connection entry points to a DNS entry, then the Apstra agents must be able to resolve that DNS entry as well. DNS must be configured so aos-server resolves to an interface on the Apstra server itself, and so the agents are configured with metadb = tbt://aos-server:29731

Static DNS - We can add a static DNS entry pointing directly to the IP of aos-server. Add a static DNS entry, or use a DNS Nameserver configuration on the device.

Arista and Cisco Static Hostname

Obtaining IP from Apstra Server

Then the agents will be configured with metadb = tbt://aos-server:29731.


In a future release, the Apstra REST API will be able to run on a separate server from the Apstra server itself. This feature is for Apstra internal usage only.


The device agent source interface applies to Linux servers only (Ubuntu, CentOS). This source IP is the server interface that the device agent uses when registering with Apstra. For example, on a server, to bind the device agent to eth1 instead of the default eth0, specify interface = eth1.

Service Section

The service section manages specific agent configuration related to configuration rendering and telemetry services.


This field specifies the operation mode of the device agent: telemetry only or full control.

enable_configuration_service = 0 To push telemetry (alerts) only, leave the default value of 0. Configuration files wont be modified unless a network administrator specifies it.

enable_configuration_service = 1 Setting this field to 1 allows Apstra to fully manage the device agent configuration, including pushing discovery and full intent-based configuration.


Configuration is not stored on the device. This prevents a device from booting up and immediately participating in fabric that may not be properly configured yet. The Apstra device agent is configured after the discovery phase completes.

backup_restoration_timeout = 00:00:00 This disabled state (default) keeps the Apstra device agent from replacing the running configuration if it cannot contact the Apstra server. Any previous configuration state is not restored.

backup_restoration_timeout = 00:15:00 Any value other than the default 00:00:00 enables the Apstra agent to boot and replace the running configuration with the most known previous state after the specified period of time (fifteen minutes in this example). Specifically, the files from /.aos/rendered/ are restored to the system after the configuration restore period expires.

Logrotate Section

Apstra logs to the /var/log/aos folder under a series of files. Apstra implements its own method of log rotation to prevent /var/log/aos from filling up. You can enable (2) or disable (1) log rotation. Each individual log file is rotated when it approaches the appropriate maximum size. Log rotation occurs by default every hour.

Device Info Section


The device info section is used to modify the default device model of servers as they register to Apstra. For example, Server 2x10G changes the server to a dual-attached L3 server. All valid options for model include:

  • Generic Model
  • Server 2x10G
  • Server 1x25G
  • Server 1x40G
  • Server 4x10G

Device Profile Section