.. _a10_object_group_service_module:


a10_object_group_service
========================

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


Synopsis
--------

Configure Service Object 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                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| svc_name              |                               | Service Object Group Name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| description           |                               | Description of the object-group instance                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rules                 |                               | Field rules                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | seq_num           |                               | Sequence number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | protocol_id       |                               | Protocol ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | tcp_udp           |                               | 'tcp'= Protocol TCP; 'udp'= Protocol UDP;                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp              |                               | Internet Control Message Protocol                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmpv6            |                               | Internet Control Message Protocol version 6                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp_type         |                               | ICMP type number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | any_type          |                               | Any ICMP type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_type      |                               | 'echo-reply'= Type 0, echo reply; 'echo-request'= Type 8, echo request; 'info- reply'= Type 16, information reply; 'info-request'= Type 15, information request; 'mask-reply'= Type 18, address mask reply; 'mask-request'= Type 17, address mask request; 'parameter-problem'= Type 12, parameter problem; 'redirect'= Type 5, redirect message; 'source-quench'= Type 4, source quench; 'time-exceeded'= Type 11, time exceeded; 'timestamp'= Type 13, timestamp; 'timestamp-reply'= Type 14, timestamp reply; 'dest-unreachable'= Type 3, destination unreachable; |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | any_code          |                               | Any ICMP code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmp_code         |                               | ICMP code number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_code      |                               | 'frag-required'= Code 4, fragmentation required; 'host-unreachable'= Code 1, destination host unreachable; 'network-unreachable'= Code 0, destination network unreachable; 'port-unreachable'= Code 3, destination port unreachable; 'proto-unreachable'= Code 2, destination protocol unreachable; 'route-failed'= Code 5, source route failed;                                                                                                                                                                                                                      |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmpv6_type       |                               | ICMPv6 type number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | v6_any_type       |                               | Any ICMP type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_v6_type   |                               | 'dest-unreachable'= Type 1, destination unreachable; 'echo-reply'= Type 129, echo reply; 'echo-request'= Type 128, echo request; 'packet-too-big'= Type 2, packet too big; 'param-prob'= Type 4, parameter problem; 'time-exceeded'= Type 3, time exceeded;                                                                                                                                                                                                                                                                                                           |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | v6_any_code       |                               | Any ICMPv6 code                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | icmpv6_code       |                               | ICMPv6 code number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | special_v6_code   |                               | 'addr-unreachable'= Code 3, address unreachable; 'admin-prohibited'= Code 1, admin prohibited; 'no-route'= Code 0, no route to destination; 'not-neighbour'= Code 2, not neighbor; 'port-unreachable'= Code 4, destination port unreachable;                                                                                                                                                                                                                                                                                                                          |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | source            |                               | Source Port Information                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | eq_src            |                               | Match only packets on a given source port (port number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | gt_src            |                               | Match only packets with a greater source port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | lt_src            |                               | Match only packets with a lower source port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | range_src         |                               | match only packets in the range of source port numbers (Starting Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | port_num_end_src  |                               | Ending Source Port Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | eq_dst            |                               | Match only packets on a given destination port (port number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | gt_dst            |                               | Match only packets with a greater destination port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | lt_dst            |                               | Match only packets with a lesser destination port number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | range_dst         |                               | Match only packets in the range of destination port numbers (Starting Destination Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | port_num_end_dst  |                               | Ending Destination Port Number                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | alg               |                               | 'FTP'= Specify FTP ALG port range; 'TFTP'= Specify TFTP ALG port range; 'SIP'= Specify SIP ALG port range; 'DNS'= Specify DNS ALG port range; 'PPTP'= Specify PPTP ALG port range; 'RTSP'= Specify RTSP ALG port range;                                                                                                                                                                                                                                                                                                                                               |
|   |                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| uuid                  |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| user_tag              |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| 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

