skills.rest
netbox-community
netbox-communityOFFICIAL
Explore all skills by this author →
WebsiteGitHub

add-config-param

Add NetBox configuration parameters via static or dynamic mechanisms.

21.3k|3.1k|Updated Feb 29, 2016
Search Tags:#documentation#configuration#admin UI#netbox#runtime settings#dynamic params#django forms
One-click install
npx skills add https://github.com/netbox-community/netbox --skill add-config-param
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: add-config-param
Source: https://github.com/netbox-community/netbox/tree/main/.claude/skills/add-config-param
Command: npx skills add https://github.com/netbox-community/netbox --skill add-config-param

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you add a new configuration parameter to NetBox without breaking runtime behavior, by guiding you to choose between static (restart-required) and dynamic (admin-editable) configuration patterns.

Core Features & Use Cases

  • Choose the right parameter type: Decide whether your setting belongs in settings.py (static) or netbox/config/parameters.py with UI editing (dynamic).
  • Implement the parameter correctly: Define dynamic parameters via the PARAMS tuple with an appropriate Django form field type, and access the value using get_config() or ConfigItem.
  • Document for operators: Add a docs section under docs/configuration/ and register the parameter in the dynamic parameter index, so it’s discoverable in the admin and documentation.

Quick Start

Use the add-config-param skill to add a dynamic parameter named MY_PARAM by defining it in netbox/netbox/config/parameters.py, documenting it under docs/configuration/, and accessing it in code via get_config().MY_PARAM.

Frequently Asked Questions about add-config-param

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a runtime-tunable configuration parameter to NetBox?▼

To add a runtime-tunable NetBox configuration parameter, define it in the `PARAMS` tuple within `netbox/config/parameters.py` using an appropriate Django form field, allowing admin UI editing without requiring a service restart.

What is the difference between static and dynamic configuration parameters in NetBox?▼

Static NetBox configuration parameters are defined in `settings.py` and require a restart to apply changes, whereas dynamic parameters are defined in `parameters.py` and are editable at runtime via the admin UI.

How do I retrieve a custom config value in NetBox code?▼

Retrieve custom NetBox config values in your code by using the `get_config()` accessor or the `ConfigItem` wrapper to safely read the dynamic parameter defined in your configuration parameters.

When should I use restart-only configuration instead of admin-editable settings in NetBox?▼

Use restart-only static configuration in `settings.py` for sensitive infrastructure behaviors, and reserve dynamic admin-editable settings for operational parameters that operators need to tune at runtime.

How do I document new NetBox configuration parameters for operators?▼

Document new NetBox configuration parameters by adding a section under `docs/configuration/` and registering the parameter in the dynamic parameter index to ensure discoverability in the admin UI and documentation.

Do I need to modify Django forms to add dynamic params to the NetBox admin UI?▼

Yes, adding dynamic params to the NetBox admin UI requires specifying an appropriate Django form field type when defining your parameter in the `PARAMS` tuple in `netbox/config/parameters.py`.

Related Skills

Explore More Software Engineering Skills→
netbox-communitynetbox-community
21.3k

remove-config-param

Remove NetBox configuration parameters and clean all references.

Official
Intermediate
jeremylongshorejeremylongshore
2.6k

managing-environment-configurations

Generate environment-specific configuration files and manage secrets via environment-config-manager.

Community
Intermediate
caobingshengcaobingsheng
1

vk-data-form

Render dynamic forms from JSON configuration for vk-data-form components.

Community
Advanced
ericwang915ericwang915
38

change_setting

Update pythonclaw.json runtime settings for API keys, tokens, and providers.

Community
Intermediate