Networking::Trunk¶
Introduced : BIG-IP_v9.0
The Trunk interface enables you to work with the definitions and
attributes contained in a device&aposs trunk.
Methods¶
| Method | Description | Introduced |
| add_interface | Adds the lists of interfaces to the specified trunks. | BIG-IP_v9.0 |
| create | Creates the specified trunks. | BIG-IP_v9.0 |
| delete_all_trunks | Deletes all trunks. | BIG-IP_v9.0 |
| delete_trunk | Deletes the specified trunks. | BIG-IP_v9.0 |
| get_active_lacp_state | Gets the states indicating whether LACP is operating in active or passive mode. When operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces or LACP-enabled trunks unless an LACP frame is first received on that interface or trunk. When operating in active mode, LACP immediately begins sending LACP frames from LACP-enabled interfaces and trunks. | BIG-IP_v9.0 |
| get_all_statistics | Gets the statistics of all trunks. | BIG-IP_v9.0 |
| get_configured_member_count | Gets the number of configured links of the specified trunks. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of trunks. | BIG-IP_v11.0.0 |
| get_distribution_hash_option | Gets the frame distribution hashing option used by the specified trunks. | BIG-IP_v9.0 |
| get_interface | Gets the list of interfaces associated with the specified trunks. | BIG-IP_v9.0 |
| get_lacp_enabled_state | Gets the states indicating whether LACP is enabled/disabled for the specified trunks. | BIG-IP_v9.0 |
| get_lacp_timeout_option | Gets LACP timeout options for the specified trunks. | BIG-IP_v9.0 |
| get_link_selection_policy | Gets the link selection policies used by the specified trunks. | BIG-IP_v9.0 |
| get_list | Gets a list of all trunks on this device. | BIG-IP_v9.0 |
| get_media_speed | Gets the current operational media speeds of the specified trunks. Unit = Mbps. This will be equivalent to the sum of the speeds of all operational links in a particular trunk. | BIG-IP_v9.0 |
| get_media_status | Gets the media status of the specified trunks. | BIG-IP_v9.0 |
| get_operational_member_count | Gets the current number of operational links of the specified trunks. | BIG-IP_v9.0 |
| get_qinq_ether_type | Gets the QinQ ether type of the specified trunks. | BIG-IP_v11.6.0 |
| get_statistics | Gets the statistics of the specified trunks. | BIG-IP_v9.0 |
| get_stp_enabled_state | Gets the states indicating whether the specified trunks will participate in the spanning tree protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding on it. The spanning tree algorithm then behaves as if the trunk did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: 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_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 trunks, until such time as a legacy STP bridge is detected again on those trunks. 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 |
| remove_all_interfaces | Removes all interfaces from the specified trunks. | BIG-IP_v9.0 |
| remove_interface | Removes the lists of interfaces from the specified trunks. | BIG-IP_v9.0 |
| reset_statistics | Resets the statistics of the specified trunks. | BIG-IP_v9.0 |
| set_active_lacp_state | Gets the states indicating whether LACP is operating in active or passive mode. When operating in passive mode, LACP will not send LACP frames out LACP-enabled interfaces or LACP-enabled trunks unless an LACP frame is first received on that interface or trunk. When operating in active mode, LACP immediately begins sending LACP frames from LACP-enabled interfaces and trunks. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of trunks. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_distribution_hash_option | Sets the frame distribution hashing option used by the specified trunks. | BIG-IP_v9.0 |
| set_lacp_enabled_state | Sets the states indicating whether LACP is enabled/disabled for the specified trunks. | BIG-IP_v9.0 |
| set_lacp_timeout_option | Gets LACP timeout options for the specified trunks. | BIG-IP_v9.0 |
| set_link_selection_policy | Sets the link selection policies used by the specified trunks. | BIG-IP_v9.0 |
| set_qinq_ether_type | Sets the QinQ ether type of the specified trunks. 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_stp_enabled_state | Sets the states indicating whether the specified trunks will participate in the spanning tree protocol. Disabling spanning tree protocol on a trunk enables learning and forwarding on it. The spanning tree algorithm then behaves as if the trunk did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the trunk, and the spanning tree algorithm exerts no control over forwarding or learning on the port. NOTE: 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_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 trunks, until such time as a legacy STP bridge is detected again on those trunks. 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 a trunk&aposs general statistics.
A struct that describes trunk statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| DistributionHashOption | A list of frame distribution hashing options used to select which link to send the frame on, to maintain packet order. |
| LACPTimeoutOption | A list of LACP timeout options. |
| LinkSelectionPolicy | A list of link selection policies. |
Aliases¶
| Alias | Type | Description |
| DistributionHashOptionSequence | DistributionHashOption [] | A sequence of hashing options. |
| LACPTimeoutOptionSequence | LACPTimeoutOption [] | A sequence of LACP timeout options. |
| LinkSelectionPolicySequence | LinkSelectionPolicy [] | A sequence of link selection policies. |
| TrunkStatisticEntrySequence | TrunkStatisticEntry [] | A sequence of trunk statistics. |
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.