valid data_path for cv_tags

[janthon1]

I am using AVD 5.7.2, and trying to generate custom, dynamic interface tags. However, some of the available keys/data_paths in the interface structured config seem to be ignored when creating the dynamic tags.

The intended application is to use specific interface tags to influence event/alert generation. In our campus environment, we want to alert on up/down events on specific port types (e.g. cameras, door access controllers). These port types may change over time, so defining a single tag for these ports would be ideal. For most port profiles, we explicitly set the [validate_state] attribute to true or false. This attribute seems well-suited for driving alerting behaviors.

In our AVD config, we have the following:

	generate_cv_tags:
	  topology_hints: true
	  interface_tags:
	    - name: Test_Alerting
	      data_path: validate_state
	    - name: Test_PortProfile
	      data_path: port_profile
	    - name: Test_portType
	      data_path: peer_type

For testing, in cv_tags.py, ~ line 204 we added to review the structured config being evaluated:

    # Silently ignoring empty values since structured config may vary between devices.
    if value:
        tags.append(EosCliConfigGen.Metadata.CvTags.InterfaceTagsItem.TagsItem(name=generate_tag.name, value=str(value)))
    else:
        msg = f"'generate_cv_tags.device_tags[name={generate_tag.name} / path={generate_tag.data_path}]' is missing undefined {ethernet_interface}"
        print(msg)

This created log output like:

'generate_cv_tags.device_tags[name=Test_Alerting / path=validate_state]' is missing undefined <EthernetInterfacesItem(name=Ethernet30, peer=None, peer_interface=None, peer_type=network_port, port_profile=PP-disabled, description=TECH-DISABLED, speed=None, shutdown=True, validate_state=False, validate_lldp=None, dot1x=<Dot1x()>, eos_cli=None, mtu=None, l2_mtu=None, l2_mru=None, spanning_tree_portfast=None, spanning_tree_bpdufilter=None, spanning_tree_bpduguard=None, service_profile=None, sflow=<Sflow(enable=True)>, switchport=<Switchport(enabled=True, mode=None)>, flow_tracker=<FlowTracker(sampled=None)>)>

'generate_cv_tags.device_tags[name=Test_Alerting / path=validate_state]' is missing undefined <EthernetInterfacesItem(name=Ethernet31, peer=None, peer_interface=None, peer_type=network_port, port_profile=PP-disabled, description=TECH-DISABLED, speed=None, shutdown=True, validate_state=False, validate_lldp=None, dot1x=<Dot1x()>, eos_cli=None, mtu=None, l2_mtu=None, l2_mru=None, spanning_tree_portfast=None, spanning_tree_bpdufilter=None, spanning_tree_bpduguard=None, service_profile=None, sflow=<Sflow(enable=True)>, switchport=<Switchport(enabled=True, mode=None)>, flow_tracker=<FlowTracker(sampled=None)>)>

'generate_cv_tags.device_tags[name=Test_Alerting / path=validate_state]' is missing undefined <EthernetInterfacesItem(name=Ethernet32, peer=None, peer_interface=None, peer_type=network_port, port_profile=PP-disabled, description=TECH-DISABLED, speed=None, shutdown=True, validate_state=False, validate_lldp=None, dot1x=<Dot1x()>, eos_cli=None, mtu=None, l2_mtu=None, l2_mru=None, spanning_tree_portfast=None, spanning_tree_bpdufilter=None, spanning_tree_bpduguard=None, service_profile=None, sflow=<Sflow(enable=True)>, switchport=<Switchport(enabled=True, mode=None)>, flow_tracker=<FlowTracker(sampled=None)>)>

'generate_cv_tags.device_tags[name=Test_Alerting / path=validate_state]' is missing undefined <EthernetInterfacesItem(name=Ethernet33, peer=None, peer_interface=None, peer_type=network_port, port_profile=PP-disabled, description=TECH-DISABLED, speed=None, shutdown=True, validate_state=False, validate_lldp=None, dot1x=<Dot1x()>, eos_cli=None, mtu=None, l2_mtu=None, l2_mru=None, spanning_tree_portfast=None, spanning_tree_bpdufilter=None, spanning_tree_bpduguard=None, service_profile=None, sflow=<Sflow(enable=True)>, switchport=<Switchport(enabled=True, mode=None)>, flow_tracker=<FlowTracker(sampled=None)>)>

AVD successfully generates the interface tags Test_PortProfile and Test_portType. However, the Test_Alerting tag is not generated. Based on the log messages above, the validate_state data_path appears to be available.

Any suggestions on how to utilize the validate_state attribute to create an interface tag would be appreciated.

-Jason

[ClausHolbechArista]

This turned out to be a bug. Thank you for bringing it to our attention. I will convert this discussion to an issue and submit a fix. We are in the final phases of preparing the 6.0 release, so it will be fixed in there.

[ClausHolbechArista]

Issue: #6456