.. _a10_rule_set_rule_action_group_module:


a10_rule_set_rule_action_group
==============================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Configure action-group






Parameters
----------

 
| Parameters                   | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| state                        | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_host                 |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_username             |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_password             |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ansible_port                 |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| a10_device_context_id        | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| a10_partition                |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| rule_set_name                |                               | Key to identify parent object                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ntype                        |                               | 'permit'= permit; 'deny'= deny; 'reset'= reset;                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| permit_log                   |                               | Enable logging                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| reset_log                    |                               | Enable logging                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| deny_log                     |                               | Enable logging                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| logging_template_list        |                               | Field logging_template_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| list                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | permit_log_template_type |                               | 'fw-logging-template'= Logging with specified fw template; 'cgnv6-logging- template'= Logging with specified cgnv6 template; 'netflow-monitor'= Logging with specified netflow/ipfix monitor;                                                                                                                                                                                                                                                                                               |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | permit_fw_log            |                               | Logging template name                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | permit_cgnv6_log         |                               | Logging template name                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | permit_netflow_log       |                               | Name of netflow monitor                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| reset_log_template_type      |                               | 'fw-logging-template'= Logging with specified fw template;                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| reset_fw_log                 |                               | Logging template name                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| deny_log_template_type       |                               | 'fw-logging-template'= Logging with specified fw template;                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| deny_fw_log                  |                               | Logging template name                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| skip_urpf_check              |                               | Skip Unicast Reverse Path Forwarding check                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| listen_on_port               |                               | Listen on port                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| forward                      |                               | Forward packet                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ipsec                        |                               | Apply IPsec encapsulation                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| ipsec_group                  |                               | Apply IPsec Group encapsulation                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| vpn_ipsec_name               |                               | VPN IPsec name                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| vpn_ipsec_group_name         |                               | VPN IPsec Group name                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| cgnv6                        |                               | Apply CGNv6 policy                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| cgnv6_policy                 |                               | 'lsn-lid'= Apply specified CGNv6 LSN LID; 'fixed-nat'= Apply CGNv6 Fixed NAT; 'ds-lite'= Apply CGNv6 DS-Lite;                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| cgnv6_lsn_lid                |                               | LSN LID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| cgnv6_ds_lite                |                               | 'lsn-lid'= Apply specified CGNv6 LSN LID;                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| cgnv6_ds_lite_lsn_lid        |                               | LSN LID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| inspect_payload              |                               | Enable DS-Lite tunnel inspection                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| permit_limit_policy          |                               | Limit policy Template                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| deny_reset_limit_policy      |                               | Limit policy Template (only works for inbound rule)                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| permit_respond_to_user_mac   |                               | Use the user's source MAC for the next hop rather than the routing table (default=off)                                                                                                                                                                                                                                                                                                                                                                                                      |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| reset_respond_to_user_mac    |                               | Use the user's source MAC for the next hop rather than the routing table (default=off)                                                                                                                                                                                                                                                                                                                                                                                                      |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| set_dscp                     |                               | DSCP setting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| dscp_value                   |                               | 'default'= Default dscp (000000); 'af11'= AF11 (001010); 'af12'= AF12 (001100); 'af13'= AF13 (001110); 'af21'= AF21 (010010); 'af22'= AF22 (010100); 'af23'= AF23 (010110); 'af31'= AF31 (011010); 'af32'= AF32 (011100); 'af33'= AF33 (011110); 'af41'= AF41 (100010); 'af42'= AF42 (100100); 'af43'= AF43 (100110); 'cs1'= CS1 (001000); 'cs2'= CS2 (010000); 'cs3'= CS3 (011000); 'cs4'= CS4 (100000); 'cs5'= CS5 (101000); 'cs6'= CS6 (110000); 'cs7'= CS7 (111000); 'ef'= EF (101110); |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| dscp_number                  |                               | DSCP Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| tcp                          |                               | Firewall rule TCP parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| syn_cookie                   |                               | Configure Firewall rule Syn-Cookie Protection                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                         |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| syn_cookie_enable            |                               | 'enable'= enable; 'disable'= disable;                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| threshold_val                |                               | Decimal number                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| on_timeout                   |                               | on-timeout for Syn-cookie (Timeout in seconds, default is 120 seconds (2 minutes))                                                                                                                                                                                                                                                                                                                                                                                                          |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| uuid                         |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 







Examples
--------

.. code-block:: yaml+jinja

    



Return Values
-------------

modified_values (changed, dict, )
  Values modified (or potential changes if using check_mode) as a result of task operation


axapi_calls (always, list, )
  Sequential list of AXAPI calls made by the task


  endpoint (, str, ['/axapi/v3/slb/virtual_server', '/axapi/v3/file/ssl-cert'])
    The AXAPI endpoint being accessed.


  http_method (, str, ['POST', 'GET'])
    HTTP method being used by the primary task to interact with the AXAPI endpoint.


  request_body (, complex, )
    Params used to query the AXAPI


  response_body (, complex, )
    Response from the AXAPI






Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

