https://github.com/ciscodevnet/terraform-provider-iosxe

Terraform Cisco IOS-XE Provider
https://github.com/ciscodevnet/terraform-provider-iosxe

cisco ios-xe iosxe restconf terraform terraform-provider

Last synced: 6 days ago
JSON representation

Terraform Cisco IOS-XE Provider

• Host: GitHub
• URL: https://github.com/ciscodevnet/terraform-provider-iosxe
• Owner: CiscoDevNet
• License: mpl-2.0
• Created: 2021-09-09T16:32:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-13T05:35:35.000Z (18 days ago)
• Last Synced: 2024-12-18T12:08:50.441Z (13 days ago)
• Topics: cisco, ios-xe, iosxe, restconf, terraform, terraform-provider
• Language: Go
• Homepage: https://registry.terraform.io/providers/CiscoDevNet/iosxe
• Size: 29.8 MB
• Stars: 59
• Watchers: 22
• Forks: 24
• Open Issues: 24
• 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

        
[![Tests](https://github.com/CiscoDevNet/terraform-provider-iosxe/actions/workflows/test.yml/badge.svg)](https://github.com/CiscoDevNet/terraform-provider-iosxe/actions/workflows/test.yml)

# Terraform Provider IOS-XE

## 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/CiscoDevNet/iosxe/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).

If any file in `gen` directory has been modified, run all the generators:

```shell

go generate -x

```

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

In order to run the full suite of Acceptance tests, run `make testacc`. Make sure the respective environment variables are set (e.g., `IOSXE_USERNAME`, `IOSXE_PASSWORD`, `IOSXE_URL`).

*Note:* Acceptance tests create real resources.

```shell

make testacc

```