a10_interface_ethernet

Synopsis

Ethernet interface

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
ifnum str/required			Ethernet interface number
name str			Name for the interface
port_scan_detection str			‘enable’= Enable port scan detection; ‘disable’= Disable port scan detection(default);
ping_sweep_detection str			‘enable’= Enabl ping sweep detection; ‘disable’= Disable ping sweep detection(default);
l3_vlan_fwd_disable bool			Field l3_vlan_fwd_disable
load_interval int			Configure Load Interval (Seconds (5-300, Multiple of 5), default 300)
media_type_copper bool			Set the media type to copper
auto_neg_enable bool			enable auto-negotiation
fec_forced_on bool			turn on the FEC
fec_forced_off bool			turn off the FEC
port_breakout str			‘4x10G’= Breakout 100G/40G ports into 4x10G ports; ‘4x25G’= Breakout 100G ports into 4x25G ports; ‘2x50G’= Breakout 100G ports into 2x50G ports;
speed_forced_1g bool			force the speed to be 1G on 25G link
speed_forced_10g bool			force the speed to be 10G on 25G link
speed_forced_40g bool			force the speed to be 40G on 100G link
ipg_bit_time int			Set Inter-packet-gap interval in bit timing, default is 96
remove_vlan_tag bool			Remove the vlan tag for egressing packets
mtu int			Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6))
trap_source bool			The trap source
duplexity str			‘Full’= Full; ‘Half’= Half; ‘auto’= auto;
speed str			‘10’= 10; ‘100’= 100; ‘1000’= 1000; ‘auto’= auto;
flow_control bool			Enable 802.3x flow control on full duplex port
action str			‘enable’= Enable; ‘disable’= Disable;
icmp_rate_limit dict			Field icmp_rate_limit
	normal int		Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit
	lockup int		Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)
	lockup_period int		Lockup period (second)
icmpv6_rate_limit dict			Field icmpv6_rate_limit
	normal_v6 int		Normal rate limit. If exceeds this limit, drop the ICMP packet that goes over the limit
	lockup_v6 int		Enter lockup state when ICMP rate exceeds lockup rate limit (Maximum rate limit. If exceeds this limit, drop all ICMP packet for a time period)
	lockup_period_v6 int		Lockup period (second)
monitor_list list			Field monitor_list
	monitor str		‘input’= Incoming packets; ‘output’= Outgoing packets; ‘both’= Both incoming and outgoing packets;
	mirror_index int		Mirror index
	monitor_vlan int		VLAN number
cpu_process bool			All Packets to this port are processed by CPU
cpu_process_dir str			‘primary’= Primary board; ‘blade’= blade board; ‘hash-dip’= Hash based on the Destination IP; ‘hash-sip’= Hash based on the Source IP; ‘hash-dmac’= Hash based on the Destination MAC; ‘hash-smac’= Hash based on the Source MAC;
traffic_distribution_mode str			‘sip’= sip; ‘dip’= dip; ‘primary’= primary; ‘blade’= blade; ‘l4-src-port’= l4-src-port; ‘l4-dst-port’= l4-dst-port;
virtual_wire bool			Mark ethernet as a virtual wire interface
update_l2_info bool			Update and use received L2 information
vlan_learning str			‘enable’= Enable VLAN learning; ‘disable’= Disable VLAN learning;
mac_learning str			‘enable’= Enable MAC learning; ‘disable’= Disable MAC learning; ‘dmac-only’= Enable destination MAC learning only;
access_list dict			Field access_list
	acl_id int		ACL id
	acl_name str		Apply an access list (Named Access List)
gaming_protocol_compliance bool			Enable Gaming Protocol Compliance Check
uuid str			uuid of the object
user_tag str			Customized tag
sampling_enable list			Field sampling_enable
	counters1 str		‘all’= all; ‘packets_input’= Input packets; ‘bytes_input’= Input bytes; ‘received_broadcasts’= Received broadcasts; ‘received_multicasts’= Received multicasts; ‘received_unicasts’= Received unicasts; ‘input_errors’= Input errors; ‘crc’= CRC; ‘frame’= Frames; ‘runts’= Runts; ‘giants’= Giants; ‘packets_output’= Output packets; ‘bytes_output’= Output bytes; ‘transmitted_broadcasts’= Transmitted broadcasts; ‘transmitted_multicasts’= Transmitted multicasts; ‘transmitted_unicasts’= Transmitted unicasts; ‘output_errors’= Output errors; ‘collisions’= Collisions; ‘giants_output’= Output Giants; ‘rate_pkt_sent’= Packet sent rate packets/sec; ‘rate_byte_sent’= Byte sent rate bits/sec; ‘rate_pkt_rcvd’= Packet received rate packets/sec; ‘rate_byte_rcvd’= Byte received rate bits/sec; ‘load_interval’= Load Interval; ‘drops’= Drops; ‘input_utilization’= Input Utilization; ‘output_utilization’= Output Utilization;
packet_capture_template str			Name of the packet capture template to be bind with this object
lldp dict			Field lldp
	enable_cfg dict		Field enable_cfg
	notification_cfg dict		Field notification_cfg
	tx_dot1_cfg dict		Field tx_dot1_cfg
	tx_tlvs_cfg dict		Field tx_tlvs_cfg
	uuid str		uuid of the object
ddos dict			Field ddos
	outside bool		DDoS outside (untrusted) interface
	inside bool		DDoS inside (trusted) interface
	uuid str		uuid of the object
ip dict			Field ip
	dhcp bool		Use DHCP to configure IP address
	address_list list		Field address_list
	allow_promiscuous_vip bool		Allow traffic to be associated with promiscuous VIP
	cache_spoofing_port bool		This interface connects to spoofing cache
	helper_address_list list		Field helper_address_list
	inside bool		Configure interface as inside
	outside bool		Configure interface as outside
	ttl_ignore bool		Ignore TTL decrement for a received packet before sending out
	syn_cookie bool		Configure Enable SYN-cookie on the interface
	slb_partition_redirect bool		Redirect SLB traffic across partition
	generate_membership_query bool		Enable Membership Query
	query_interval int		1 - 255 (Default is 125)
	max_resp_time int		Maximum Response Time (Max Response Time (Default is 100))
	client bool		Client facing interface for IPv4/v6 traffic
	server bool		Server facing interface for IPv4/v6 traffic
	unnumbered bool		Set the interface as unnumbered
	uuid str		uuid of the object
	stateful_firewall dict		Field stateful_firewall
	router dict		Field router
	rip dict		Field rip
	ospf dict		Field ospf
ipv6 dict			Field ipv6
	address_list list		Field address_list
	inside bool		Configure interface as inside
	outside bool		Configure interface as outside
	ipv6_enable bool		Enable IPv6 processing
	ttl_ignore bool		Ignore TTL decrement for a received packet before sending out
	access_list_cfg dict		Field access_list_cfg
	router_adver dict		Field router_adver
	uuid str		uuid of the object
	stateful_firewall dict		Field stateful_firewall
	router dict		Field router
	rip dict		Field rip
	ospf dict		Field ospf
nptv6 dict			Field nptv6
	domain_list list		Field domain_list
map dict			Field map
	inside bool		Configure MAP inside interface (connected to MAP domains)
	outside bool		Configure MAP outside interface
	map_t_inside bool		Configure MAP inside interface (connected to MAP domains)
	map_t_outside bool		Configure MAP outside interface
	uuid str		uuid of the object
lw_4o6 dict			Field lw_4o6
	outside bool		Configure LW-4over6 inside interface
	inside bool		Configure LW-4over6 outside interface
	uuid str		uuid of the object
trunk_group_list list			Field trunk_group_list
	trunk_number int		Trunk Number
	ntype str		‘static’= Static (default); ‘lacp’= lacp; ‘lacp-udld’= lacp-udld;
	admin_key int		LACP admin key (Admin key value)
	port_priority int		Set LACP priority for a port (LACP port priority)
	udld_timeout_cfg dict		Field udld_timeout_cfg
	mode str		‘active’= enable initiation of LACP negotiation on a port(default); ‘passive’= disable initiation of LACP negotiation on a port;
	timeout str		‘long’= Set LACP long timeout (default); ‘short’= Set LACP short timeout;
	uuid str		uuid of the object
	user_tag str		Customized tag
bfd dict			Field bfd
	authentication dict		Field authentication
	echo bool		Enable BFD Echo
	demand bool		Demand mode
	interval_cfg dict		Field interval_cfg
	uuid str		uuid of the object
isis dict			Field isis
	authentication dict		Field authentication
	bfd_cfg dict		Field bfd_cfg
	circuit_type str		‘level-1’= Level-1 only adjacencies are formed; ‘level-1-2’= Level-1-2 adjacencies are formed; ‘level-2-only’= Level-2 only adjacencies are formed;
	csnp_interval_list list		Field csnp_interval_list
	padding bool		Add padding to IS-IS hello packets
	hello_interval_list list		Field hello_interval_list
	hello_interval_minimal_list list		Field hello_interval_minimal_list
	hello_multiplier_list list		Field hello_multiplier_list
	lsp_interval int		Set LSP transmission interval (LSP transmission interval (milliseconds))
	mesh_group dict		Field mesh_group
	metric_list list		Field metric_list
	network str		‘broadcast’= Specify IS-IS broadcast multi-access network; ‘point-to-point’= Specify IS-IS point-to-point network;
	password_list list		Field password_list
	priority_list list		Field priority_list
	retransmit_interval int		Set per-LSP retransmission interval (Interval between retransmissions of the same LSP (seconds))
	wide_metric_list list		Field wide_metric_list
	uuid str		uuid of the object
spanning_tree dict			Field spanning_tree
	auto_edge bool		Enable auto-edge
	admin_edge bool		Enable admin-edge
	instance_list list		Field instance_list
	path_cost int		Path cost (Limit)
	uuid str		uuid of the object
oper dict			Field oper
	state str		Field state
	line_protocol str		Field line_protocol
	link_type str		Field link_type
	mac str		Field mac
	config_speed str		Field config_speed
	actual_speed str		Field actual_speed
	config_duplexity str		Field config_duplexity
	actual_duplexity str		Field actual_duplexity
	media_type str		Field media_type
	ipv4_address str		IP address
	ipv4_netmask str		IP subnet mask
	ipv4_addr_count int		Field ipv4_addr_count
	ipv4_list list		Field ipv4_list
	ipv6_addr_count int		Field ipv6_addr_count
	ipv6_list list		Field ipv6_list
	ipv6_link_local str		Field ipv6_link_local
	ipv6_link_local_prefix str		Field ipv6_link_local_prefix
	ipv6_link_local_type str		Field ipv6_link_local_type
	ipv6_link_local_scope str		Field ipv6_link_local_scope
	igmp_query_sent int		Field igmp_query_sent
	icmp_rate_limit_current int		Field icmp_rate_limit_current
	icmp_rate_over_limit_drop int		Field icmp_rate_over_limit_drop
	icmp6_rate_limit_current int		Field icmp6_rate_limit_current
	icmp6_rate_over_limit_drop int		Field icmp6_rate_over_limit_drop
	is_tagged int		Field is_tagged
	vlan_id int		Field vlan_id
	tagged_vlan_list str		Field tagged_vlan_list
	span_mode str		Field span_mode
	span_port_state str		Field span_port_state
	is_lead_member int		Field is_lead_member
	is_blocked int		Field is_blocked
	current_vnp_id int		Field current_vnp_id
	port_vnp_id int		Field port_vnp_id
	is_pristine int		Field is_pristine
	rate_byte_rcvd int		Field rate_byte_rcvd
	rate_byte_sent int		Field rate_byte_sent
	rate_pkt_rcvd int		Field rate_pkt_rcvd
	rate_pkt_sent int		Field rate_pkt_sent
	input_utilization int		Field input_utilization
	output_utilization int		Field output_utilization
	is_device_transparent int		Field is_device_transparent
	incoming_pkts_mirrored int		Field incoming_pkts_mirrored
	outgoing_pkts_mirrored int		Field outgoing_pkts_mirrored
	incoming_pkts_monitored int		Field incoming_pkts_monitored
	outgoing_pkts_monitored int		Field outgoing_pkts_monitored
	ip_unnumbered_oper int		Field ip_unnumbered_oper
	ip_unnumbered_enabled int		Field ip_unnumbered_enabled
	ip_unnumbered_mac_learned int		Field ip_unnumbered_mac_learned
	ip_unnumbered_peer_lla str		Field ip_unnumbered_peer_lla
	last_count_clear_at str		Field last_count_clear_at
	last_up_event_at str		Field last_up_event_at
	last_down_event_at str		Field last_down_event_at
	ifnum str		Ethernet interface number
stats dict			Field stats
	packets_input str		Input packets
	bytes_input str		Input bytes
	received_broadcasts str		Received broadcasts
	received_multicasts str		Received multicasts
	received_unicasts str		Received unicasts
	input_errors str		Input errors
	crc str		CRC
	frame str		Frames
	runts str		Runts
	giants str		Giants
	packets_output str		Output packets
	bytes_output str		Output bytes
	transmitted_broadcasts str		Transmitted broadcasts
	transmitted_multicasts str		Transmitted multicasts
	transmitted_unicasts str		Transmitted unicasts
	output_errors str		Output errors
	collisions str		Collisions
	giants_output str		Output Giants
	rate_pkt_sent str		Packet sent rate packets/sec
	rate_byte_sent str		Byte sent rate bits/sec
	rate_pkt_rcvd str		Packet received rate packets/sec
	rate_byte_rcvd str		Byte received rate bits/sec
	load_interval str		Load Interval
	drops str		Drops
	input_utilization str		Input Utilization
	output_utilization str		Output Utilization
	ifnum str		Ethernet interface number

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