cisco.aci.aci_tenant_ep_retention_policy module – Manage End Point (EP) retention protocol policies (fv:EpRetPol)
Note
This module is part of the cisco.aci collection (version 2.10.1).
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.aci
.
To use it in a playbook, specify: cisco.aci.aci_tenant_ep_retention_policy
.
Synopsis
Manage End Point (EP) retention protocol policies on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable If the value is not specified in the task and environment variable Default: |
|
Bounce entry aging interval in seconds. Accepted values range between The APIC defaults to |
|
Determines if the bounce entries are installed by RARP Flood or COOP Protocol. The APIC defaults to Choices:
|
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a If PEM-formatted content was provided for If the value is not specified in the task, the value of environment variable |
|
Description for the End point retention policy. |
|
The name of the end point retention policy. |
|
Hold interval in seconds. Accepted values range between The APIC defaults to |
|
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 |
|
Local end point aging interval in seconds. Accepted values range between The APIC defaults to |
|
Move frequency per second. Accepted values range between The APIC defaults to |
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
Influence the output of this ACI module.
If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
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 |
|
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 |
|
The password to use for authentication. This option is mutual exclusive with If the value is not specified in the task, the value of environment variables |
|
Port number to be used for REST connection. The default value depends on parameter If the value is not specified in the task, the value of environment variable |
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default This option is mutual exclusive with If the value is not specified in the task, the value of environment variable |
|
Remote end point aging interval in seconds. Accepted values range between The APIC defaults to |
|
Use Use Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices:
|
|
The name of an existing tenant. |
|
The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable The default value is 30. |
|
If If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
|
If If the value is not specified in the task, the value of environment variable The default value is true when the connection is local. Choices:
|
|
The username to use for authentication. If the value is not specified in the task, the value of environment variables The default value is admin. |
|
If This should only set to If the value is not specified in the task, the value of environment variable The default value is true. Choices:
|
Notes
Note
The
tenant
used must exist before using this module in your playbook. The cisco.aci.aci_tenant module can be used for this.
See Also
See also
- cisco.aci.aci_tenant
Manage tenants (fv:Tenant).
- APIC Management Information Model reference
More information about the internal APIC class fv:EpRetPol.
- Cisco ACI Guide
Detailed information on how to manage your ACI infrastructure using Ansible.
- Developing Cisco ACI modules
Detailed guide on how to write your own Cisco ACI modules to contribute.
Examples
- name: Add a new EPR policy
cisco.aci.aci_tenant_ep_retention_policy:
host: 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
delegate_to: localhost
- name: Remove an EPR policy
cisco.aci.aci_tenant_ep_retention_policy:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
epr_policy: EPRPol1
state: absent
delegate_to: localhost
- name: Query an EPR policy
cisco.aci.aci_tenant_ep_retention_policy:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
epr_policy: EPRPol1
state: query
delegate_to: localhost
register: query_result
- name: Query all EPR policies
cisco.aci.aci_tenant_ep_retention_policy:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The existing configuration from the APIC after the module has finished Returned: success Sample: |
|
The error information as returned from the APIC Returned: failure Sample: |
|
The filter string used for the request Returned: failure or debug Sample: |
|
The HTTP method used for the request to the APIC Returned: failure or debug Sample: |
|
The original configuration from the APIC before the module has started Returned: info Sample: |
|
The assembled configuration from the user-provided parameters Returned: info Sample: |
|
The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: |
|
The HTTP response from the APIC Returned: failure or debug Sample: |
|
The actual/minimal configuration pushed to the APIC Returned: info Sample: |
|
The HTTP status from the APIC Returned: failure or debug Sample: |
|
The HTTP url used for the request to the APIC Returned: failure or debug Sample: |