terraform-provider-catalystcenter

terraform-provider-catalystcenter is a Terraform Provider for Cisco Catalyst Center

Requirements

• Terraform 0.13.x
• Go 1.20 (to build the provider plugin)

Introduction

The terraform-provider-catalystcenter provides a Terraform provider for managing and automating your Cisco Catalyst Center environment. It consists of a set of resources and data-sources for performing tasks related to Catalyst Center.

This collection has been tested and supports Cisco Catalyst Center 2.3.5.3.

Other versions of this collection have support for previous Cisco Catalyst Center versions. The recommended versions are listed below on the Compatibility matrix.

Compatibility matrix

The following table shows the supported versions.

Cisco Catalyst Center version	Terraform "catalystcenter" provider version
2.3.7.6	1.0.0-beta

If your SDK, Terraform provider is older please consider updating it first.

Using the provider

There are two ways to get and use the provider.

1. Downloading & installing it from registry.terraform.io
2. Building it from source

From build (For test)

Clone this repository to: $GOPATH/src/github.com/cisco-en-programmability/terraform-provider-catalystcenter

$ mkdir -p $GOPATH/src/github.com/cisco-en-programmability/
$ cd $GOPATH/src/github.com/cisco-en-programmability/
$ git clone https://github.com/cisco-en-programmability/terraform-provider-catalystcenter.git

Enter the provider directory and build the provider

! NOTE: It is important to check the architecture of your operating system in the file MakeFile

$ cd $GOPATH/src/github.com/cisco-en-programmability/terraform-provider-catalystcenter
$ make developtest

If the Makefile values (HOSTNAME, NAMESPACE, NAME, VERSION) were not changed, then the following code could used without changes. Otherwise change the values accordingly.

To use this provider, copy and paste this code into your Terraform configuration. Then, run terraform init.

terraform {
  required_providers {
    catalystcenter = {
      source = "cisco-en-programmability/catalystcenter"
      version = "1.0.0-beta"
    }
  }
}

# Configure provider with your Cisco Catalyst Center SDK credentials
provider "catalystcenter" {
  # Cisco Catalyst Center user name
  username = "admin"
  # it can be set using the environment variable CATALYST_BASE_URL

  # Cisco Catalyst Center password
  password = "admin123"
  # it can be set using the environment variable CATALYST_USERNAME

  # Cisco Catalyst Center base URL, FQDN or IP
  base_url = "https://172.168.196.2"
  # it can be set using the environment variable CATALYST_PASSWORD

  # Boolean to enable debugging
  debug = "false"
  # it can be set using the environment variable CATALYST_DEBUG

  # Boolean to enable or disable SSL certificate verification
  ssl_verify = "false"
  # it can be set using the environment variable CATALYST_SSL_VERIFY
}

There are several examples of the use of the provider within the folder samples

Example for_each

locals {
 interfaces = {
   "1" = { description = "desc1", interface_uuid = "c6820b57-ecde-4b6d-98db-06ba10486809" },
   "2" = { description = "desc2", interface_uuid = "c6820b57-ecde-4b6d-98db-06ba10486801" },
   "3" = { description = "desc3", interface_uuid = "c6820b57-ecde-4b6d-98db-06ba10486802" }
 }
}

resource "catalystcenter_interface_update" "example" {
  provider = catalystcenter
  for_each = local.interfaces
  parameters {
    description    = each.value.description
    interface_uuid = each.value.interface_uuid
    vlan_id        = each.key
  }
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.15+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-catalystcenter
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources.

$ make testacc

Documentation

In the docs directory you can find the documentation source for this 1.0.19-beta version.

You can find the documentation online for the previously released versions at Terraform Registry - Cisco Catalyst Center provider.

Contributing

Ongoing development efforts and contributions to this provider are tracked as issues in this repository.

We welcome community contributions to this project. If you find problems, need an enhancement or need a new data-source or resource, please open an issue or create a PR against the Terraform Provider for Cisco Catalyst Center repository.

Change log

All notable changes to this project will be documented in the CHANGELOG file.

The development team may make additional changes as the library evolves with the Cisco Catalyst Center.

NOTE: Consider reviewing the Changelog to review the new features of the 1.0.19-beta version.

License

This library is distributed under the license found in the LICENSE file.