Device Sensor

Device Sensor is a network visibility feature that enables switches to collect and analyze information about connected endpoints through various discovery protocols including DHCP, LLDP, and CDP. It provides intelligent filtering and processing capabilities to extract relevant device attributes such as device type, operating system, user identity, and network behavior patterns. This information is essential for network access control, security policy enforcement, and asset management, allowing administrators to make informed decisions about device authorization and network segmentation.

Diagram

Classes

iosxe

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No

devices (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (iosxe.devices)

Name	Type	Constraint	Mandatory	Default Value
device_sensor	Class	device_sensor	No

device_sensor (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
notify_all_changes	Boolean	true, false	No
dhcp_filter_lists	List	dhcp_filter_lists	No
lldp_filter_lists	List	lldp_filter_lists	No
cdp_filter_lists	List	cdp_filter_lists	No
filter_spec_cdp_includes	List	String	No
filter_spec_cdp_excludes	List	String	No
filter_spec_dhcp_includes	List	String	No
filter_spec_dhcp_excludes	List	String	No
filter_spec_lldp_includes	List	String	No
filter_spec_lldp_excludes	List	String	No

dhcp_filter_lists (iosxe.devices.configuration.device_sensor)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
option_name_class_identifier	Boolean	true, false	No
option_name_client_fqdn	Boolean	true, false	No
option_name_client_identifier	Boolean	true, false	No
option_name_default_ip_ttl	Boolean	true, false	No
option_name_host_name	Boolean	true, false	No
option_name_parameter_request_list	Boolean	true, false	No
option_name_requested_address	Boolean	true, false	No

lldp_filter_lists (iosxe.devices.configuration.device_sensor)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
tlv_name_port_description	Boolean	true, false	No
tlv_name_port_id	Boolean	true, false	No
tlv_name_system_description	Boolean	true, false	No
tlv_name_system_capabilities	Boolean	true, false	No
tlv_name_system_name	Boolean	true, false	No

cdp_filter_lists (iosxe.devices.configuration.device_sensor)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
tlv_name_device_name	Boolean	true, false	No
tlv_name_address_type	Boolean	true, false	No
tlv_name_port_id_type	Boolean	true, false	No
tlv_name_capabilities_type	Boolean	true, false	No
tlv_name_platform_type	Boolean	true, false	No

Sample Configuration

device-sensor notify all-changes
!
device-sensor filter-list dhcp list DHCP-FILTER-1
 option name class-identifier
 option name client-fqdn
 option name client-identifier
 option name host-name
 option name parameter-request-list
 option name requested-address
!
device-sensor filter-list dhcp list DHCP-FILTER-2
 option name default-ip-ttl
 option name host-name
!
device-sensor filter-list lldp list LLDP-FILTER-1
 tlv name port-description
 tlv name port-id
 tlv name system-capabilities
 tlv name system-description
 tlv name system-name
!
device-sensor filter-list lldp list LLDP-FILTER-2
 tlv name system-capabilities
!
device-sensor filter-list cdp list CDP-FILTER-1
 tlv name device-name
 tlv name address-type
 tlv name port-id-type
 tlv name capabilities-type
 tlv name platform-type
!
device-sensor filter-spec dhcp exclude list DHCP-FILTER-2
device-sensor filter-spec lldp exclude list LLDP-FILTER-2
device-sensor filter-spec cdp include list CDP-FILTER-1

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        device_sensor:
          notify_all_changes: true
          dhcp_filter_lists:
            - name: DHCP-FILTER-1
              option_name_class_identifier: true
              option_name_client_fqdn: true
              option_name_client_identifier: true
              option_name_host_name: true
              option_name_parameter_request_list: true
              option_name_requested_address: true
            - name: DHCP-FILTER-2
              option_name_default_ip_ttl: true
              option_name_host_name: true
          lldp_filter_lists:
            - name: LLDP-FILTER-1
              tlv_name_port_description: true
              tlv_name_port_id: true
              tlv_name_system_capabilities: true
              tlv_name_system_description: true
              tlv_name_system_name: true
            - name: LLDP-FILTER-2
              tlv_name_system_capabilities: true
          cdp_filter_lists:
            - name: CDP-FILTER-1
              tlv_name_device_name: true
              tlv_name_address_type: true
              tlv_name_port_id_type: true
              tlv_name_capabilities_type: true
              tlv_name_platform_type: true
          filter_spec_dhcp_includes:
            - DHCP-FILTER-1
          filter_spec_dhcp_excludes:
            - DHCP-FILTER-2
          filter_spec_lldp_includes:
            - LLDP-FILTER-1
          filter_spec_lldp_excludes:
            - LLDP-FILTER-2
          filter_spec_cdp_includes:
            - CDP-FILTER-1

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        device_sensor:
          notify_all_changes: true
          dhcp_filter_lists:
            - name: DHCP-FILTER-1
              option_name_class_identifier: true
              option_name_client_fqdn: true
              option_name_client_identifier: true
              option_name_host_name: true
              option_name_parameter_request_list: true
              option_name_requested_address: true
            - name: DHCP-FILTER-2
              option_name_default_ip_ttl: true
              option_name_host_name: true
          lldp_filter_lists:
            - name: LLDP-FILTER-1
              tlv_name_port_description: true
              tlv_name_port_id: true
              tlv_name_system_description: true
              tlv_name_system_name: true
          cdp_filter_lists:
            - name: CDP-FILTER-1
              tlv_name_device_name: true
              tlv_name_address_type: true
              tlv_name_port_id_type: true
              tlv_name_capabilities_type: true
              tlv_name_platform_type: true
          filter_spec_dhcp_includes:
            - DHCP-FILTER-1
          filter_spec_dhcp_excludes:
            - DHCP-FILTER-2
          filter_spec_lldp_includes:
            - LLDP-FILTER-1
          filter_spec_cdp_includes:
            - CDP-FILTER-1