https://github.com/netascode/terraform-iosxe-nac-iosxe
Terraform Cisco IOS-XE Network-as-Code Module
https://github.com/netascode/terraform-iosxe-nac-iosxe
catalyst cisco iac ios-xe iosxe nac netascode network-as-code terraform terraform-module
Last synced: 8 months ago
JSON representation
Terraform Cisco IOS-XE Network-as-Code Module
- Host: GitHub
- URL: https://github.com/netascode/terraform-iosxe-nac-iosxe
- Owner: netascode
- License: apache-2.0
- Created: 2025-03-27T18:11:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-26T11:37:28.000Z (8 months ago)
- Last Synced: 2025-09-26T13:25:34.166Z (8 months ago)
- Topics: catalyst, cisco, iac, ios-xe, iosxe, nac, netascode, network-as-code, terraform, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/netascode/nac-iosxe/iosxe
- Size: 296 KB
- Stars: 3
- Watchers: 3
- Forks: 39
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform Network-as-Code Cisco IOS-XE Module
A Terraform module to configure Cisco IOS-XE devices.
## Usage
This module supports an inventory driven approach, where a complete IOS-XE configuration or parts of it are either modeled in one or more YAML files or natively using Terraform variables.
## Examples
Configuring an IOS-XE system configuration using YAML:
#### `system.nac.yaml`
```yaml
iosxe:
devices:
- name: Switch1
url: https://1.2.3.4
configuration:
system:
hostname: Switch1
mtu: 9198
```
#### `main.tf`
```hcl
module "iosxe" {
source = "netascode/nac-iosxe/iosxe"
version = ">= 0.1.0"
yaml_files = ["system.nac.yaml"]
}
```
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.8.0 |
| [iosxe](#requirement\_iosxe) | = 0.9.0 |
| [local](#requirement\_local) | >= 2.3.0 |
| [utils](#requirement\_utils) | = 1.1.0-beta1 |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [managed\_device\_groups](#input\_managed\_device\_groups) | List of device group names to be managed. By default all device groups will be managed. | `list(string)` | `[]` | no |
| [managed\_devices](#input\_managed\_devices) | List of device names to be managed. By default all devices will be managed. | `list(string)` | `[]` | no |
| [model](#input\_model) | As an alternative to YAML files, a native Terraform data structure can be provided as well. | `map(any)` | `{}` | no |
| [save\_config](#input\_save\_config) | Write changes to startup-config on all devices. | `bool` | `false` | no |
| [write\_default\_values\_file](#input\_write\_default\_values\_file) | Write all default values to a YAML file. Value is a path pointing to the file to be created. | `string` | `""` | no |
| [write\_model\_file](#input\_write\_model\_file) | Write the full model including all resolved templates to a single YAML file. Value is a path pointing to the file to be created. | `string` | `""` | no |
| [yaml\_directories](#input\_yaml\_directories) | List of paths to YAML directories. | `list(string)` | `[]` | no |
| [yaml\_files](#input\_yaml\_files) | List of paths to YAML files. | `list(string)` | `[]` | no |
## Outputs
| Name | Description |
|------|-------------|
| [default\_values](#output\_default\_values) | All default values. |
| [model](#output\_model) | Full model. |
## Resources
| Name | Type |
|------|------|
| [iosxe_aaa.aaa](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/aaa) | resource |
| [iosxe_aaa_accounting.aaa_accounting](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/aaa_accounting) | resource |
| [iosxe_aaa_authentication.aaa_authentication](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/aaa_authentication) | resource |
| [iosxe_aaa_authorization.aaa_authorization](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/aaa_authorization) | resource |
| [iosxe_access_list_extended.access_list_extended](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/access_list_extended) | resource |
| [iosxe_access_list_role_based.access_list_role_based](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/access_list_role_based) | resource |
| [iosxe_access_list_standard.access_list_standard](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/access_list_standard) | resource |
| [iosxe_arp.arp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/arp) | resource |
| [iosxe_as_path_access_list.as_path_access_list](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/as_path_access_list) | resource |
| [iosxe_banner.banner](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/banner) | resource |
| [iosxe_bfd.bfd](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bfd) | resource |
| [iosxe_bfd_template_multi_hop.bfd_template_multi_hop](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bfd_template_multi_hop) | resource |
| [iosxe_bfd_template_single_hop.bfd_template_single_hop](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bfd_template_single_hop) | resource |
| [iosxe_bgp.bgp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp) | resource |
| [iosxe_bgp_address_family_ipv4.bgp_address_family_ipv4](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_address_family_ipv4) | resource |
| [iosxe_bgp_address_family_ipv4_vrf.bgp_address_family_ipv4_vrf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_address_family_ipv4_vrf) | resource |
| [iosxe_bgp_address_family_ipv6.bgp_address_family_ipv6](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_address_family_ipv6) | resource |
| [iosxe_bgp_address_family_ipv6_vrf.bgp_address_family_ipv6_vrf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_address_family_ipv6_vrf) | resource |
| [iosxe_bgp_address_family_l2vpn.bgp_address_family_l2vpn](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_address_family_l2vpn) | resource |
| [iosxe_bgp_ipv4_unicast_neighbor.bgp_ipv4_unicast_neighbor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_ipv4_unicast_neighbor) | resource |
| [iosxe_bgp_ipv4_unicast_vrf_neighbor.bgp_ipv4_unicast_vrf_neighbor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_ipv4_unicast_vrf_neighbor) | resource |
| [iosxe_bgp_ipv6_unicast_neighbor.bgp_ipv6_unicast_neighbor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_ipv6_unicast_neighbor) | resource |
| [iosxe_bgp_l2vpn_evpn_neighbor.bgp_l2vpn_evpn_neighbor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_l2vpn_evpn_neighbor) | resource |
| [iosxe_bgp_neighbor.bgp_neighbor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/bgp_neighbor) | resource |
| [iosxe_cdp.cdp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/cdp) | resource |
| [iosxe_class_map.class_map](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/class_map) | resource |
| [iosxe_cli.cli](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/cli) | resource |
| [iosxe_clock.clock](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/clock) | resource |
| [iosxe_community_list_expanded.community_list_expanded](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/community_list_expanded) | resource |
| [iosxe_community_list_standard.community_list_standard](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/community_list_standard) | resource |
| [iosxe_crypto_ikev2.crypto_ikev2](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ikev2) | resource |
| [iosxe_crypto_ikev2_keyring.crypto_ikev2_keyring](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ikev2_keyring) | resource |
| [iosxe_crypto_ikev2_policy.crypto_ikev2_policy](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ikev2_policy) | resource |
| [iosxe_crypto_ikev2_profile.crypto_ikev2_profile](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ikev2_profile) | resource |
| [iosxe_crypto_ikev2_proposal.crypto_ikev2_proposal](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ikev2_proposal) | resource |
| [iosxe_crypto_ipsec_profile.crypto_ipsec_profile](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ipsec_profile) | resource |
| [iosxe_crypto_ipsec_transform_set.crypto_ipsec_transform_set](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_ipsec_transform_set) | resource |
| [iosxe_crypto_pki.crypto_pki](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/crypto_pki) | resource |
| [iosxe_cts.cts](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/cts) | resource |
| [iosxe_device_sensor.device_sensor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/device_sensor) | resource |
| [iosxe_dhcp.dhcp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/dhcp) | resource |
| [iosxe_dot1x.dot1x](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/dot1x) | resource |
| [iosxe_errdisable.errdisable](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/errdisable) | resource |
| [iosxe_evpn.evpn](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/evpn) | resource |
| [iosxe_evpn_instance.evpn_instance](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/evpn_instance) | resource |
| [iosxe_flow_exporter.flow_exporter](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/flow_exporter) | resource |
| [iosxe_flow_monitor.flow_monitor](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/flow_monitor) | resource |
| [iosxe_flow_record.flow_record](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/flow_record) | resource |
| [iosxe_interface_ethernet.ethernet](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ethernet) | resource |
| [iosxe_interface_loopback.loopback](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_loopback) | resource |
| [iosxe_interface_mpls.ethernet_mpls](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_mpls) | resource |
| [iosxe_interface_mpls.loopback_mpls](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_mpls) | resource |
| [iosxe_interface_mpls.port_channel_mpls](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_mpls) | resource |
| [iosxe_interface_mpls.port_channel_subinterface_mpls](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_mpls) | resource |
| [iosxe_interface_mpls.vlan_mpls](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_mpls) | resource |
| [iosxe_interface_nve.nve](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_nve) | resource |
| [iosxe_interface_ospf.ethernet_ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospf) | resource |
| [iosxe_interface_ospf.loopback_ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospf) | resource |
| [iosxe_interface_ospf.port_channel_ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospf) | resource |
| [iosxe_interface_ospf.port_channel_subinterface_ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospf) | resource |
| [iosxe_interface_ospf.vlan_ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospf) | resource |
| [iosxe_interface_ospfv3.ethernet_ospfv3](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospfv3) | resource |
| [iosxe_interface_ospfv3.loopback_ospfv3](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospfv3) | resource |
| [iosxe_interface_ospfv3.port_channel_ospfv3](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospfv3) | resource |
| [iosxe_interface_ospfv3.port_channel_subinterface_ospfv3](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospfv3) | resource |
| [iosxe_interface_ospfv3.vlan_ospfv3](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_ospfv3) | resource |
| [iosxe_interface_pim.ethernet_pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_pim) | resource |
| [iosxe_interface_pim.loopback_pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_pim) | resource |
| [iosxe_interface_pim.port_channel_pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_pim) | resource |
| [iosxe_interface_pim.port_channel_subinterface_pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_pim) | resource |
| [iosxe_interface_pim.vlan_pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_pim) | resource |
| [iosxe_interface_port_channel.port_channel](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_port_channel) | resource |
| [iosxe_interface_port_channel_subinterface.port_channel_subinterface](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_port_channel_subinterface) | resource |
| [iosxe_interface_switchport.ethernet_switchport](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_switchport) | resource |
| [iosxe_interface_switchport.port_channel_switchport](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_switchport) | resource |
| [iosxe_interface_vlan.vlan](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/interface_vlan) | resource |
| [iosxe_license.license](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/license) | resource |
| [iosxe_line.line](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/line) | resource |
| [iosxe_lldp.lldp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/lldp) | resource |
| [iosxe_logging.logging](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/logging) | resource |
| [iosxe_mdt_subscription.mdt_subscription](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/mdt_subscription) | resource |
| [iosxe_msdp.msdp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/msdp) | resource |
| [iosxe_nat.nat](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/nat) | resource |
| [iosxe_ntp.ntp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/ntp) | resource |
| [iosxe_ospf.ospf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/ospf) | resource |
| [iosxe_ospf_vrf.ospf_vrf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/ospf_vrf) | resource |
| [iosxe_pim.pim](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/pim) | resource |
| [iosxe_platform.platform](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/platform) | resource |
| [iosxe_policy_map.policy_map](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/policy_map) | resource |
| [iosxe_policy_map_event.policy_map_event](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/policy_map_event) | resource |
| [iosxe_prefix_list.prefix_list](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/prefix_list) | resource |
| [iosxe_radius.radius](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/radius) | resource |
| [iosxe_radius_server.radius_server](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/radius_server) | resource |
| [iosxe_route_map.route_map](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/route_map) | resource |
| [iosxe_save_config.save_config](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/save_config) | resource |
| [iosxe_service.service](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/service) | resource |
| [iosxe_service_template.service_template](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/service_template) | resource |
| [iosxe_sla.sla](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/sla) | resource |
| [iosxe_snmp_server.snmp_server](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/snmp_server) | resource |
| [iosxe_spanning_tree.spanning_tree](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/spanning_tree) | resource |
| [iosxe_static_route.static_route](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/static_route) | resource |
| [iosxe_static_routes_vrf.static_routes_vrf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/static_routes_vrf) | resource |
| [iosxe_system.system](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/system) | resource |
| [iosxe_tacacs_server.tacacs_server](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/tacacs_server) | resource |
| [iosxe_template.template](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/template) | resource |
| [iosxe_udld.udld](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/udld) | resource |
| [iosxe_username.username](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/username) | resource |
| [iosxe_vlan.vlan](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vlan) | resource |
| [iosxe_vlan_access_map.vlan_access_map](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vlan_access_map) | resource |
| [iosxe_vlan_configuration.vlan_configuration](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vlan_configuration) | resource |
| [iosxe_vlan_filter.vlan_filter](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vlan_filter) | resource |
| [iosxe_vlan_group.vlan_group](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vlan_group) | resource |
| [iosxe_vrf.vrf](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vrf) | resource |
| [iosxe_vtp.vtp](https://registry.terraform.io/providers/CiscoDevNet/iosxe/0.9.0/docs/resources/vtp) | resource |
## Modules
| Name | Source | Version |
|------|--------|---------|
| [model](#module\_model) | ./modules/model | n/a |