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,339 +1,383 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileServerSSL interface enables you to manipulate a local load balancer's server SSL profile.
3
+ # The ProfileServerSSL interface enables you to manipulate a local load balancer's
4
+ # server SSL profile.
4
5
  class ProfileServerSSL < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfileServerSSLStatisticEntry < IControl::Base::Struct; end
9
- class ProfileServerSSLStatistics < IControl::Base::Struct; end ##
10
+ class ProfileServerSSLStatistics < IControl::Base::Struct; end
11
+ class ProfileServerSSLStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
12
  # Creates this server SSL 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 server SSL 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 server SSL 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
- # Gets the connection timeouts (in seconds) after sending an alert for this server SSL profile.
42
+ # Gets the connection timeouts (in seconds) after sending an alert for this server
43
+ # SSL profile.
44
+ # @rspec_example
38
45
  # @return [ProfileULong]
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 alert_timeout
43
50
  super
44
51
  end
45
52
 
46
53
  ##
47
54
  # Gets the statistics for all the server SSL profile.
55
+ # @rspec_example
48
56
  # @return [ProfileServerSSLStatistics]
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
65
  # Gets the client certificate chain maximum traversal depth for this server SSL profile.
66
+ # @rspec_example
58
67
  # @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.
68
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
69
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
70
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
71
  def authenticate_depth
63
72
  super
64
73
  end
65
74
 
66
75
  ##
67
- # Gets the expected server certificate distinguished name (DN) for this server SSL profile.
76
+ # Gets the expected server certificate distinguished name (DN) for this server SSL
77
+ # profile.
78
+ # @rspec_example
68
79
  # @return [ProfileString]
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.
80
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
72
83
  def authenticate_name
73
84
  super
74
85
  end
75
86
 
76
87
  ##
77
88
  # Gets the states to request the client certificate once for this server SSL profile.
89
+ # @rspec_example
78
90
  # @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.
91
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
92
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
93
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
94
  def authenticate_once_state
83
95
  super
84
96
  end
85
97
 
86
98
  ##
87
99
  # Gets the CA filenames for this server SSL profile.
100
+ # @rspec_example
88
101
  # @return [ProfileString]
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.
102
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
105
  def ca_file
93
106
  super
94
107
  end
95
108
 
96
109
  ##
97
110
  # Gets the SSL session cache sizes for this server SSL profile.
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 cache_size
103
117
  super
104
118
  end
105
119
 
106
120
  ##
107
121
  # Gets the SSL session cache timeouts for this server SSL 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 cache_timeout
113
128
  super
114
129
  end
115
130
 
116
131
  ##
117
132
  # Gets the certificate filenames to be used by this server SSL profile.
133
+ # @rspec_example
118
134
  # @return [ProfileString]
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 certificate_file
123
139
  super
124
140
  end
125
141
 
126
142
  ##
127
143
  # Gets the certificate chain filenames for this server SSL profile.
144
+ # @rspec_example
128
145
  # @return [ProfileString]
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 chain_file
133
150
  super
134
151
  end
135
152
 
136
153
  ##
137
154
  # Gets the cipher lists for this server SSL profile.
155
+ # @rspec_example
138
156
  # @return [ProfileStringArray]
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 cipher_list
143
161
  super
144
162
  end
145
163
 
146
164
  ##
147
165
  # Gets the CRL filenames for this server SSL profile.
166
+ # @rspec_example
148
167
  # @return [ProfileString]
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.
168
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
171
  def crl_file
153
172
  super
154
173
  end
155
174
 
156
175
  ##
157
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
176
+ # Gets the names of the default profile from which this profile will derive default
177
+ # values for its attributes.
178
+ # @rspec_example
158
179
  # @return [String]
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 default_profile
163
184
  super
164
185
  end
165
186
 
166
187
  ##
167
- # Gets the connection timeouts (in seconds) during handshake phase for this server SSL profile.
188
+ # Gets the connection timeouts (in seconds) during handshake phase for this server
189
+ # SSL 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 handshake_timeout
173
196
  super
174
197
  end
175
198
 
176
199
  ##
177
200
  # Gets the key filenames to be used by this server SSL profile.
201
+ # @rspec_example
178
202
  # @return [ProfileString]
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 key_file
183
207
  super
184
208
  end
185
209
 
186
210
  ##
187
211
  # Gets a list of all server SSL profile.
212
+ # @rspec_example
188
213
  # @return [String]
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 list
193
218
  super
194
219
  end
195
220
 
196
221
  ##
197
222
  # Gets the states to emulate modSSL for this server SSL profile.
223
+ # @rspec_example
198
224
  # @return [ProfileEnabledState]
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 modssl_emulation_state
203
229
  super
204
230
  end
205
231
 
206
232
  ##
207
233
  # Gets the key passphrases (if any) for this server SSL profile.
234
+ # @rspec_example
208
235
  # @return [ProfileString]
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 passphrase
213
240
  super
214
241
  end
215
242
 
216
243
  ##
217
244
  # Gets the peer certification modes for this server SSL profile.
245
+ # @rspec_example
218
246
  # @return [ProfileServerSSLCertificateMode]
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 peer_certification_mode
223
251
  super
224
252
  end
225
253
 
226
254
  ##
227
255
  # Gets the modes for this server SSL profile.
256
+ # @rspec_example
228
257
  # @return [ProfileProfileMode]
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 profile_mode
233
262
  super
234
263
  end
235
264
 
236
265
  ##
237
266
  # Gets the SSL renegotiation periods for this server SSL 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 renegotiation_period
243
273
  super
244
274
  end
245
275
 
246
276
  ##
247
- # Gets the states controlling whether mid-stream renegotiation is allowed for this server SSL profile.
277
+ # Gets the states controlling whether mid-stream renegotiation is allowed for this
278
+ # server SSL profile.
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 renegotiation_state
253
285
  super
254
286
  end
255
287
 
256
288
  ##
257
289
  # Gets the SSL renegotiation throughputs for this server SSL profile.
290
+ # @rspec_example
258
291
  # @return [ProfileULong]
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 renegotiation_throughput
263
296
  super
264
297
  end
265
298
 
266
299
  ##
267
300
  # Gets the SSL options for this server SSL profile.
301
+ # @rspec_example
268
302
  # @return [ProfileSSLOption]
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 ssl_option
273
307
  super
274
308
  end
275
309
 
276
310
  ##
277
311
  # Gets the statistics for this server SSL profile.
312
+ # @rspec_example
278
313
  # @return [ProfileServerSSLStatistics]
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.
314
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
315
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
316
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
282
317
  def statistics
283
318
  super
284
319
  end
285
320
 
286
321
  ##
287
- # Gets the states to enforce strict SSL session resumption per RFC2246 for this server SSL profile.
322
+ # Gets the states to enforce strict SSL session resumption per RFC2246 for this server
323
+ # SSL profile.
324
+ # @rspec_example
288
325
  # @return [ProfileEnabledState]
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.
326
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
327
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
328
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
292
329
  def strict_resume_state
293
330
  super
294
331
  end
295
332
 
296
333
  ##
297
334
  # Gets the states to do an unclean shutdown for this server SSL profile.
335
+ # @rspec_example
298
336
  # @return [ProfileEnabledState]
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.
337
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
338
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
339
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
302
340
  def unclean_shutdown_state
303
341
  super
304
342
  end
305
343
 
306
344
  ##
307
345
  # Gets the version information for this interface.
346
+ # @rspec_example
308
347
  # @return [String]
309
348
  def version
310
349
  super
311
350
  end
312
351
 
313
352
  ##
314
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
353
+ # Determines whether this profile are base/pre-configured profile, or user-defined
354
+ # profile.
355
+ # @rspec_example
315
356
  # @return [boolean]
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.
357
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
358
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
359
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
319
360
  def is_base_profile
320
361
  super
321
362
  end
322
363
 
323
364
  ##
324
365
  # Resets the statistics for this server SSL profile.
325
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
326
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
327
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
366
+ # @rspec_example
367
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
368
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
369
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
328
370
  def reset_statistics
329
371
  super
330
372
  end
331
373
 
332
374
  ##
333
- # Sets the connection timeouts (in seconds) after sending an alert for this server SSL profile.
334
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
335
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
336
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
375
+ # Sets the connection timeouts (in seconds) after sending an alert for this server
376
+ # SSL profile.
377
+ # @rspec_example
378
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
379
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
380
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
337
381
  # @param [Hash] opts
338
382
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The connection timeouts (in seconds) after sending an alert for the specified server SSL profiles.
339
383
  def set_alert_timeout(opts)
@@ -343,9 +387,10 @@ module IControl::LocalLB
343
387
 
344
388
  ##
345
389
  # Sets the client certificate chain maximum traversal depth for this server SSL profile.
346
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
347
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
348
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
390
+ # @rspec_example
391
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
392
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
393
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
349
394
  # @param [Hash] opts
350
395
  # @option opts [IControl::LocalLB::ProfileULong] :depths The client certificate chain maximum traversal depth for the specified server SSL profiles.
351
396
  def set_authenticate_depth(opts)
@@ -354,10 +399,12 @@ module IControl::LocalLB
354
399
  end
355
400
 
356
401
  ##
357
- # Sets the expected server certificate distinguished name (DN) for this server SSL profile.
358
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
359
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
360
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
402
+ # Sets the expected server certificate distinguished name (DN) for this server SSL
403
+ # profile.
404
+ # @rspec_example
405
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
406
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
407
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
361
408
  # @param [Hash] opts
362
409
  # @option opts [IControl::LocalLB::ProfileString] :dn_names The expected server certificate distinguished name (DN) to be used by the specified server SSL profiles.
363
410
  def set_authenticate_name(opts)
@@ -366,10 +413,13 @@ module IControl::LocalLB
366
413
  end
367
414
 
368
415
  ##
369
- # Sets the states to request the client certificate once for this server SSL profile. If the state is false/disabled, client certificate is requested for each SSL session renegotiation.
370
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
371
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
372
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
416
+ # Sets the states to request the client certificate once for this server SSL profile.
417
+ # If the state is false/disabled, client certificate is requested for each SSL session
418
+ # renegotiation.
419
+ # @rspec_example
420
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
421
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
422
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
373
423
  # @param [Hash] opts
374
424
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to request the client certificate once for the specified server SSL profiles.
375
425
  def set_authenticate_once_state(opts)
@@ -379,9 +429,10 @@ module IControl::LocalLB
379
429
 
380
430
  ##
381
431
  # Sets the CA filenames for this server SSL profile.
382
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
383
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
384
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
432
+ # @rspec_example
433
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
434
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
435
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
385
436
  # @param [Hash] opts
386
437
  # @option opts [IControl::LocalLB::ProfileString] :cas The CA filenames for the specified server SSL profiles.
387
438
  def set_ca_file(opts)
@@ -391,9 +442,10 @@ module IControl::LocalLB
391
442
 
392
443
  ##
393
444
  # Sets the SSL session cache sizes for this server SSL profile.
394
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
395
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
396
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
445
+ # @rspec_example
446
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
447
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
448
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
397
449
  # @param [Hash] opts
398
450
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The SSL session cache sizes for the specified server SSL profiles.
399
451
  def set_cache_size(opts)
@@ -403,9 +455,10 @@ module IControl::LocalLB
403
455
 
404
456
  ##
405
457
  # Sets the SSL session cache timeouts for this server SSL profile.
406
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
407
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
408
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
458
+ # @rspec_example
459
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
460
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
461
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
409
462
  # @param [Hash] opts
410
463
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The SSL session cache timeouts for the specified server SSL profiles.
411
464
  def set_cache_timeout(opts)
@@ -415,9 +468,10 @@ module IControl::LocalLB
415
468
 
416
469
  ##
417
470
  # Sets the certificate filenames to be used by this server SSL profile.
418
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
419
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
420
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
471
+ # @rspec_example
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.
421
475
  # @param [Hash] opts
422
476
  # @option opts [IControl::LocalLB::ProfileString] :certs The certificate filenames to be used by the specified server SSL profiles.
423
477
  def set_certificate_file(opts)
@@ -427,9 +481,10 @@ module IControl::LocalLB
427
481
 
428
482
  ##
429
483
  # Sets the certificate chain filenames for this server SSL profile.
430
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
431
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
432
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
484
+ # @rspec_example
485
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
486
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
487
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
433
488
  # @param [Hash] opts
434
489
  # @option opts [IControl::LocalLB::ProfileString] :chains The certificate chain filenames for the specified server SSL profiles.
435
490
  def set_chain_file(opts)
@@ -439,9 +494,10 @@ module IControl::LocalLB
439
494
 
440
495
  ##
441
496
  # Sets the cipher lists for this server SSL profile.
442
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
443
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
444
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
497
+ # @rspec_example
498
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
499
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
500
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
445
501
  # @param [Hash] opts
446
502
  # @option opts [IControl::LocalLB::ProfileStringArray] :ciphers The cipher lists for the specified server SSL profiles.
447
503
  def set_cipher_list(opts)
@@ -451,9 +507,10 @@ module IControl::LocalLB
451
507
 
452
508
  ##
453
509
  # Sets the CRL filenames for this server SSL profile.
454
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
455
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
456
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
510
+ # @rspec_example
511
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
512
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
513
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
457
514
  # @param [Hash] opts
458
515
  # @option opts [IControl::LocalLB::ProfileString] :crls The CRL filenames to be used by the specified server SSL profiles.
459
516
  def set_crl_file(opts)
@@ -462,10 +519,12 @@ module IControl::LocalLB
462
519
  end
463
520
 
464
521
  ##
465
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
466
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
467
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
468
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
522
+ # Sets the names of the default profile from which this profile will derive default
523
+ # values for its attributes.
524
+ # @rspec_example
525
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
526
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
527
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
469
528
  # @param [Hash] opts
470
529
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
471
530
  def set_default_profile(opts)
@@ -474,10 +533,12 @@ module IControl::LocalLB
474
533
  end
475
534
 
476
535
  ##
477
- # Sets the connection timeouts (in seconds) during handshake phase for this server SSL profile.
478
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
479
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
480
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
536
+ # Sets the connection timeouts (in seconds) during handshake phase for this server
537
+ # SSL profile.
538
+ # @rspec_example
539
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
540
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
541
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
481
542
  # @param [Hash] opts
482
543
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The connection timeouts (in seconds) during handshake phase for the specified server SSL profiles.
483
544
  def set_handshake_timeout(opts)
@@ -487,9 +548,10 @@ module IControl::LocalLB
487
548
 
488
549
  ##
489
550
  # Sets the key filenames to be used by this server SSL profile.
490
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
491
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
492
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
493
555
  # @param [Hash] opts
494
556
  # @option opts [IControl::LocalLB::ProfileString] :keys The key filenames to be used by the specified server SSL profiles.
495
557
  def set_key_file(opts)
@@ -499,9 +561,10 @@ module IControl::LocalLB
499
561
 
500
562
  ##
501
563
  # Sets the states to emulate modSSL for this server SSL profile.
502
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
503
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
504
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
564
+ # @rspec_example
565
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
566
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
567
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
505
568
  # @param [Hash] opts
506
569
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to emulate modSSL for the specified server SSL profiles.
507
570
  def set_modssl_emulation_state(opts)
@@ -511,9 +574,10 @@ module IControl::LocalLB
511
574
 
512
575
  ##
513
576
  # Sets the key passphrases (if any) for this server SSL profile.
514
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
515
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
516
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
577
+ # @rspec_example
578
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
579
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
580
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
517
581
  # @param [Hash] opts
518
582
  # @option opts [IControl::LocalLB::ProfileString] :passphrases The key passphrases (if any) for the specified server SSL profiles.
519
583
  def set_passphrase(opts)
@@ -523,9 +587,10 @@ module IControl::LocalLB
523
587
 
524
588
  ##
525
589
  # Sets the peer certification modes for this server SSL profile.
526
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
527
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
528
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
590
+ # @rspec_example
591
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
592
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
593
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
529
594
  # @param [Hash] opts
530
595
  # @option opts [IControl::LocalLB::ProfileServerSSLCertificateMode] :modes The peer certification modes for the specified server SSL profiles.
531
596
  def set_peer_certificate_mode(opts)
@@ -535,9 +600,10 @@ module IControl::LocalLB
535
600
 
536
601
  ##
537
602
  # Sets the modes for this server SSL profile.
538
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
539
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
540
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
603
+ # @rspec_example
604
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
605
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
606
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
541
607
  # @param [Hash] opts
542
608
  # @option opts [IControl::LocalLB::ProfileProfileMode] :modes The modes of the specified server SSL profiles.
543
609
  def set_profile_mode(opts)
@@ -547,9 +613,10 @@ module IControl::LocalLB
547
613
 
548
614
  ##
549
615
  # Sets the SSL renegotiation periods for this server SSL profile.
550
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
551
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
552
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
616
+ # @rspec_example
617
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
618
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
619
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
553
620
  # @param [Hash] opts
554
621
  # @option opts [IControl::LocalLB::ProfileULong] :periods The SSL renegotiation periods for the specified server SSL profiles.
555
622
  def set_renegotiation_period(opts)
@@ -558,10 +625,15 @@ module IControl::LocalLB
558
625
  end
559
626
 
560
627
  ##
561
- # Sets the states controlling whether mid-stream renegotiation is allowed for this server SSL profile. If renegotiations are enabled, the behavior is unchanged from previous releases, and mid-stream SSL renegotiations are allowed. If renegotiations are disabled, and we are acting as an SSL client, we ignore the server's HelloRequest messages. For ServerSSL, renegotiations are enabled by default.
562
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
563
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
564
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
628
+ # Sets the states controlling whether mid-stream renegotiation is allowed for this
629
+ # server SSL profile. If renegotiations are enabled, the behavior is unchanged from
630
+ # previous releases, and mid-stream SSL renegotiations are allowed. If renegotiations
631
+ # are disabled, and we are acting as an SSL client, we ignore the server's HelloRequest
632
+ # messages. For ServerSSL, renegotiations are enabled by default.
633
+ # @rspec_example
634
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
635
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
636
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
565
637
  # @param [Hash] opts
566
638
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
567
639
  def set_renegotiation_state(opts)
@@ -571,9 +643,10 @@ module IControl::LocalLB
571
643
 
572
644
  ##
573
645
  # Sets the SSL renegotiation throughputs for this server SSL profile.
574
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
575
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
576
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
646
+ # @rspec_example
647
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
648
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
649
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
577
650
  # @param [Hash] opts
578
651
  # @option opts [IControl::LocalLB::ProfileULong] :throughputs The SSL renegotiation throughputs for the specified server SSL profiles.
579
652
  def set_renegotiation_throughput(opts)
@@ -583,9 +656,10 @@ module IControl::LocalLB
583
656
 
584
657
  ##
585
658
  # Sets the SSL options for this server SSL profile.
586
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
587
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
588
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
659
+ # @rspec_example
660
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
661
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
662
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
589
663
  # @param [Hash] opts
590
664
  # @option opts [IControl::LocalLB::ProfileSSLOption] :options The list of SSL options for the specified server SSL profiles.
591
665
  def set_ssl_option(opts)
@@ -594,10 +668,13 @@ module IControl::LocalLB
594
668
  end
595
669
 
596
670
  ##
597
- # Sets the states to enforce strict SSL session resumption per RFC2246 for this server SSL profile. If the state is true/enabled, don't send a close notify alert when closing connection.
598
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
599
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
600
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
671
+ # Sets the states to enforce strict SSL session resumption per RFC2246 for this server
672
+ # SSL profile. If the state is true/enabled, don't send a close notify alert when closing
673
+ # connection.
674
+ # @rspec_example
675
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
676
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
677
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
601
678
  # @param [Hash] opts
602
679
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to enforce strict SSL session resumption per RFC2246 for the specified server SSL profiles.
603
680
  def set_strict_resume_state(opts)
@@ -606,10 +683,12 @@ module IControl::LocalLB
606
683
  end
607
684
 
608
685
  ##
609
- # Sets the states to do an unclean shutdown for this server SSL profile. If the state is true/enabled, don't send a close notify alert when closing connection.
610
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
611
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
612
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
686
+ # Sets the states to do an unclean shutdown for this server SSL profile. If the state
687
+ # is true/enabled, don't send a close notify alert when closing connection.
688
+ # @rspec_example
689
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
690
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
691
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
613
692
  # @param [Hash] opts
614
693
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to do an unclean shutdown for the specified server SSL profiles.
615
694
  def set_unclean_shutdown_state(opts)
@@ -620,18 +699,18 @@ module IControl::LocalLB
620
699
  ##
621
700
  # A struct that describes statistics for a particular server SSL profile.
622
701
  # @attr [String] profile_name The profile name.
623
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
702
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
624
703
  class ProfileServerSSLStatisticEntry < IControl::Base::Struct
625
704
  icontrol_attribute :profile_name, String
626
- icontrol_attribute :statistics, IControl::Common::Statistic
705
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
627
706
  end
628
707
 
629
708
  ##
630
709
  # A struct that describes profile statistics and timestamp.
631
- # @attr [IControl::LocalLB::ProfileServerSSL::ProfileServerSSLStatisticEntry] statistics The statistics for a sequence of profiles.
710
+ # @attr [IControl::LocalLB::ProfileServerSSL::ProfileServerSSLStatisticEntrySequence] statistics The statistics for a sequence of profiles.
632
711
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
633
712
  class ProfileServerSSLStatistics < IControl::Base::Struct
634
- icontrol_attribute :statistics, IControl::LocalLB::ProfileServerSSL::ProfileServerSSLStatisticEntry
713
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileServerSSL::ProfileServerSSLStatisticEntrySequence
635
714
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
636
715
  end
637
716