dhcprelay#

Collection Note

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

ansible-galaxy collection install nokia.eda_services_v1

Added in version 0.3.0.

Synopsis#

The DHCPRelay enables the forwarding of DHCP requests and responses between clients and servers across different networks. This resource allows for the configuration of various DHCP relay sub-options, such as CircuitID, RemoteID, and ClientLinkLayerAddress, to provide detailed client information. It also includes settings for specifying the router to reach the DHCP server, the list of DHCP servers to forward requests to, and selectors for Routed and IRB interfaces where the relay will be configured. Additionally, the GI Address option can be set to derive the Gateway IP address from the selected interface, ensuring correct routing of DHCP messages.

Parameter	Defaults / Choices	Comments
auth_token str required		HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly.
base_url 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.
ca_path str required		A path to the PEM-encoded CA certificate to use for TLS verification. Required unless state is cronly.
hash str		Resource content will be returned as it was at the time of this git hash
name str required		Name of the DHCPRelay. 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 DHCPRelay 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.
tls_skip_verify bool required		A flag to control the TLS verification of the session. Required unless state is cronly.