https://github.com/netascode/terraform-provider-fmc
https://github.com/netascode/terraform-provider-fmc
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/netascode/terraform-provider-fmc
- Owner: netascode
- License: mpl-2.0
- Created: 2024-01-07T17:09:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-13T01:53:36.000Z (2 months ago)
- Last Synced: 2025-03-21T18:04:19.487Z (2 months ago)
- Language: Go
- Size: 1.46 MB
- Stars: 2
- Watchers: 5
- Forks: 8
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/netascode/terraform-provider-fmc/actions/workflows/test.yml)
# Terraform Provider FMC
The FMC provider provides resources to interact with a Cisco Secure FMC (Firewall Management Center) instance. It communicates with FMC via the REST API.
Resources and data sources have been tested with the following releases.
| Platform | Version |
| -------- | ------- |
| FMC | 7.2 |
| FMC | 7.4 |
| FMC | 7.6 |
Please note that resources and data sources support depends on FMC version.
Documentation:
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) >= 1.0
- [Go](https://golang.org/doc/install) >= 1.22
## Building The Provider
1. Clone the repository
2. Enter the repository directory
3. 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
This Terraform Provider is available to install automatically via `terraform init`. If you're building the provider, follow the instructions to
[install it as a plugin.](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin)
After placing it into your plugins directory, run `terraform init` to initialize it.
Additional documentation, including available resources and their arguments/attributes can be found on the [Terraform documentation website](https://registry.terraform.io/providers/netascode/fmc/latest/docs).
## 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`.
## Acceptance tests
Note: Acceptance tests create real resources. You'd need an FMC instance with an administrative user on the default global domain. Make sure the respective environment variables are set: `FMC_USERNAME`, `FMC_PASSWORD`, `FMC_URL`.
A number of test cases use a pre-existing device (e.g. FTDv). If you want your test to be exhaustive, it's recommended to add it manually to your FMC:
1. SSH onto FTDv and use `configure manager add` followed by `show managers verbose`.
2. Use FMC web interface -> Device Management -> Add Device.
3. After the Device is registered, snatch its UUID, e.g. from the "edit" link, and set it on the environment variable `TF_VAR_device_id`.
4. Optionally, you might want to test registering/unregistering an FTDv device by exporting the `FTD_USERNAME`, `FTD_PASSWORD`, `FTD_ADDR` (the IP address, not a URL this time). This however requires an unregistered FTDv device, so it's not possible to use the device from the above points. You'd need either two separate FTDv devices, or two separate test runs.
Depending on whether the environment is full or partial, the suite of Acceptance tests will
execute all/partial tests:
```shell
make testacc
```