LAN Automation

Version:

Location in GUI: Provision » Network Devices » LAN Automation

Diagram

Classes

catalyst_center

Name	Type	Constraint	Mandatory	Default Value
lan_automation	List	`[lan_automation]`	No

lan_automation (catalyst_center)

Name	Type	Constraint	Mandatory
name	String		Yes
type	Choice	`link`, `devices`	Yes
status	Choice	`START`, `STOP`	Yes
discovered_device_site_name_hierarchy	String		Yes
primary_device_management_ip_address	IP		Yes
secondary_device_management_ip_address	IP		No
primary_device_interface_names	List	String	No
ip_pools	List	`[ip_pools]`	No
multicast_enabled	Boolean	`true`, `false`	No
host_name_prefix	String		No
isis_domain_password	String		No
advertise_lan_automation_routes_into_bgp	Boolean	`true`, `false`	No
discovery_level	Integer	min: `1`, max: `5`	No
discovery_timeout	Integer	min: `20`, max: `10080`	No
discovery_devices	List	`[discovery_devices]`	No

ip_pools (catalyst_center.lan_automation)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
role	Choice	`PRINCIPAL_IP_ADDRESS_POOL`, `LINK_OVERLAPPING_IP_POOL`	No

discovery_devices (catalyst_center.lan_automation)

Name	Type	Mandatory
device_serial_number	String	Yes
device_host_name	String	No
device_site_name_hierarchy	String	No
device_management_ip_address	IP	No

Examples

Before running LAN Automation, the IP pool used for Lan automation (eg. LAN_AUTO_POol) with type LAN must be created and assigned to the site:

Example-1: Basic LAN Automation for Edge Switch Discovery

This example demonstrates how to configure LAN Automation in Catalyst Center for automated discovery and assignment of access switches. LAN Automation simplifies the deployment of access layer switches by automatically discovering, configuring, and onboarding new devices into the network infrastructure.

The LAN Automation configuration includes:

Automation name (EDGE_SWITCHES) for identification and workflow tracking
START status to initiate the automated discovery process
Device type targeting for switch discovery and provisioning
Site hierarchy assignment (Global/Poland/Krakow) for discovered devices
Primary device configuration with management IP and interface specifications
IP pool assignment (LAN_AUTO_Pool) for automated IP address allocation
Hostname prefix (lan-EN) for systematic device naming convention
Discovery parameters including level (2 hops) and timeout (20 minutes)
Specific device discovery with serial numbers and management addresses

---
catalyst_center:
  lan_automation:
    - name: EDGE_SWTICHES
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Poland/Krakow
      primary_device_management_ip_address: 198.18.130.10
      secondary_device_management_ip_address: 198.18.130.20
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
      host_name_prefix: lan-EN
      advertise_lan_automation_routes_into_bgp: false
      multicast_enabled: true
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: Global/Poland/Krakow/Bld A
          device_management_ip_address: "192.168.252.10"

Example-2: IP Pool Configuration for LAN Automation

This example shows how to configure the IP pool required for LAN Automation. The IP pool must be created and reserved before running LAN Automation to ensure proper IP address allocation for discovered devices.

The IP pool configuration includes:

Parent pool (Overlay) with IPv4 address space covering the entire network range
LAN Automation specific reservation (LAN_AUTO) with LAN type designation
Subnet allocation (192.168.252.0/24) for automated device management addressing
Gateway specification (192.168.252.1) for network connectivity and routing

---
catalyst_center:
  network_settings:
    ip_pools:
      - name: Overlay
        ip_address_space: IPv4
        ip_pool_cidr: 192.168.0.0/16
        ip_pools_reservations:
          - name: LAN_AUTO
            type: LAN
            prefix_length: 24
            subnet: 192.168.252.0
            gateway: 192.168.252.1

Example-3: Site Hierarchy and IP Pool Assignment

This example demonstrates how to configure the site hierarchy and assign IP pool reservations to the appropriate sites for LAN Automation deployment. Proper site organization ensures discovered devices are placed in the correct network locations.

---
catalyst_center:
  sites:
    areas:
      - name: Poland
        parent_name: Global
      - name: Krakow
        parent_name: Global/Poland
        ip_pools_reservations:
          - LAN_AUTO

Example-4: Multi-Site LAN Automation with Different Discovery Levels

This example shows how to configure LAN Automation for multiple sites with different discovery requirements and network topologies, enabling scalable automated deployment across diverse locations.

---
catalyst_center:
  lan_automation:
    - name: CAMPUS_DISTRIBUTION_DISCOVERY
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/NorthAmerica/Campus
      primary_device_management_ip_address: 10.1.1.10
      secondary_device_management_ip_address: 10.1.1.20
      primary_device_interface_names:
        - TenGigabitEthernet1/0/1
        - TenGigabitEthernet1/0/2
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
      host_name_prefix: campus-dist-
      advertise_lan_automation_routes_into_bgp: true
      multicast_enabled: true
      discovery_level: 3
      discovery_timeout: 30
      discovery_devices:
        - device_serial_number: "FDO12345678"
          device_host_name: "DIST-SW01"
          device_site_name_hierarchy: Global/NorthAmerica/Campus/Building A
          device_management_ip_address: "10.1.10.10"
        - device_serial_number: "FDO87654321"
          device_host_name: "DIST-SW02"
          device_site_name_hierarchy: Global/NorthAmerica/Campus/Building B
          device_management_ip_address: "10.1.20.10"

Example-5: Branch Office LAN Automation with Limited Discovery

This example demonstrates how to configure LAN Automation for branch office environments with link overlapping pool and limited discovery scope, suitable for smaller remote locations with basic switching requirements.

---
catalyst_center:
  lan_automation:
    - name: Automate_Edge_Switches
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Canada/BLD1
      primary_device_management_ip_address: 198.18.130.10
      secondary_device_management_ip_address: 181.1.1.40
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
        - name: LAN_AUTO_P2P_LINKS
          role: LINK_OVERLAPPING_IP_POOL
      multicast_enabled: true
      host_name_prefix: EN
      advertise_lan_automation_routes_into_bgp: true
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: "Global/Canada/BLD1"
          device_management_ip_address: "192.168.252.10"

Location in GUI: Provision » Network Devices » LAN Automation

Diagram

Classes

catalyst_center

Name	Type	Constraint	Mandatory	Default Value
lan_automation	List	`[lan_automation]`	No

lan_automation (catalyst_center)

Name	Type	Constraint	Mandatory
name	String		Yes
type	Choice	`link`, `devices`	Yes
status	Choice	`START`, `STOP`	Yes
discovered_device_site_name_hierarchy	String		Yes
primary_device_management_ip_address	IP		Yes
secondary_device_management_ip_address	IP		No
primary_device_interface_names	List	String	No
ip_pools	List	`[ip_pools]`	No
multicast_enabled	Boolean	`true`, `false`	No
host_name_prefix	String		No
isis_domain_password	String		No
advertise_lan_automation_routes_into_bgp	Boolean	`true`, `false`	No
discovery_level	Integer	min: `1`, max: `5`	No
discovery_timeout	Integer	min: `20`, max: `10080`	No
discovery_devices	List	`[discovery_devices]`	No

ip_pools (catalyst_center.lan_automation)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
role	Choice	`PRINCIPAL_IP_ADDRESS_POOL`, `LINK_OVERLAPPING_IP_POOL`	No

discovery_devices (catalyst_center.lan_automation)

Name	Type	Mandatory
device_serial_number	String	Yes
device_host_name	String	No
device_site_name_hierarchy	String	No
device_management_ip_address	IP	No

Examples

Before running LAN Automation, the IP pool used for Lan automation (eg. LAN_AUTO_POol) with type LAN must be created and assigned to the site:

Example-1: Basic LAN Automation for Edge Switch Discovery

The LAN Automation configuration includes:

Automation name (EDGE_SWITCHES) for identification and workflow tracking
START status to initiate the automated discovery process
Device type targeting for switch discovery and provisioning
Site hierarchy assignment (Global/Poland/Krakow) for discovered devices
Primary device configuration with management IP and interface specifications
IP pool assignment (LAN_AUTO_Pool) for automated IP address allocation
Hostname prefix (lan-EN) for systematic device naming convention
Discovery parameters including level (2 hops) and timeout (20 minutes)
Specific device discovery with serial numbers and management addresses

---
catalyst_center:
  lan_automation:
    - name: EDGE_SWTICHES
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Poland/Krakow
      primary_device_management_ip_address: 198.18.130.10
      secondary_device_management_ip_address: 198.18.130.20
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
      host_name_prefix: lan-EN
      advertise_lan_automation_routes_into_bgp: false
      multicast_enabled: true
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: Global/Poland/Krakow/Bld A
          device_management_ip_address: "192.168.252.10"

Example-2: IP Pool Configuration for LAN Automation

The IP pool configuration includes:

Parent pool (Overlay) with IPv4 address space covering the entire network range
LAN Automation specific reservation (LAN_AUTO) with LAN type designation
Subnet allocation (192.168.252.0/24) for automated device management addressing
Gateway specification (192.168.252.1) for network connectivity and routing

---
catalyst_center:
  network_settings:
    ip_pools:
      - name: Overlay
        ip_address_space: IPv4
        ip_pool_cidr: 192.168.0.0/16
        ip_pools_reservations:
          - name: LAN_AUTO
            type: LAN
            prefix_length: 24
            subnet: 192.168.252.0
            gateway: 192.168.252.1

Example-3: Site Hierarchy and IP Pool Assignment

---
catalyst_center:
  sites:
    areas:
      - name: Poland
        parent_name: Global
      - name: Krakow
        parent_name: Global/Poland
        ip_pools_reservations:
          - LAN_AUTO

Example-4: Multi-Site LAN Automation with Different Discovery Levels

This example shows how to configure LAN Automation for multiple sites with different discovery requirements and network topologies, enabling scalable automated deployment across diverse locations.

---
catalyst_center:
  lan_automation:
    - name: CAMPUS_DISTRIBUTION_DISCOVERY
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/NorthAmerica/Campus
      primary_device_management_ip_address: 10.1.1.10
      secondary_device_management_ip_address: 10.1.1.20
      primary_device_interface_names:
        - TenGigabitEthernet1/0/1
        - TenGigabitEthernet1/0/2
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
      host_name_prefix: campus-dist-
      advertise_lan_automation_routes_into_bgp: true
      multicast_enabled: true
      discovery_level: 3
      discovery_timeout: 30
      discovery_devices:
        - device_serial_number: "FDO12345678"
          device_host_name: "DIST-SW01"
          device_site_name_hierarchy: Global/NorthAmerica/Campus/Building A
          device_management_ip_address: "10.1.10.10"
        - device_serial_number: "FDO87654321"
          device_host_name: "DIST-SW02"
          device_site_name_hierarchy: Global/NorthAmerica/Campus/Building B
          device_management_ip_address: "10.1.20.10"

Example-5: Branch Office LAN Automation with Limited Discovery

---
catalyst_center:
  lan_automation:
    - name: Automate_Edge_Switches
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Canada/BLD1
      primary_device_management_ip_address: 198.18.130.10
      secondary_device_management_ip_address: 181.1.1.40
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - name: LAN_AUTO_Pool
          role: PRINCIPAL_IP_ADDRESS_POOL
        - name: LAN_AUTO_P2P_LINKS
          role: LINK_OVERLAPPING_IP_POOL
      multicast_enabled: true
      host_name_prefix: EN
      advertise_lan_automation_routes_into_bgp: true
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: "Global/Canada/BLD1"
          device_management_ip_address: "192.168.252.10"

Location in GUI: Provision » Network Devices » LAN Automation

Diagram

Classes

catalyst_center

Name	Type	Constraint	Mandatory	Default Value
lan_automation	List	`[lan_automation]`	No

lan_automation (catalyst_center)

Name	Type	Constraint	Mandatory
name	String		Yes
type	Choice	`link`, `devices`	Yes
status	Choice	`START`, `STOP`	Yes
discovered_device_site_name_hierarchy	String		Yes
primary_device_management_ip_address	IP		Yes
peer_device_management_ip_address	IP		No
primary_device_interface_names	List	String	No
ip_pools	List	`[ip_pools]`	No
multicast_enabled	Boolean	`true`, `false`	No
host_name_prefix	String		No
isis_domain_password	String		No
redistribute_isis_to_bgp	Boolean	`true`, `false`	No
discovery_level	Integer	min: `1`, max: `5`	No
discovery_timeout	Integer	min: `20`, max: `10080`	No
discovery_devices	List	`[discovery_devices]`	No

ip_pools (catalyst_center.lan_automation)

Name	Type	Constraint	Mandatory	Default Value
ip_pool_name	String		Yes
ip_pool_role	Choice	`MAIN_POOL`, `PHYSICAL_LINK_POOL`	No

discovery_devices (catalyst_center.lan_automation)

Name	Type	Mandatory
device_serial_number	String	Yes
device_host_name	String	No
device_site_name_hierarchy	String	No
device_management_ip_address	IP	No

Examples

---
catalyst_center:
  lan_automation:
    - name: EDGE_SWTICHES
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Poland/Krakow
      primary_device_management_ip_address: 198.18.130.10
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - ip_pool_name: "LAN_AUTO"
          ip_pool_role: "MAIN_POOL"
      host_name_prefix: lan-sw0
      redistribute_isis_to_bgp: false
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: Global/Poland/Krakow/Bld A
          device_management_ip_address: "192.168.252.10"

Before running LAN Automation, the IP pool LAN_AUTO must be created and assigned to the site:

---
catalyst_center:
  network_settings:
    ip_pools:
      - name: Overlay
        ip_address_space: IPv4
        ip_pool_cidr: 192.168.0.0/16
        ip_pools_reservations:
          - name: LAN_AUTO
            type: LAN
            prefix_length: 24
            subnet: 192.168.252.0
            gateway: 192.168.252.1

---
catalyst_center:
  sites:
    areas:
      - name: Poland
        parent_name: Global
      - name: Krakow
        parent_name: Global/Poland
        ip_pools_reservations:
          - LAN_AUTO

Location in GUI: Provision » Network Devices » LAN Automation

Diagram

Classes

catalyst_center

Name	Type	Constraint	Mandatory	Default Value
lan_automation	List	`[lan_automation]`	No

lan_automation (catalyst_center)

Name	Type	Constraint	Mandatory
name	String		Yes
type	Choice	`link`, `devices`	Yes
status	Choice	`START`, `STOP`	Yes
discovered_device_site_name_hierarchy	String		Yes
primary_device_management_ip_address	IP		Yes
peer_device_management_ip_address	IP		No
primary_device_interface_names	List	String	No
ip_pools	List	`[ip_pools]`	No
multicast_enabled	Boolean	`true`, `false`	No
host_name_prefix	String		No
redistribute_isis_to_bgp	Boolean	`true`, `false`	No
discovery_level	Integer	min: `1`, max: `5`	No
discovery_timeout	Integer	min: `20`, max: `10080`	No
discovery_devices	List	`[discovery_devices]`	No

ip_pools (catalyst_center.lan_automation)

Name	Type	Constraint	Mandatory	Default Value
ip_pool_name	String		Yes
ip_pool_role	Choice	`MAIN_POOL`, `PHYSICAL_LINK_POOL`	No

discovery_devices (catalyst_center.lan_automation)

Name	Type	Mandatory
device_serial_number	String	Yes
device_host_name	String	No
device_site_name_hierarchy	String	No
device_management_ip_address	IP	No

Examples

---
catalyst_center:
  lan_automation:
    - name: EDGE_SWTICHES
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Poland/Krakow
      primary_device_management_ip_address: 198.18.130.10
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - ip_pool_name: "LAN_AUTO"
          ip_pool_role: "MAIN_POOL"
      host_name_prefix: lan-sw0
      redistribute_isis_to_bgp: false
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: Global/Poland/Krakow/Bld A
          device_management_ip_address: "192.168.252.10"

Before running LAN Automation, the IP pool LAN_AUTO must be created and assigned to the site:

---
catalyst_center:
  network_settings:
    ip_pools:
      - name: Overlay
        ip_address_space: IPv4
        ip_pool_cidr: 192.168.0.0/16
        ip_pools_reservations:
          - name: LAN_AUTO
            type: LAN
            prefix_length: 24
            subnet: 192.168.252.0
            gateway: 192.168.252.1

---
catalyst_center:
  sites:
    areas:
      - name: Poland
        parent_name: Global
      - name: Krakow
        parent_name: Global/Poland
        ip_pools_reservations:
          - LAN_AUTO

Location in GUI: Provision » Network Devices » LAN Automation

Diagram

Classes

catalyst_center

Name	Type	Constraint	Mandatory	Default Value
lan_automation	List	`[lan_automation]`	No

lan_automation (catalyst_center)

Name	Type	Constraint	Mandatory
name	String		Yes
type	Choice	`link`, `devices`	Yes
status	Choice	`START`, `STOP`	Yes
discovered_device_site_name_hierarchy	String		Yes
primary_device_management_ip_address	IP		Yes
peer_device_management_ip_address	IP		No
primary_device_interface_names	List	String	No
ip_pools	List	`[ip_pools]`	No
multicast_enabled	Boolean	`true`, `false`	No
host_name_prefix	String		No
redistribute_isis_to_bgp	Boolean	`true`, `false`	No
discovery_level	Integer	min: `1`, max: `5`	No
discovery_timeout	Integer	min: `20`, max: `10080`	No
discovery_devices	List	`[discovery_devices]`	No

ip_pools (catalyst_center.lan_automation)

Name	Type	Constraint	Mandatory	Default Value
ip_pool_name	String		Yes
ip_pool_role	Choice	`MAIN_POOL`, `PHYSICAL_LINK_POOL`	No

discovery_devices (catalyst_center.lan_automation)

Name	Type	Mandatory
device_serial_number	String	Yes
device_host_name	String	No
device_site_name_hierarchy	String	No
device_management_ip_address	IP	No

Examples

---
catalyst_center:
  lan_automation:
    - name: EDGE_SWTICHES
      status: START
      type: devices
      discovered_device_site_name_hierarchy: Global/Poland/Krakow
      primary_device_management_ip_address: 198.18.130.10
      primary_device_interface_names:
        - GigabitEthernet1/0/20
      ip_pools:
        - ip_pool_name: "LAN_AUTO"
          ip_pool_role: "MAIN_POOL"
      host_name_prefix: lan-sw0
      redistribute_isis_to_bgp: false
      discovery_level: 2
      discovery_timeout: 20
      discovery_devices:
        - device_serial_number: "FOC12345678"
          device_host_name: "EDGE01"
          device_site_name_hierarchy: Global/Poland/Krakow/Bld A
          device_management_ip_address: "192.168.252.10"

Before running LAN Automation, the IP pool LAN_AUTO must be created and assigned to the site:

---
catalyst_center:
  network_settings:
    ip_pools:
      - name: Overlay
        ip_address_space: IPv4
        ip_pool_cidr: 192.168.0.0/16
        ip_pools_reservations:
          - name: LAN_AUTO
            type: LAN
            prefix_length: 24
            subnet: 192.168.252.0
            gateway: 192.168.252.1

---
catalyst_center:
  sites:
    areas:
      - name: Poland
        parent_name: Global
      - name: Krakow
        parent_name: Global/Poland
        ip_pools_reservations:
          - LAN_AUTO