Documentation
    Preparing search index...
    Key Name Type Required
    description str None

    Description or description template to be used on the port-channel interface. This can be a template using the AVD string formatter syntax: https://avd.arista.com/stable/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-descriptions-names.html#avd-string-formatter-syntax. The available template fields are:

    • endpoint_type - the type of the connected endpoint either set on the endpoint or taken from connected_endpoints_keys.type like server, router etc.
    • endpoint - The name of the connected endpoint
    • endpoint_port_channel - The value from endpoint_port_channel if set.
    • port_channel_id - The port-channel number for the switch.
    • adapter_description - The adapter's description if set.
    • adapter_description_or_endpoint - Helper alias of the adapter_description or endpoint.

    The default description is set by default_connected_endpoints_port_channel_description. By default the description is templated from the type, name and port_channel interface of the endpoint if set.

    NOTE: We are using the same format as jq to specify the path to the key.

    .network_ports[].port_channel.description