cisco.aci.aci_bd_dhcp_label – Manage DHCP Labels (dhcp:Lbl)
cisco.aci.aci_bd_dhcp_label – Manage DHCP Labels (dhcp:Lbl)
Note
This plugin is part of the cisco.aci collection (version 1.1.1).
To install it use: ansible-galaxy collection install cisco.aci
.
To use it in a playbook, specify: cisco.aci.aci_bd_dhcp_label
.
Synopsis
- Manage DHCP Labels on Cisco ACI fabrics.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
annotation string |
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable | |
bd string |
The name of the Bridge Domain.
| |
certificate_name string |
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable
| |
description string |
The description for the DHCP Label.
| |
dhcp_label string |
The name of the DHCP Relay Label.
| |
dhcp_option string |
Name of the DHCP Option Policy to be associated with the DCHP Relay Policy. This policy need to be present in the same tenant as the bridge domain. The DHCP option is used to supply DHCP clients with configuration parameters such as a domain, name server, subnet, and network address. | |
host 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
| |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
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 | |
owner_key string |
User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable | |
owner_tag string |
User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable | |
password string |
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables | |
port integer |
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable | |
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 This option is mutual exclusive with If the value is not specified in the task, the value of environment variable
| |
scope string |
|
Represents the target relay servers ownership.
|
state string |
|
Use Use |
tenant string |
The name of the Tenant.
| |
timeout integer |
Default: 30 |
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable |
use_proxy boolean |
|
If If the value is not specified in the task, the value of environment variable |
use_ssl boolean |
|
If If the value is not specified in the task, the value of environment variable |
username string |
Default: "admin" |
The username to use for authentication. If the value is not specified in the task, the value of environment variables
|
validate_certs boolean |
|
If This should only set to If the value is not specified in the task, the value of environment variable |
Notes
Note
- A DHCP relay label contains a
name
for the label, thescope
, and a DHCP option policy. The scope is theowner
of the relay server and the DHCP option policy supplies DHCP clients with configuration parameters such as domain, nameserver, and subnet router addresses. - The
tenant
andbd
used must exist before using this module in your playbook. The cisco.aci.aci_tenant module and cisco.aci.aci_bd can be used for these.
See Also
See also
- cisco.aci.aci_bd
- The official documentation on the cisco.aci.aci_bd module.
- cisco.aci.aci_tenant
- The official documentation on the cisco.aci.aci_tenant module.
- APIC Management Information Model reference
- More information about the internal APIC class dhcp:Lbl.
- 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: Create a new DHCP Relay Label to a Bridge Domain
cisco.aci.aci_bd_dhcp_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
dhcp_label: label1
scope: infra
state: present
- name: Query a DHCP Relay Label of a Bridge Domain
cisco.aci.aci_bd_dhcp_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
dhcp_label: label1
scope: infra
state: query
- name: Query all DHCP Relay Labels of a Bridge Domain
cisco.aci.aci_bd_dhcp_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
state: query
- name: Remove a DHCP Relay Label for a Bridge Domain
cisco.aci.aci_bd_dhcp_label:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
bd: database
dhcp_label: label1
scope: infra
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
current list / elements=string |
success |
The existing configuration from the APIC after the module has finished
Sample: [{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
error dictionary |
failure |
The error information as returned from the APIC
Sample: {'code': '122', 'text': 'unknown managed object class foo'} |
filter_string string |
failure or debug |
The filter string used for the request
Sample: ?rsp-prop-include=config-only |
method string |
failure or debug |
The HTTP method used for the request to the APIC
Sample: POST |
previous list / elements=string |
info |
The original configuration from the APIC before the module has started
Sample: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}] |
proposed dictionary |
info |
The assembled configuration from the user-provided parameters
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}} |
raw string |
parse error |
The raw output returned by the APIC REST API (xml or json)
Sample:
|
response string |
failure or debug |
The HTTP response from the APIC
Sample: OK (30 bytes) |
sent list / elements=string |
info |
The actual/minimal configuration pushed to the APIC
Sample: {'fvTenant': {'attributes': {'descr': 'Production environment'}}} |
status integer |
failure or debug |
The HTTP status from the APIC
Sample: 200 |
url string |
failure or debug |
The HTTP url used for the request to the APIC
Sample: |
Authors
- sig9 (@sig9org)
- Dag Wieers (@dagwieers)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_bd_dhcp_label_module.html