icontrol 0.3.1 → 0.3.2

data/lib/icontrol/networking/self_ip.rb

@@ -1,15 +1,17 @@
 module IControl::Networking
   ##
-  # The SelfIP interface enables you to work with the definitions and attributes contained in a device's Self IP.
+  # The SelfIP interface enables you to work with the definitions and attributes contained
+  # in a device's Self IP.
   class SelfIP < IControl::Base
 
     set_id_name "self_ips"
 
     ##
     # Creates this self IP addresses with extended attributes.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :vlan_names The VLANs that the new self IPs will be on.
     # @option opts [String] :netmasks The netmasks for the self IPs .
@@ -22,64 +24,71 @@ module IControl::Networking
 
     ##
     # Deletes all self IP addresses.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_all_self_ips
       super
     end
 
     ##
     # Deletes this self IP addresses.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_self_ip
       super
     end
 
     ##
     # Gets the floating states of this self IPs.
+    # @rspec_example
     # @return [EnabledState]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def floating_state
       super
     end
 
     ##
     # Gets a list of all self IPs on this device.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def list
       super
     end
 
     ##
     # Gets the netmasks of this self IPs.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def netmask
       super
     end
 
     ##
     # Gets the unit ids of this self IPs.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def unit_id
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
@@ -87,19 +96,23 @@ module IControl::Networking
 
     ##
     # Gets the VLANs with which this self IPs are associated.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def vlan
       super
     end
 
     ##
-    # Sets the floating states of this self IPs. Note: If floating state is being set to enabled, then unit ID will be set to 1 by default.	If floating state is being set to disabled, then unit ID will be set to 0.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Sets the floating states of this self IPs. Note: If floating state is being set to
+    # enabled, then unit ID will be set to 1 by default.	If floating state is being set
+    # to disabled, then unit ID will be set to 0.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Common::EnabledState] :states The floating states of the specified self IPs .
     def set_floating_state(opts)
@@ -109,9 +122,10 @@ module IControl::Networking
 
     ##
     # Sets the netmasks of this self IPs.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :netmasks The netmasks of the specified self IPs .
     def set_netmask(opts)
@@ -120,10 +134,13 @@ module IControl::Networking
     end
 
     ##
-    # Sets the unit ids of this self IPs. Note: If unit ID is being set to 0, then floating state will be set to disabled by default.	If unit ID is being set to 1 or 2, then floating state will be set to enabled.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Sets the unit ids of this self IPs. Note: If unit ID is being set to 0, then floating
+    # state will be set to disabled by default.	If unit ID is being set to 1 or 2, then
+    # floating state will be set to enabled.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [long] :unit_ids The unit ids of the specified self IPs .
     def set_unit_id(opts)
@@ -133,9 +150,10 @@ module IControl::Networking
 
     ##
     # Sets the VLANs with which this self IPs are associated.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :vlan_names The VLAN names.
     def set_vlan(opts)

data/lib/icontrol/networking/self_ip_port_lockdown.rb

@@ -1,27 +1,33 @@
 module IControl::Networking
   ##
-  # The SelfIPPortLockdown interface enables you to lock down protocols and ports on self IP addresses.
+  # The SelfIPPortLockdown interface enables you to lock down protocols and ports on
+  # self IP addresses.
   class SelfIPPortLockdown < IControl::Base
 
     set_id_name "access_lists"
 
     class ProtocolPort < IControl::Base::Struct; end
     class SelfIPAccess < IControl::Base::Struct; end
+    class AllowModeSequence < IControl::Base::Sequence ; end
+    class ProtocolPortSequence < IControl::Base::Sequence ; end
+    class SelfIPAccessSequence < IControl::Base::Sequence ; end
     # A list of access modes.
     class AllowMode < IControl::Base::Enumeration; end    ##
     # Adds the list of access methods, with optional protocols/ports, for this self IPs.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def add_allow_access_list
       super
     end
 
     ##
     # Adds to the default list of protocols/ports on which access is allowed.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Networking::SelfIPPortLockdown::ProtocolPort] :defaults The defaults protocols/ports to add.
     def add_default_protocol_port_access_list(opts)
@@ -31,19 +37,21 @@ module IControl::Networking
 
     ##
     # Deletes protocols and ports from the allow access list for this self IPs.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def delete_allow_access_list
       super
     end
 
     ##
     # Gets the access list for this self IPs.
+    # @rspec_example
     # @return [SelfIPAccess]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [String] :self_ips The self IPs .
     def allow_access_list(opts)
@@ -53,26 +61,30 @@ module IControl::Networking
 
     ##
     # Gets the default protocol/port access list on which access is allowed.
+    # @rspec_example
     # @return [ProtocolPort]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def default_protocol_port_access_list
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
     end
 
     ##
-    # Remove protocols and ports from the default list of protocols/ports on which access is allowed.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # Remove protocols and ports from the default list of protocols/ports on which access
+    # is allowed.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     # @param [Hash] opts
     # @option opts [IControl::Networking::SelfIPPortLockdown::ProtocolPort] :defaults The defaults protocols/ports to remove.
     def remove_default_protocol_port_access_list(opts)
@@ -93,11 +105,11 @@ module IControl::Networking
     # A structure that defines the access mode for the specified self IP.
     # @attr [String] self_ip The self IP address.
     # @attr [IControl::Networking::SelfIPPortLockdown::AllowMode] mode The access mode for the self IP.
-    # @attr [IControl::Networking::SelfIPPortLockdown::ProtocolPort] protocol_ports The list of protocols/ports for which access is allowed.
+    # @attr [IControl::Networking::SelfIPPortLockdown::ProtocolPortSequence] protocol_ports The list of protocols/ports for which access is allowed.
     class SelfIPAccess < IControl::Base::Struct
       icontrol_attribute :self_ip, String
       icontrol_attribute :mode, IControl::Networking::SelfIPPortLockdown::AllowMode
-      icontrol_attribute :protocol_ports, IControl::Networking::SelfIPPortLockdown::ProtocolPort
+      icontrol_attribute :protocol_ports, IControl::Networking::SelfIPPortLockdown::ProtocolPortSequence
     end
 
 

data/lib/icontrol/networking/stp_globals.rb

@@ -1,165 +1,217 @@
 module IControl::Networking
   ##
-  # The STPGlobals interface enables you to work with global attributes used to configure STP (Spanning Tree Protocol).
+  # The STPGlobals interface enables you to work with global attributes used to configure
+  # STP (Spanning Tree Protocol).
   class STPGlobals < IControl::Base
 
     set_id_name "value"
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [String]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def configuration_identifier
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def configuration_revision
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def forward_delay
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def hello_time
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def maximum_age
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def maximum_hop
       super
     end
 
     ##
     # Gets the STP mode.
+    # @rspec_example
     # @return [STPModeType]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def mode
       super
     end
 
     ##
-    # 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.
+    # 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.
+    # @rspec_example
     # @return [long]
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def transmit_hold
       super
     end
 
     ##
     # Gets the version information for this interface.
+    # @rspec_example
     # @return [String]
     def version
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_configuration_identifier
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_configuration_revision
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_forward_delay
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_hello_time
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_maximum_age
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_maximum_hop
       super
     end
 
     ##
     # Sets the STP mode.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_mode
       super
     end
 
     ##
-    # 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.
-    # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
-    # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
-    # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
+    # 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.
+    # @rspec_example
+    # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
+    # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
+    # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
     def set_transmit_hold
       super
     end