icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,6 +1,7 @@
1
1
  module IControl::Networking
2
2
  ##
3
- # The Interface interface enables you to work with the definitions and attributes contained in a device's interface.
3
+ # The Interface interface enables you to work with the definitions and attributes contained
4
+ # in a device's interface.
4
5
  class Interfaces < IControl::Base
5
6
 
6
7
  set_id_name "interfaces"
@@ -8,269 +9,325 @@ module IControl::Networking
8
9
  class InterfaceMediaOption < IControl::Base::Struct; end
9
10
  class InterfaceStatisticEntry < IControl::Base::Struct; end
10
11
  class InterfaceStatistics < IControl::Base::Struct; end
12
+ class InterfaceMediaOptionSequence < IControl::Base::Sequence ; end
13
+ class InterfaceStatisticEntrySequence < IControl::Base::Sequence ; end
14
+ class MediaTypeSequence < IControl::Base::Sequence ; end
15
+ class MediaTypeSequenceSequence < IControl::Base::SequenceSequence ; end
11
16
  # A list of interface media types.
12
17
  class MediaType < IControl::Base::Enumeration; end ##
13
18
  # Gets the active media types of this interface names.
19
+ # @rspec_example
14
20
  # @return [MediaType]
15
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
21
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
18
24
  def active_media
19
25
  super
20
26
  end
21
27
 
22
28
  ##
23
29
  # Gets the actual/effective flow control types for this interface.
30
+ # @rspec_example
24
31
  # @return [FlowControlType]
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
27
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
28
35
  def actual_flow_control
29
36
  super
30
37
  end
31
38
 
32
39
  ##
33
40
  # Gets the statistics of all interface.
41
+ # @rspec_example
34
42
  # @return [InterfaceStatistics]
35
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
43
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
38
46
  def all_statistics
39
47
  super
40
48
  end
41
49
 
42
50
  ##
43
- # Gets the states indicating whether the interface is a dual media port supporting both fixed copper and SFP.
51
+ # Gets the states indicating whether the interface is a dual media port supporting
52
+ # both fixed copper and SFP.
53
+ # @rspec_example
44
54
  # @return [EnabledState]
45
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
46
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
47
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
55
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
56
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
57
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
48
58
  def dual_media_state
49
59
  super
50
60
  end
51
61
 
52
62
  ##
53
63
  # Gets the states of this interface names.
64
+ # @rspec_example
54
65
  # @return [EnabledState]
55
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
56
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
57
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
66
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
67
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
68
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
58
69
  def enabled_state
59
70
  super
60
71
  end
61
72
 
62
73
  ##
63
74
  # Gets the configured learning modes of this interface.
75
+ # @rspec_example
64
76
  # @return [LearningMode]
65
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
77
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
78
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
79
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
68
80
  def learning_mode
69
81
  super
70
82
  end
71
83
 
72
84
  ##
73
85
  # Gets a list of all interface on this device.
86
+ # @rspec_example
74
87
  # @return [String]
75
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
88
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
91
  def list
79
92
  super
80
93
  end
81
94
 
82
95
  ##
83
96
  # Gets the MAC addresses of this interface names.
97
+ # @rspec_example
84
98
  # @return [String]
85
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
99
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
88
102
  def mac_address
89
103
  super
90
104
  end
91
105
 
92
106
  ##
93
- # Gets the configured media types of this interface names (settings for fixed, non-pluggable interface).
107
+ # Gets the configured media types of this interface names (settings for fixed, non-pluggable
108
+ # interface).
109
+ # @rspec_example
94
110
  # @return [MediaType]
95
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
111
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
112
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
113
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
114
  def media
99
115
  super
100
116
  end
101
117
 
102
118
  ##
103
119
  # Gets the media options for this interface.
120
+ # @rspec_example
104
121
  # @return [InterfaceMediaOption]
105
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
122
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
123
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
124
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
108
125
  def media_option
109
126
  super
110
127
  end
111
128
 
112
129
  ##
113
130
  # Gets the SFP media options for this interface.
131
+ # @rspec_example
114
132
  # @return [InterfaceMediaOption]
115
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
133
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
134
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
135
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
118
136
  def media_option_sfp
119
137
  super
120
138
  end
121
139
 
122
140
  ##
123
141
  # Gets the configured SFP media types of this interface names.
142
+ # @rspec_example
124
143
  # @return [MediaType]
125
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
144
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
145
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
146
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
128
147
  def media_sfp
129
148
  super
130
149
  end
131
150
 
132
151
  ##
133
152
  # Gets the media speeds of this interface names. Unit = Mbps.
153
+ # @rspec_example
134
154
  # @return [long]
135
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
155
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
156
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
157
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
138
158
  def media_speed
139
159
  super
140
160
  end
141
161
 
142
162
  ##
143
163
  # Gets the media status of this interface names.
164
+ # @rspec_example
144
165
  # @return [MediaStatus]
145
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
146
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
147
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
166
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
167
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
168
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
148
169
  def media_status
149
170
  super
150
171
  end
151
172
 
152
173
  ##
153
174
  # Gets the MTUs of this interface names.
175
+ # @rspec_example
154
176
  # @return [long]
155
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
156
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
157
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
177
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
178
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
179
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
158
180
  def mtu
159
181
  super
160
182
  end
161
183
 
162
184
  ##
163
185
  # Gets the configured SFP media types of this interface names.
186
+ # @rspec_example
164
187
  # @return [PhyMasterSlaveMode]
165
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
166
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
167
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
188
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
189
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
190
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
168
191
  def phy_master_slave_mode
169
192
  super
170
193
  end
171
194
 
172
195
  ##
173
- # Gets the states indicating that SFP is the preferred media. Only used for dual media ports.
196
+ # Gets the states indicating that SFP is the preferred media. Only used for dual media
197
+ # ports.
198
+ # @rspec_example
174
199
  # @return [EnabledState]
175
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
176
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
177
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
200
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
201
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
202
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
178
203
  def prefer_sfp_state
179
204
  super
180
205
  end
181
206
 
182
207
  ##
183
208
  # Gets the configured/requested flow control types for this interface.
209
+ # @rspec_example
184
210
  # @return [FlowControlType]
185
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
186
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
187
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
211
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
188
214
  def requested_flow_control
189
215
  super
190
216
  end
191
217
 
192
218
  ##
193
219
  # Gets the states indicating whether the interface supports SFP media.
220
+ # @rspec_example
194
221
  # @return [EnabledState]
195
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
196
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
197
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
222
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
223
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
224
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
198
225
  def sfp_media_state
199
226
  super
200
227
  end
201
228
 
202
229
  ##
203
230
  # Gets the statistics of this interface.
231
+ # @rspec_example
204
232
  # @return [InterfaceStatistics]
205
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
233
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
234
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
235
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
208
236
  def statistics
209
237
  super
210
238
  end
211
239
 
212
240
  ##
213
- # 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.
241
+ # Gets the active states indicating whether this interface are edge ports or not. The
242
+ # spanning tree algorithms include important optimizations that can only be used on
243
+ # so-called edge ports, i.e. interface that connect to end stations rather than to
244
+ # other bridges. Note: This active state is reported by STP daemon.
245
+ # @rspec_example
214
246
  # @return [EnabledState]
215
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
216
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
217
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
247
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
248
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
249
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
218
250
  def stp_active_edge_port_state
219
251
  super
220
252
  end
221
253
 
222
254
  ##
223
- # 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.
255
+ # Gets the states indicating whether automatic detection of edge port status for this
256
+ # interface. When automatic edge port detection is enabled on an interface, the BIG-IP
257
+ # monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets
258
+ # are received for a sufficient period of time (about 3 seconds), the interface is
259
+ # automatically given edge port status. When automatic edge port detection is disabled
260
+ # on an interface, the BIG-IP never gives the interface edge port status automatically.
261
+ # By default, automatic edge port detection is enabled on all interface.
262
+ # @rspec_example
224
263
  # @return [EnabledState]
225
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
226
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
227
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
264
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
265
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
266
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
228
267
  def stp_auto_edge_port_detection_state
229
268
  super
230
269
  end
231
270
 
232
271
  ##
233
- # 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.
272
+ # Gets the states indicating whether this interface are edge ports or not. The spanning
273
+ # tree algorithms include important optimizations that can only be used on so-called
274
+ # edge ports, i.e. interface that connect to end stations rather than to other bridges.
275
+ # @rspec_example
234
276
  # @return [EnabledState]
235
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
236
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
237
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
277
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
278
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
279
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
238
280
  def stp_edge_port_state
239
281
  super
240
282
  end
241
283
 
242
284
  ##
243
- # 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.
285
+ # Gets the states indicating whether this interface will participate in the spanning
286
+ # tree protocol. Disabling spanning tree protocol on an interface enables learning
287
+ # and forwarding on it. The spanning tree algorithm then behaves as if the interface
288
+ # did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the interface,
289
+ # and the spanning tree algorithm exerts no control over forwarding or learning on
290
+ # the port. NOTE: Disabling spanning tree protocol on an interface which is a configured
291
+ # member of a trunk disables spanning tree protocol on the trunk as a whole. For a
292
+ # trunk to participate in spanning tree protocol, the protocol must be enabled on all
293
+ # of its configured member interface.
294
+ # @rspec_example
244
295
  # @return [EnabledState]
245
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
246
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
247
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
296
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
297
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
298
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
248
299
  def stp_enabled_state
249
300
  super
250
301
  end
251
302
 
252
303
  ##
253
304
  # Gets the STP link types for this interface.
305
+ # @rspec_example
254
306
  # @return [STPLinkType]
255
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
256
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
257
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
307
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
308
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
309
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
258
310
  def stp_link_type
259
311
  super
260
312
  end
261
313
 
262
314
  ##
263
- # 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.
315
+ # Gets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
316
+ # mode) to be sent on this interface, until such time as a legacy STP bridge is detected
317
+ # again on those interface. Note: This method is only applicable when the current STP
318
+ # mode is RSTP or MSTP.
319
+ # @rspec_example
264
320
  # @return [EnabledState]
265
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
266
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
267
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
321
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
322
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
323
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
268
324
  def stp_protocol_detection_reset_state
269
325
  super
270
326
  end
271
327
 
272
328
  ##
273
329
  # Gets the version information for this interface.
330
+ # @rspec_example
274
331
  # @return [String]
275
332
  def version
276
333
  super
@@ -278,18 +335,20 @@ module IControl::Networking
278
335
 
279
336
  ##
280
337
  # Resets the statistics of this interface.
281
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
282
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
283
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
338
+ # @rspec_example
339
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
340
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
341
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
284
342
  def reset_statistics
285
343
  super
286
344
  end
287
345
 
288
346
  ##
289
347
  # Sets the states of this interface names.
290
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
348
+ # @rspec_example
349
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
350
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
351
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
293
352
  # @param [Hash] opts
294
353
  # @option opts [IControl::Common::EnabledState] :states The states to set for the specified interfaces.
295
354
  def set_enabled_state(opts)
@@ -299,9 +358,10 @@ module IControl::Networking
299
358
 
300
359
  ##
301
360
  # Sets the learning modes for this interface.
302
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
303
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
304
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
361
+ # @rspec_example
362
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
363
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
364
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
305
365
  # @param [Hash] opts
306
366
  # @option opts [IControl::Networking::LearningMode] :modes The learning modes to set for the specified interfaces.
307
367
  def set_learning_mode(opts)
@@ -310,10 +370,13 @@ module IControl::Networking
310
370
  end
311
371
 
312
372
  ##
313
- # 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.
314
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
315
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
316
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
373
+ # Sets the media types of this interface names. (settings for fixed, non-pluggable
374
+ # interface). See set_media_fixed_or_sfp for a method you can use to set media type
375
+ # and not have to choose whether to affect settings for fixed or sfp media.
376
+ # @rspec_example
377
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
378
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
379
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
317
380
  # @param [Hash] opts
318
381
  # @option opts [IControl::Networking::Interfaces::MediaType] :media_types The media types to set for the specified interfaces (e.g. auto, 100baseTX, 10baseT).
319
382
  def set_media(opts)
@@ -322,10 +385,17 @@ module IControl::Networking
322
385
  end
323
386
 
324
387
  ##
325
- # 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.
326
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
327
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
328
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
388
+ # Set the media types of this interface names, conveniently choosing fixed or SFP media
389
+ # automatically. When you set the media type using this method, the system automatically
390
+ # affects the correct media based on whether the interface is a small form factor pluggable
391
+ # (SFP) interface, or for combo ports (see get_dual_media_state method) whether SFP
392
+ # is the preferred port. (When you get the setting you'll still need to use the correct
393
+ # method, get_media or get_media_sfp.) You may manually affect the interface settings
394
+ # more directly by using the set_media or set_media_sfp methods.
395
+ # @rspec_example
396
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
397
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
398
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
329
399
  # @param [Hash] opts
330
400
  # @option opts [IControl::Networking::Interfaces::MediaType] :media_types The media types to set for the specified interfaces (e.g. auto, 100baseTX, 10baseT).
331
401
  def set_media_fixed_or_sfp(opts)
@@ -335,9 +405,10 @@ module IControl::Networking
335
405
 
336
406
  ##
337
407
  # Sets the SFP media types of this interface names.
338
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
339
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
340
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
408
+ # @rspec_example
409
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
410
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
411
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
341
412
  # @param [Hash] opts
342
413
  # @option opts [IControl::Networking::Interfaces::MediaType] :media_types The SFP media types to set for the specified interfaces (e.g. auto, 100baseTX, 10baseT).
343
414
  def set_media_sfp(opts)
@@ -347,9 +418,10 @@ module IControl::Networking
347
418
 
348
419
  ##
349
420
  # Sets the SFP media types of this interface names.
350
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
351
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
352
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
421
+ # @rspec_example
422
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
423
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
424
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
353
425
  # @param [Hash] opts
354
426
  # @option opts [IControl::Networking::PhyMasterSlaveMode] :modes The PHY master/slave modes to set for the specified interfaces.
355
427
  def set_phy_master_slave_mode(opts)
@@ -358,10 +430,12 @@ module IControl::Networking
358
430
  end
359
431
 
360
432
  ##
361
- # Sets the states indicating that SFP is the preferred media. Only used for dual media ports.
362
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
363
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
364
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
433
+ # Sets the states indicating that SFP is the preferred media. Only used for dual media
434
+ # ports.
435
+ # @rspec_example
436
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
437
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
438
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
365
439
  # @param [Hash] opts
366
440
  # @option opts [IControl::Common::EnabledState] :states The states to set for the specified interfaces.
367
441
  def set_prefer_sfp_state(opts)
@@ -371,9 +445,10 @@ module IControl::Networking
371
445
 
372
446
  ##
373
447
  # Sets the configured/requested flow control types for this interface.
374
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
375
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
376
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
448
+ # @rspec_example
449
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
450
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
451
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
377
452
  # @param [Hash] opts
378
453
  # @option opts [IControl::Networking::FlowControlType] :flow_controls The configured/requested flow control types to set for the specified interface names.
379
454
  def set_requested_flow_control(opts)
@@ -382,10 +457,17 @@ module IControl::Networking
382
457
  end
383
458
 
384
459
  ##
385
- # 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.
386
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
387
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
388
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
460
+ # Sets the states indicating whether automatic detection of edge port status for this
461
+ # interface. When automatic edge port detection is enabled on an interface, the BIG-IP
462
+ # monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets
463
+ # are received for a sufficient period of time (about 3 seconds), the interface is
464
+ # automatically given edge port status. When automatic edge port detection is disabled
465
+ # on an interface, the BIG-IP never gives the interface edge port status automatically.
466
+ # By default, automatic edge port detection is enabled on all interface.
467
+ # @rspec_example
468
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
469
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
470
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
389
471
  # @param [Hash] opts
390
472
  # @option opts [IControl::Common::EnabledState] :states The auto edge-port detection states to set for the specified interface names.
391
473
  def set_stp_auto_edge_port_detection_state(opts)
@@ -394,10 +476,13 @@ module IControl::Networking
394
476
  end
395
477
 
396
478
  ##
397
- # 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.
398
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
399
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
400
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
479
+ # Sets the states indicating whether this interface are edge ports or not. The spanning
480
+ # tree algorithms include important optimizations that can only be used on so-called
481
+ # edge ports, i.e. interface that connect to end stations rather than to other bridges.
482
+ # @rspec_example
483
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
484
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
485
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
401
486
  # @param [Hash] opts
402
487
  # @option opts [IControl::Common::EnabledState] :states The edge-port states to set for the specified interface names.
403
488
  def set_stp_edge_port_state(opts)
@@ -406,10 +491,19 @@ module IControl::Networking
406
491
  end
407
492
 
408
493
  ##
409
- # 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.
410
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
411
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
412
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
494
+ # Sets the states indicating whether this interface will participate in the spanning
495
+ # tree protocol. Disabling spanning tree protocol on an interface enables learning
496
+ # and forwarding on it. The spanning tree algorithm then behaves as if the interface
497
+ # did not exist. No STP, RSTP, or MSTP packets are transmitted or received on the interface,
498
+ # and the spanning tree algorithm exerts no control over forwarding or learning on
499
+ # the port. NOTE: Disabling spanning tree protocol on an interface which is a configured
500
+ # member of a trunk disables spanning tree protocol on the trunk as a whole. For a
501
+ # trunk to participate in spanning tree protocol, the protocol must be enabled on all
502
+ # of its configured member interface.
503
+ # @rspec_example
504
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
506
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
413
507
  # @param [Hash] opts
414
508
  # @option opts [IControl::Common::EnabledState] :states The STP enabled states to set for the specified interface names.
415
509
  def set_stp_enabled_state(opts)
@@ -419,9 +513,10 @@ module IControl::Networking
419
513
 
420
514
  ##
421
515
  # Sets the STP link types for this interface.
422
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
423
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
424
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
516
+ # @rspec_example
517
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
518
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
519
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
425
520
  # @param [Hash] opts
426
521
  # @option opts [IControl::Networking::STPLinkType] :link_types The STP link types to set for the specified interface names.
427
522
  def set_stp_link_type(opts)
@@ -430,10 +525,14 @@ module IControl::Networking
430
525
  end
431
526
 
432
527
  ##
433
- # 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.
434
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
435
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
436
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
528
+ # Sets the states indicating whether RSTP or MSTP BPDUs (depending on the current STP
529
+ # mode) to be sent on this interface, until such time as a legacy STP bridge is detected
530
+ # again on those interface. Note: This method is only applicable when the current STP
531
+ # mode is RSTP or MSTP.
532
+ # @rspec_example
533
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
534
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
535
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
437
536
  # @param [Hash] opts
438
537
  # @option opts [IControl::Common::EnabledState] :states The STP protocol detection reset states to set for the specified interface names.
439
538
  def set_stp_protocol_detection_reset_state(opts)
@@ -444,27 +543,27 @@ module IControl::Networking
444
543
  ##
445
544
  # A struct that describes an interface's media options.
446
545
  # @attr [String] interface_name The interface name.
447
- # @attr [IControl::Networking::Interfaces::MediaType] media_options The media options for this interface.
546
+ # @attr [IControl::Networking::Interfaces::MediaTypeSequence] media_options The media options for this interface.
448
547
  class InterfaceMediaOption < IControl::Base::Struct
449
548
  icontrol_attribute :interface_name, String
450
- icontrol_attribute :media_options, IControl::Networking::Interfaces::MediaType
549
+ icontrol_attribute :media_options, IControl::Networking::Interfaces::MediaTypeSequence
451
550
  end
452
551
 
453
552
  ##
454
553
  # A struct that describes an interface's general statistics.
455
554
  # @attr [String] interface_name The interface name.
456
- # @attr [IControl::Common::Statistic] statistics The statistics.
555
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics.
457
556
  class InterfaceStatisticEntry < IControl::Base::Struct
458
557
  icontrol_attribute :interface_name, String
459
- icontrol_attribute :statistics, IControl::Common::Statistic
558
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
460
559
  end
461
560
 
462
561
  ##
463
562
  # A struct that describes network interface statistics and timestamp.
464
- # @attr [IControl::Networking::Interfaces::InterfaceStatisticEntry] statistics The statistics for a sequence of network interfaces.
563
+ # @attr [IControl::Networking::Interfaces::InterfaceStatisticEntrySequence] statistics The statistics for a sequence of network interfaces.
465
564
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
466
565
  class InterfaceStatistics < IControl::Base::Struct
467
- icontrol_attribute :statistics, IControl::Networking::Interfaces::InterfaceStatisticEntry
566
+ icontrol_attribute :statistics, IControl::Networking::Interfaces::InterfaceStatisticEntrySequence
468
567
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
469
568
  end
470
569