cisco.aci.aci_interface_policy_bfd module – Manage BFD Interface policies (bfd:IfPol)
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_interface_policy_bfd
.
Synopsis
Manage BFD Interface policy configuration on Cisco ACI fabrics
Only available in APIC version 5.2 or later
Parameters
Parameter |
Comments |
---|---|
Admin state of the BFD Interface policy APIC sets the default value to enabled Choices:
|
|
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: |
|
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 of the BFD Interface policy |
|
Detection multiplier of the BFD Interface policy APIC sets the default value to 3 Allowed range is 1-50 |
|
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 |
|
Minimum receive (Rx) interval of the BFD Interface policy APIC sets the default value to 50 Allowed range is 250-999 |
|
Minimum transmit (Tx) interval of the BFD Interface policy APIC sets the default value to 50 Allowed range is 250-999 |
|
Name of the BFD Interface policy |
|
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 |
|
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 |
|
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:
|
|
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
must exist before using this module in your playbook The cisco.aci.aci_tenant modules can be used for this
See Also
See also
- APIC Management Information Model reference
More information about the internal APIC class bfd:IfPol
- cisco.aci.aci_tenant
Manage tenants (fv:Tenant).
- 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 BFD Interface policy
cisco.aci.aci_interface_policy_bfd:
host: apic
username: admin
password: SomeSecretPassword
tenant: ansible_tenant
name: ansible_bfd_interface_policy
description: Ansible BFD Interface Policy
state: present
delegate_to: localhost
- name: Remove a BFD Interface policy
cisco.aci.aci_interface_policy_bfd:
host: apic
username: admin
password: SomeSecretPassword
tenant: ansible_tenant
name: ansible_bfd_interface_policy
state: absent
delegate_to: localhost
- name: Query a BFD Interface policy
cisco.aci.aci_interface_policy_bfd:
host: apic
username: admin
password: SomeSecretPassword
tenant: ansible_tenant
name: ansible_bfd_interface_policy
state: query
delegate_to: localhost
- name: Query all BFD Interface policies in a specific tenant
cisco.aci.aci_interface_policy_bfd:
host: apic
username: admin
password: SomeSecretPassword
tenant: ansible_tenant
state: query
delegate_to: localhost
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: |