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
@@ -8,11 +8,19 @@ module IControl::LocalLB
8
8
  class NamespaceMapping < IControl::Base::Struct; end
9
9
  class ProfileNamespaceMappingSequence < IControl::Base::Struct; end
10
10
  class ProfileXMLStatisticEntry < IControl::Base::Struct; end
11
- class ProfileXMLStatistics < IControl::Base::Struct; end ##
12
- # Adds sets of namespace mappings to a set of XML profile. Specifies a list of mappings between namespaces and prefixes to be used in the profile context. For example, to define a namespace mapping of XML schema namespace one would add the namespace mapping of the prefix &amp;quot;xsd" to the namespace &amp;quot;http://www.w3.org/2001/XMLSchema".
13
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
11
+ class ProfileXMLStatistics < IControl::Base::Struct; end
12
+ class NamespaceMappingSequence < IControl::Base::Sequence ; end
13
+ class NamespaceMappingSequenceSequence < IControl::Base::SequenceSequence ; end
14
+ class ProfileNamespaceMappingSequenceSequence < IControl::Base::SequenceSequence ; end
15
+ class ProfileXMLStatisticEntrySequence < IControl::Base::Sequence ; end ##
16
+ # Adds sets of namespace mappings to a set of XML profile. Specifies a list of mappings
17
+ # between namespaces and prefixes to be used in the profile context. For example, to
18
+ # define a namespace mapping of XML schema namespace one would add the namespace mapping
19
+ # of the prefix &amp;quot;xsd" to the namespace &amp;quot;http://www.w3.org/2001/XMLSchema".
20
+ # @rspec_example
21
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
16
24
  # @param [Hash] opts
17
25
  # @option opts [IControl::LocalLB::ProfileXML::NamespaceMapping[]] :namespace_mappings The lists of namespace mappings to be added to the namespace mappings list for each of the XML profiles respectively.
18
26
  def add_namespace_mappings(opts)
@@ -21,10 +29,14 @@ module IControl::LocalLB
21
29
  end
22
30
 
23
31
  ##
24
- # Adds sets of XPath query strings to a set of XML profile. A match of any of the queries will trigger an iRule event. For example, to trigger an iRule event on document having title of the first book node under the bookstore element it's needed to add the &amp;quot;/bookstore/book[1]/title" XPath query to a xml profile.
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
27
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # Adds sets of XPath query strings to a set of XML profile. A match of any of the queries
33
+ # will trigger an iRule event. For example, to trigger an iRule event on document having
34
+ # title of the first book node under the bookstore element it's needed to add the &amp;quot;/bookstore/book[1]/title"
35
+ # XPath query to a xml profile.
36
+ # @rspec_example
37
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
38
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
39
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
28
40
  # @param [Hash] opts
29
41
  # @option opts [String[]] :xpath_queries The lists of XPath queries to be added to the XPath queries list of each XML profile respectively.
30
42
  def add_xpath_queries(opts)
@@ -34,103 +46,115 @@ module IControl::LocalLB
34
46
 
35
47
  ##
36
48
  # Creates this XML profile.
37
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
38
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
39
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
49
+ # @rspec_example
50
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
51
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
52
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
40
53
  def create
41
54
  super
42
55
  end
43
56
 
44
57
  ##
45
58
  # Deletes all XML profile.
46
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
59
+ # @rspec_example
60
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
61
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
62
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
49
63
  def delete_all_profiles
50
64
  super
51
65
  end
52
66
 
53
67
  ##
54
68
  # Deletes this XML profile.
55
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
56
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
57
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
69
+ # @rspec_example
70
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
58
73
  def delete_profile
59
74
  super
60
75
  end
61
76
 
62
77
  ##
63
78
  # Gets the state that if true, abort the connection on errors.
79
+ # @rspec_example
64
80
  # @return [ProfileEnabledState]
65
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
81
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
82
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
83
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
68
84
  def abort_on_error_state
69
85
  super
70
86
  end
71
87
 
72
88
  ##
73
89
  # Gets the statistics for all the XML profile.
90
+ # @rspec_example
74
91
  # @return [ProfileXMLStatistics]
75
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
92
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
93
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
94
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
78
95
  def all_statistics
79
96
  super
80
97
  end
81
98
 
82
99
  ##
83
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
100
+ # Gets the names of the default profile from which this profile will derive default
101
+ # values for its attributes.
102
+ # @rspec_example
84
103
  # @return [String]
85
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
104
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
105
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
106
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
88
107
  def default_profile
89
108
  super
90
109
  end
91
110
 
92
111
  ##
93
112
  # Gets a list of all XML profile.
113
+ # @rspec_example
94
114
  # @return [String]
95
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
115
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
98
118
  def list
99
119
  super
100
120
  end
101
121
 
102
122
  ##
103
123
  # Gets the values that specify the maximum buffer size for this profile.
124
+ # @rspec_example
104
125
  # @return [ProfileULong]
105
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
126
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
127
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
128
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
108
129
  def maximum_buffer_size
109
130
  super
110
131
  end
111
132
 
112
133
  ##
113
134
  # Gets sets of namespace mappings of a set of XML profile.
135
+ # @rspec_example
114
136
  # @return [ProfileNamespaceMappingSequence]
115
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
137
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
118
140
  def namespace_mappings
119
141
  super
120
142
  end
121
143
 
122
144
  ##
123
145
  # Gets the statistics for this XML profile.
146
+ # @rspec_example
124
147
  # @return [ProfileXMLStatistics]
125
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
126
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
127
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
128
151
  def statistics
129
152
  super
130
153
  end
131
154
 
132
155
  ##
133
156
  # Gets the version information for this interface.
157
+ # @rspec_example
134
158
  # @return [String]
135
159
  def version
136
160
  super
@@ -138,47 +162,53 @@ module IControl::LocalLB
138
162
 
139
163
  ##
140
164
  # Gets sets of XPath query strings of a set of XML profile.
165
+ # @rspec_example
141
166
  # @return [ProfileStringArray]
142
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
143
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
144
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
167
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
168
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
169
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
145
170
  def xpath_queries
146
171
  super
147
172
  end
148
173
 
149
174
  ##
150
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
175
+ # Determines whether this profile are base/pre-configured profile, or user-defined
176
+ # profile.
177
+ # @rspec_example
151
178
  # @return [boolean]
152
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
153
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
154
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
179
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
180
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
181
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
155
182
  def is_base_profile
156
183
  super
157
184
  end
158
185
 
159
186
  ##
160
187
  # Removes all the namespace mappings from a set of XML profile.
161
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
162
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
163
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
188
+ # @rspec_example
189
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
190
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
191
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
164
192
  def remove_all_namespace_mappings
165
193
  super
166
194
  end
167
195
 
168
196
  ##
169
197
  # Removes all the XPath queries from a set of XML profile.
170
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
171
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
172
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
198
+ # @rspec_example
199
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
200
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
201
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
173
202
  def remove_all_xpath_queries
174
203
  super
175
204
  end
176
205
 
177
206
  ##
178
207
  # Removes sets of namespace mappings from a set of XML profile.
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.
208
+ # @rspec_example
209
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
210
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
211
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
182
212
  # @param [Hash] opts
183
213
  # @option opts [IControl::LocalLB::ProfileXML::NamespaceMapping[]] :namespace_mappings The lists of namespace mappings to be removed from each of the XML profiles respectively.
184
214
  def remove_namespace_mappings(opts)
@@ -188,9 +218,10 @@ module IControl::LocalLB
188
218
 
189
219
  ##
190
220
  # Removes sets of XPath query strings from a set of XML profile.
191
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
221
+ # @rspec_example
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.
194
225
  # @param [Hash] opts
195
226
  # @option opts [String[]] :xpath_queries The lists of XPath queries to be removed from the XPath queries list of each XML profile respectively.
196
227
  def remove_xpath_queries(opts)
@@ -200,18 +231,20 @@ module IControl::LocalLB
200
231
 
201
232
  ##
202
233
  # Resets the statistics for this XML profile.
203
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
204
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
205
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
234
+ # @rspec_example
235
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
236
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
237
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
206
238
  def reset_statistics
207
239
  super
208
240
  end
209
241
 
210
242
  ##
211
243
  # Sets the state that if true, abort the connection on errors.
212
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
213
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
214
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
244
+ # @rspec_example
245
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
246
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
247
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
215
248
  # @param [Hash] opts
216
249
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified profiles.
217
250
  def set_abort_on_error_state(opts)
@@ -220,10 +253,12 @@ module IControl::LocalLB
220
253
  end
221
254
 
222
255
  ##
223
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
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.
256
+ # Sets the names of the default profile from which this profile will derive default
257
+ # values for its attributes.
258
+ # @rspec_example
259
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
260
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
261
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
227
262
  # @param [Hash] opts
228
263
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
229
264
  def set_default_profile(opts)
@@ -233,9 +268,10 @@ module IControl::LocalLB
233
268
 
234
269
  ##
235
270
  # Sets the values that specify the maximum buffer size for this profile.
236
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
237
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
238
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
271
+ # @rspec_example
272
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
273
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
274
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
239
275
  # @param [Hash] opts
240
276
  # @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum buffer sizes.
241
277
  def set_maximum_buffer_size(opts)
@@ -253,29 +289,30 @@ module IControl::LocalLB
253
289
  end
254
290
 
255
291
  ##
256
- # A structure that specifies a sequence of namespace mappings strings used in profile attributes.
257
- # @attr [IControl::LocalLB::ProfileXML::NamespaceMapping] values The namespace mappings strings.
292
+ # A structure that specifies a sequence of namespace mappings strings used in profile
293
+ # attributes.
294
+ # @attr [IControl::LocalLB::ProfileXML::NamespaceMappingSequence] values The namespace mappings strings.
258
295
  # @attr [Object] default_flag The flag that indicates how the value should be interpreted. On queries, if default_flag is true, that means the requested value is the parent profile's value. If false, that means the requested value has been explicitly set. On creations/modifications, if default_flag is true, that means the parent profile's value should be restored for this attribute value, hence the passed-in value is ignored. If false, that means the user wants to set the attribute value using the passed-in value.
259
296
  class ProfileNamespaceMappingSequence < IControl::Base::Struct
260
- icontrol_attribute :values, IControl::LocalLB::ProfileXML::NamespaceMapping
297
+ icontrol_attribute :values, IControl::LocalLB::ProfileXML::NamespaceMappingSequence
261
298
  icontrol_attribute :default_flag, Object
262
299
  end
263
300
 
264
301
  ##
265
302
  # A struct that describes statistics for a particular XML profile.
266
303
  # @attr [String] profile_name The profile name.
267
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
304
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
268
305
  class ProfileXMLStatisticEntry < IControl::Base::Struct
269
306
  icontrol_attribute :profile_name, String
270
- icontrol_attribute :statistics, IControl::Common::Statistic
307
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
271
308
  end
272
309
 
273
310
  ##
274
311
  # A struct that describes profile statistics and timestamp.
275
- # @attr [IControl::LocalLB::ProfileXML::ProfileXMLStatisticEntry] statistics The statistics for a sequence of profiles.
312
+ # @attr [IControl::LocalLB::ProfileXML::ProfileXMLStatisticEntrySequence] statistics The statistics for a sequence of profiles.
276
313
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
277
314
  class ProfileXMLStatistics < IControl::Base::Struct
278
- icontrol_attribute :statistics, IControl::LocalLB::ProfileXML::ProfileXMLStatisticEntry
315
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileXML::ProfileXMLStatisticEntrySequence
279
316
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
280
317
  end
281
318
 
@@ -1,6 +1,7 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The RAMCacheInformation interface enables you to query for RAM cache entries/statistics, as well as evicting RAM cache entries.
3
+ # The RAMCacheInformation interface enables you to query for RAM cache entries/statistics,
4
+ # as well as evicting RAM cache entries.
4
5
  class RAMCacheInformation < IControl::Base
5
6
 
6
7
  set_id_name "keys"
@@ -8,30 +9,42 @@ module IControl::LocalLB
8
9
  class RAMCacheEntry < IControl::Base::Struct; end
9
10
  class RAMCacheEntryExactMatch < IControl::Base::Struct; end
10
11
  class RAMCacheKey < IControl::Base::Struct; end
12
+ class RAMCacheEntryExactMatchSequence < IControl::Base::Sequence ; end
13
+ class RAMCacheEntryExactMatchSequenceSequence < IControl::Base::SequenceSequence ; end
14
+ class RAMCacheEntrySequence < IControl::Base::Sequence ; end
15
+ class RAMCacheEntrySequenceSequence < IControl::Base::SequenceSequence ; end
16
+ class RAMCacheKeySequence < IControl::Base::Sequence ; end
17
+ class RAMCacheVaryTypeSequence < IControl::Base::Sequence ; end
11
18
  # A list of types that indicate what type of content is cached.
12
19
  class RAMCacheVaryType < IControl::Base::Enumeration; end ##
13
20
  # Resets/evicts all cache entries.
14
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
21
+ # @rspec_example
22
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
17
25
  def evict_all_ramcache_entries
18
26
  super
19
27
  end
20
28
 
21
29
  ##
22
- # Note: This function has been deprecated. Please use evict_ramcache_entry_v2. Resets/evicts the cache entries associated with this key. Note: The &amp;quot;max_responses" field in each RAMCacheKey key is ignored in this method.
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.
30
+ # Note: This function has been deprecated. Please use evict_ramcache_entry_v2. Resets/evicts
31
+ # the cache entries associated with this key. Note: The &amp;quot;max_responses" field
32
+ # in each RAMCacheKey key is ignored in this method.
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.
26
37
  def evict_ramcache_entry
27
38
  super
28
39
  end
29
40
 
30
41
  ##
31
- # Resets/evicts the cache entries associated with this key. Note: The &amp;quot;max_responses" field in each RAMCacheKey key is ignored in this method.
32
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
42
+ # Resets/evicts the cache entries associated with this key. Note: The &amp;quot;max_responses"
43
+ # field in each RAMCacheKey key is ignored in this method.
44
+ # @rspec_example
45
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
46
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
47
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
35
48
  # @param [Hash] opts
36
49
  # @option opts [boolean] :exact_match Whether to look for an exact match for host and uri. If exact, you must specify host and uri in the key. If non-exact, host and uri can be a subset of the text in a matched entry during the search.
37
50
  def evict_ramcache_entry_v2(opts)
@@ -40,27 +53,37 @@ module IControl::LocalLB
40
53
  end
41
54
 
42
55
  ##
43
- # Gets the RAM cache entries associated with this key. The &amp;quot;profile_name" in the key is required, however, other fields in each key are optionally specified. &amp;quot;max_response" is recommended to be set to avoid possible large amount of entries.
56
+ # Gets the RAM cache entries associated with this key. The &amp;quot;profile_name"
57
+ # in the key is required, however, other fields in each key are optionally specified.
58
+ # &amp;quot;max_response" is recommended to be set to avoid possible large amount of
59
+ # entries.
60
+ # @rspec_example
44
61
  # @return [RAMCacheEntry[]]
45
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
46
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
47
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
62
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
48
65
  def ramcache_entry
49
66
  super
50
67
  end
51
68
 
52
69
  ##
53
- # Gets the RAM cache entries associated with this key. Each field in the key must be provided, and together the key is used to extract a specific entry. However, since each entry with the same profile/hostname/URI can still vary based on the User-Agent or Accept-Encoding headers, a separate entry will be returned for each variation, with also the specific header string that causes the variation.
70
+ # Gets the RAM cache entries associated with this key. Each field in the key must be
71
+ # provided, and together the key is used to extract a specific entry. However, since
72
+ # each entry with the same profile/hostname/URI can still vary based on the User-Agent
73
+ # or Accept-Encoding headers, a separate entry will be returned for each variation,
74
+ # with also the specific header string that causes the variation.
75
+ # @rspec_example
54
76
  # @return [RAMCacheEntryExactMatch[]]
55
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
56
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
57
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
77
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
78
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
79
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
58
80
  def ramcache_entry_exact_match
59
81
  super
60
82
  end
61
83
 
62
84
  ##
63
85
  # Gets the version information for this interface.
86
+ # @rspec_example
64
87
  # @return [String]
65
88
  def version
66
89
  super