a10_object_group_service

Synopsis

Configure Service Object Group

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

svc_name

str/required

Service Object Group Name

description

str

Description of the object-group instance

rules

list

Field rules

seq_num

int

Sequence number

protocol_id

int

Protocol ID

tcp_udp

str

‘tcp’= Protocol TCP; ‘udp’= Protocol UDP;

icmp

bool

Internet Control Message Protocol

icmpv6

bool

Internet Control Message Protocol version 6

icmp_type

int

ICMP type number

any_type

bool

Any ICMP type

special_type

str

‘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;

any_code

bool

Any ICMP code

icmp_code

int

ICMP code number

special_code

str

‘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;

icmpv6_type

int

ICMPv6 type number

v6_any_type

bool

Any ICMP type

special_v6_type

str

‘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;

v6_any_code

bool

Any ICMPv6 code

icmpv6_code

int

ICMPv6 code number

special_v6_code

str

‘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;

source

bool

Source Port Information

eq_src

int

Match only packets on a given source port (port number)

gt_src

int

Match only packets with a greater source port number

lt_src

int

Match only packets with a lower source port number

range_src

int

match only packets in the range of source port numbers (Starting Port Number)

port_num_end_src

int

Ending Source Port Number

eq_dst

int

Match only packets on a given destination port (port number)

gt_dst

int

Match only packets with a greater destination port number

lt_dst

int

Match only packets with a lesser destination port number

range_dst

int

Match only packets in the range of destination port numbers (Starting Destination Port Number)

port_num_end_dst

int

Ending Destination Port Number

alg

str

‘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;

uuid

str

uuid of the object

user_tag

str

Customized tag

Examples


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