terraform-provider-fmc

command module
v0.0.0-...-988b87f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2024 License: MPL-2.0 Imports: 5 Imported by: 0

README

Tests

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.

All resources and data sources have been tested with the following releases.

Platform Version
FMC 7.2

Documentation: https://registry.terraform.io/providers/netascode/fmc/latest

Requirements

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
go install

Adding Dependencies

This provider uses Go 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:

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. 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.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see 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:

make testacc

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
ftd
Package ftd handles the functionality specific to Secure Firewall Threat Defense boxes.
Package ftd handles the functionality specific to Secure Firewall Threat Defense boxes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL