https://github.com/devon-mar/terraform-provider-nblists
https://github.com/devon-mar/terraform-provider-nblists
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devon-mar/terraform-provider-nblists
- Owner: devon-mar
- License: mpl-2.0
- Created: 2023-01-04T18:17:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2026-03-05T05:33:39.000Z (3 months ago)
- Last Synced: 2026-03-05T10:40:55.076Z (3 months ago)
- Language: Go
- Homepage: https://registry.terraform.io/providers/devon-mar/nblists/latest
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Terraform Provider NetBox Lists
A Terraform provider to interact with the [NetBox Lists](https://github.com/devon-mar/netbox-lists) plugin for NetBox.
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.19
## Building The Provider
1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
```shell
go install
```
## Adding Dependencies
This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
Please see the Go documentation for the most up to date information about using Go modules.
To add a new dependency `github.com/author/dependency` to your Terraform provider:
```shell
go get github.com/author/dependency
go mod tidy
```
Then commit the changes to `go.mod` and `go.sum`.
## Using the provider
```hcl
provider "nblists" {
# The provider can also be configured through environment variables
url = "https://netbox.example.com"
token = "mytokenhere"
}
# Get IP addresses with the "special" tag
data "nblists_list" "special" {
endpoint = "ip-addresses"
filter = {
tag = ["special"]
}
}
# Use the data
resource "some_resource" "r" {
cidrs = data.nblists_list.special.list
}
```
## Developing the Provider
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
To generate or update documentation, run `go generate`.
In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run.
```shell
make testacc
```