Skip to content

Miscellaneous Parameters

ADMINS

NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example:

ADMINS = [
    ['Hank Hill', 'hhill@example.com'],
    ['Dale Gribble', 'dgribble@example.com'],
]

Dynamic Configuration Parameter

Sets content for the bottom banner in the user interface.

Dynamic Configuration Parameter

This defines custom content to be displayed on the login page above the login form. HTML is allowed.

Dynamic Configuration Parameter

Note

This parameter was added in NetBox v3.5.

This adds a banner to the top of every page when maintenance mode is enabled. HTML is allowed.

Dynamic Configuration Parameter

Sets content for the top banner in the user interface.

Tip

If you'd like the top and bottom banners to match, set the following:

BANNER_TOP = 'Your banner text'
BANNER_BOTTOM = BANNER_TOP

CENSUS_REPORTING_ENABLED

Default: True

Enables anonymous census reporting. To opt out of census reporting, set this to False.

This data enables the project maintainers to estimate how many NetBox deployments exist and track the adoption of new versions over time. Census reporting effects a single HTTP request each time a worker starts. The only data reported by this function are the NetBox version, Python version, and a pseudorandom unique identifier.

CHANGELOG_RETENTION

Dynamic Configuration Parameter

Default: 90

The number of days to retain logged changes (object creations, updates, and deletions). Set this to 0 to retain changes in the database indefinitely.

Warning

If enabling indefinite changelog retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.

CHANGELOG_SKIP_EMPTY_CHANGES

Default: True

If enabled, a change log record will not be created when an object is updated without any changes to its existing field values.

Note

The object's last_updated field will always reflect the time of the most recent update, regardless of this parameter.

DATA_UPLOAD_MAX_MEMORY_SIZE

Default: 2621440 (2.5 MB)

The maximum size (in bytes) of an incoming HTTP request (i.e. GET or POST data). Requests which exceed this size will raise a RequestDataTooBig exception.

ENFORCE_GLOBAL_UNIQUE

Dynamic Configuration Parameter

Default: True

By default, NetBox will prevent the creation of duplicate prefixes and IP addresses in the global table (that is, those which are not assigned to any VRF). This validation can be disabled by setting ENFORCE_GLOBAL_UNIQUE to False.

Changed in v3.7

The default value for this parameter was changed from False to True in NetBox v3.7.

FILE_UPLOAD_MAX_MEMORY_SIZE

Default: 2621440 (2.5 MB)

The maximum amount (in bytes) of uploaded data that will be held in memory before being written to the filesystem. Changing this setting can be useful for example to be able to upload files bigger than 2.5MB to custom scripts for processing.

GRAPHQL_ENABLED

Dynamic Configuration Parameter

Default: True

Setting this to False will disable the GraphQL API.

JOB_RETENTION

Dynamic Configuration Parameter

Note

This parameter was renamed from JOBRESULT_RETENTION in NetBox v3.5.

Default: 90

The number of days to retain job results (scripts and reports). Set this to 0 to retain job results in the database indefinitely.

Warning

If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity.

MAINTENANCE_MODE

Dynamic Configuration Parameter

Default: False

Setting this to True will display a "maintenance mode" banner at the top of every page. Additionally, NetBox will no longer update a user's "last active" time upon login. This is to allow new logins when the database is in a read-only state. Recording of login times will resume when maintenance mode is disabled.

MAPS_URL

Dynamic Configuration Parameter

Default: https://maps.google.com/?q= (Google Maps)

This specifies the URL to use when presenting a map of a physical location by street address or GPS coordinates. The URL must accept either a free-form street address or a comma-separated pair of numeric coordinates appended to it. Set this to None to disable the "map it" button within the UI.

MAX_PAGE_SIZE

Dynamic Configuration Parameter

Default: 1000

A web user or API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. ?limit=1000). This parameter defines the maximum acceptable limit. Setting this to 0 or None will allow a client to retrieve all matching objects at once with no limit by specifying ?limit=0.

METRICS_ENABLED

Default: False

Toggle the availability Prometheus-compatible metrics at /metrics. See the Prometheus Metrics documentation for more details.

PREFER_IPV4

Dynamic Configuration Parameter

Default: False

When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead.

QUEUE_MAPPINGS

Allows changing which queues are used internally for background tasks.

QUEUE_MAPPINGS = {
    'webhook': 'low',
    'report': 'high',
    'script': 'high',
}

If no queue is defined the queue named default will be used.

RELEASE_CHECK_URL

Default: None (disabled)

This parameter defines the URL of the repository that will be checked for new NetBox releases. When a new release is detected, a message will be displayed to administrative users on the home page. This can be set to the official repository ('https://api.github.com/repos/netbox-community/netbox/releases') or a custom fork. Set this to None to disable automatic update checks.

Note

The URL provided must be compatible with the GitHub REST API.

RQ_DEFAULT_TIMEOUT

Default: 300

The maximum execution time of a background task (such as running a custom script), in seconds.

RQ_RETRY_INTERVAL

Note

This parameter was added in NetBox v3.5.

Default: 60

This parameter controls how frequently a failed job is retried, up to the maximum number of times specified by RQ_RETRY_MAX. This must be either an integer specifying the number of seconds to wait between successive attempts, or a list of such values. For example, [60, 300, 3600] will retry the task after 1 minute, 5 minutes, and 1 hour.

RQ_RETRY_MAX

Note

This parameter was added in NetBox v3.5.

Default: 0 (retries disabled)

The maximum number of times a background task will be retried before being marked as failed.