Networking::Interfaces¶
Introduced : BIG-IP_v9.0
The Interface interface enables you to work with the definitions and
attributes contained in a device&aposs interface.
Methods¶
| Method | Description | Introduced |
| get_active_media | Gets the active media types of the specified interface names. | BIG-IP_v9.0 |
| get_actual_flow_control | Gets the actual/effective flow control types for the specified interfaces. | BIG-IP_v9.0 |
| get_all_statistics | Gets the statistics of all interfaces. | BIG-IP_v9.0 |
| get_bundle_state | Gets the bundle states of the specified interface names. | BIG-IP_v10.2.4 |
| get_description | Gets the descriptions for a set of interfaces. | BIG-IP_v11.0.0 |
| get_dual_media_state | Gets the states indicating whether the interface is a dual media port supporting both fixed copper and SFP. | BIG-IP_v9.0 |
| get_enabled_state | Gets the states of the specified interface names. | BIG-IP_v9.0 |
| get_if_index | Gets the IF indices for the specified interfaces. This is a unique identifier assigned to all objects displayed in the SNMP IF-MIB. | BIG-IP_v11.4.0 |
| get_learning_mode | Gets the configured learning modes of the specified interfaces. | BIG-IP_v9.0 |
| get_list | Gets a list of all interfaces on this device. | BIG-IP_v9.0 |
| get_lldp_admin_status | Gets the LLDP admin statuses of the specified interface names. | BIG-IP_v11.1.0 |
| get_lldp_tlvmap | Gets the LLDP tlvmap of the specified interface names. The tlvmap is a 32 bit bitmap to define which LLDP TLV will be transmitted. | BIG-IP_v11.1.0 |
| get_mac_address | Gets the MAC addresses of the specified interface names. | BIG-IP_v9.0 |
| get_media | Gets the configured media types of the specified interface names (settings for fixed, non-pluggable interfaces). | BIG-IP_v9.0 |
| get_media_option | Gets the media options for the specified interfaces. | BIG-IP_v9.0 |
| get_media_option_sfp | Gets the SFP media options for the specified interfaces. | BIG-IP_v9.0 |
| get_media_sfp | Gets the configured SFP media types of the specified interface names. | BIG-IP_v9.0 |
| get_media_speed | Gets the media speeds of the specified interface names. Unit = Mbps. | BIG-IP_v9.0 |
| get_media_status | Gets the media status of the specified interface names. | BIG-IP_v9.0 |
| get_mtu | Gets the MTUs of the specified interface names. | BIG-IP_v9.0 |
| get_phy_master_slave_mode | Gets the configured SFP media types of the specified interface names. | BIG-IP_v9.0 |
| get_prefer_sfp_state | Gets the states indicating that SFP is the preferred media. Only used for dual media ports. | BIG-IP_v9.0 |
| get_qinq_ether_type | Gets the QinQ ether type of the specified interface names. | BIG-IP_v11.6.0 |
| get_requested_flow_control | Gets the configured/requested flow control types for the specified interfaces. | BIG-IP_v9.0 |
| get_sflow_poll_interval | Gets the sFlow poll intervals for the specified interfaces. | BIG-IP_v11.4.0 |
| get_sflow_poll_interval_global | Gets the sFlow polling types for the specified interfaces. | BIG-IP_v11.4.0 |
| get_sfp_media_state | Gets the states indicating whether the interface supports SFP media. | BIG-IP_v9.0 |
| get_statistics | Gets the statistics of the specified interfaces. | BIG-IP_v9.0 |
| get_stp_active_edge_port_state | Gets the active states indicating whether the specified interfaces are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interfaces that connect to end stations rather than to other bridges. Note: This active state is reported by STP daemon. | BIG-IP_v9.0 |
| get_stp_auto_edge_port_detection_state | Gets the states indicating whether automatic detection of edge port status for the specified interfaces. When automatic edge port detection is enabled on an interface, the BIG-IP monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets are received for a sufficient period of time (about 3 seconds), the interface is automatically given edge port status. When automatic edge port detection is disabled on an interface, the BIG-IP never gives the interface edge port status automatically. By default, automatic edge port detection is enabled on all interfaces. | BIG-IP_v9.0 |
| get_stp_edge_port_state | Gets the states indicating whether the specified interfaces are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interfaces that connect to end stations rather than to other bridges. | BIG-IP_v9.0 |
| get_stp_enabled_state | Gets the states indicating whether the specified interfaces will participate in the spanning tree protocol. Disabling spanning tree protocol on an interface enables learning and forwarding on it. The spanning tree algorithm then behaves as if the interface did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the interface, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: Disabling spanning tree protocol on an interface which is a configured member of a trunk disables spanning tree protocol on the trunk as a whole. For a trunk to participate in spanning tree protocol, the protocol must be enabled on all of its configured member interfaces. | BIG-IP_v9.0 |
| get_stp_link_type | Gets the STP link types for the specified interfaces. | BIG-IP_v9.0 |
| get_stp_protocol_detection_reset_state | Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on the specified interfaces, until such time as a legacy STP bridge is detected again on those interfaces. Note: This method is only applicable when the current STP mode is RSTP or MSTP. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| reset_statistics | Resets the statistics of the specified interfaces. | BIG-IP_v9.0 |
| set_bundle_state | Sets the bundle states of the specified interface names. A bundle interface is one which represents a collection of interfaces such as QSFP+ modules which can act in aggregate or as a collection of individual interfaces. By enabling the bundle you activate the collection of interfaces to work as a single interface with the aggregate bandwidth of all interfaces in the bundle. When disabled, each interface in the bundle is configured to operate as an individual interface. A change in this setting can result in a reset of the data-plane, and thus may disrupt traffic. In particular, such a disruption will occur on version BIG-IP_v10.2.4. Note: bundles were introduced in BIP-IP v10.2.4 and v11.2.0; intervening releases precede the engineering of this feature and may not support it. | BIG-IP_v10.2.4 |
| set_description | Sets the description for a set of interfaces. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_enabled_state | Sets the states of the specified interface names. | BIG-IP_v9.0 |
| set_learning_mode | Sets the learning modes for the specified interfaces. | BIG-IP_v9.0 |
| set_lldp_admin_status | Sets the LLDP admin statuses for the specified interfaces. | BIG-IP_v11.1.0 |
| set_lldp_tlvmap | Sets the LLDP tlvmaps for the specified interfaces. The tlvmap is a 32 bit bitmap to define which LLDP TLV will be transmitted. TLV bitmap (32 bits): bit 0 is the least significant bit. BYTE 1: bit 0-7: Standard TLV 1-8. First 3 TLVs are mandatory. So bits 0-2 are actually unused. BYTE 2: bit 8-11: IEEE 802.1 TLVs. bit 12-15: IEEE 802.3 TLVs. Power MDI (bit 14) is not currently supported. BYTE 3: bit 16: F5 TLV product model. bit 17-23: reserved. BYTE 4: bit 24-31: reserved. | BIG-IP_v11.1.0 |
| set_media | Sets the media types of the specified interface names. (settings for fixed, non-pluggable interfaces). See set_media_fixed_or_sfp for a method you can use to set media type and not have to choose whether to affect settings for fixed or sfp media. | BIG-IP_v9.0 |
| set_media_fixed_or_sfp | Set the media types of the specified interface names, conveniently choosing fixed or SFP media automatically. When you set the media type using this method, the system automatically affects the correct media based on whether the interface is a small form factor pluggable (SFP) interface, or for combo ports (see get_dual_media_state method) whether SFP is the preferred port. (When you get the setting you&aposll still need to use the correct method, get_media or get_media_sfp.) You may manually affect the interface settings more directly by using the set_media or set_media_sfp methods. | BIG-IP_v10.0.0 |
| set_media_sfp | Sets the SFP media types of the specified interface names. | BIG-IP_v9.0 |
| set_phy_master_slave_mode | Sets the SFP media types of the specified interface names. | BIG-IP_v9.0 |
| set_prefer_sfp_state | Sets the states indicating that SFP is the preferred media. Only used for dual media ports. | BIG-IP_v9.0 |
| set_qinq_ether_type | Sets the QinQ ether type of the specified interface names. The ether type is a 16 bit field that is used to identify a frame. It preceeds the vlan tag field in the frame. | BIG-IP_v11.6.0 |
| set_requested_flow_control | Sets the configured/requested flow control types for the specified interfaces. | BIG-IP_v9.0 |
| set_sflow_poll_interval | Sets the sFlow poll intervals for the specified interfaces. This is the maximum interval in seconds between polling of the specified interfaces. You should set the poll intervals for the interfaces when you want the counters associated with these interfaces to be sampled at an interval that is different than the global sFlow poll interval. Note: you will also need to set the polling type to SFLOW_GLOBAL_NO (see set_sflow_poll_interval_global). The default is 0 (zero). | BIG-IP_v11.4.0 |
| set_sflow_poll_interval_global | Sets the sFlow polling types for the specified interfaces. It allows you to specify whether the global sFlow poll interval overrides the object-level poll interval for the specified interfaces. The default is SFLOW_GLOBAL_YES. | BIG-IP_v11.4.0 |
| set_stp_auto_edge_port_detection_state | Sets the states indicating whether automatic detection of edge port status for the specified interfaces. When automatic edge port detection is enabled on an interface, the BIG-IP monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets are received for a sufficient period of time (about 3 seconds), the interface is automatically given edge port status. When automatic edge port detection is disabled on an interface, the BIG-IP never gives the interface edge port status automatically. By default, automatic edge port detection is enabled on all interfaces. | BIG-IP_v9.0 |
| set_stp_edge_port_state | Sets the states indicating whether the specified interfaces are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interfaces that connect to end stations rather than to other bridges. | BIG-IP_v9.0 |
| set_stp_enabled_state | Sets the states indicating whether the specified interfaces will participate in the spanning tree protocol. Disabling spanning tree protocol on an interface enables learning and forwarding on it. The spanning tree algorithm then behaves as if the interface did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the interface, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: Disabling spanning tree protocol on an interface which is a configured member of a trunk disables spanning tree protocol on the trunk as a whole. For a trunk to participate in spanning tree protocol, the protocol must be enabled on all of its configured member interfaces. | BIG-IP_v9.0 |
| set_stp_link_type | Sets the STP link types for the specified interfaces. | BIG-IP_v9.0 |
| set_stp_protocol_detection_reset_state | Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on the specified interfaces, until such time as a legacy STP bridge is detected again on those interfaces. Note: This method is only applicable when the current STP mode is RSTP or MSTP. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes an interface&aposs media options.
A struct that describes an interface&aposs general statistics.
A struct that describes network interface statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| BundleState | This enum represents the bundle state of the interface, a parameter that is only used on interfaces which can act as bundles. An interface bundle is a collection of interfaces which work as a single interface in order to support the aggregate bandwidth of all of them. For example, QSFP+ interfaces form a 40Gbps interface bundle out of 4 SFP+ interfaces. Note: bundles were introduced in BIP-IP v10.2.4 and v11.2.0; intervening releases precede the engineering of this feature and may not support it. |
| LLDPAdminStatus | A list of LLDP admin Status. |
| MediaType | A list of interface media types. |
Aliases¶
| Alias | Type | Description |
| BundleSequenceSequence | BundleState [] [] | An alias for sequence of interface bundle sequences. |
| BundleStateSequence | BundleState [] | A sequence of interface bundle states. |
| InterfaceMediaOptionSequence | InterfaceMediaOption [] | A sequence of interface media options. |
| InterfaceStatisticEntrySequence | InterfaceStatisticEntry [] | A sequence of network interface statistics. |
| LLDPAdminStatusSequence | LLDPAdminStatus [] | A sequence of interface LLDP aAdmin Status. |
| MediaTypeSequence | MediaType [] | A sequence of interface media types. |
| MediaTypeSequenceSequence | MediaType [] [] | A alias for sequence of interface media types. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.