APIRef_tm_net_interfaceΒΆ
mgmt/tm/net/interface
Interface configuration and statistics
REST Endpoints
- Collection URI
/mgmt/tm/net/interface- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/net/interface/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, POST- Resource Natural Key
name
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
bundle |
string | not-supported | optional | read/write | Enables or disables bundle capability. |
bundleSpeed |
string | not-supported | optional | read/write | Sets the bundle speed. The speed is applicable only when the bundle is enabled. |
description |
string | optional | read/write | User defined description. | |
disabled |
boolean | true | optional | read/write | Disables the specified interfaces from passing traffic. |
enabled |
boolean | true | optional | read/write | Enables the specified interfaces to pass traffic. |
flowControl |
string | tx-rx | optional | read/write | Specifies how the system controls the sending of PAUSE frames. The default value is tx-rx. |
forceGigabitFiber |
string | disabled | optional | read/write | Enables or disables forcing of gigabit fiber media. If this is enabled for a gigabit fiber interface, the media setting will be forced, and no auto-negotiation will be performed. If it is disabled, auto-negotiation will be performed with just a single gigabit fiber option advertised. |
forwardErrorCorrection |
string | not-supported | optional | read/write | Enables or disables IEEE 802.3bm Clause 91 Reed-Solomon Forward Error Correction (RS-FEC) on 100G interfaces. Not valid for LR4 media. |
ifAlias |
string | optional | read/write | ||
ifIndex |
integer | 0 | optional | read/write | Displays the index assigned to this interface. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB. |
lldpAdmin |
string | txonly | optional | read/write | |
lldpTlvmap |
integer | 130943 | optional | read/write | |
macAddress |
string | optional | read/write | Displays the MAC address (6-byte Ethernet address in hexadecimal colon notation, for example, 00:0b:09:88:00:9a) of the interface. This is the hardware address. | |
media |
string | none | optional | read/write | Specifies the settings for the interface. When you set the media option, the system automatically sets the media-sfp or media-fixed option based on whether the interface is a small form factor pluggable (SFP) interface, or for combo ports whether SFP is the preferred port. |
mediaActive |
string | none | optional | read/write | Displays the current media settings for the interface. |
mediaFixed |
string | auto | optional | read/write | 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. |
mediaMax |
string | none | optional | read/write | Displays the maximum media value for the interface. |
mediaSfp |
string | auto | optional | read/write | 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. |
moduleDescription |
string | optional | read/write | ||
mtu |
integer | 1500 | optional | read/write | Displays the maximum Transmission Unit (MTU) of the interface, which is the maximum number of bytes in a frame without IP fragmentation. |
portFwdMode |
string | l3 | optional | read/write | |
preferPort |
string | sfp | optional | read/write | 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. |
qinqEthertype |
string | 0x8100 | optional | read/write | Specifies the protocol identifier associated with the tagged mode of the interface. |
serial |
string | optional | read/write | Displays the serial number of the pluggable unit on an interface. | |
stp |
string | enabled | optional | read/write | Enables or disables STP. If you disable STP, no STP, RSTP, or MSTP packets are transmitted or received on the interface or trunk, and spanning tree has no control over forwarding or learning on the port or the trunk. The default value is enabled. |
stpAutoEdgePort |
string | enabled | optional | read/write | Sets STP automatic edge port detection for the interface. The default value is true. When automatic edge port detection is set to true for an interface, 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 automatic edge port detection is set to false for an interface, 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. |
stpEdgePort |
string | true | optional | read/write | Specifies whether the interface connects to an end station instead of another spanning tree bridge. The default value is true. |
stpLinkType |
string | auto | optional | read/write | Specifies the STP link type for the interface. The default value is auto. The spanning tree system includes important optimizations that can only be used on point-to-point links, that is, on links which connect just two bridges. If these optimizations are used on shared links, incorrect or unstable behavior may result. By default, the implementation assumes that full-duplex links are point-to-point and that half-duplex links are shared. |
stpReset |
boolean | false | optional | read/write | Resets STP, which forces a migration check. |
vendor |
string | optional | read/write | Displays the name of the vendor of the pluggable unit on an interface. | |
vendorOui |
string | optional | read/write | ||
vendorPartnum |
string | optional | read/write | ||
vendorRevision |
string | optional | read/write |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/sflow |
array_structure | optional | read/write | ||
/sflow/poll-interval |
integer | 0 | optional | read/write | Specifies the maximum interval in seconds between two pollings. To enable this setting, you must also set the poll-interval-global setting to no. |
/sflow/poll-interval-global |
string | yes | optional | read/write | Specifies whether the global interface poll-interval setting overrides the object-level poll-interval setting. The default value is yes. |
/sflow/poll-interval |
integer | 0 | optional | read/write | Specifies the maximum interval in seconds between two pollings. To enable this setting, you must also set the poll-interval-global setting to no. |
/sflow/poll-interval-global |
string | yes | optional | read/write | Specifies whether the global interface poll-interval setting overrides the object-level poll-interval setting. The default value is yes. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.