Skip to content
Network as Code

Site

This includes site and device specific configuration including device variables.

Diagram

Diagram

Classes

sdwan

NameTypeConstraintMandatoryDefault Value
sitesList[sites]No

sites (sdwan)

NameTypeConstraintMandatoryDefault Value
idIntegermin: 1, max: 4294967295Yes
routersList[routers]Yes

routers (sdwan.sites)

NameTypeConstraintMandatoryDefault Value
chassis_idStringYes
configuration_groupStringRegex: ^[^<>!&" ]{1,128}$No
configuration_group_deployBooleantrue, falseNotrue
tagsListString[Regex: ^[^<>!&" ]{1,128}$]No
modelChoiceASR-1001-HX, ASR-1001-X, ASR-1002-HX, ASR-1002-X, ASR-1006-X, C1101-4P, C1101-4PLTEP, C1101-4PLTEPW, C1109-2PLTEGB, C1109-2PLTEUS, C1109-2PLTEVZ, C1109-4PLTE2P, C1109-4PLTE2PW, C1111-4P, C1111-4PLTEEA, C1111-4PLTELA, C1111-4PW, C1111-8P, C1111-8PLTEEA, C1111-8PLTEEAW, C1111-8PLTELA, C1111-8PLTELAW, C1111-8PW, C1111X-8P, C1112-8P, C1112-8PLTEEA, C1112-8PLTEEAWE, C1112-8PWE, C1113-8P, C1113-8PLTEEA, C1113-8PLTEEAW, C1113-8PLTELA, C1113-8PLTELAWZ, C1113-8PLTEW, C1113-8PM, C1113-8PMLTEEA, C1113-8PMWE, C1113-8PW, C1116-4P, C1116-4PLTEEA, C1116-4PLTEEAWE, C1116-4PWE, C1117-4P, C1117-4PLTEEA, C1117-4PLTEEAW, C1117-4PLTELA, C1117-4PLTELAWZ, C1117-4PM, C1117-4PMLTEEA, C1117-4PMLTEEAWE, C1117-4PMWE, C1117-4PW, C1118-8P, C1121-4P, C1121-4PLTEP, C1121-8P, C1121-8PLTEP, C1121-8PLTEPW, C1121X-8P, C1121X-8PLTEP, C1121X-8PLTEPW, C1126-8PLTEP, C1126X-8PLTEP, C1127-8PLTEP, C1127-8PMLTEP, C1127X-8PLTEP, C1127X-8PMLTEP, C1128-8PLTEP, C1131-8PLTEPW, C1131-8PW, C1131X-8PLTEPW, C1131X-8PW, C1161-8P, C1161-8PLTEP, C1161X-8P, C1161X-8PLTEP, C8000V, C8200-1N-4T, C8200L-1N-4T, C8300-1N1S-4T2X, C8300-1N1S-6T, C8300-2N2S-4T2X, C8300-2N2S-6T, C8500-12X, C8500-12X4QC, C8500-20X6C, C8500L-8S4X, IR-1101, IR-1821, IR-1831, IR-1833, IR-1835, IR-8140H, IR-8140H-P, IR-8340, ISR-4221, ISR-4221X, ISR-4321, ISR-4331, ISR-4351, ISR-4431, ISR-4451-X, ISR-4461, ISR1100-4G-XE, ISR1100-4GLTEGB-XE, ISR1100-4GLTENA-XE, ISR1100-6G-XE, ISR1100X-4G-XE, ISR1100X-6G-XENo
device_templateStringRegex: ^[^<>!&" ]{1,128}$No
device_variablesMapNo

Examples

Example-1: The example below shows how to assign router to a single device configuration group, list variables for device-specific fields in features under this configuration group and specify configuration should not be deployed to the device.

sdwan:
  sites:
    - id: 1
      routers:
        - chassis_id: C8K-3D1A8960-6E76-532C-DA93-50626FC5797E
          configuration_group: branch_type1
          configuration_group_deploy: false
          device_variables:
            system_ip: 10.0.0.1
            site_id: 1
            host_name: Edge1
            pseudo_commit_timer: 300
            vpn0_inet_ip: 172.16.1.1
            vpn0_inet_mask: 255.255.255.0
            vpn0_inet_sec1_ip: 172.16.1.191
            vpn0_inet_sec1_mask: 255.255.255.0
            vpn0_inet_ipv6: 2001:db8::1/64
            vpn0_ipv6_sec1_ip: 2001:db8:1::1/64
            motd_banner: this is motd banner
            device_access_destination_prefixes:
              - 10.0.0.0/8
              - 172.16.0.0/12
            device_access_source_prefixes:
              - 10.0.0.0/8
              - 172.16.0.0/12
            vpn512_mgmt_int_ip: 192.168.254.1
            vpn512_mgmt_int_mask: 255.255.255.0
            vpn512_mgmt_int_ipv6: fd02::1/64

Example-2: The example below shows how to assign router to a dual device configuration group, assign the tag required for dual device configuration group, list variables for device-specific fields in features under this configuration group and specify configuration should be deployed to the device.

sdwan:
  sites:
    - id: 1
      routers:
        - chassis_id: C8K-3D1A8960-6E76-532C-DA93-50626FC5797E
          configuration_group: branch_type2
          configuration_group_deploy: true
          tags:
            - primary_router
          device_variables:
            system_ip: 10.0.0.1
            site_id: 1
            host_name: Edge1
            pseudo_commit_timer: 300
            vpn0_inet_ip: 172.16.1.1
            vpn0_inet_mask: 255.255.255.0
            vpn0_inet_sec1_ip: 172.16.1.191
            vpn0_inet_sec1_mask: 255.255.255.0
            vpn0_inet_ipv6: 2001:db8::1/64
            vpn0_ipv6_sec1_ip: 2001:db8:1::1/64
            motd_banner: this is motd banner
            device_access_destination_prefixes:
              - 10.0.0.0/8
              - 172.16.0.0/12
            device_access_source_prefixes:
              - 10.0.0.0/8
              - 172.16.0.0/12
            vpn512_mgmt_int_ip: 192.168.254.1
            vpn512_mgmt_int_mask: 255.255.255.0
            vpn512_mgmt_int_ipv6: fd02::1/64

Example-3: The example below shows how to assign router to a device template and list all the variables required for template assignement.

sdwan:
  sites:
    - id: 2101
      routers:
        - chassis_id: C8K-CC678D1C-8EDF-3966-4F51-ABFAB64F5ABE
          model: C8000V
          device_template: DT-C8000V-TEST
          device_variables:
            site_id: 2101
            system_ip: 10.0.2.101
            system_hostname: SITE2101-C8KV-01
            logging_server_source_interface: Loopback511
            ntp_server_source_interface: Loopback511
            global_cdp_enable: true
            global_lldp_enable: false
            global_ip_domain_lookup_enable: true
            snmp_shutdown: false
            snmp_trap_source_interface: Loopback511
            snmp_contact: contact@acme.com
            snmp_location: Location 2101
            system_location: Site2101
            system_description: Site 2101 C8KV01
            timezone: UTC
            system_latitude: 38.1
            system_longitude: -1.9
            ondemand_tunnel_enable: false
            ondemand_tunnel_idle_timeout: 10
            vpn0_layer4_ecmp_enable: true
            vpn0_tloc01_if_name: GigabitEthernet1
            vpn0_tloc01_if_description: INET-1
            vpn0_tloc01_if_shutdown: false
            vpn0_tloc01_shaping_rate: 1000000