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

description

string

The description of the DHCP Relay Policy.

host

aliases: hostname

string

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 MSO_HOST will be used instead.

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 MSO_LOGIN_DOMAIN will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_login_domain will be used if this attribute is not specified.

output_level

string

Influence the output of this MSO 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 MSO_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"

  • "info"

  • "normal" ← (default)

password

string

The password to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

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 MSO_PORT will be used instead.

providers

list / elements=dictionary

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.

anp

string

The name of the Application Profile (ANP).

This parameter is required when providers.epg is provided.

epg

string

The name of the Endpoint Group (EPG).

providers.epg and providers.external_epg are mutually exclusive.

providers.epg is required when providers.external_epg is not provided.

external_epg

string

The name of the External Endpoint Group (EPG).

providers.external_epg and providers.epg are mutually exclusive.

providers.external_epg is required when providers.epg is not provided.

ip

string / required

The IP address of the DHCP server.

schema

string / required

The name of the schema for the (External) EPG.

template

string / required

The name of the template for the (External) EPG.

use_server_vrf

boolean

Use the server VRF.

Choices:

  • false ← (default)

  • true

relay_policy

aliases: name

string

The name of the DHCP Relay Policy.

relay_policy_uuid

aliases: uuid

string

The uuid of the DHCP Relay Policy.

This parameter is required when the relay_policy needs to be updated.

state

string

Use absent for removing.

Use query for listing an object or multiple objects.

Use present for creating or updating.

Choices:

  • "absent"

  • "query" ← (default)

  • "present"

template

string / required

The name of the template.

The template must be a tenant template.

timeout

integer

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 MSO_TIMEOUT will be used instead.

use_proxy

boolean

If 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 MSO_USE_PROXY will be used instead.

The default is true.

Choices:

  • false

  • true

use_ssl

boolean

If 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 MSO_USE_SSL will be used instead.

When using a HTTPAPI connection plugin the inventory variable ansible_httpapi_use_ssl will be used if this attribute is not specified.

The default is false when using a HTTPAPI connection plugin (mso or nd) and true when using the legacy connection method (only for mso).

Choices:

  • false

  • true

username

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables MSO_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to 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 MSO_VALIDATE_CERTS will be used instead.

The default is true.

Choices:

  • false

  • true

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

Authors

  • Akini Ross (@akinross)