cisco.mso.ndo_dhcp_relay_policy module – Manage DHCP Relay Policies on Cisco Nexus Dashboard Orchestrator (NDO).
Note
This module is part of the cisco.mso collection (version 2.9.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.mso
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.mso.ndo_dhcp_relay_policy
.
Synopsis
Manage DHCP Relay Policies on Cisco Nexus Dashboard Orchestrator (NDO).
This module is only supported on ND v3.1 (NDO v4.3) and later.
Requirements
The below requirements are needed on the host that executes this module.
Multi Site Orchestrator v2.1 or newer
Parameters
Parameter |
Comments |
---|---|
The description of the DHCP Relay Policy. |
|
IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable |
|
The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable |
|
Influence the output of this MSO module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
The password to use for authentication. If the value is not specified in the task, the value of environment variables |
|
Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable |
|
A list of providers attached to the DHCP Relay Policy. The list of configured providers must contain at least one provider. When the list of providers is null the update will not change existing providers configuration. |
|
The name of the Application Profile (ANP). This parameter is required when |
|
The name of the Endpoint Group (EPG).
|
|
The name of the External Endpoint Group (EPG).
|
|
The IP address of the DHCP server. |
|
The name of the schema for the (External) EPG. |
|
The name of the template for the (External) EPG. |
|
Use the server VRF. Choices:
|
|
The name of the DHCP Relay Policy. |
|
The uuid of the DHCP Relay Policy. This parameter is required when the |
|
Use Use Use Choices:
|
|
The name of the template. The template must be a tenant template. |
|
The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable |
|
If If the value is not specified in the task, the value of environment variable The default is Choices:
|
|
If If the value is not specified in the task, the value of environment variable When using a HTTPAPI connection plugin the inventory variable The default is Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default is Choices:
|
Notes
Note
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
Examples
- name: Create a new dhcp relay policy
cisco.mso.ndo_dhcp_relay_policy:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
relay_policy: ansible_test_relay_policy
providers:
- schema: ansible_test_schema
template: ansible_test_template
anp: ansible_test_anp
epg: ansible_test_epg_1
ip: 1.1.1.1
state: present
- name: Query a dhcp relay policy with template_name
cisco.mso.ndo_dhcp_relay_policy:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
relay_policy: ansible_test_relay_policy
state: query
register: query_one
- name: Query all dhcp relay policy in the template
cisco.mso.ndo_dhcp_relay_policy:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
state: query
register: query_all
- name: Delete a dhcp relay policy
cisco.mso.ndo_dhcp_relay_policy:
host: mso_host
username: admin
password: SomeSecretPassword
template: ansible_tenant_template
relay_policy: ansible_test_relay_policy
state: absent