Class: IControl::Networking::STPGlobals

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/networking/stp_globals.rb,
lib/icontrol/networking.rb

Overview

The STPGlobals interface enables you to work with global attributes used to configure STP (Spanning Tree Protocol).

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#configuration_identifierString

Gets the configuration identifier name in a spanning tree region, used to identify a group of adjacent bridges with identical configuration name, configuration revision levels, and assignments of VLANs to spanning tree instances. This setting is used only when the STP mode is MSTP, however the user may set it in any STP mode.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



19
20
21
# File 'lib/icontrol/networking/stp_globals.rb', line 19

def configuration_identifier
  super
end

#configuration_revisionlong

Gets the configuration revision level of the MSTP configuration. It's used only when the STP mode is MSTP, however, the user may set it in any STP mode.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



31
32
33
# File 'lib/icontrol/networking/stp_globals.rb', line 31

def configuration_revision
  super
end

#forward_delaylong

Gets the forward delay parameter, which controls how long an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. The default valu is 15 seconds, and the valid range is 4-30 seconds. Note that this parameter has no effect when the STP mode is RSPT or MSTP, as long as all bridges in the spanning tree use the RSTP or MSTP protocol.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



46
47
48
# File 'lib/icontrol/networking/stp_globals.rb', line 46

def forward_delay
  super
end

#hello_timelong

Gets the hello time, which is the time interval in seconds between the periodic transmissions that communicate spanning tree information to the adjacent bridges in the network. The default valu is 2 seconds, and the valid range is 1-10 seconds.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



59
60
61
# File 'lib/icontrol/networking/stp_globals.rb', line 59

def hello_time
  super
end

#maximum_agelong

Gets the maximum age parameter, which controls how long spanning tree information received from other bridges is considered valid. The default valu is 20 seconds, and the valid range is 6-40 seconds.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



72
73
74
# File 'lib/icontrol/networking/stp_globals.rb', line 72

def maximum_age
  super
end

#maximum_hoplong

Gets the maximum hops an MSTP packet may travel before it is discarded. It's used only when the STP mode is MSTP, however, the user may set it in any STP mode.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



84
85
86
# File 'lib/icontrol/networking/stp_globals.rb', line 84

def maximum_hop
  super
end

#modeSTPModeType

Gets the STP mode.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



95
96
97
# File 'lib/icontrol/networking/stp_globals.rb', line 95

def mode
  super
end

#set_configuration_identifierObject

Sets the configuration identifier name in a spanning tree region, used to identify a group of adjacent bridges with identical configuration name, configuration revision levels, and assignments of VLANs to spanning tree instances. This setting is used only when the STP mode is MSTP, however the user may set it in any STP mode.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



131
132
133
# File 'lib/icontrol/networking/stp_globals.rb', line 131

def set_configuration_identifier
  super
end

#set_configuration_revisionObject

Sets the configuration revision level of the MSTP configuration. It's used only when the STP mode is MSTP, however, the user may set it in any STP mode.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



142
143
144
# File 'lib/icontrol/networking/stp_globals.rb', line 142

def set_configuration_revision
  super
end

#set_forward_delayObject

Sets the forward delay parameter, which controls how long an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. The default valu is 15 seconds, and the valid range is 4-30 seconds. Note that this parameter has no effect when the STP mode is RSPT or MSTP, as long as all bridges in the spanning tree use the RSTP or MSTP protocol.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



156
157
158
# File 'lib/icontrol/networking/stp_globals.rb', line 156

def set_forward_delay
  super
end

#set_hello_timeObject

Sets the hello time, which is the time interval in seconds between the periodic transmissions that communicate spanning tree information to the adjacent bridges in the network. The default valu is 2 seconds, and the valid range is 1-10 seconds.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



168
169
170
# File 'lib/icontrol/networking/stp_globals.rb', line 168

def set_hello_time
  super
end

#set_maximum_ageObject

Sets the maximum age parameter, which controls how long spanning tree information received from other bridges is considered valid. The default valu is 20 seconds, and the valid range is 6-40 seconds.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



180
181
182
# File 'lib/icontrol/networking/stp_globals.rb', line 180

def set_maximum_age
  super
end

#set_maximum_hopObject

Sets the maximum hops an MSTP packet may travel before it is discarded. It's used only when the STP mode is MSTP, however, the user may set it in any STP mode.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



191
192
193
# File 'lib/icontrol/networking/stp_globals.rb', line 191

def set_maximum_hop
  super
end

#set_modeObject

Sets the STP mode.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



201
202
203
# File 'lib/icontrol/networking/stp_globals.rb', line 201

def set_mode
  super
end

#set_transmit_holdObject

Sets the transmit hold count parameter, which is an absolute limit on the number of spanning tree protocol packets the BIG-IP may transmit on a port in any hello time interval. This ensures that the spanning tree packets will not unduly load the network even in unstable conditions. The default valu is 6 packets, and the valid range is 1-10 packets.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



215
216
217
# File 'lib/icontrol/networking/stp_globals.rb', line 215

def set_transmit_hold
  super
end

#transmit_holdlong

Gets the transmit hold count parameter, which is an absolute limit on the number of spanning tree protocol packets the BIG-IP may transmit on a port in any hello time interval. This ensures that the spanning tree packets will not unduly load the network even in unstable conditions. The default valu is 6 packets, and the valid range is 1-10 packets.

Returns:

  • (long)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



110
111
112
# File 'lib/icontrol/networking/stp_globals.rb', line 110

def transmit_hold
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


118
119
120
# File 'lib/icontrol/networking/stp_globals.rb', line 118

def version
  super
end