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

iosxe:
  devices:
    - name: Switch1
      host: 1.2.3.4
      configuration:
        system:
          hostname: Switch1
          mtu: 9198

main.tf

module "iosxe" {
  source  = "netascode/nac-iosxe/iosxe"
  version = ">= 0.1.0"

  yaml_files = ["system.nac.yaml"]
}

Requirements

Name	Version
terraform	>= 1.8.0
iosxe	= 0.10.2
utils	= 1.1.0-beta3

Inputs

Name	Description	Type	Default	Required
device_transaction	Enable device transaction mode. This will group all changes into a single transaction. Only valid if NETCONF is used.	bool	false	no
managed_device_groups	List of device group names to be managed. By default all device groups will be managed.	list(string)	[]	no
managed_devices	List of device names to be managed. By default all devices will be managed.	list(string)	[]	no
model	As an alternative to YAML files, a native Terraform data structure can be provided as well.	map(any)	{}	no
save_config	Write changes to startup-config on all devices.	bool	false	no
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	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	List of paths to YAML directories.	list(string)	[]	no
yaml_files	List of paths to YAML files.	list(string)	[]	no

Outputs

Name	Description
default_values	All default values.
model	Full model.

Resources

Name	Type
iosxe_aaa.aaa	resource
iosxe_aaa_accounting.aaa_accounting	resource
iosxe_aaa_authentication.aaa_authentication	resource
iosxe_aaa_authorization.aaa_authorization	resource
iosxe_access_list_extended.access_list_extended	resource
iosxe_access_list_role_based.access_list_role_based	resource
iosxe_access_list_standard.access_list_standard	resource
iosxe_arp.arp	resource
iosxe_as_path_access_list.as_path_access_list	resource
iosxe_banner.banner	resource
iosxe_bfd.bfd	resource
iosxe_bfd_template_multi_hop.bfd_template_multi_hop	resource
iosxe_bfd_template_single_hop.bfd_template_single_hop	resource
iosxe_bgp.bgp	resource
iosxe_bgp_address_family_ipv4.bgp_address_family_ipv4	resource
iosxe_bgp_address_family_ipv4_vrf.bgp_address_family_ipv4_vrf	resource
iosxe_bgp_address_family_ipv6.bgp_address_family_ipv6	resource
iosxe_bgp_address_family_ipv6_vrf.bgp_address_family_ipv6_vrf	resource
iosxe_bgp_address_family_l2vpn.bgp_address_family_l2vpn	resource
iosxe_bgp_ipv4_unicast_neighbor.bgp_ipv4_unicast_neighbor	resource
iosxe_bgp_ipv4_unicast_vrf_neighbor.bgp_ipv4_unicast_vrf_neighbor	resource
iosxe_bgp_ipv6_unicast_neighbor.bgp_ipv6_unicast_neighbor	resource
iosxe_bgp_l2vpn_evpn_neighbor.bgp_l2vpn_evpn_neighbor	resource
iosxe_bgp_neighbor.bgp_neighbor	resource
iosxe_cdp.cdp	resource
iosxe_class_map.class_map	resource
iosxe_cli.cli_0	resource
iosxe_cli.cli_1	resource
iosxe_cli.cli_2	resource
iosxe_cli.cli_3	resource
iosxe_cli.cli_4	resource
iosxe_cli.cli_5	resource
iosxe_cli.cli_6	resource
iosxe_cli.cli_7	resource
iosxe_cli.cli_8	resource
iosxe_cli.cli_9	resource
iosxe_clock.clock	resource
iosxe_commit.commit	resource
iosxe_community_list_expanded.community_list_expanded	resource
iosxe_community_list_standard.community_list_standard	resource
iosxe_crypto_ikev2.crypto_ikev2	resource
iosxe_crypto_ikev2_keyring.crypto_ikev2_keyring	resource
iosxe_crypto_ikev2_policy.crypto_ikev2_policy	resource
iosxe_crypto_ikev2_profile.crypto_ikev2_profile	resource
iosxe_crypto_ikev2_proposal.crypto_ikev2_proposal	resource
iosxe_crypto_ipsec_profile.crypto_ipsec_profile	resource
iosxe_crypto_ipsec_transform_set.crypto_ipsec_transform_set	resource
iosxe_crypto_pki.crypto_pki	resource
iosxe_cts.cts	resource
iosxe_device_sensor.device_sensor	resource
iosxe_dhcp.dhcp	resource
iosxe_dot1x.dot1x	resource
iosxe_errdisable.errdisable	resource
iosxe_evpn.evpn	resource
iosxe_evpn_instance.evpn_instance	resource
iosxe_flow_exporter.flow_exporter	resource
iosxe_flow_monitor.flow_monitor	resource
iosxe_flow_record.flow_record	resource
iosxe_interface_ethernet.ethernet	resource
iosxe_interface_loopback.loopback	resource
iosxe_interface_mpls.ethernet_mpls	resource
iosxe_interface_mpls.loopback_mpls	resource
iosxe_interface_mpls.port_channel_mpls	resource
iosxe_interface_mpls.port_channel_subinterface_mpls	resource
iosxe_interface_mpls.vlan_mpls	resource
iosxe_interface_nve.nve	resource
iosxe_interface_ospf.ethernet_ospf	resource
iosxe_interface_ospf.loopback_ospf	resource
iosxe_interface_ospf.port_channel_ospf	resource
iosxe_interface_ospf.port_channel_subinterface_ospf	resource
iosxe_interface_ospf.vlan_ospf	resource
iosxe_interface_ospfv3.ethernet_ospfv3	resource
iosxe_interface_ospfv3.loopback_ospfv3	resource
iosxe_interface_ospfv3.port_channel_ospfv3	resource
iosxe_interface_ospfv3.port_channel_subinterface_ospfv3	resource
iosxe_interface_ospfv3.vlan_ospfv3	resource
iosxe_interface_pim.ethernet_pim	resource
iosxe_interface_pim.loopback_pim	resource
iosxe_interface_pim.port_channel_pim	resource
iosxe_interface_pim.port_channel_subinterface_pim	resource
iosxe_interface_pim.vlan_pim	resource
iosxe_interface_port_channel.port_channel	resource
iosxe_interface_port_channel_subinterface.port_channel_subinterface	resource
iosxe_interface_switchport.ethernet_switchport	resource
iosxe_interface_switchport.port_channel_switchport	resource
iosxe_interface_vlan.vlan	resource
iosxe_license.license	resource
iosxe_line.line	resource
iosxe_lldp.lldp	resource
iosxe_logging.logging	resource
iosxe_mdt_subscription.mdt_subscription	resource
iosxe_msdp.msdp	resource
iosxe_nat.nat	resource
iosxe_ntp.ntp	resource
iosxe_ospf.ospf	resource
iosxe_ospf_vrf.ospf_vrf	resource
iosxe_pim.pim	resource
iosxe_platform.platform	resource
iosxe_policy_map.policy_map	resource
iosxe_policy_map_event.policy_map_event	resource
iosxe_prefix_list.prefix_list	resource
iosxe_radius.radius	resource
iosxe_radius_server.radius_server	resource
iosxe_route_map.route_map	resource
iosxe_service.service	resource
iosxe_service_template.service_template	resource
iosxe_sla.sla	resource
iosxe_snmp_server.snmp_server	resource
iosxe_spanning_tree.spanning_tree	resource
iosxe_static_route.static_route	resource
iosxe_static_routes_vrf.static_routes_vrf	resource
iosxe_system.system	resource
iosxe_tacacs_server.tacacs_server	resource
iosxe_template.template	resource
iosxe_udld.udld	resource
iosxe_username.username	resource
iosxe_vlan.vlan	resource
iosxe_vlan_access_map.vlan_access_map	resource
iosxe_vlan_configuration.vlan_configuration	resource
iosxe_vlan_filter.vlan_filter	resource
iosxe_vlan_group.vlan_group	resource
iosxe_vrf.vrf	resource
iosxe_vtp.vtp	resource

Modules

Name	Source	Version
model	./modules/model	n/a