You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.aci.aci_dhcp_relay_provider module – Manage DHCP relay policy providers.

Note

This module is part of the cisco.aci collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_dhcp_relay_provider.

Synopsis

• Manage DHCP relay policy providers (dhcpRsProv) configuration on Cisco ACI fabrics.

Parameters

Parameter	Comments
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead. If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used. Default: "orchestrator:ansible"
anp string	Application Profile the EPG is in. Only used when epg_type is app_epg.
certificate_name aliases: cert_name string	The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a private_key filename was provided, this defaults to the private_key basename, without extension. If PEM-formatted content was provided for private_key, this defaults to the username value. If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
dhcp_server_addr string	DHCP server address
dn string	dn of the EPG the DHCP server is in Only used when epg_type is dn
epg aliases: app_epg string	Name of the Application EPG the DHCP server is in. Only used when epg_type is epg
epg_type string / required	Type of EPG the DHCP server is in Choices: "epg" "l2_external" "l3_external" "dn"
external_epg aliases: external_net string	Name of the external network object the DHCP server is in. Only used when epg_type is l2_external or l3_external.
host aliases: hostname string / required	IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.
l2out_name string	Name of the L2out the DHCP server is in. Only used when epg_type is l2_external
l3out_name string	Name of the L3out the DHCP server is in. Only used when epg_type is l3_external.
output_level string	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
output_path string	Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.
password string	The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
port integer	Port number to be used for REST connection. The default value depends on parameter use_ssl. If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
private_key aliases: cert_key string	Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default certificate_name that is used. This option is mutual exclusive with password. If password is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.
provider_tenant string	Name of the tenant the epg or external_epg is in Only required if the epg or external_epg is in a different tenant than the relay_policy
relay_policy aliases: relay_policy_name string	Name of an existing DHCP relay policy
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: "absent" "present" ← (default) "query"
tenant string	Name of the tenant the relay_policy is in.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead. Default: 30
use_proxy boolean	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead. Choices: false true ← (default)
use_ssl boolean	If no, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead. Choices: false true ← (default)
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead. Default: "admin"
validate_certs boolean	If no, SSL certificates will not be validated. This should only set to no when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead. Choices: false true ← (default)

Notes

Note

• The tenant and relay_policy must exist before using this module in your playbook. The cisco.aci.aci_tenant and cisco.aci.aci_dhcp_relay modules can be used for this.

See Also

See also

APIC Management Information Model reference

More information about the internal APIC class dhcpRsProv.

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Add a new DHCP relay App EPG provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    dhcp_server_addr: 10.20.30.40
    state: present
  delegate_to: localhost

- name: Add a new DHCP relay L3out provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: l3_external
    l3out_name: my_l3out
    external_net: my_l3out_ext_net
    dhcp_server_addr: 10.20.30.40
    state: present
  delegate_to: localhost

- name: Remove a DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: absent
  delegate_to: localhost

- name: Query a DHCP relay provider
  cisco.aci.aci_dhcp_relay_provider:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: Auto-Demo
    relay_policy: my_dhcp_relay
    epg_type: epg
    anp: my_anp
    epg: my_app_epg
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	The existing configuration from the APIC after the module has finished Returned: success Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	The error information as returned from the APIC Returned: failure Sample: {"code": "122", "text": "unknown managed object class foo"}
filter_string string	The filter string used for the request Returned: failure or debug Sample: "?rsp-prop-include=config-only"
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: "POST"
previous list / elements=string	The original configuration from the APIC before the module has started Returned: info Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw string	The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"
response string	The HTTP response from the APIC Returned: failure or debug Sample: "OK (30 bytes)"
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status integer	The HTTP status from the APIC Returned: failure or debug Sample: 200
url string	The HTTP url used for the request to the APIC Returned: failure or debug Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

• Tim Cragg (@timcragg)

Collection links

Issue Tracker Repository (Sources)