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
@@ -6,464 +6,552 @@ module IControl::LocalLB
6
6
  set_id_name "profile_names"
7
7
 
8
8
  class ProfileTCPStatisticEntry < IControl::Base::Struct; end
9
- class ProfileTCPStatistics < IControl::Base::Struct; end ##
9
+ class ProfileTCPStatistics < IControl::Base::Struct; end
10
+ class ProfileTCPStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
11
  # Creates this TCP profile.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
12
+ # @rspec_example
13
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
16
  def create
15
17
  super
16
18
  end
17
19
 
18
20
  ##
19
21
  # Deletes all TCP profile.
20
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
22
+ # @rspec_example
23
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
26
  def delete_all_profiles
24
27
  super
25
28
  end
26
29
 
27
30
  ##
28
31
  # Deletes this TCP profile.
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # @rspec_example
33
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
36
  def delete_profile
33
37
  super
34
38
  end
35
39
 
36
40
  ##
37
- # Gets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option.
41
+ # Gets the states that if true, data-bearing in-order TCP segments will elicit immediate
42
+ # ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack
43
+ # profile option.
44
+ # @rspec_example
38
45
  # @return [ProfileEnabledState]
39
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
46
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
49
  def ack_on_push_state
43
50
  super
44
51
  end
45
52
 
46
53
  ##
47
54
  # Gets the statistics for all the profile.
55
+ # @rspec_example
48
56
  # @return [ProfileTCPStatistics]
49
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
57
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
58
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
59
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
52
60
  def all_statistics
53
61
  super
54
62
  end
55
63
 
56
64
  ##
57
- # Gets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting).
65
+ # Gets the states that if true, count the number of bytes acked rather than the number
66
+ # of returning ACKs from the peer when in the linear congestion-window expansion phase
67
+ # of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate
68
+ # Byte Counting).
69
+ # @rspec_example
58
70
  # @return [ProfileEnabledState]
59
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
71
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
74
  def appropriate_byte_counting_state
63
75
  super
64
76
  end
65
77
 
66
78
  ##
67
- # Gets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don't exceed it.
79
+ # Gets the states that if true, attempt to calculate the optimal bandwidth to use to
80
+ # the peer based on throughput and round-trip time, and don't exceed it.
81
+ # @rspec_example
68
82
  # @return [ProfileEnabledState]
69
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
83
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
72
86
  def bandwidth_delay_state
73
87
  super
74
88
  end
75
89
 
76
90
  ##
77
- # Gets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN).
91
+ # Gets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is
92
+ # forever (or until max retransmission of FIN).
93
+ # @rspec_example
78
94
  # @return [ProfileULong]
79
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
95
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
98
  def close_wait_timeout
83
99
  super
84
100
  end
85
101
 
86
102
  ##
87
- # Gets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving.
103
+ # Gets the states that if true, use the route-metrics cache in order to jump-start
104
+ # congestion-control parameters. When this parameter is disabled, the system slow-starts
105
+ # to the peer every time (assuming, of course, that slow-start is enabled), resulting
106
+ # in a much more conservative ramp-up in bandwidth utilization. This may be required
107
+ # in cases where an intermediate device is NATing multiple distinct clients to the
108
+ # same IP address, yet each of these hosts has distinctly different bandwidth and jitter
109
+ # parameters. It may also be required when the link is heavily oversubscribed and dropping
110
+ # packets due to overdriving.
111
+ # @rspec_example
88
112
  # @return [ProfileEnabledState]
89
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
113
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
116
  def cmetrics_cache_state
93
117
  super
94
118
  end
95
119
 
96
120
  ##
97
121
  # Gets the TCP congestion control modes for this TCP profile.
122
+ # @rspec_example
98
123
  # @return [ProfileTCPCongestionControlMode]
99
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
124
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
125
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
126
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
102
127
  def congestion_control_mode
103
128
  super
104
129
  end
105
130
 
106
131
  ##
107
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
132
+ # Gets the names of the default profile from which this profile will derive default
133
+ # values for its attributes.
134
+ # @rspec_example
108
135
  # @return [String]
109
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
136
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
137
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
138
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
112
139
  def default_profile
113
140
  super
114
141
  end
115
142
 
116
143
  ##
117
- # Gets the states that if true, defer allocation of connection chain context until payload from the client has been seen.
144
+ # Gets the states that if true, defer allocation of connection chain context until
145
+ # payload from the client has been seen.
146
+ # @rspec_example
118
147
  # @return [ProfileEnabledState]
119
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
151
  def deferred_accept_state
123
152
  super
124
153
  end
125
154
 
126
155
  ##
127
- # Gets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses.
156
+ # Gets the states that if true, enabled delayed ACK to allow coalescing of multiple
157
+ # ACK responses.
158
+ # @rspec_example
128
159
  # @return [ProfileEnabledState]
129
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
130
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
131
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
160
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
161
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
162
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
132
163
  def delayed_ack_state
133
164
  super
134
165
  end
135
166
 
136
167
  ##
137
168
  # Gets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement.
169
+ # @rspec_example
138
170
  # @return [ProfileEnabledState]
139
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
140
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
141
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
171
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
172
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
173
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
142
174
  def duplicate_selective_ack_state
143
175
  super
144
176
  end
145
177
 
146
178
  ##
147
- # Gets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN).
179
+ # Gets the states that if true, enable support for RFC3168 Extended Congestion Notification
180
+ # (ECN).
181
+ # @rspec_example
148
182
  # @return [ProfileEnabledState]
149
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
183
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
184
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
185
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
186
  def ecn_state
153
187
  super
154
188
  end
155
189
 
156
190
  ##
157
- # Gets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN).
191
+ # Gets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up.
192
+ # Zero is forever (or until max retransmission of FIN).
193
+ # @rspec_example
158
194
  # @return [ProfileULong]
159
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
195
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
196
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
197
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
198
  def fin_wait_timeout
163
199
  super
164
200
  end
165
201
 
166
202
  ##
167
- # Gets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions).
203
+ # Gets the states that if true, enable support for RFC1323 timestamps and window scaling
204
+ # (high performance TCP extensions).
205
+ # @rspec_example
168
206
  # @return [ProfileEnabledState]
169
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
207
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
208
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
209
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
210
  def high_performance_tcp_extension_state
173
211
  super
174
212
  end
175
213
 
176
214
  ##
177
- # Gets the idle timeout for this TCP profile. The number of seconds without traffic before a connection is eligible for deletion.
215
+ # Gets the idle timeout for this TCP profile. The number of seconds without traffic
216
+ # before a connection is eligible for deletion.
217
+ # @rspec_example
178
218
  # @return [ProfileULong]
179
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
180
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
181
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
219
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
182
222
  def idle_timeout
183
223
  super
184
224
  end
185
225
 
186
226
  ##
187
227
  # Gets the client-side IP TOS values for this TCP profile.
228
+ # @rspec_example
188
229
  # @return [ProfileULong]
189
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
190
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
191
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
230
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
192
233
  def ip_tos_to_client
193
234
  super
194
235
  end
195
236
 
196
237
  ##
197
238
  # Gets the keep-alive intervals (in seconds) for this profile.
239
+ # @rspec_example
198
240
  # @return [ProfileULong]
199
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
241
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
242
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
243
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
202
244
  def keep_alive_interval
203
245
  super
204
246
  end
205
247
 
206
248
  ##
207
249
  # Gets the states that if true, enable support for RFC3042 Limited Transmit Recovery.
250
+ # @rspec_example
208
251
  # @return [ProfileEnabledState]
209
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
210
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
211
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
252
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
253
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
254
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
212
255
  def limited_transmit_recovery_state
213
256
  super
214
257
  end
215
258
 
216
259
  ##
217
260
  # Gets the client-side link QoS values for this TCP profile.
261
+ # @rspec_example
218
262
  # @return [ProfileULong]
219
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
263
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
264
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
265
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
222
266
  def link_qos_to_client
223
267
  super
224
268
  end
225
269
 
226
270
  ##
227
271
  # Gets a list of all TCP profile.
272
+ # @rspec_example
228
273
  # @return [String]
229
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
274
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
275
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
276
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
277
  def list
233
278
  super
234
279
  end
235
280
 
236
281
  ##
237
282
  # Gets the maximum number of retransmission of data segments for this profile.
283
+ # @rspec_example
238
284
  # @return [ProfileULong]
239
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
240
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
241
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
285
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
286
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
287
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
242
288
  def maximum_data_retransmission
243
289
  super
244
290
  end
245
291
 
246
292
  ##
247
293
  # Gets the maximum number of retransmission of SYN segments for this profile.
294
+ # @rspec_example
248
295
  # @return [ProfileULong]
249
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
250
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
251
- # @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.
252
299
  def maximum_syn_retransmission
253
300
  super
254
301
  end
255
302
 
256
303
  ##
257
- # Gets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385.
304
+ # Gets the plaintext passphrase which may be between 1 and 80 characters in length,
305
+ # and is used in a shared-secret scheme to implement the spoof-prevention parts of
306
+ # RFC2385.
307
+ # @rspec_example
258
308
  # @return [ProfileString]
259
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
260
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
261
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
309
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
310
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
311
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
262
312
  def md5_signature_passphrase
263
313
  super
264
314
  end
265
315
 
266
316
  ##
267
- # Gets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering.
317
+ # Gets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic
318
+ # against intermediate tampering.
319
+ # @rspec_example
268
320
  # @return [ProfileEnabledState]
269
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
270
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
271
- # @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.
272
324
  def md5_signature_state
273
325
  super
274
326
  end
275
327
 
276
328
  ##
277
- # Gets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control.
329
+ # Gets values indicating the likelihood of performing congestion control when multiple
330
+ # packets in a row are lost even if the loss threshold has not been exceeded. Valid
331
+ # values from 0 to 32. Higher values decrease the likelihood of performing congestion
332
+ # control.
333
+ # @rspec_example
278
334
  # @return [ProfileULong]
279
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
280
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
281
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
335
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
336
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
337
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
282
338
  def packet_loss_ignore_burst
283
339
  super
284
340
  end
285
341
 
286
342
  ##
287
- # Gets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000.
343
+ # Gets the threshold of packets lost per million at which the system should perform
344
+ # congestion control. Measured in packets per million. Valid values are from 0 to 1000000.
345
+ # @rspec_example
288
346
  # @return [ProfileULong]
289
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
290
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
291
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
347
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
348
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
349
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
292
350
  def packet_loss_ignore_rate
293
351
  super
294
352
  end
295
353
 
296
354
  ##
297
355
  # Gets the proxy buffer level at which the receive window is closed, i.e. not advanced.
356
+ # @rspec_example
298
357
  # @return [ProfileULong]
299
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
300
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
301
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
358
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
359
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
360
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
302
361
  def proxy_buffer_high
303
362
  super
304
363
  end
305
364
 
306
365
  ##
307
366
  # Gets the proxy buffer level at which the receive window is opened.
367
+ # @rspec_example
308
368
  # @return [ProfileULong]
309
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
310
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
311
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
369
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
370
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
371
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
312
372
  def proxy_buffer_low
313
373
  super
314
374
  end
315
375
 
316
376
  ##
317
377
  # Gets the states that if true, enable proxying of maximum segment size.
378
+ # @rspec_example
318
379
  # @return [ProfileEnabledState]
319
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
320
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
321
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
380
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
381
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
382
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
322
383
  def proxy_mss_state
323
384
  super
324
385
  end
325
386
 
326
387
  ##
327
- # Gets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client.
388
+ # Gets the states that if true, enable proxying of an option (e.g. time-stamps) to
389
+ # the server only if it was negotiated with the client.
390
+ # @rspec_example
328
391
  # @return [ProfileEnabledState]
329
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
330
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
331
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
392
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
393
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
394
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
332
395
  def proxy_option_state
333
396
  super
334
397
  end
335
398
 
336
399
  ##
337
400
  # Gets the receive window sizes (in bytes) for this profile.
401
+ # @rspec_example
338
402
  # @return [ProfileULong]
339
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
340
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
341
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
403
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
404
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
405
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
342
406
  def receive_window_size
343
407
  super
344
408
  end
345
409
 
346
410
  ##
347
- # Gets the reset on timeout states for this TCP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
411
+ # Gets the reset on timeout states for this TCP profile. If true and a TCP connection
412
+ # exceeds its idle timeout, send a reset in addition to deleting the connection.
413
+ # @rspec_example
348
414
  # @return [ProfileEnabledState]
349
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
350
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
351
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
415
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
416
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
417
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
352
418
  def reset_on_timeout_state
353
419
  super
354
420
  end
355
421
 
356
422
  ##
357
423
  # Gets the states that if true, enable support for RFC2018 Selective Acknowledgement.
424
+ # @rspec_example
358
425
  # @return [ProfileEnabledState]
359
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
360
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
361
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
426
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
427
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
428
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
362
429
  def selective_ack_state
363
430
  super
364
431
  end
365
432
 
366
433
  ##
367
434
  # Gets the send buffer sizes (in bytes) for this profile.
435
+ # @rspec_example
368
436
  # @return [ProfileULong]
369
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
370
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
371
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
437
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
438
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
439
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
372
440
  def send_buffer_size
373
441
  super
374
442
  end
375
443
 
376
444
  ##
377
- # Gets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.
445
+ # Gets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses
446
+ # RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.
447
+ # @rspec_example
378
448
  # @return [ProfileEnabledState]
379
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
380
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
381
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
382
452
  def slow_start_state
383
453
  super
384
454
  end
385
455
 
386
456
  ##
387
457
  # Gets the statistics for this profile.
458
+ # @rspec_example
388
459
  # @return [ProfileTCPStatistics]
389
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
390
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
391
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
460
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
461
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
462
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
392
463
  def statistics
393
464
  super
394
465
  end
395
466
 
396
467
  ##
397
- # Gets the states that if true, recycle the connection when SYN is received in TIME-WAIT state.
468
+ # Gets the states that if true, recycle the connection when SYN is received in TIME-WAIT
469
+ # state.
470
+ # @rspec_example
398
471
  # @return [ProfileEnabledState]
399
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
400
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
401
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
472
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
473
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
474
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
402
475
  def time_wait_recycle_state
403
476
  super
404
477
  end
405
478
 
406
479
  ##
407
480
  # Gets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state.
481
+ # @rspec_example
408
482
  # @return [ProfileULong]
409
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
410
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
411
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
412
486
  def time_wait_timeout
413
487
  super
414
488
  end
415
489
 
416
490
  ##
417
- # Gets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links.
491
+ # Gets the states that if true, delay sending data that is less than MSS in size unless
492
+ # all prior data has been ACKed. This leads to less in-flight small-data, and less
493
+ # chance for drops, but can have poor effects for interactive protocols such as telnet
494
+ # over high latency links.
495
+ # @rspec_example
418
496
  # @return [ProfileEnabledState]
419
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
420
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
421
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
497
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
498
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
499
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
422
500
  def use_nagle_algorithm_state
423
501
  super
424
502
  end
425
503
 
426
504
  ##
427
- # Gets the states that if true, the system must not respond to the client's SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open.
505
+ # Gets the states that if true, the system must not respond to the client's SYN with
506
+ # a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is
507
+ # open.
508
+ # @rspec_example
428
509
  # @return [ProfileEnabledState]
429
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
430
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
431
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
510
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
511
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
512
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
432
513
  def verified_accept_state
433
514
  super
434
515
  end
435
516
 
436
517
  ##
437
518
  # Gets the version information for this interface.
519
+ # @rspec_example
438
520
  # @return [String]
439
521
  def version
440
522
  super
441
523
  end
442
524
 
443
525
  ##
444
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
526
+ # Determines whether this profile are base/pre-configured profile, or user-defined
527
+ # profile.
528
+ # @rspec_example
445
529
  # @return [boolean]
446
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
447
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
448
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
530
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
531
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
532
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
449
533
  def is_base_profile
450
534
  super
451
535
  end
452
536
 
453
537
  ##
454
538
  # Resets the statistics for this profile.
455
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
456
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
457
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
539
+ # @rspec_example
540
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
541
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
542
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
458
543
  def reset_statistics
459
544
  super
460
545
  end
461
546
 
462
547
  ##
463
- # Sets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option.
464
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
465
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
466
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
548
+ # Sets the states that if true, data-bearing in-order TCP segments will elicit immediate
549
+ # ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack
550
+ # profile option.
551
+ # @rspec_example
552
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
553
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
554
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
467
555
  # @param [Hash] opts
468
556
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
469
557
  def set_ack_on_push_state(opts)
@@ -472,10 +560,14 @@ module IControl::LocalLB
472
560
  end
473
561
 
474
562
  ##
475
- # Sets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting).
476
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
477
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
478
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
563
+ # Sets the states that if true, count the number of bytes acked rather than the number
564
+ # of returning ACKs from the peer when in the linear congestion-window expansion phase
565
+ # of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate
566
+ # Byte Counting).
567
+ # @rspec_example
568
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
569
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
570
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
479
571
  # @param [Hash] opts
480
572
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
481
573
  def set_appropriate_byte_counting_state(opts)
@@ -484,10 +576,12 @@ module IControl::LocalLB
484
576
  end
485
577
 
486
578
  ##
487
- # Sets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don't exceed it.
488
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
489
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
490
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
579
+ # Sets the states that if true, attempt to calculate the optimal bandwidth to use to
580
+ # the peer based on throughput and round-trip time, and don't exceed it.
581
+ # @rspec_example
582
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
583
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
584
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
491
585
  # @param [Hash] opts
492
586
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
493
587
  def set_bandwidth_delay_state(opts)
@@ -496,10 +590,12 @@ module IControl::LocalLB
496
590
  end
497
591
 
498
592
  ##
499
- # Sets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN).
500
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
501
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
502
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
593
+ # Sets the time (in seconds) to remain in LAST-ACK state before giving up. Zero is
594
+ # forever (or until max retransmission of FIN).
595
+ # @rspec_example
596
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
597
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
598
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
503
599
  # @param [Hash] opts
504
600
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The timeouts for the specified TCP profiles.
505
601
  def set_close_wait_timeout(opts)
@@ -508,10 +604,18 @@ module IControl::LocalLB
508
604
  end
509
605
 
510
606
  ##
511
- # Sets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving.
512
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
513
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
514
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
607
+ # Sets the states that if true, use the route-metrics cache in order to jump-start
608
+ # congestion-control parameters. When this parameter is disabled, the system slow-starts
609
+ # to the peer every time (assuming, of course, that slow-start is enabled), resulting
610
+ # in a much more conservative ramp-up in bandwidth utilization. This may be required
611
+ # in cases where an intermediate device is NATing multiple distinct clients to the
612
+ # same IP address, yet each of these hosts has distinctly different bandwidth and jitter
613
+ # parameters. It may also be required when the link is heavily oversubscribed and dropping
614
+ # packets due to overdriving.
615
+ # @rspec_example
616
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
617
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
618
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
515
619
  # @param [Hash] opts
516
620
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
517
621
  def set_cmetrics_cache_state(opts)
@@ -521,9 +625,10 @@ module IControl::LocalLB
521
625
 
522
626
  ##
523
627
  # Sets the TCP congestion control modes for this TCP profile.
524
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
525
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
526
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
628
+ # @rspec_example
629
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
630
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
631
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
527
632
  # @param [Hash] opts
528
633
  # @option opts [IControl::LocalLB::ProfileTCPCongestionControlMode] :values The TCP congestion control modes.
529
634
  def set_congestion_control_mode(opts)
@@ -532,10 +637,12 @@ module IControl::LocalLB
532
637
  end
533
638
 
534
639
  ##
535
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
536
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
537
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
538
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
640
+ # Sets the names of the default profile from which this profile will derive default
641
+ # values for its attributes.
642
+ # @rspec_example
643
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
644
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
645
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
539
646
  # @param [Hash] opts
540
647
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
541
648
  def set_default_profile(opts)
@@ -544,10 +651,12 @@ module IControl::LocalLB
544
651
  end
545
652
 
546
653
  ##
547
- # Sets the states that if true, defer allocation of connection chain context until payload from the client has been seen.
548
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
549
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
550
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
654
+ # Sets the states that if true, defer allocation of connection chain context until
655
+ # payload from the client has been seen.
656
+ # @rspec_example
657
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
658
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
659
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
551
660
  # @param [Hash] opts
552
661
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
553
662
  def set_deferred_accept_state(opts)
@@ -556,10 +665,12 @@ module IControl::LocalLB
556
665
  end
557
666
 
558
667
  ##
559
- # Sets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses.
560
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
561
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
562
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
668
+ # Sets the states that if true, enabled delayed ACK to allow coalescing of multiple
669
+ # ACK responses.
670
+ # @rspec_example
671
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
672
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
673
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
563
674
  # @param [Hash] opts
564
675
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
565
676
  def set_delayed_ack_state(opts)
@@ -569,9 +680,10 @@ module IControl::LocalLB
569
680
 
570
681
  ##
571
682
  # Sets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement.
572
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
573
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
574
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
683
+ # @rspec_example
684
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
685
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
686
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
575
687
  # @param [Hash] opts
576
688
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
577
689
  def set_duplicate_selective_ack_state(opts)
@@ -580,10 +692,12 @@ module IControl::LocalLB
580
692
  end
581
693
 
582
694
  ##
583
- # Sets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN).
584
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
585
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
586
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
695
+ # Sets the states that if true, enable support for RFC3168 Extended Congestion Notification
696
+ # (ECN).
697
+ # @rspec_example
698
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
699
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
700
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
587
701
  # @param [Hash] opts
588
702
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
589
703
  def set_ecn_state(opts)
@@ -592,10 +706,12 @@ module IControl::LocalLB
592
706
  end
593
707
 
594
708
  ##
595
- # Sets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN).
596
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
597
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
598
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
709
+ # Sets the time (in seconds) to remain in FIN-WAIT or CLOSING state before giving up.
710
+ # Zero is forever (or until max retransmission of FIN).
711
+ # @rspec_example
712
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
713
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
714
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
599
715
  # @param [Hash] opts
600
716
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The timeouts for the specified TCP profiles.
601
717
  def set_fin_wait_timeout(opts)
@@ -604,10 +720,12 @@ module IControl::LocalLB
604
720
  end
605
721
 
606
722
  ##
607
- # Sets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions).
608
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
609
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
610
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
723
+ # Sets the states that if true, enable support for RFC1323 timestamps and window scaling
724
+ # (high performance TCP extensions).
725
+ # @rspec_example
726
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
727
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
728
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
611
729
  # @param [Hash] opts
612
730
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
613
731
  def set_high_performance_tcp_extension_state(opts)
@@ -616,10 +734,12 @@ module IControl::LocalLB
616
734
  end
617
735
 
618
736
  ##
619
- # Sets the idle timeout for this TCP profile. The number of seconds without traffic before a connection is eligible for deletion.
620
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
621
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
622
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
737
+ # Sets the idle timeout for this TCP profile. The number of seconds without traffic
738
+ # before a connection is eligible for deletion.
739
+ # @rspec_example
740
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
741
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
742
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
623
743
  # @param [Hash] opts
624
744
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeouts for the specified TCP profiles.
625
745
  def set_idle_timeout(opts)
@@ -629,9 +749,10 @@ module IControl::LocalLB
629
749
 
630
750
  ##
631
751
  # Sets the client-side IP TOS values for this TCP profile.
632
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
633
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
634
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
752
+ # @rspec_example
753
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
754
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
755
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
635
756
  # @param [Hash] opts
636
757
  # @option opts [IControl::LocalLB::ProfileULong] :values The client-side IP TOS values.
637
758
  def set_ip_tos_to_client(opts)
@@ -641,9 +762,10 @@ module IControl::LocalLB
641
762
 
642
763
  ##
643
764
  # Sets the keep-alive intervals (in seconds) for this profile.
644
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
645
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
646
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
765
+ # @rspec_example
766
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
767
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
768
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
647
769
  # @param [Hash] opts
648
770
  # @option opts [IControl::LocalLB::ProfileULong] :intervals The keep-alive intervals for the specified TCP profiles.
649
771
  def set_keep_alive_interval(opts)
@@ -653,9 +775,10 @@ module IControl::LocalLB
653
775
 
654
776
  ##
655
777
  # Sets the states that if true, enable support for RFC3042 Limited Transmit Recovery.
656
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
657
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
658
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
778
+ # @rspec_example
779
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
780
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
781
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
659
782
  # @param [Hash] opts
660
783
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
661
784
  def set_limited_transmit_recovery_state(opts)
@@ -665,9 +788,10 @@ module IControl::LocalLB
665
788
 
666
789
  ##
667
790
  # Sets the client-side link QoS values for this TCP profile.
668
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
669
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
670
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
791
+ # @rspec_example
792
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
793
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
794
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
671
795
  # @param [Hash] opts
672
796
  # @option opts [IControl::LocalLB::ProfileULong] :values The client-side link QoS values.
673
797
  def set_link_qos_to_client(opts)
@@ -677,9 +801,10 @@ module IControl::LocalLB
677
801
 
678
802
  ##
679
803
  # Sets the maximum number of retransmission of data segments for this profile.
680
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
681
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
682
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
804
+ # @rspec_example
805
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
806
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
807
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
683
808
  # @param [Hash] opts
684
809
  # @option opts [IControl::LocalLB::ProfileULong] :retries The maximum retransmission count of data segments for the specified TCP profiles.
685
810
  def set_maximum_data_retransmission(opts)
@@ -689,9 +814,10 @@ module IControl::LocalLB
689
814
 
690
815
  ##
691
816
  # Sets the maximum number of retransmission of SYN segments for this profile.
692
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
693
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
694
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
817
+ # @rspec_example
818
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
819
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
820
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
695
821
  # @param [Hash] opts
696
822
  # @option opts [IControl::LocalLB::ProfileULong] :retries The maximum retransmission count of SYN segments for the specified TCP profiles.
697
823
  def set_maximum_syn_retransmission(opts)
@@ -700,10 +826,13 @@ module IControl::LocalLB
700
826
  end
701
827
 
702
828
  ##
703
- # Sets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385.
704
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
705
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
706
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
829
+ # Sets the plaintext passphrase which may be between 1 and 80 characters in length,
830
+ # and is used in a shared-secret scheme to implement the spoof-prevention parts of
831
+ # RFC2385.
832
+ # @rspec_example
833
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
834
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
835
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
707
836
  # @param [Hash] opts
708
837
  # @option opts [IControl::LocalLB::ProfileString] :passphrases The MD5 passphrases for the specified profiles.
709
838
  def set_md5_signature_passphrase(opts)
@@ -712,10 +841,12 @@ module IControl::LocalLB
712
841
  end
713
842
 
714
843
  ##
715
- # Sets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering.
716
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
717
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
718
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
844
+ # Sets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic
845
+ # against intermediate tampering.
846
+ # @rspec_example
847
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
848
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
849
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
719
850
  # @param [Hash] opts
720
851
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
721
852
  def set_md5_signature_state(opts)
@@ -724,10 +855,14 @@ module IControl::LocalLB
724
855
  end
725
856
 
726
857
  ##
727
- # Sets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control.
728
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
729
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
730
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
858
+ # Sets values indicating the likelihood of performing congestion control when multiple
859
+ # packets in a row are lost even if the loss threshold has not been exceeded. Valid
860
+ # values from 0 to 32. Higher values decrease the likelihood of performing congestion
861
+ # control.
862
+ # @rspec_example
863
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
864
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
865
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
731
866
  # @param [Hash] opts
732
867
  # @option opts [IControl::LocalLB::ProfileULong] :values The packet loss ignore burst setting for the specified TCP profiles.
733
868
  def set_packet_loss_ignore_burst(opts)
@@ -736,10 +871,12 @@ module IControl::LocalLB
736
871
  end
737
872
 
738
873
  ##
739
- # Sets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000.
740
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
741
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
742
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
874
+ # Sets the threshold of packets lost per million at which the system should perform
875
+ # congestion control. Measured in packets per million. Valid values are from 0 to 1000000.
876
+ # @rspec_example
877
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
878
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
879
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
743
880
  # @param [Hash] opts
744
881
  # @option opts [IControl::LocalLB::ProfileULong] :thresholds The threshold for the specified TCP profiles.
745
882
  def set_packet_loss_ignore_rate(opts)
@@ -749,9 +886,10 @@ module IControl::LocalLB
749
886
 
750
887
  ##
751
888
  # Sets the proxy buffer level at which the receive window is closed, i.e. not advanced.
752
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
753
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
754
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
889
+ # @rspec_example
890
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
891
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
892
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
755
893
  # @param [Hash] opts
756
894
  # @option opts [IControl::LocalLB::ProfileULong] :levels The high proxy buffer level for the specified TCP profiles.
757
895
  def set_proxy_buffer_high(opts)
@@ -761,9 +899,10 @@ module IControl::LocalLB
761
899
 
762
900
  ##
763
901
  # Sets the proxy buffer level at which the receive window is opened.
764
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
765
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
766
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
902
+ # @rspec_example
903
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
904
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
905
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
767
906
  # @param [Hash] opts
768
907
  # @option opts [IControl::LocalLB::ProfileULong] :levels The low proxy buffer level for the specified TCP profiles.
769
908
  def set_proxy_buffer_low(opts)
@@ -773,9 +912,10 @@ module IControl::LocalLB
773
912
 
774
913
  ##
775
914
  # Sets the states that if true, enable proxying of maximum segment size.
776
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
777
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
778
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
915
+ # @rspec_example
916
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
917
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
918
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
779
919
  # @param [Hash] opts
780
920
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
781
921
  def set_proxy_mss_state(opts)
@@ -784,10 +924,12 @@ module IControl::LocalLB
784
924
  end
785
925
 
786
926
  ##
787
- # Sets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client.
788
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
789
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
790
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
927
+ # Sets the states that if true, enable proxying of an option (e.g. time-stamps) to
928
+ # the server only if it was negotiated with the client.
929
+ # @rspec_example
930
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
931
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
932
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
791
933
  # @param [Hash] opts
792
934
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
793
935
  def set_proxy_option_state(opts)
@@ -797,9 +939,10 @@ module IControl::LocalLB
797
939
 
798
940
  ##
799
941
  # Sets the receive window sizes (in bytes) for this profile.
800
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
801
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
802
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
942
+ # @rspec_example
943
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
944
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
945
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
803
946
  # @param [Hash] opts
804
947
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The receive window sizes for the specified TCP profiles.
805
948
  def set_receive_window_size(opts)
@@ -808,10 +951,12 @@ module IControl::LocalLB
808
951
  end
809
952
 
810
953
  ##
811
- # Sets the reset on timeout states for this TCP profile. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection.
812
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
813
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
814
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
954
+ # Sets the reset on timeout states for this TCP profile. If true and a TCP connection
955
+ # exceeds its idle timeout, send a reset in addition to deleting the connection.
956
+ # @rspec_example
957
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
958
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
959
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
815
960
  # @param [Hash] opts
816
961
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The key reset on timeout states for the specified TCP profiles.
817
962
  def set_reset_on_timeout_state(opts)
@@ -821,9 +966,10 @@ module IControl::LocalLB
821
966
 
822
967
  ##
823
968
  # Sets the states that if true, enable support for RFC2018 Selective Acknowledgement.
824
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
825
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
826
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
969
+ # @rspec_example
970
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
971
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
972
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
827
973
  # @param [Hash] opts
828
974
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
829
975
  def set_selective_ack_state(opts)
@@ -833,9 +979,10 @@ module IControl::LocalLB
833
979
 
834
980
  ##
835
981
  # Sets the send buffer sizes (in bytes) for this profile.
836
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
837
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
838
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
982
+ # @rspec_example
983
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
984
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
985
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
839
986
  # @param [Hash] opts
840
987
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The send buffer sizes for the specified TCP profiles.
841
988
  def set_send_buffer_size(opts)
@@ -844,10 +991,12 @@ module IControl::LocalLB
844
991
  end
845
992
 
846
993
  ##
847
- # Sets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.
848
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
849
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
850
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
994
+ # Sets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses
995
+ # RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms.
996
+ # @rspec_example
997
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
998
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
999
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
851
1000
  # @param [Hash] opts
852
1001
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
853
1002
  def set_slow_start_state(opts)
@@ -856,10 +1005,12 @@ module IControl::LocalLB
856
1005
  end
857
1006
 
858
1007
  ##
859
- # Sets the states that if true, recycle the connection when SYN is received in TIME-WAIT state.
860
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
861
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
862
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1008
+ # Sets the states that if true, recycle the connection when SYN is received in TIME-WAIT
1009
+ # state.
1010
+ # @rspec_example
1011
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1012
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1013
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
863
1014
  # @param [Hash] opts
864
1015
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
865
1016
  def set_time_wait_recycle_state(opts)
@@ -869,9 +1020,10 @@ module IControl::LocalLB
869
1020
 
870
1021
  ##
871
1022
  # Sets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state.
872
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
873
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
874
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1023
+ # @rspec_example
1024
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1025
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1026
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
875
1027
  # @param [Hash] opts
876
1028
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The timeouts for the specified TCP profiles.
877
1029
  def set_time_wait_timeout(opts)
@@ -880,10 +1032,14 @@ module IControl::LocalLB
880
1032
  end
881
1033
 
882
1034
  ##
883
- # Sets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links.
884
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
885
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
886
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1035
+ # Sets the states that if true, delay sending data that is less than MSS in size unless
1036
+ # all prior data has been ACKed. This leads to less in-flight small-data, and less
1037
+ # chance for drops, but can have poor effects for interactive protocols such as telnet
1038
+ # over high latency links.
1039
+ # @rspec_example
1040
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1041
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1042
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
887
1043
  # @param [Hash] opts
888
1044
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
889
1045
  def set_use_nagle_algorithm_state(opts)
@@ -892,10 +1048,13 @@ module IControl::LocalLB
892
1048
  end
893
1049
 
894
1050
  ##
895
- # Sets the states that if true, the system must not respond to the client's SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open.
896
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
897
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
898
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
1051
+ # Sets the states that if true, the system must not respond to the client's SYN with
1052
+ # a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is
1053
+ # open.
1054
+ # @rspec_example
1055
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
1056
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
1057
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
899
1058
  # @param [Hash] opts
900
1059
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified TCP profiles.
901
1060
  def set_verified_accept_state(opts)
@@ -906,18 +1065,18 @@ module IControl::LocalLB
906
1065
  ##
907
1066
  # A struct that describes statistics for a particular profile.
908
1067
  # @attr [String] profile_name The profile name.
909
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
1068
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
910
1069
  class ProfileTCPStatisticEntry < IControl::Base::Struct
911
1070
  icontrol_attribute :profile_name, String
912
- icontrol_attribute :statistics, IControl::Common::Statistic
1071
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
913
1072
  end
914
1073
 
915
1074
  ##
916
1075
  # A struct that describes profile statistics and timestamp.
917
- # @attr [IControl::LocalLB::ProfileTCP::ProfileTCPStatisticEntry] statistics The statistics for a sequence of profiles.
1076
+ # @attr [IControl::LocalLB::ProfileTCP::ProfileTCPStatisticEntrySequence] statistics The statistics for a sequence of profiles.
918
1077
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
919
1078
  class ProfileTCPStatistics < IControl::Base::Struct
920
- icontrol_attribute :statistics, IControl::LocalLB::ProfileTCP::ProfileTCPStatisticEntry
1079
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileTCP::ProfileTCPStatisticEntrySequence
921
1080
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
922
1081
  end
923
1082