Class: IControl::Networking::Interfaces
- Inherits:
-
Base
- Object
- Base
- IControl::Networking::Interfaces
- Defined in:
- lib/icontrol/networking/interfaces.rb,
lib/icontrol/networking.rb
Overview
The Interface interface enables you to work with the definitions and attributes contained in a device’s interface.
Defined Under Namespace
Classes: InterfaceMediaOption, InterfaceMediaOptionSequence, InterfaceStatisticEntry, InterfaceStatisticEntrySequence, InterfaceStatistics, MediaType, MediaTypeSequence, MediaTypeSequenceSequence
Instance Method Summary collapse
-
#active_media ⇒ MediaType
Gets the active media types of this interface names.
-
#actual_flow_control ⇒ FlowControlType
Gets the actual/effective flow control types for this interface.
-
#all_statistics ⇒ InterfaceStatistics
Gets the statistics of all interface.
-
#dual_media_state ⇒ EnabledState
Gets the states indicating whether the interface is a dual media port supporting both fixed copper and SFP.
-
#enabled_state ⇒ EnabledState
Gets the states of this interface names.
-
#learning_mode ⇒ LearningMode
Gets the configured learning modes of this interface.
-
#list ⇒ String
Gets a list of all interface on this device.
-
#mac_address ⇒ String
Gets the MAC addresses of this interface names.
-
#media ⇒ MediaType
Gets the configured media types of this interface names (settings for fixed, non-pluggable interface).
-
#media_option ⇒ InterfaceMediaOption
Gets the media options for this interface.
-
#media_option_sfp ⇒ InterfaceMediaOption
Gets the SFP media options for this interface.
-
#media_sfp ⇒ MediaType
Gets the configured SFP media types of this interface names.
-
#media_speed ⇒ long
Gets the media speeds of this interface names.
-
#media_status ⇒ MediaStatus
Gets the media status of this interface names.
-
#mtu ⇒ long
Gets the MTUs of this interface names.
-
#phy_master_slave_mode ⇒ PhyMasterSlaveMode
Gets the configured SFP media types of this interface names.
-
#prefer_sfp_state ⇒ EnabledState
Gets the states indicating that SFP is the preferred media.
-
#requested_flow_control ⇒ FlowControlType
Gets the configured/requested flow control types for this interface.
-
#reset_statistics ⇒ Object
Resets the statistics of this interface.
-
#set_enabled_state(opts) ⇒ Object
Sets the states of this interface names.
-
#set_learning_mode(opts) ⇒ Object
Sets the learning modes for this interface.
-
#set_media(opts) ⇒ Object
Sets the media types of this interface names.
-
#set_media_fixed_or_sfp(opts) ⇒ Object
Set the media types of this interface names, conveniently choosing fixed or SFP media automatically.
-
#set_media_sfp(opts) ⇒ Object
Sets the SFP media types of this interface names.
-
#set_phy_master_slave_mode(opts) ⇒ Object
Sets the SFP media types of this interface names.
-
#set_prefer_sfp_state(opts) ⇒ Object
Sets the states indicating that SFP is the preferred media.
-
#set_requested_flow_control(opts) ⇒ Object
Sets the configured/requested flow control types for this interface.
-
#set_stp_auto_edge_port_detection_state(opts) ⇒ Object
Sets the states indicating whether automatic detection of edge port status for this interface.
-
#set_stp_edge_port_state(opts) ⇒ Object
Sets the states indicating whether this interface are edge ports or not.
-
#set_stp_enabled_state(opts) ⇒ Object
Sets the states indicating whether this interface will participate in the spanning tree protocol.
-
#set_stp_link_type(opts) ⇒ Object
Sets the STP link types for this interface.
-
#set_stp_protocol_detection_reset_state(opts) ⇒ Object
Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this interface, until such time as a legacy STP bridge is detected again on those interface.
-
#sfp_media_state ⇒ EnabledState
Gets the states indicating whether the interface supports SFP media.
-
#statistics ⇒ InterfaceStatistics
Gets the statistics of this interface.
-
#stp_active_edge_port_state ⇒ EnabledState
Gets the active states indicating whether this interface are edge ports or not.
-
#stp_auto_edge_port_detection_state ⇒ EnabledState
Gets the states indicating whether automatic detection of edge port status for this interface.
-
#stp_edge_port_state ⇒ EnabledState
Gets the states indicating whether this interface are edge ports or not.
-
#stp_enabled_state ⇒ EnabledState
Gets the states indicating whether this interface will participate in the spanning tree protocol.
-
#stp_link_type ⇒ STPLinkType
Gets the STP link types for this interface.
-
#stp_protocol_detection_reset_state ⇒ EnabledState
Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this interface, until such time as a legacy STP bridge is detected again on those interface.
-
#version ⇒ String
Gets the version information for this interface.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class IControl::Base
Instance Method Details
#active_media ⇒ MediaType
Gets the active media types of this interface names.
24 25 26 |
# File 'lib/icontrol/networking/interfaces.rb', line 24 def active_media super end |
#actual_flow_control ⇒ FlowControlType
Gets the actual/effective flow control types for this interface.
35 36 37 |
# File 'lib/icontrol/networking/interfaces.rb', line 35 def actual_flow_control super end |
#all_statistics ⇒ InterfaceStatistics
Gets the statistics of all interface.
46 47 48 |
# File 'lib/icontrol/networking/interfaces.rb', line 46 def all_statistics super end |
#dual_media_state ⇒ EnabledState
Gets the states indicating whether the interface is a dual media port supporting both fixed copper and SFP.
58 59 60 |
# File 'lib/icontrol/networking/interfaces.rb', line 58 def dual_media_state super end |
#enabled_state ⇒ EnabledState
Gets the states of this interface names.
69 70 71 |
# File 'lib/icontrol/networking/interfaces.rb', line 69 def enabled_state super end |
#learning_mode ⇒ LearningMode
Gets the configured learning modes of this interface.
80 81 82 |
# File 'lib/icontrol/networking/interfaces.rb', line 80 def learning_mode super end |
#list ⇒ String
Gets a list of all interface on this device.
91 92 93 |
# File 'lib/icontrol/networking/interfaces.rb', line 91 def list super end |
#mac_address ⇒ String
Gets the MAC addresses of this interface names.
102 103 104 |
# File 'lib/icontrol/networking/interfaces.rb', line 102 def mac_address super end |
#media ⇒ MediaType
Gets the configured media types of this interface names (settings for fixed, non-pluggable interface).
114 115 116 |
# File 'lib/icontrol/networking/interfaces.rb', line 114 def media super end |
#media_option ⇒ InterfaceMediaOption
Gets the media options for this interface.
125 126 127 |
# File 'lib/icontrol/networking/interfaces.rb', line 125 def media_option super end |
#media_option_sfp ⇒ InterfaceMediaOption
Gets the SFP media options for this interface.
136 137 138 |
# File 'lib/icontrol/networking/interfaces.rb', line 136 def media_option_sfp super end |
#media_sfp ⇒ MediaType
Gets the configured SFP media types of this interface names.
147 148 149 |
# File 'lib/icontrol/networking/interfaces.rb', line 147 def media_sfp super end |
#media_speed ⇒ long
Gets the media speeds of this interface names. Unit = Mbps.
158 159 160 |
# File 'lib/icontrol/networking/interfaces.rb', line 158 def media_speed super end |
#media_status ⇒ MediaStatus
Gets the media status of this interface names.
169 170 171 |
# File 'lib/icontrol/networking/interfaces.rb', line 169 def media_status super end |
#mtu ⇒ long
Gets the MTUs of this interface names.
180 181 182 |
# File 'lib/icontrol/networking/interfaces.rb', line 180 def mtu super end |
#phy_master_slave_mode ⇒ PhyMasterSlaveMode
Gets the configured SFP media types of this interface names.
191 192 193 |
# File 'lib/icontrol/networking/interfaces.rb', line 191 def phy_master_slave_mode super end |
#prefer_sfp_state ⇒ EnabledState
Gets the states indicating that SFP is the preferred media. Only used for dual media ports.
203 204 205 |
# File 'lib/icontrol/networking/interfaces.rb', line 203 def prefer_sfp_state super end |
#requested_flow_control ⇒ FlowControlType
Gets the configured/requested flow control types for this interface.
214 215 216 |
# File 'lib/icontrol/networking/interfaces.rb', line 214 def requested_flow_control super end |
#reset_statistics ⇒ Object
Resets the statistics of this interface.
342 343 344 |
# File 'lib/icontrol/networking/interfaces.rb', line 342 def reset_statistics super end |
#set_enabled_state(opts) ⇒ Object
Sets the states of this interface names.
354 355 356 357 |
# File 'lib/icontrol/networking/interfaces.rb', line 354 def set_enabled_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#set_learning_mode(opts) ⇒ Object
Sets the learning modes for this interface.
367 368 369 370 |
# File 'lib/icontrol/networking/interfaces.rb', line 367 def set_learning_mode(opts) opts = check_params(opts,[:modes]) super(opts) end |
#set_media(opts) ⇒ Object
Sets the media types of this interface names. (settings for fixed, non-pluggable interface). 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.
382 383 384 385 |
# File 'lib/icontrol/networking/interfaces.rb', line 382 def set_media(opts) opts = check_params(opts,[:media_types]) super(opts) end |
#set_media_fixed_or_sfp(opts) ⇒ Object
Set the media types of this 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’ll 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.
401 402 403 404 |
# File 'lib/icontrol/networking/interfaces.rb', line 401 def set_media_fixed_or_sfp(opts) opts = check_params(opts,[:media_types]) super(opts) end |
#set_media_sfp(opts) ⇒ Object
Sets the SFP media types of this interface names.
414 415 416 417 |
# File 'lib/icontrol/networking/interfaces.rb', line 414 def set_media_sfp(opts) opts = check_params(opts,[:media_types]) super(opts) end |
#set_phy_master_slave_mode(opts) ⇒ Object
Sets the SFP media types of this interface names.
427 428 429 430 |
# File 'lib/icontrol/networking/interfaces.rb', line 427 def set_phy_master_slave_mode(opts) opts = check_params(opts,[:modes]) super(opts) end |
#set_prefer_sfp_state(opts) ⇒ Object
Sets the states indicating that SFP is the preferred media. Only used for dual media ports.
441 442 443 444 |
# File 'lib/icontrol/networking/interfaces.rb', line 441 def set_prefer_sfp_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#set_requested_flow_control(opts) ⇒ Object
Sets the configured/requested flow control types for this interface.
454 455 456 457 |
# File 'lib/icontrol/networking/interfaces.rb', line 454 def set_requested_flow_control(opts) opts = check_params(opts,[:flow_controls]) super(opts) end |
#set_stp_auto_edge_port_detection_state(opts) ⇒ Object
Sets the states indicating whether automatic detection of edge port status for this interface. 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 interface.
473 474 475 476 |
# File 'lib/icontrol/networking/interfaces.rb', line 473 def set_stp_auto_edge_port_detection_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#set_stp_edge_port_state(opts) ⇒ Object
Sets the states indicating whether this interface are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interface that connect to end stations rather than to other bridges.
488 489 490 491 |
# File 'lib/icontrol/networking/interfaces.rb', line 488 def set_stp_edge_port_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#set_stp_enabled_state(opts) ⇒ Object
Sets the states indicating whether this interface 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 interface.
509 510 511 512 |
# File 'lib/icontrol/networking/interfaces.rb', line 509 def set_stp_enabled_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#set_stp_link_type(opts) ⇒ Object
Sets the STP link types for this interface.
522 523 524 525 |
# File 'lib/icontrol/networking/interfaces.rb', line 522 def set_stp_link_type(opts) opts = check_params(opts,[:link_types]) super(opts) end |
#set_stp_protocol_detection_reset_state(opts) ⇒ Object
Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this interface, until such time as a legacy STP bridge is detected again on those interface. Note: This method is only applicable when the current STP mode is RSTP or MSTP.
538 539 540 541 |
# File 'lib/icontrol/networking/interfaces.rb', line 538 def set_stp_protocol_detection_reset_state(opts) opts = check_params(opts,[:states]) super(opts) end |
#sfp_media_state ⇒ EnabledState
Gets the states indicating whether the interface supports SFP media.
225 226 227 |
# File 'lib/icontrol/networking/interfaces.rb', line 225 def sfp_media_state super end |
#statistics ⇒ InterfaceStatistics
Gets the statistics of this interface.
236 237 238 |
# File 'lib/icontrol/networking/interfaces.rb', line 236 def statistics super end |
#stp_active_edge_port_state ⇒ EnabledState
Gets the active states indicating whether this interface are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interface that connect to end stations rather than to other bridges. Note: This active state is reported by STP daemon.
250 251 252 |
# File 'lib/icontrol/networking/interfaces.rb', line 250 def stp_active_edge_port_state super end |
#stp_auto_edge_port_detection_state ⇒ EnabledState
Gets the states indicating whether automatic detection of edge port status for this interface. 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 interface.
267 268 269 |
# File 'lib/icontrol/networking/interfaces.rb', line 267 def stp_auto_edge_port_detection_state super end |
#stp_edge_port_state ⇒ EnabledState
Gets the states indicating whether this interface are edge ports or not. The spanning tree algorithms include important optimizations that can only be used on so-called edge ports, i.e. interface that connect to end stations rather than to other bridges.
280 281 282 |
# File 'lib/icontrol/networking/interfaces.rb', line 280 def stp_edge_port_state super end |
#stp_enabled_state ⇒ EnabledState
Gets the states indicating whether this interface 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 interface.
299 300 301 |
# File 'lib/icontrol/networking/interfaces.rb', line 299 def stp_enabled_state super end |
#stp_link_type ⇒ STPLinkType
Gets the STP link types for this interface.
310 311 312 |
# File 'lib/icontrol/networking/interfaces.rb', line 310 def stp_link_type super end |
#stp_protocol_detection_reset_state ⇒ EnabledState
Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP mode) to be sent on this interface, until such time as a legacy STP bridge is detected again on those interface. Note: This method is only applicable when the current STP mode is RSTP or MSTP.
324 325 326 |
# File 'lib/icontrol/networking/interfaces.rb', line 324 def stp_protocol_detection_reset_state super end |
#version ⇒ String
Gets the version information for this interface.
332 333 334 |
# File 'lib/icontrol/networking/interfaces.rb', line 332 def version super end |