cisco.aci.aci_bd_dhcp_label – Manage DHCP Labels (dhcp:Lbl)¶

Note

This plugin is part of the cisco.aci collection (version 2.0.0).

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

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

Synopsis
Parameters
Notes
See Also
Examples
Return Values

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 `ACI_ANNOTATION` will be used instead.
bd string		The name of the Bridge Domain. aliases: bd_name
certificate_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. aliases: cert_name
description string		The description for the DHCP Label. aliases: descr
dhcp_label string		The name of the DHCP Relay Label. aliases: name
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 `ACI_HOST` will be used instead. aliases: hostname
output_level string	Choices: debug info normal ←	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.
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.
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 `ACI_OWNER_KEY` will be used instead.
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 `ACI_OWNER_TAG` 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 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` will be used instead. aliases: cert_key
scope string	Choices: infra ← tenant	Represents the target relay servers ownership. aliases: owner
state string	Choices: absent present ← query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
tenant string		The name of the Tenant. aliases: tenant_name
timeout integer	Default: 30	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.
use_proxy boolean	Choices: no yes ←	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.
use_ssl boolean	Choices: no yes ←	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.
username string	Default: "admin"	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. aliases: user
validate_certs boolean	Choices: no yes ←	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.

Notes ¶

Note

A DHCP relay label contains a name for the label, the scope, and a DHCP option policy. The scope is the owner 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 and bd 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.

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: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
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: https://10.11.12.13/api/mo/uni/tn-production.json

Authors¶

sig9 (@sig9org)
Dag Wieers (@dagwieers)

cisco.aci.aci_bd_dhcp_label – Manage DHCP Labels (dhcp:Lbl)¶

Synopsis¶

Parameters¶

Notes¶

See Also¶

Examples¶

Return Values¶