cisco.aci.aci_tenant_action_rule_profile module – Manage action rule profiles (rtctrl:AttrP)
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_action_rule_profile
.
Synopsis
Manage action rule profiles on Cisco ACI fabrics.
Parameters
Parameter |
Comments |
---|---|
The name of the action rule profile. |
|
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 |
|
The description for the action rule profile. |
|
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 |
|
Set action rule based on set redistribute multipath configuration. Can not be configured along with Can not be configured for APIC version 4.2 and prior. The APIC defaults to Choices:
|
|
The alias for the current object. This relates to the nameAlias field in ACI. |
|
The set action rule based on nexthop unchanged configuration. Can not be configured along with Can not be configured for APIC version 4.2 and prior. The APIC defaults to Choices:
|
|
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 |
|
The set action rule based on communities. To delete this attribute, pass an empty dictionary. |
|
The community value. |
|
The community criteria. The option to append or replace the community value. Choices:
|
|
The set action rule based on dampening. To delete this attribute, pass an empty dictionary. |
|
The half life value (minutes). |
|
The maximum suppress time value (minutes). |
|
The reuse limit value. |
|
The suppress limit value. |
|
The set action rule based on metric. To delete this attribute, pass an empty string. |
|
The set action rule based on a metric type. To delete this attribute, pass an empty string. Choices:
|
|
The set action rule based on the next hop address. To delete this attribute, pass an empty string. |
|
The set action rule based on preference. To delete this attribute, pass an empty string. |
|
The set action rule based on route tag. Can not be configured along with To delete this attribute, pass an empty string. |
|
The set action rule based on weight. To delete this attribute, pass an empty string. |
|
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 the 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 rtctrl:AttrP.
- 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: Create a action rule profile
cisco.aci.aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
action_rule: my_action_rule
tenant: prod
set_preference: 100
set_weight: 100
set_metric: 100
set_metric_type: ospf_type_1
set_next_hop: 1.1.1.1
next_hop_propagation: true
multipath: true
set_community:
community: no-advertise
criteria: replace
set_dampening:
half_life: 10
reuse: 1
suppress: 10
max_suppress_time: 100
state: present
delegate_to: localhost
- name: Delete action rule profile's children
cisco.aci.aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
action_rule: my_action_rule
tenant: prod
set_preference: ""
set_weight: ""
set_metric: ""
set_metric_type: ""
set_next_hop: ""
next_hop_propagation: false
multipath: false
set_community: {}
set_dampening: {}
state: present
delegate_to: localhost
- name: Delete a action rule profile
cisco.aci.aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
action_rule: my_action_rule
tenant: prod
state: absent
delegate_to: localhost
- name: Query all action rule profiles
cisco.aci.aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
- name: Query a specific action rule profile
cisco.aci.aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
action_rule: my_action_rule
tenant: prod
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: |