a10_axdebug

Synopsis

Packet Trace Options

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

count

int

Maximum packets to capture per cpu. Default is 3000. (Maximum packets to capture. For umlimited, specify 0)

incoming

bool

Incoming interface. (For all ports, don’t specify port number.)

inc_port_num

str

Port Numbers separated by commas(,) and hyphens(-) without spaces. ex= 4,5,10-30, or separated by spaces and double-quoted(‘)

outgoing

bool

Outgoing interface (For all ports, don’t specify port number.)

out_port_num

str

Port Numbers separated by commas(,) and hyphens(-) without spaces. ex= 4,5,10-30, or separated by spaces and double-quoted(‘)

length

int

Packet length to capture

maxfile

int

Maximum number of debug packet files. Default is 100

sess_filter_dis

bool

Disable session based filter

timeout

int

Maximum number of minutes for a capture. Default is 5 minutes. For unlimited, specify 0

uuid

str

uuid of the object

apply_config

dict

Field apply_config

config_file

str

config file name

save_config

dict

Field save_config

config_file

str

config file name

default

bool

save to default config file

delete

dict

Field delete

capture_file

str

Delete a capture file (Specify target filename to change)

config_file

str

Delete AXDebug config file (Specify target filename to change)

exit

dict

Field exit

stop_capture

bool

stop capture traffic

capture

dict

Field capture

brief

bool

Print basic packet information

detail

bool

Include packet payload

save

str

Save packets into file (Specify filename to save packets)

current_slot

bool

Only for current-slot of chassis

no_stop

bool

Non-stop execution

filter_config_list

list

Field filter_config_list

number

int

Specify filter id

l3_proto

str

‘arp’= arp; ‘neighbor’= neighbor;

dst

bool

Destination

src

bool

Src

ip

bool

IP

ipv4_address

str

ip address

ipv4_netmask

str

IP subnet mask

ipv6

bool

IPV6

ipv6_address

str

ipv6 address

mac

bool

mac address

mac_addr

str

mac address

port

bool

port configurations

dst_ip

bool

dest IP

dst_ipv4_address

str

dest ip address

src_ip

bool

src IP

src_ipv4_address

str

src ip address

dst_mac

bool

dest mac address

dst_mac_addr

str

dest mac address

src_mac

bool

src mac address

src_mac_addr

str

src mac address

dst_port

bool

dest port number

dst_port_num

int

dest Port number

src_port

bool

src port number

src_port_num

int

src Port number

port_num_min

int

min port number

port_num_max

int

max port number

proto

bool

ip protocol number

proto_val

str

‘icmp’= icmp; ‘icmpv6’= icmpv6; ‘tcp’= tcp; ‘udp’= udp;

prot_num

int

protocol number

offset

int

byte offset

length

int

byte length

oper_range

str

‘gt’= greater than; ‘gte’= greater than or equal to; ‘se’= smaller than or equal to; ‘st’= smaller than; ‘eq’= equal to; ‘range’= select a range;

hex

bool

Define hex value

min_hex

str

min value

max_hex

str

max value

comp_hex

str

value to compare

integer

bool

Define decimal value

integer_min

int

min value

integer_max

int

max value

integer_comp

int

value to compare

word

bool

Define hex value

WORD0

str

WORD0 to compare

WORD1

str

WORD min value

WORD2

str

WORD max value

exit

bool

Exit from axdebug mode

uuid

str

uuid of the object

user_tag

str

Customized tag

pcapng_config

dict

Field pcapng_config

pcapng_enable

bool

Enable pcapng

ssl_key_enable

bool

Enable ssl key tracking

exit

bool

Exit from axdebug pcapng mode

uuid

str

uuid of the object

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