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,16 +1,19 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileHttpClass interface enables you to manipulate a local load balancer's ability to classify HTTP traffic.
3
+ # The ProfileHttpClass interface enables you to manipulate a local load balancer's
4
+ # ability to classify HTTP traffic.
4
5
  class ProfileHttpClass < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
7
8
 
8
9
  class ProfileHttpClassStatisticEntry < IControl::Base::Struct; end
9
- class ProfileHttpClassStatistics < IControl::Base::Struct; end ##
10
+ class ProfileHttpClassStatistics < IControl::Base::Struct; end
11
+ class ProfileHttpClassStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
12
  # Adds to the lists of patterns used to match the cookies.
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
  # @param [Hash] opts
15
18
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be added to the cookie match pattern list.
16
19
  def add_cookie_match_pattern(opts)
@@ -20,9 +23,10 @@ module IControl::LocalLB
20
23
 
21
24
  ##
22
25
  # Adds to the lists of patterns used to match the headers.
23
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
26
+ # @rspec_example
27
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
28
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
29
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
30
  # @param [Hash] opts
27
31
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be added to the host match pattern list.
28
32
  def add_header_match_pattern(opts)
@@ -32,9 +36,10 @@ module IControl::LocalLB
32
36
 
33
37
  ##
34
38
  # Adds to the lists of patterns used to match the hosts.
35
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
39
+ # @rspec_example
40
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
41
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
42
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
38
43
  # @param [Hash] opts
39
44
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be added to the host match pattern list.
40
45
  def add_host_match_pattern(opts)
@@ -44,9 +49,10 @@ module IControl::LocalLB
44
49
 
45
50
  ##
46
51
  # Adds to the lists of patterns used to match the URI paths.
47
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
48
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
49
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
52
+ # @rspec_example
53
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
50
56
  # @param [Hash] opts
51
57
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be added to the URI path match pattern list.
52
58
  def add_path_match_pattern(opts)
@@ -56,153 +62,173 @@ module IControl::LocalLB
56
62
 
57
63
  ##
58
64
  # Creates this HTTP class profile.
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.
65
+ # @rspec_example
66
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
67
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
68
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
69
  def create
63
70
  super
64
71
  end
65
72
 
66
73
  ##
67
74
  # Deletes all HTTP class profile.
68
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
69
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
70
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
75
+ # @rspec_example
76
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
77
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
78
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
71
79
  def delete_all_profiles
72
80
  super
73
81
  end
74
82
 
75
83
  ##
76
84
  # Deletes this HTTP class profile.
77
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
78
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
79
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
85
+ # @rspec_example
86
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
80
89
  def delete_profile
81
90
  super
82
91
  end
83
92
 
84
93
  ##
85
94
  # Gets the statistics for all the profile.
95
+ # @rspec_example
86
96
  # @return [ProfileHttpClassStatistics]
87
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
88
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
89
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
97
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
99
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
90
100
  def all_statistics
91
101
  super
92
102
  end
93
103
 
94
104
  ##
95
- # Gets the states that specify whether specified classes are Application Security Module classes.
105
+ # Gets the states that specify whether specified classes are Application Security Module
106
+ # classes.
107
+ # @rspec_example
96
108
  # @return [ProfileEnabledState]
97
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
99
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
109
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
100
112
  def application_security_module_enabled_state
101
113
  super
102
114
  end
103
115
 
104
116
  ##
105
117
  # Gets the lists of patterns used to match the cookies.
118
+ # @rspec_example
106
119
  # @return [ProfileMatchPatternStringArray]
107
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
108
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
109
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
120
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
110
123
  def cookie_match_pattern
111
124
  super
112
125
  end
113
126
 
114
127
  ##
115
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
128
+ # Gets the names of the default profile from which this profile will derive default
129
+ # values for its attributes.
130
+ # @rspec_example
116
131
  # @return [String]
117
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
118
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
119
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
132
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
120
135
  def default_profile
121
136
  super
122
137
  end
123
138
 
124
139
  ##
125
140
  # Gets the lists of patterns used to match the headers.
141
+ # @rspec_example
126
142
  # @return [ProfileMatchPatternStringArray]
127
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
128
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
129
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
143
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
130
146
  def header_match_pattern
131
147
  super
132
148
  end
133
149
 
134
150
  ##
135
151
  # Gets the lists of patterns used to match the hosts.
152
+ # @rspec_example
136
153
  # @return [ProfileMatchPatternStringArray]
137
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
154
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
155
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
156
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
140
157
  def host_match_pattern
141
158
  super
142
159
  end
143
160
 
144
161
  ##
145
162
  # Gets a list of all HTTP class profile.
163
+ # @rspec_example
146
164
  # @return [String]
147
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
148
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
149
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
165
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
166
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
167
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
150
168
  def list
151
169
  super
152
170
  end
153
171
 
154
172
  ##
155
173
  # Gets the lists of patterns used to match the URI paths.
174
+ # @rspec_example
156
175
  # @return [ProfileMatchPatternStringArray]
157
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
158
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
159
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
176
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
177
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
178
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
160
179
  def path_match_pattern
161
180
  super
162
181
  end
163
182
 
164
183
  ##
165
184
  # Gets the pool names to use when this classes match.
185
+ # @rspec_example
166
186
  # @return [ProfileString]
167
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
168
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
169
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
187
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
188
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
189
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
170
190
  def pool_name
171
191
  super
172
192
  end
173
193
 
174
194
  ##
175
- # Gets the string (which may include a TCL expression) to indicates where to redirect the original HTTP request once a match occurs. For example, to redirect requests to https://myserver.com to http://myotherserver.com.
195
+ # Gets the string (which may include a TCL expression) to indicates where to redirect
196
+ # the original HTTP request once a match occurs. For example, to redirect requests
197
+ # to https://myserver.com to http://myotherserver.com.
198
+ # @rspec_example
176
199
  # @return [ProfileString]
177
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
178
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
179
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
200
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
201
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
202
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
180
203
  def redirect_location
181
204
  super
182
205
  end
183
206
 
184
207
  ##
185
208
  # Gets the strings (which may include a TCL expression) with which to rewrite the URLs.
209
+ # @rspec_example
186
210
  # @return [ProfileString]
187
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
188
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
189
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
211
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
190
214
  def rewrite_url
191
215
  super
192
216
  end
193
217
 
194
218
  ##
195
219
  # Gets the statistics for this profile.
220
+ # @rspec_example
196
221
  # @return [ProfileHttpClassStatistics]
197
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
198
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
199
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
222
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
223
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
224
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
200
225
  def statistics
201
226
  super
202
227
  end
203
228
 
204
229
  ##
205
230
  # Gets the version information for this interface.
231
+ # @rspec_example
206
232
  # @return [String]
207
233
  def version
208
234
  super
@@ -210,29 +236,33 @@ module IControl::LocalLB
210
236
 
211
237
  ##
212
238
  # Gets the states that specify whether specified classes are Web Accelerator classes.
239
+ # @rspec_example
213
240
  # @return [ProfileEnabledState]
214
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
215
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
216
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
241
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
242
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
243
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
217
244
  def web_accelerator_module_enabled_state
218
245
  super
219
246
  end
220
247
 
221
248
  ##
222
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
249
+ # Determines whether this profile are base/pre-configured profile, or user-defined
250
+ # profile.
251
+ # @rspec_example
223
252
  # @return [boolean]
224
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
225
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
226
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
253
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
254
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
255
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
227
256
  def is_base_profile
228
257
  super
229
258
  end
230
259
 
231
260
  ##
232
261
  # Removes from the lists of patterns used to match the cookies.
233
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
234
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
235
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
262
+ # @rspec_example
263
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
264
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
265
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
236
266
  # @param [Hash] opts
237
267
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be removed from the cookie match pattern list.
238
268
  def remove_cookie_match_pattern(opts)
@@ -242,9 +272,10 @@ module IControl::LocalLB
242
272
 
243
273
  ##
244
274
  # Removes from the lists of patterns used to match the headers.
245
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
246
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
247
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
275
+ # @rspec_example
276
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
277
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
278
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
248
279
  # @param [Hash] opts
249
280
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be added to the host match pattern list.
250
281
  def remove_header_match_pattern(opts)
@@ -254,9 +285,10 @@ module IControl::LocalLB
254
285
 
255
286
  ##
256
287
  # Removes from the lists of patterns used to match the hosts.
257
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
258
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
259
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
288
+ # @rspec_example
289
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
290
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
291
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
260
292
  # @param [Hash] opts
261
293
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be removed from the host match pattern list.
262
294
  def remove_host_match_pattern(opts)
@@ -266,9 +298,10 @@ module IControl::LocalLB
266
298
 
267
299
  ##
268
300
  # Removes from the lists of patterns used to match the URI paths.
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.
301
+ # @rspec_example
302
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
303
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
304
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
272
305
  # @param [Hash] opts
273
306
  # @option opts [IControl::LocalLB::MatchPatternString[]] :patterns The lists of patterns (regular expressions or globs) to be removed from the URI path match pattern list.
274
307
  def remove_path_match_pattern(opts)
@@ -278,18 +311,21 @@ module IControl::LocalLB
278
311
 
279
312
  ##
280
313
  # Resets the statistics for this profile.
281
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
282
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
283
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
314
+ # @rspec_example
315
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
316
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
317
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
284
318
  def reset_statistics
285
319
  super
286
320
  end
287
321
 
288
322
  ##
289
- # Sets the states that specify whether specified classes are Application Security Module classes.
290
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
291
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
292
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
323
+ # Sets the states that specify whether specified classes are Application Security Module
324
+ # classes.
325
+ # @rspec_example
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.
293
329
  # @param [Hash] opts
294
330
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
295
331
  def set_application_security_module_enabled_state(opts)
@@ -299,45 +335,51 @@ module IControl::LocalLB
299
335
 
300
336
  ##
301
337
  # Resets the lists to parent defaults.
302
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
303
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
304
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
338
+ # @rspec_example
339
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
340
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
341
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
305
342
  def set_default_cookie_match_pattern
306
343
  super
307
344
  end
308
345
 
309
346
  ##
310
347
  # Resets the lists to parent defaults.
311
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
312
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
313
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
348
+ # @rspec_example
349
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
350
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
351
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
314
352
  def set_default_header_match_pattern
315
353
  super
316
354
  end
317
355
 
318
356
  ##
319
357
  # Resets the lists to parent defaults.
320
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
321
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
322
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
358
+ # @rspec_example
359
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
360
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
361
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
323
362
  def set_default_host_match_pattern
324
363
  super
325
364
  end
326
365
 
327
366
  ##
328
367
  # Resets the lists to parent defaults.
329
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
330
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
331
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
368
+ # @rspec_example
369
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
370
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
371
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
332
372
  def set_default_path_match_pattern
333
373
  super
334
374
  end
335
375
 
336
376
  ##
337
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
338
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
339
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
340
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
377
+ # Sets the names of the default profile from which this profile will derive default
378
+ # values for its attributes.
379
+ # @rspec_example
380
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
381
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
382
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
341
383
  # @param [Hash] opts
342
384
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
343
385
  def set_default_profile(opts)
@@ -347,9 +389,10 @@ module IControl::LocalLB
347
389
 
348
390
  ##
349
391
  # Sets the pool names to use when this classes match.
350
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
351
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
352
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
392
+ # @rspec_example
393
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
394
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
395
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
353
396
  # @param [Hash] opts
354
397
  # @option opts [IControl::LocalLB::ProfileString] :pool_names The pool names.
355
398
  def set_pool_name(opts)
@@ -358,10 +401,13 @@ module IControl::LocalLB
358
401
  end
359
402
 
360
403
  ##
361
- # Sets the string (which may include a TCL expression) to indicates where to redirect the original HTTP request once a match occurs. For example, to redirect requests to https://myserver.com to http://myotherserver.com.
362
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
363
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
364
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
404
+ # Sets the string (which may include a TCL expression) to indicates where to redirect
405
+ # the original HTTP request once a match occurs. For example, to redirect requests
406
+ # to https://myserver.com to http://myotherserver.com.
407
+ # @rspec_example
408
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
409
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
410
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
365
411
  # @param [Hash] opts
366
412
  # @option opts [IControl::LocalLB::ProfileString] :redirect_locations The new locations to redirect to.
367
413
  def set_redirect_location(opts)
@@ -371,9 +417,10 @@ module IControl::LocalLB
371
417
 
372
418
  ##
373
419
  # Sets the strings (which may include a TCL expression) with which to rewrite the URLs.
374
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
375
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
376
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
420
+ # @rspec_example
421
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
422
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
423
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
377
424
  # @param [Hash] opts
378
425
  # @option opts [IControl::LocalLB::ProfileString] :urls The URLs to rewrite.
379
426
  def set_rewrite_url(opts)
@@ -383,9 +430,10 @@ module IControl::LocalLB
383
430
 
384
431
  ##
385
432
  # Sets the states that specify whether specified classes are Web Accelerator classes.
386
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
387
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
388
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
433
+ # @rspec_example
434
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
435
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
436
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
389
437
  # @param [Hash] opts
390
438
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
391
439
  def set_web_accelerator_module_enabled_state(opts)
@@ -396,18 +444,18 @@ module IControl::LocalLB
396
444
  ##
397
445
  # A struct that describes statistics for a particular HTTP class profile.
398
446
  # @attr [String] profile_name The profile name.
399
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
447
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
400
448
  class ProfileHttpClassStatisticEntry < IControl::Base::Struct
401
449
  icontrol_attribute :profile_name, String
402
- icontrol_attribute :statistics, IControl::Common::Statistic
450
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
403
451
  end
404
452
 
405
453
  ##
406
454
  # A struct that describes profile statistics and timestamp.
407
- # @attr [IControl::LocalLB::ProfileHttpClass::ProfileHttpClassStatisticEntry] statistics The statistics for a sequence of profiles.
455
+ # @attr [IControl::LocalLB::ProfileHttpClass::ProfileHttpClassStatisticEntrySequence] statistics The statistics for a sequence of profiles.
408
456
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
409
457
  class ProfileHttpClassStatistics < IControl::Base::Struct
410
- icontrol_attribute :statistics, IControl::LocalLB::ProfileHttpClass::ProfileHttpClassStatisticEntry
458
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileHttpClass::ProfileHttpClassStatisticEntrySequence
411
459
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
412
460
  end
413
461