aci_tenant_ep_retention_policy - Manage End Point (EP) retention protocol policies on Cisco ACI fabrics (fv:EpRetPol)

New in version 2.4.

Synopsis

Manage End Point (EP) retention protocol policies on Cisco ACI fabrics.
More information from the internal APIC class fv:EpRetPol at https://developer.cisco.com/media/mim-ref/MO-fvEpRetPol.html.

Requirements (on host that executes module)

ACI Fabric 1.0(3f)+

Options

parameter	required	default	choices	comments
bounce_age	no	630		Bounce Entry Aging Interval (range 150secs - 65535secs) 0 is used for infinite.
bounce_trigger	no	coop		Determines if the bounce entries are installed by RARP Flood or COOP Protocol. The APIC defaults new End Point Retention Policies to `coop`.
description	no			Description for the End point rentention policy. aliases: descr
epr_policy	no			The name of the end point retention policy. aliases: epr_name, name
hold_interval	no	300		Hold Interval (range 5secs - 65535secs).
hostname	yes			IP Address or hostname of APIC resolvable by Ansible control host. aliases: host
local_ep_interval	no	900		Local end point Aging Interval (range 120secs - 65535secs). 0 is used for infinite.
move_frequency	no	256		Move frequency per second (range 0secs - 65535secs). 0 is used for none.
password	yes			The password to use for authentication.
remote_ep_interval	no	300		Remote end point Aging Interval (range 120secs - 65535secs). O is used for infinite.
state	no	present	absent present query	Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
tenant	no			The name of an existing tenant. aliases: tenant_name
timeout	no	30		The socket level timeout in seconds.
use_proxy	no	yes	yes no	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl	no	yes	yes no	If `no`, an HTTP connection will be used instead of the default HTTPS connection.
username	yes	admin		The username to use for authentication. aliases: user
validate_certs	no	yes	yes no	If `no`, SSL certificates will not be validated. This should only set to `no` used on personally controlled sites using self-signed certificates.

Examples

- name: Add a new EPR policy
  aci_epr_policy:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    bounce_age: 630
    hold_interval: 300
    local_ep_interval: 900
    remote_ep_interval: 300
    move_frequency: 256
    description: test
    state: present

- name: Remove an EPR policy
  aci_epr_policy:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: absent

- name: Query an EPR policy
  aci_epr_policy:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: query

- name: Query all EPR policies
  aci_epr_policy:
    hostname: apic
    username: admin
    password: SomeSecretPassword
    state: query

Notes

Note

The tenant used must exist before using this module in your playbook. The aci_tenant module can be used for this.
By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/aci_tenant_ep_retention_policy_module.html

Docs

Docs4dev

Title here