SVI/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2026-06-14 03:11:57 -04:00
Code Issues 3.0k Packages Projects Releases 10 Wiki Activity

Ansible module #446

New Issue
Open
opened 2025-11-20 05:11:27 -05:00 by saavagebueno · 3 comments
saavagebueno commented 2025-11-20 05:11:27 -05:00
Owner
Copy Link

Originally created by @yarcod on GitHub (Sep 12, 2023).

Is your feature request related to a problem? Please describe.
My setup utilises Ansible to configure all containers in my network, and I haven't found a good/easy way to authenticate them on-the-fly. The Netbird API has made it possible at all, but it is still slightly cumbersome to handle multiple API calls for different scenarios.

Describe the solution you'd like
If the API was wrapped in an Ansible module, it would make adding, changing and/or removing devices easier.

Describe alternatives you've considered
While it is possible to continue using API calls via the uri method, it is, as mentioned, cumbersome, and is also more to keep up to date from a user perspective when the API changes.

Additional context
Since Ansible is built on Python, and writing new modules is also done using Python, it should not be a massive undertaking.

Originally created by @yarcod on GitHub (Sep 12, 2023). **Is your feature request related to a problem? Please describe.** My setup utilises Ansible to configure all containers in my network, and I haven't found a good/easy way to authenticate them on-the-fly. The Netbird API has made it possible at all, but it is still slightly cumbersome to handle multiple API calls for different scenarios. **Describe the solution you'd like** If the API was wrapped in an Ansible module, it would make adding, changing and/or removing devices easier. **Describe alternatives you've considered** While it is possible to continue using API calls via the `uri` method, it is, as mentioned, cumbersome, and is also more to keep up to date from a user perspective when the API changes. **Additional context** Since Ansible is built on Python, and writing new modules is also done using Python, it should not be a massive undertaking.
saavagebueno added the feature-requestintegrationautomation labels 2025-11-20 05:11:27 -05:00
saavagebueno commented 2025-11-20 05:11:27 -05:00
Author
Owner
Copy Link

@jakob1379 commented on GitHub (Jul 15, 2025):

Do you imagine this just a role to configure clients a fullscale netbird management interface?

@jakob1379 commented on GitHub (Jul 15, 2025): Do you imagine this just a role to configure clients a fullscale netbird management interface?
saavagebueno commented 2025-11-20 05:11:28 -05:00
Author
Owner
Copy Link

@yarcod commented on GitHub (Jul 15, 2025):

Do you imagine this just a role to configure clients a fullscale netbird management interface?

My use case for this would be just for device enrollment. Using my admin auth token to access the API and in turn add new devices with some (ephemeral?) key. This way I wouldn't have to care much about what the key actually is, i.e. I don't need to keep track of it someplace else, as I could just regenerate a new key whenever a host needs to be reconfigured.

@yarcod commented on GitHub (Jul 15, 2025): > Do you imagine this just a role to configure clients a fullscale netbird management interface? My use case for this would be just for device enrollment. Using my admin auth token to access the API and in turn add new devices with some (ephemeral?) key. This way I wouldn't have to care much about what the key *actually is*, i.e. I don't need to keep track of it someplace else, as I could just regenerate a new key whenever a host needs to be reconfigured.
saavagebueno commented 2025-11-20 05:11:28 -05:00
Author
Owner
Copy Link

@jakob1379 commented on GitHub (Jul 16, 2025):

there is already a handful of roles out there, the most developed being

https://galaxy.ansible.com/ui/repo/published/dominion_solutions/netbird/

It is already gnu, so its safe to fork, but even easier to endorse by netbird themselves, as to not acquire more technical debt if it is not of interest.

@jakob1379 commented on GitHub (Jul 16, 2025): there is already a handful of roles out there, the most developed being > https://galaxy.ansible.com/ui/repo/published/dominion_solutions/netbird/ It is already gnu, so its safe to fork, but even easier to endorse by netbird themselves, as to not acquire more technical debt if it is not of interest.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
2021 Q4
2022 Q1
2022 Q1
accessibility
acl
agent
agent
Android
Android
api
authentik
automation
azure
battery-usage
bug
cache
client
client-ui
cloud
cloud-only
cloudflare
community
compatibility
config-idp
config-issue
connection
contribution
coturn
cross-vpn
dashboard
data-usage
distribution
dns
docker
documentation
duplicate
enhancement
enhancement
event-stream
feature-request
freebsd
getting-started
go
good first issue
gui
help wanted
home-assistant
idp
inconsistency
integration
integrations
ios
ipv6
jwt
k8s
keycloak
linux
login
macos
management-service
missing-docs
mobile
moved-internal
needs-review
netbird-ui
networking
new-platform
nginx
notification
okta
openwrt
packaging
peer-management
peer-management
peer-management
performance
postgres
posture-checks
psk
pull-request
Mirrored from GitHub Pull Request
 question
refactor
relay
release
rfc
routes
security
security-related
self-hosting
server
signal
sleep-issue
ssh
ssl
status
store
synology
system-compatibility-issue
test-suite
third-party-integration
triage
triage-needed
troubleshooting
UX
waiting-feedback
windows
wontfix
zitadel
No Label automation feature-request integration
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
saavagebueno
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: SVI/netbird#446
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?