cisco.mso.mso_dhcp_relay_policy_provider – Manage DHCP providers in a DHCP Relay policy.
cisco.mso.mso_dhcp_relay_policy_provider – Manage DHCP providers in a DHCP Relay policy.
Note
This plugin is part of the cisco.mso collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.mso
.
To use it in a playbook, specify: cisco.mso.mso_dhcp_relay_policy_provider
.
Synopsis
- Manage DHCP providers in a DHCP Relay policy on Cisco Multi-Site Orchestrator.
Requirements
The below requirements are needed on the host that executes this module.
- Multi Site Orchestrator v2.1 or newer
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
application_profile string |
Application Profile where the DHCP provider is configured
| |
dhcp_relay_policy string / required |
Name of the DHCP Relay Policy
| |
endpoint_group string |
EPG where the DHCP provider is configured
| |
external_endpoint_group string |
External EPG where the DHCP provider is configured
| |
host string / required |
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
| |
ip string |
IP address of the DHCP Server | |
login_domain string |
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 | |
output_level string |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable |
password string / required |
The password to use for authentication. If the value is not specified in the task, the value of environment variables | |
port integer |
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 | |
schema string |
Schema where the DHCP provider is configured | |
state string |
|
Use Use |
template string |
template where the DHCP provider is configured | |
tenant string |
Tenant where the DHCP provider is located. | |
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
- Please read the Cisco ACI Guide for more detailed information on how to manage your ACI infrastructure using Ansible.
- This module was written to support ACI Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.
Examples
- name: Add a new provider to a DHCP Relay Policy
cisco.mso.mso_dhcp_relay_policy_provider:
host: mso_host
username: admin
password: SomeSecretPassword
dhcp_relay_policy: my_test_dhcp_policy
tenant: ansible_test
schema: ansible_test
template: Template 1
application_profile: ansible_test
endpoint_group: ansible_test
state: present
delegate_to: localhost
- name: Remove a provider to a DHCP Relay Policy
cisco.mso.mso_dhcp_relay_policy_provider:
host: mso_host
username: admin
password: SomeSecretPassword
dhcp_relay_policy: my_test_dhcp_policy
tenant: ansible_test
schema: ansible_test
template: Template 1
application_profile: ansible_test
endpoint_group: ansible_test
state: absent
delegate_to: localhost
- name: Query a provider to a DHCP Relay Policy
cisco.mso.mso_dhcp_relay_policy_provider:
host: mso_host
username: admin
password: SomeSecretPassword
dhcp_relay_policy: my_test_dhcp_policy
tenant: ansible_test
schema: ansible_test
template: Template 1
application_profile: ansible_test
endpoint_group: ansible_test
state: query
delegate_to: localhost
- name: Query all provider of a DHCP Relay Policy
cisco.mso.mso_dhcp_relay_policy_provider:
host: mso_host
username: admin
password: SomeSecretPassword
dhcp_relay_policy: my_test_dhcp_policy
state: query
delegate_to: localhost
Authors
- Jorge Gomez (@jorgegome2307)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/mso/mso_dhcp_relay_policy_provider_module.html