f5networks.f5_modules.bigip_interface – Module to manage BIG-IP physical interfaces.

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_interface.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Module to manage BIG-IP physical interfaces.

Parameters

Parameter		Choices/Defaults	Comments
bundle string		Choices: enabled disabled not-supported	Enables or disables bundle capability. This option is only supported on select hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure.
bundle_speed string		Choices: 100G 40G not-supported	Sets the bundle speed, which is applicable only when the bundle is `yes`. This option is only supported on selected hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure.
description string			User defined description.
enabled boolean		Choices: no yes	Specifies the current status of the interface. When `yes`, enables the interface to pass traffic. When `no`, disables the interface from passing traffic.
flow_control string		Choices: none rx tx tx-rx	Specifies how the system controls the sending of PAUSE frames. When `tx-rx`, the interface honors pause frames from its partner, and also generates pause frames when necessary. When `tx`, the interface ignores pause frames from its partner, and generates pause frames when necessary. When `rx`, the interface honors pause frames from its partner, but does not generate pause frames. When (none), the flow control is disabled on the interface.
force_gigabit_fiber boolean		Choices: no yes	Enables or disables forcing of gigabit fiber media. When `yes` for a gigabit fiber interface, the media setting will be forced, and no auto-negotiation will be performed. When `no` auto-negotiation will be performed with just a single gigabit fiber option advertised.
forward_error_correction string		Choices: enabled disabled not-supported auto	Enables or disables IEEE 802.3bm Clause 91 Reed-Solomon Forward Error Correction on 100G interfaces. Not valid for LR4 media. This option is only supported on selected hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure.
lldp_admin string		Choices: disable rxonly txonly txrx	Specifies LLDP settings on an interface level. When `disabled`, the interface neither transmits (sends) LLDP messages to nor receives LLDP messages from neighboring devices. When `txonly`, the interface transmits LLDP messages to neighbor devices, but does not receive LLDP messages from neighbor devices. When `rxonly`, the interface receives LLDP messages from neighbor devices, but does not transmit LLDP messages to neighbor devices. When `txrx`, the interface transmits LLDP messages to and receives LLDP messages from neighboring devices.
lldp_tlvmap integer			Specifies the content of an LLDP message being sent or received. Each LLDP attribute specified with this setting is optional and is in the form of Type, Length, Value (TLV). The three mandatory TLVs not taken into account when calculating this value are: `Chassis ID`, `Port ID`, and `TTL`. The optional attributes that are available have a specific TLV numeric value mapped to them. The `Port Description` attribute has a TLV value of `8`. The `System Name` attribute has a TLV value of `16`. The `System Description` attribute has a TLV value of `32`. The `System Capabilities` attribute has a TLV value of `64`. The `Management Address` attribute has a TLV value of `128`. The `Port VLAN ID` attribute has a TLV value of `256`. The `VLAN Name` attribute has a TLV value of `512`. The `Port and Protocol VLAN ID` attribute has a TLV value of `1024`. The `Protocol Identity` attribute has a TLV value of `2048`. The `MAC/PHY Config Status` attribute has a TLV value of `4096`. The `Link Aggregation` attribute has a TLV value of `8192`. The `Max Frame Size` attribute has a TLV value of `32768`. The `Product Model` attribute has a TLV value of `65536`. The `lldp_tlvmap` is a numeric value that is a sum of all TLV values of selected attributes. Setting `lldp_tlvmap` to `0` will remove all attributes from the interface. Setting `lldp_tlvmap` to `114680` will add all attributes to the interface.
media_fixed string		Choices: 100000-FD 100000LR4-FD 10000LR-FD 10000T-FD 1000SX-FD 100TX-FD 10T-HD 20000-FD 40000LR4-FD 100000AR4-FD 100000SR4-FD 10000SFPCU-FD 1000CX-FD 1000T-FD 100TX-HD 12000-FD 21000-FD 40000SR4-FD 100000CR4-FD 10000ER-FD 10000SR-FD 1000LX-FD 1000T-HD 10T-FD 16000-FD 40000-FD 42000-FD auto no-phy	Specifies the settings for a fixed (non-pluggable) interface. Use this option only with a combo port to specify the media type for the fixed interface, when it is not the preferred port.
media_sfp string		Choices: 100000-FD 100000LR4-FD 10000LR-FD 10000T-FD 1000SX-FD 100TX-FD 10T-HD 20000-FD 40000LR4-FD 100000AR4-FD 100000SR4-FD 10000SFPCU-FD 1000CX-FD 1000T-FD 100TX-HD 12000-FD 21000-FD 40000SR4-FD 100000CR4-FD 10000ER-FD 10000SR-FD 1000LX-FD 1000T-HD 10T-FD 16000-FD 40000-FD 42000-FD auto no-phy	Specifies the settings for an SFP (pluggable) interface. Use this option only with a combo port to specify the media type for the SFP interface, when it is not the preferred port.
name string / required			Specifies the name of the interface to manage.
port_fwd_mode string		Choices: l3 passive virtual-wire	Specifies the operation mode.
prefer_port string		Choices: sfp fixed	Indicates which side of a combo port the interface uses, if both sides have the potential for an external link. The default value for a combo port is sfp. Do not use this option for non-combo ports.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TEEM`.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	timeout integer		Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
	validate_certs boolean	Choices: no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
sflow dictionary			Specifies sFlow settings for the interface.
	poll_interval integer		Specifies the maximum interval between two pollings, in seconds. For this setting to take effect, `poll_interval_global` must be set to `no`. The valid range is 0 - 4294967295.
	poll_interval_global boolean	Choices: no yes	Specifies whether the global interface `poll_interval` setting overrides the object-level `poll_interval` setting. When `yes` the `poll_interval` setting does not take effect.
stp boolean		Choices: no yes	Enables or disables STP.
stp_auto_edge_port boolean		Choices: no yes	Sets STP automatic edge port detection for the interface. When `yes`, the system monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets are received for a sufficient period of time (about three seconds), the interface is automatically given edge port status. When `no`, the system never gives the interface edge port status automatically. Any STP setting set on a per-interface basis applies to all spanning tree instances.
stp_edge_port boolean		Choices: no yes	Specifies whether the interface connects to an end station instead of another spanning tree bridge.
stp_link_type string		Choices: auto p2p shared	Specifies the STP link type for the interface.

Notes

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Update Interface Settings
  bigip_interface:
    name: 1.1
    stp: yes
    stp_auto_edge_port: no
    stp_edge_port: yes
    stp_link_type: shared
    description: my description
    flow_control: tx
    lldp_admin: txrx
    lldp_tlvmap: 8
    force_gigabit_fiber: no
    sflow:
      - poll_interval: 10
      - poll_interval_global: no
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Disable Interface
  bigip_interface:
    name: 1.1
    enabled: no
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change sflow interface settings
  bigip_interface:
    name: 1.1
    sflow:
      - poll_interval: 0
      - poll_interval_global: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
bundle string		changed	Enables or disables bundle capability. Sample: not-supported
bundle_speed string		changed	The bundle speed. Sample: 100G
description string		changed	User defined description. Sample: my description
enabled boolean		changed	The current status of the interface. Sample: True
flow_control string		changed	Specifies how the system controls the sending of PAUSE frames. Sample: tx
force_gigabit_fiber boolean		changed	Enables or disables forcing of gigabit fiber media. Sample: True
forward_error_correction string		changed	Enables or disables Forward Error Correction. Sample: auto
lldp_admin string		changed	The LLDP settings on an interface level. Sample: txrx
lldp_tlvmap integer		changed	The content of an LLDP message being sent or received. Sample: 136
media_fixed string		changed	The settings for a fixed interface. Sample: 100000-FD
media_sfp string		changed	The settings for a SFP interface. Sample: 100000-FD
port_fwd_mode string		changed	The operation mode. Sample: passive
prefer_port string		changed	The side of a combo port the interface uses. Sample: fixed
sflow complex		changed	Specifies sFlow settings for the interface. Sample: hash/dictionary of values
	poll_interval integer	changed	The maximum interval in seconds between two pollings. Sample: 128
	poll_interval_global boolean	changed	The global sFlow settings override. Sample: True
stp boolean		changed	Enables or disables STP.
stp_auto_edge_port boolean		changed	Sets STP automatic edge port detection for the interface. Sample: True
stp_edge_port boolean		changed	Specifies whether the interface connects to an end station instead of another spanning tree bridge.
stp_link_type string		changed	The STP link type for the interface. Sample: shared

Authors

Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_interface_module.html