aci_dhcp_relay_provider
Manage DHCP relay policy providers (dhcp:RsProv)
Collection: cisco.aci
Full Name: cisco.aci.aci_dhcp_relay_provider
Synopsis
Manage DHCP relay policy providers (dhcp:RsProv)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| anp | string | Application Profile the EPG is in. Only used when epg_type is app_epg. | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(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 | string | Name of the Application EPG the DHCP server is in. Only used when epg_type is epg | ||
| epg_type | string | Type of EPG the DHCP server is in | ||
| external_epg | string | Name of the external network object the DHCP server is in. Only used when epg_type is l2_external or l3_external. | ||
| host | string | 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 C(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 | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| 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 C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| provider_tenant | string | Name of the tenant the epg or external_epg is in Required when epg or external_epg is in a different tenant than the relay_policy Required when global (infra) relay_policy is configured with epg or external_epg types | ||
| relay_policy | string | Name of an existing DHCP relay policy | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| tenant | string | Name of the tenant the relay_policy is in. When tenant is not provided the module will be applied to the global (infra) policy. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), 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 C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), 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 C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "dhcp_server_addr": "10.20.30.40", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "relay_policy": "my_dhcp_relay", "state": "present", "tenant": "Auto-Demo", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new DHCP relay App EPG provider"}
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "dhcp_server_addr": "10.20.30.40", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "provider_tenant": "Auto-Demo", "relay_policy": "my_dhcp_relay", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new Global (infra) DHCP relay App EPG provider"}
- {"cisco.aci.aci_dhcp_relay_provider": {"dhcp_server_addr": "10.20.30.40", "epg_type": "l3_external", "external_net": "my_l3out_ext_net", "host": "apic", "l3out_name": "my_l3out", "password": "SomeSecretPassword", "relay_policy": "my_dhcp_relay", "state": "present", "tenant": "Auto-Demo", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new DHCP relay L3out provider"}
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "relay_policy": "my_dhcp_relay", "state": "absent", "tenant": "Auto-Demo", "username": "admin"}, "delegate_to": "localhost", "name": "Remove a DHCP relay provider"}
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "provider_tenant": "Auto-Demo", "relay_policy": "my_dhcp_relay", "state": "absent", "username": "admin"}, "delegate_to": "localhost", "name": "Remove a Global (infra) DHCP relay provider"}
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "relay_policy": "my_dhcp_relay", "state": "query", "tenant": "Auto-Demo", "username": "admin"}, "delegate_to": "localhost", "name": "Query a DHCP relay provider", "register": "query_result"}
- {"cisco.aci.aci_dhcp_relay_provider": {"anp": "my_anp", "epg": "my_app_epg", "epg_type": "epg", "host": "apic", "password": "SomeSecretPassword", "provider_tenant": "Auto-Demo", "relay_policy": "my_dhcp_relay", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query a Global (infra) DHCP relay provider", "register": "query_result"}
- {"cisco.aci.aci_dhcp_relay_provider": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "tenant": "Auto-Demo", "username": "admin"}, "delegate_to": "localhost", "name": "Query all DHCP relay providers in a specific tenant", "register": "query_result"}
- {"cisco.aci.aci_dhcp_relay_provider": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all DHCP relay providers", "register": "query_result"}