Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
[![Website](https://img.shields.io/badge/Website-coredocs.eu-9146FF?style=for-the-badge&logo=google-chrome&logoColor=white)](https://coredocs.eu)

[![Lint](https://img.shields.io/github/actions/workflow/status/swaQQii/coredocs-netbox-scripts/lint.yml?style=for-the-badge&label=Lint%20CI&logo=github)](https://github.com/swaQQii/coredocs-netbox-scripts/actions/workflows/lint.yml)
[![Style](https://img.shields.io/github/actions/workflow/status/swaQQii/coredocs-netbox-scripts/style.yml?style=for-the-badge&label=Style%20CI&logo=github)](https://github.com/swaQQii/coredocs-netbox-scripts/actions/workflows/style.yml)

[![Last Commit](https://img.shields.io/github/last-commit/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/commits/main)

[![Made with Python](https://img.shields.io/badge/Made%20with-Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/swaQQii/coredocs-netbox-scripts?style=for-the-badge)](https://github.com/swaQQii/coredocs-netbox-scripts/pulls)

# coredocs-netbox-scripts

Collection of reusable **NetBox Custom Scripts** – automation examples for:
Expand All @@ -23,9 +24,8 @@ Collection of reusable **NetBox Custom Scripts** – automation examples for:

- [Getting Started](#getting-started)
- [Available Scripts](#available-scripts)
- [Hello Script](docs/hello_script.md) → [Code](scripts/01_hello_script.py)
- [Reserve IPv4 Script](docs/reserve_ipv4.md) → [Code](scripts/02_reserve_ipv4.py)
- [Create Site (Auto Geo)](docs/create_site_osm.md) → [Code](scripts/03_create_site_osm.py)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
- [Related](#related)

Expand All @@ -46,29 +46,42 @@ Collection of reusable **NetBox Custom Scripts** – automation examples for:
3. Alternatively, place them under your NetBox installation:
4. Run scripts via the NetBox web interface.

- Toggle **Commit** off → dry run (no database changes)
- Toggle **Commit** on → changes are saved
- Toggle **Commit** off → dry run (no database changes)
- Toggle **Commit** on → changes are saved

---

## Available Scripts

- **[Hello Script](docs/hello_script.md)** – Minimal example to demonstrate inputs, logging, and commit.
- **[Reserve IPv4](docs/reserve_ipv4.md)** – Finds the first free IPv4 in a prefix and assigns it.
- **[Create Site (Auto-Geo)](docs/create_site_osm.md)** – Creates a Site using OSM geocoding, coordinates, and timezone auto-detection.
- **[Hello Script](docs/hello_script.md)** – Minimal example to demonstrate inputs, logging, and commit.
- **[Reserve IPv4](docs/reserve_ipv4.md)** – Finds the first free IPv4 in a prefix and assigns it.
- **[Create Site (Auto-Geo)](docs/create_site_osm.md)** – Creates a Site using OSM geocoding, coordinates, and timezone auto-detection.

---

## Contributing

Contributions are welcome!
See the [Contributing Guidelines](CONTRIBUTING.md) before opening issues or pull requests.

---

## Security

If you discover a security issue, please review our [Security Policy](SECURITY.md).

---

## License

This project is licensed under the [MIT License](LICENSE).
You are free to use, modify, and distribute these scripts with attribution.
You are free to use, modify, and distribute these scripts with attribution.

---

## Related

These scripts are part of the **[CoreDocs](https://coredocs.eu)** knowledge base project,
which provides open IT guides, tools, and documentation resources.
which provides open IT guides, tools, and documentation resources.

[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Y6pGPFacvp)