aggregateroute#

Collection Note

This module is part of the nokia.eda_protocols_v1 collection. To install the collection, use:

ansible-galaxy collection install nokia.eda_protocols_v1

Added in version 1.0.0.

Synopsis#

The AggregateRoute enables the configuration of aggregated routes on a specified Router. This resource allows for the definition of destination prefixes, the selection of a router, and optionally, specific nodes where the aggregate routes should be configured. Advanced options include the ability to generate ICMP unreachable messages for packets matching the aggregate route, and the ability to block the advertisement of all contributing routes in dynamic protocols like BGP.

Parameter	Defaults / Choices	Comments
authToken str required		HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly.
baseUrl str required		EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443. Required unless state is cronly.
caPath str required		A path to the PEM-encoded CA certificate to use for TLS verification. Required unless state is cronly.
detailLevel str		The detail level to keep in the transaction log for the transaction resulting from this request.
disableBatching bool		If true, prevents the transaction resulting from this request from being bundled with others.
hash str		Resource content will be returned as it was at the time of this git hash
name str required		Name of the AggregateRoute. Required when state is query or absent.
namespace str required		The namespace to use when querying or removing the resource. Required when state is query or absent.
resource dict required		The AggregateRoute resource definition in YAML format as seen in the EDA UI or https://crd.eda.dev. Required when state is present or cronly.
state str required	Choices: absent, query, present, cronly	State of the requested resource object.
tlsSkipVerify bool required		A flag to control the TLS verification of the session. Required unless state is cronly.