icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,309 +1,348 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileSCTP interface enables you to manipulate a local load balancer's SCTP profile.
3
+ # The ProfileSCTP interface enables you to manipulate a local load balancer's SCTP
4
+ # profile.
4
5
  class ProfileSCTP < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfileSCTPStatisticEntry < IControl::Base::Struct; end
9
- class ProfileSCTPStatistics < IControl::Base::Struct; end ##
10
+ class ProfileSCTPStatistics < IControl::Base::Struct; end
11
+ class ProfileSCTPStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
12
  # Creates this SCTP 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.
13
+ # @rspec_example
14
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
17
  def create
15
18
  super
16
19
  end
17
20
 
18
21
  ##
19
22
  # Deletes all SCTP 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.
23
+ # @rspec_example
24
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
27
  def delete_all_profiles
24
28
  super
25
29
  end
26
30
 
27
31
  ##
28
32
  # Deletes this SCTP 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.
33
+ # @rspec_example
34
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
37
  def delete_profile
33
38
  super
34
39
  end
35
40
 
36
41
  ##
37
42
  # Gets the statistics for all the SCTP profile.
43
+ # @rspec_example
38
44
  # @return [ProfileSCTPStatistics]
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.
45
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
46
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
47
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
48
  def all_statistics
43
49
  super
44
50
  end
45
51
 
46
52
  ##
47
53
  # Gets the maximum number of retries to establish the connection for this SCTP profile.
54
+ # @rspec_example
48
55
  # @return [ProfileULong]
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.
56
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
52
59
  def connect_maximum_retry
53
60
  super
54
61
  end
55
62
 
56
63
  ##
57
64
  # Gets the valid duration of cookies for this SCTP profile.
65
+ # @rspec_example
58
66
  # @return [ProfileULong]
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.
67
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
68
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
69
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
70
  def cookie_expiration
63
71
  super
64
72
  end
65
73
 
66
74
  ##
67
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
75
+ # Gets the names of the default profile from which this profile will derive default
76
+ # values for its attributes.
77
+ # @rspec_example
68
78
  # @return [String]
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.
79
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
72
82
  def default_profile
73
83
  super
74
84
  end
75
85
 
76
86
  ##
77
87
  # Gets the state that if true, SCTP will emulate TCP closing.
88
+ # @rspec_example
78
89
  # @return [ProfileEnabledState]
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.
90
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
93
  def emulate_tcp_shutdown_state
83
94
  super
84
95
  end
85
96
 
86
97
  ##
87
98
  # Gets the intervals (in seconds) between heartbeats.
99
+ # @rspec_example
88
100
  # @return [ProfileULong]
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.
101
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
102
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
103
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
104
  def heartbeat_interval
93
105
  super
94
106
  end
95
107
 
96
108
  ##
97
- # Gets the number of seconds without traffic before the connection is eligible for deletion.
109
+ # Gets the number of seconds without traffic before the connection is eligible for
110
+ # deletion.
111
+ # @rspec_example
98
112
  # @return [ProfileULong]
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.
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.
102
116
  def idle_timeout
103
117
  super
104
118
  end
105
119
 
106
120
  ##
107
121
  # Gets the number of inbound streams used by this SCTP profile.
122
+ # @rspec_example
108
123
  # @return [ProfileULong]
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.
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.
112
127
  def inbound_stream
113
128
  super
114
129
  end
115
130
 
116
131
  ##
117
132
  # Gets the IP ToS values in packets sent to peer.
133
+ # @rspec_example
118
134
  # @return [ProfileULong]
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.
135
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
138
  def ip_tos_to_peer
123
139
  super
124
140
  end
125
141
 
126
142
  ##
127
143
  # Gets the link QoS values in packets sent to peer.
144
+ # @rspec_example
128
145
  # @return [ProfileULong]
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.
146
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
147
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
148
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
132
149
  def link_qos_to_peer
133
150
  super
134
151
  end
135
152
 
136
153
  ##
137
154
  # Gets a list of all SCTP profile.
155
+ # @rspec_example
138
156
  # @return [String]
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.
157
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
158
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
159
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
142
160
  def list
143
161
  super
144
162
  end
145
163
 
146
164
  ##
147
- # Gets the state that if true, SCPT will order the received messages before delivering them to upper layer.
165
+ # Gets the state that if true, SCPT will order the received messages before delivering
166
+ # them to upper layer.
167
+ # @rspec_example
148
168
  # @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.
169
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
172
  def order_receive_message_state
153
173
  super
154
174
  end
155
175
 
156
176
  ##
157
177
  # Gets the number of outbound streams used by this SCTP profile.
178
+ # @rspec_example
158
179
  # @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.
180
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
183
  def outbound_stream
163
184
  super
164
185
  end
165
186
 
166
187
  ##
167
- # Gets the proxy buffer level at which the receive window is closed (not advanced) for this SCTP profile.
188
+ # Gets the proxy buffer level at which the receive window is closed (not advanced)
189
+ # for this SCTP profile.
190
+ # @rspec_example
168
191
  # @return [ProfileULong]
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.
192
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
195
  def proxy_buffer_high
173
196
  super
174
197
  end
175
198
 
176
199
  ##
177
200
  # Gets the proxy buffer level at which the receive window is opened for this SCTP profile.
201
+ # @rspec_example
178
202
  # @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.
203
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
204
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
205
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
182
206
  def proxy_buffer_low
183
207
  super
184
208
  end
185
209
 
186
210
  ##
187
211
  # Gets the number of RX chunk buffers used by this SCTP profile.
212
+ # @rspec_example
188
213
  # @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.
214
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
215
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
216
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
192
217
  def receive_chunk_buffer
193
218
  super
194
219
  end
195
220
 
196
221
  ##
197
222
  # Gets the receive window sizes used by this SCTP profile.
223
+ # @rspec_example
198
224
  # @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.
225
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
226
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
227
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
202
228
  def receive_window_size
203
229
  super
204
230
  end
205
231
 
206
232
  ##
207
233
  # Gets the state that if true, SCTP will reset the connection when a timeout occurs.
234
+ # @rspec_example
208
235
  # @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.
236
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
237
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
238
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
212
239
  def reset_on_timeout_state
213
240
  super
214
241
  end
215
242
 
216
243
  ##
217
244
  # Gets the internal secret strings used to HMAC cookies.
245
+ # @rspec_example
218
246
  # @return [ProfileString]
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.
247
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
248
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
249
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
222
250
  def secret
223
251
  super
224
252
  end
225
253
 
226
254
  ##
227
255
  # Gets the send buffer sizes (in bytes) used by this SCTP profile.
256
+ # @rspec_example
228
257
  # @return [ProfileULong]
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.
258
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
259
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
260
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
261
  def send_buffer_size
233
262
  super
234
263
  end
235
264
 
236
265
  ##
237
266
  # Gets the maximum number of retries to send data for this SCTP profile.
267
+ # @rspec_example
238
268
  # @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.
269
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
270
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
271
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
242
272
  def send_maximum_retry
243
273
  super
244
274
  end
245
275
 
246
276
  ##
247
- # Gets the state that indicates whether SCTP will accept and send partial application data.
277
+ # Gets the state that indicates whether SCTP will accept and send partial application
278
+ # data.
279
+ # @rspec_example
248
280
  # @return [ProfileEnabledState]
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.
281
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
282
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
283
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
252
284
  def send_partial_data_state
253
285
  super
254
286
  end
255
287
 
256
288
  ##
257
289
  # Gets the statistics for this SCTP profile.
290
+ # @rspec_example
258
291
  # @return [ProfileSCTPStatistics]
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.
292
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
293
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
294
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
262
295
  def statistics
263
296
  super
264
297
  end
265
298
 
266
299
  ##
267
300
  # Gets the number of TX chunk buffers used by this SCTP profile.
301
+ # @rspec_example
268
302
  # @return [ProfileULong]
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.
303
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
304
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
305
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
272
306
  def transmit_chunk_buffer
273
307
  super
274
308
  end
275
309
 
276
310
  ##
277
311
  # Gets the version information for this interface.
312
+ # @rspec_example
278
313
  # @return [String]
279
314
  def version
280
315
  super
281
316
  end
282
317
 
283
318
  ##
284
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
319
+ # Determines whether this profile are base/pre-configured profile, or user-defined
320
+ # profile.
321
+ # @rspec_example
285
322
  # @return [boolean]
286
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
287
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
288
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
323
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
324
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
325
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
289
326
  def is_base_profile
290
327
  super
291
328
  end
292
329
 
293
330
  ##
294
331
  # Resets the statistics for this SCTP profile.
295
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
296
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
297
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
332
+ # @rspec_example
333
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
334
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
335
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
298
336
  def reset_statistics
299
337
  super
300
338
  end
301
339
 
302
340
  ##
303
341
  # Sets the maximum number of retries to establish the connection for this SCTP profile.
304
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
305
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
306
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
342
+ # @rspec_example
343
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
344
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
345
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
307
346
  # @param [Hash] opts
308
347
  # @option opts [IControl::LocalLB::ProfileULong] :retries The maximum number of retries.
309
348
  def set_connect_maximum_retry(opts)
@@ -313,9 +352,10 @@ module IControl::LocalLB
313
352
 
314
353
  ##
315
354
  # Sets the valid duration of cookies for this SCTP profile.
316
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
317
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
318
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
355
+ # @rspec_example
356
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
357
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
358
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
319
359
  # @param [Hash] opts
320
360
  # @option opts [IControl::LocalLB::ProfileULong] :durations The valid cookie durations.
321
361
  def set_cookie_expiration(opts)
@@ -324,10 +364,12 @@ module IControl::LocalLB
324
364
  end
325
365
 
326
366
  ##
327
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
328
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
329
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
330
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
367
+ # Sets the names of the default profile from which this profile will derive default
368
+ # values for its attributes.
369
+ # @rspec_example
370
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
371
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
372
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
331
373
  # @param [Hash] opts
332
374
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
333
375
  def set_default_profile(opts)
@@ -337,9 +379,10 @@ module IControl::LocalLB
337
379
 
338
380
  ##
339
381
  # Sets the state that if true, SCTP will emulate TCP closing.
340
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
341
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
342
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
382
+ # @rspec_example
383
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
384
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
385
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
343
386
  # @param [Hash] opts
344
387
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified profiles.
345
388
  def set_emulate_tcp_shutdown_state(opts)
@@ -349,9 +392,10 @@ module IControl::LocalLB
349
392
 
350
393
  ##
351
394
  # Sets the intervals (in seconds) between heartbeats.
352
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
353
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
354
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
395
+ # @rspec_example
396
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
397
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
398
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
355
399
  # @param [Hash] opts
356
400
  # @option opts [IControl::LocalLB::ProfileULong] :intervals The heartbeat intervals.
357
401
  def set_heartbeat_interval(opts)
@@ -360,10 +404,12 @@ module IControl::LocalLB
360
404
  end
361
405
 
362
406
  ##
363
- # Sets the number of seconds without traffic before the connection is eligible for deletion.
364
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
365
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
366
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
407
+ # Sets the number of seconds without traffic before the connection is eligible for
408
+ # deletion.
409
+ # @rspec_example
410
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
411
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
412
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
367
413
  # @param [Hash] opts
368
414
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeouts.
369
415
  def set_idle_timeout(opts)
@@ -373,9 +419,10 @@ module IControl::LocalLB
373
419
 
374
420
  ##
375
421
  # Sets the number of inbound streams used by this SCTP profile.
376
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
377
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
378
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
422
+ # @rspec_example
423
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
424
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
425
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
379
426
  # @param [Hash] opts
380
427
  # @option opts [IControl::LocalLB::ProfileULong] :streams The number of streams.
381
428
  def set_inbound_stream(opts)
@@ -385,9 +432,10 @@ module IControl::LocalLB
385
432
 
386
433
  ##
387
434
  # Sets the IP ToS values in packets sent to peer.
388
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
389
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
390
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
435
+ # @rspec_example
436
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
437
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
438
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
391
439
  # @param [Hash] opts
392
440
  # @option opts [IControl::LocalLB::ProfileULong] :values The IP ToS values.
393
441
  def set_ip_tos_to_peer(opts)
@@ -397,9 +445,10 @@ module IControl::LocalLB
397
445
 
398
446
  ##
399
447
  # Sets the link QoS values in packets sent to peer.
400
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
401
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
402
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
448
+ # @rspec_example
449
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
450
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
451
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
403
452
  # @param [Hash] opts
404
453
  # @option opts [IControl::LocalLB::ProfileULong] :values The link QoS values.
405
454
  def set_link_qos_to_peer(opts)
@@ -408,10 +457,12 @@ module IControl::LocalLB
408
457
  end
409
458
 
410
459
  ##
411
- # Sets the state that if true, SCPT will order the received messages before delivering them to upper layer.
412
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
413
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
414
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
460
+ # Sets the state that if true, SCPT will order the received messages before delivering
461
+ # them to upper layer.
462
+ # @rspec_example
463
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
464
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
465
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
415
466
  # @param [Hash] opts
416
467
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified profiles.
417
468
  def set_order_receive_message_state(opts)
@@ -421,9 +472,10 @@ module IControl::LocalLB
421
472
 
422
473
  ##
423
474
  # Sets the number of outbound streams used by this SCTP profile.
424
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
425
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
426
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
475
+ # @rspec_example
476
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
477
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
478
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
427
479
  # @param [Hash] opts
428
480
  # @option opts [IControl::LocalLB::ProfileULong] :streams The number of streams.
429
481
  def set_outbound_stream(opts)
@@ -432,10 +484,12 @@ module IControl::LocalLB
432
484
  end
433
485
 
434
486
  ##
435
- # Sets the proxy buffer level at which the receive window is closed (not advanced) for this SCTP profile.
436
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
437
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
438
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
487
+ # Sets the proxy buffer level at which the receive window is closed (not advanced)
488
+ # for this SCTP profile.
489
+ # @rspec_example
490
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
491
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
492
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
439
493
  # @param [Hash] opts
440
494
  # @option opts [IControl::LocalLB::ProfileULong] :levels The high proxy buffer levels.
441
495
  def set_proxy_buffer_high(opts)
@@ -445,9 +499,10 @@ module IControl::LocalLB
445
499
 
446
500
  ##
447
501
  # Sets the proxy buffer level at which the receive window is opened for this SCTP profile.
448
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
449
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
450
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
502
+ # @rspec_example
503
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
504
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
505
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
451
506
  # @param [Hash] opts
452
507
  # @option opts [IControl::LocalLB::ProfileULong] :levels The low proxy buffer levels.
453
508
  def set_proxy_buffer_low(opts)
@@ -457,9 +512,10 @@ module IControl::LocalLB
457
512
 
458
513
  ##
459
514
  # Sets the number of RX chunk buffers used by this SCTP profile.
460
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
461
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
462
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
515
+ # @rspec_example
516
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
517
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
518
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
463
519
  # @param [Hash] opts
464
520
  # @option opts [IControl::LocalLB::ProfileULong] :buffers The number of buffers.
465
521
  def set_receive_chunk_buffer(opts)
@@ -469,9 +525,10 @@ module IControl::LocalLB
469
525
 
470
526
  ##
471
527
  # Sets the receive window sizes used by this SCTP profile.
472
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
473
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
474
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
528
+ # @rspec_example
529
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
530
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
531
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
475
532
  # @param [Hash] opts
476
533
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The receive window sizes.
477
534
  def set_receive_window_size(opts)
@@ -481,9 +538,10 @@ module IControl::LocalLB
481
538
 
482
539
  ##
483
540
  # Sets the state that if true, SCTP will reset the connection when a timeout occurs.
484
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
485
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
486
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
541
+ # @rspec_example
542
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
543
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
544
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
487
545
  # @param [Hash] opts
488
546
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified profiles.
489
547
  def set_reset_on_timeout_state(opts)
@@ -493,9 +551,10 @@ module IControl::LocalLB
493
551
 
494
552
  ##
495
553
  # Sets the internal secret strings used to HMAC cookies.
496
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
497
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
498
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
554
+ # @rspec_example
555
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
556
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
557
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
499
558
  # @param [Hash] opts
500
559
  # @option opts [IControl::LocalLB::ProfileString] :secrets The secret string values.
501
560
  def set_secret(opts)
@@ -505,9 +564,10 @@ module IControl::LocalLB
505
564
 
506
565
  ##
507
566
  # Sets the send buffer sizes (in bytes) used by this SCTP profile.
508
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
509
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
510
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
511
571
  # @param [Hash] opts
512
572
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The send buffer sizes.
513
573
  def set_send_buffer_size(opts)
@@ -517,9 +577,10 @@ module IControl::LocalLB
517
577
 
518
578
  ##
519
579
  # Sets the maximum number of retries to send data for this SCTP profile.
520
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
521
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
522
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
580
+ # @rspec_example
581
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
582
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
583
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
523
584
  # @param [Hash] opts
524
585
  # @option opts [IControl::LocalLB::ProfileULong] :retries The maximum number of retries.
525
586
  def set_send_maximum_retry(opts)
@@ -528,10 +589,12 @@ module IControl::LocalLB
528
589
  end
529
590
 
530
591
  ##
531
- # Sets the state that indicates whether SCTP will accept and send partial application data.
532
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
533
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
534
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
592
+ # Sets the state that indicates whether SCTP will accept and send partial application
593
+ # data.
594
+ # @rspec_example
595
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
596
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
597
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
535
598
  # @param [Hash] opts
536
599
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified profiles.
537
600
  def set_send_partial_data_state(opts)
@@ -541,9 +604,10 @@ module IControl::LocalLB
541
604
 
542
605
  ##
543
606
  # Sets the number of TX chunk buffers used by this SCTP profile.
544
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
545
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
546
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
607
+ # @rspec_example
608
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
609
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
610
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
547
611
  # @param [Hash] opts
548
612
  # @option opts [IControl::LocalLB::ProfileULong] :buffers The number of buffers.
549
613
  def set_transmit_chunk_buffer(opts)
@@ -554,18 +618,18 @@ module IControl::LocalLB
554
618
  ##
555
619
  # A struct that describes statistics for a particular SCTP profile.
556
620
  # @attr [String] profile_name The profile name.
557
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
621
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
558
622
  class ProfileSCTPStatisticEntry < IControl::Base::Struct
559
623
  icontrol_attribute :profile_name, String
560
- icontrol_attribute :statistics, IControl::Common::Statistic
624
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
561
625
  end
562
626
 
563
627
  ##
564
628
  # A struct that describes profile statistics and timestamp.
565
- # @attr [IControl::LocalLB::ProfileSCTP::ProfileSCTPStatisticEntry] statistics The statistics for a sequence of profiles.
629
+ # @attr [IControl::LocalLB::ProfileSCTP::ProfileSCTPStatisticEntrySequence] statistics The statistics for a sequence of profiles.
566
630
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
567
631
  class ProfileSCTPStatistics < IControl::Base::Struct
568
- icontrol_attribute :statistics, IControl::LocalLB::ProfileSCTP::ProfileSCTPStatisticEntry
632
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileSCTP::ProfileSCTPStatisticEntrySequence
569
633
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
570
634
  end
571
635