icontrol 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -6,164 +6,187 @@ module IControl::LocalLB
6
6
  set_id_name "profile_names"
7
7
 
8
8
  class ProfileUDPStatisticEntry < IControl::Base::Struct; end
9
- class ProfileUDPStatistics < IControl::Base::Struct; end ##
9
+ class ProfileUDPStatistics < IControl::Base::Struct; end
10
+ class ProfileUDPStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
11
  # Creates this UDP profile.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
12
+ # @rspec_example
13
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
16
  def create
15
17
  super
16
18
  end
17
19
 
18
20
  ##
19
21
  # Deletes all UDP profile.
20
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
21
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
22
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
22
+ # @rspec_example
23
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
23
26
  def delete_all_profiles
24
27
  super
25
28
  end
26
29
 
27
30
  ##
28
31
  # Deletes this UDP profile.
29
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
30
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
31
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # @rspec_example
33
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
32
36
  def delete_profile
33
37
  super
34
38
  end
35
39
 
36
40
  ##
37
41
  # Gets the statistics for all the profile.
42
+ # @rspec_example
38
43
  # @return [ProfileUDPStatistics]
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.
44
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
45
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
46
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
47
  def all_statistics
43
48
  super
44
49
  end
45
50
 
46
51
  ##
47
- # Gets the states that if true, will allow UDP packets with no payload (just the UDP header) to propagate through the system.
52
+ # Gets the states that if true, will allow UDP packets with no payload (just the UDP
53
+ # header) to propagate through the system.
54
+ # @rspec_example
48
55
  # @return [ProfileEnabledState]
49
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
56
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
52
59
  def allow_no_payload_state
53
60
  super
54
61
  end
55
62
 
56
63
  ##
57
64
  # Gets the states that if true, will load balance each UDP datagram separately.
65
+ # @rspec_example
58
66
  # @return [ProfileEnabledState]
59
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
67
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
68
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
69
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
70
  def datagram_lb_state
63
71
  super
64
72
  end
65
73
 
66
74
  ##
67
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
75
+ # Gets the names of the default profile from which this profile will derive default
76
+ # values for its attributes.
77
+ # @rspec_example
68
78
  # @return [String]
69
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
79
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
72
82
  def default_profile
73
83
  super
74
84
  end
75
85
 
76
86
  ##
77
87
  # Gets the idle timeout for this UDP profile.
88
+ # @rspec_example
78
89
  # @return [ProfileULong]
79
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
90
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
93
  def idle_timeout
83
94
  super
84
95
  end
85
96
 
86
97
  ##
87
98
  # Gets the client-side IP TOS values for this UDP profile.
99
+ # @rspec_example
88
100
  # @return [ProfileULong]
89
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
101
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
102
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
103
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
104
  def ip_tos_to_client
93
105
  super
94
106
  end
95
107
 
96
108
  ##
97
109
  # Gets the client-side link QoS values for this UDP profile.
110
+ # @rspec_example
98
111
  # @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.
112
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
113
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
114
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
102
115
  def link_qos_to_client
103
116
  super
104
117
  end
105
118
 
106
119
  ##
107
120
  # Gets a list of all UDP profile.
121
+ # @rspec_example
108
122
  # @return [String]
109
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
123
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
112
126
  def list
113
127
  super
114
128
  end
115
129
 
116
130
  ##
117
- # Gets the states that if true, disables checksum processing (note: if the datagram is IPv6, the system always performs checksum processing).
131
+ # Gets the states that if true, disables checksum processing (note: if the datagram
132
+ # is IPv6, the system always performs checksum processing).
133
+ # @rspec_example
118
134
  # @return [ProfileEnabledState]
119
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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 no_checksum_state
123
139
  super
124
140
  end
125
141
 
126
142
  ##
127
143
  # Gets the statistics for this profile.
144
+ # @rspec_example
128
145
  # @return [ProfileUDPStatistics]
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 statistics
133
150
  super
134
151
  end
135
152
 
136
153
  ##
137
154
  # Gets the version information for this interface.
155
+ # @rspec_example
138
156
  # @return [String]
139
157
  def version
140
158
  super
141
159
  end
142
160
 
143
161
  ##
144
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
162
+ # Determines whether this profile are base/pre-configured profile, or user-defined
163
+ # profile.
164
+ # @rspec_example
145
165
  # @return [boolean]
146
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
147
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
148
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
166
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
167
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
168
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
149
169
  def is_base_profile
150
170
  super
151
171
  end
152
172
 
153
173
  ##
154
174
  # Resets the statistics for this profile.
155
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
156
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
157
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
175
+ # @rspec_example
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.
158
179
  def reset_statistics
159
180
  super
160
181
  end
161
182
 
162
183
  ##
163
- # Sets the states that if true, will allow UDP packets with no payload (just the UDP header) to propagate through the system.
164
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
165
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
166
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
184
+ # Sets the states that if true, will allow UDP packets with no payload (just the UDP
185
+ # header) to propagate through the system.
186
+ # @rspec_example
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.
167
190
  # @param [Hash] opts
168
191
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified UDP profiles.
169
192
  def set_allow_no_payload_state(opts)
@@ -173,9 +196,10 @@ module IControl::LocalLB
173
196
 
174
197
  ##
175
198
  # Sets the states that if true, will load balance each UDP datagram separately.
176
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
177
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
178
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
199
+ # @rspec_example
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.
179
203
  # @param [Hash] opts
180
204
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified UDP profiles.
181
205
  def set_datagram_lb_state(opts)
@@ -184,10 +208,12 @@ module IControl::LocalLB
184
208
  end
185
209
 
186
210
  ##
187
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
188
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
189
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
190
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
211
+ # Sets the names of the default profile from which this profile will derive default
212
+ # values for its attributes.
213
+ # @rspec_example
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.
191
217
  # @param [Hash] opts
192
218
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
193
219
  def set_default_profile(opts)
@@ -197,9 +223,10 @@ module IControl::LocalLB
197
223
 
198
224
  ##
199
225
  # Sets the idle timeout for this UDP profile.
200
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
201
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
202
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
226
+ # @rspec_example
227
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
228
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
229
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
203
230
  # @param [Hash] opts
204
231
  # @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeout for the specified UDP profiles.
205
232
  def set_idle_timeout(opts)
@@ -209,9 +236,10 @@ module IControl::LocalLB
209
236
 
210
237
  ##
211
238
  # Sets the client-side IP TOS values for this UDP profile.
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.
239
+ # @rspec_example
240
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
241
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
242
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
215
243
  # @param [Hash] opts
216
244
  # @option opts [IControl::LocalLB::ProfileULong] :values The client-side IP TOS values.
217
245
  def set_ip_tos_to_client(opts)
@@ -221,9 +249,10 @@ module IControl::LocalLB
221
249
 
222
250
  ##
223
251
  # Sets the client-side link QoS values for this UDP profile.
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.
252
+ # @rspec_example
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
  # @param [Hash] opts
228
257
  # @option opts [IControl::LocalLB::ProfileULong] :values The client-side link QoS values.
229
258
  def set_link_qos_to_client(opts)
@@ -232,10 +261,12 @@ module IControl::LocalLB
232
261
  end
233
262
 
234
263
  ##
235
- # Sets the states that if true, disables checksum processing (note: if the datagram is IPv6, the system always performs checksum processing).
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.
264
+ # Sets the states that if true, disables checksum processing (note: if the datagram
265
+ # is IPv6, the system always performs checksum processing).
266
+ # @rspec_example
267
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
268
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
269
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
239
270
  # @param [Hash] opts
240
271
  # @option opts [IControl::LocalLB::ProfileEnabledState] :states The states for the specified UDP profiles.
241
272
  def set_no_checksum_state(opts)
@@ -246,18 +277,18 @@ module IControl::LocalLB
246
277
  ##
247
278
  # A struct that describes statistics for a particular profile.
248
279
  # @attr [String] profile_name The profile name.
249
- # @attr [IControl::Common::Statistic] statistics The statistics for the profile.
280
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
250
281
  class ProfileUDPStatisticEntry < IControl::Base::Struct
251
282
  icontrol_attribute :profile_name, String
252
- icontrol_attribute :statistics, IControl::Common::Statistic
283
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
253
284
  end
254
285
 
255
286
  ##
256
287
  # A struct that describes profile statistics and timestamp.
257
- # @attr [IControl::LocalLB::ProfileUDP::ProfileUDPStatisticEntry] statistics The statistics for a sequence of profiles.
288
+ # @attr [IControl::LocalLB::ProfileUDP::ProfileUDPStatisticEntrySequence] statistics The statistics for a sequence of profiles.
258
289
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
259
290
  class ProfileUDPStatistics < IControl::Base::Struct
260
- icontrol_attribute :statistics, IControl::LocalLB::ProfileUDP::ProfileUDPStatisticEntry
291
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileUDP::ProfileUDPStatisticEntrySequence
261
292
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
262
293
  end
263
294
 
@@ -1,6 +1,7 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The ProfileUserStatistic interface enables you to manage user-defined statistics in a profile. The user can define up to 32 user-defined statistics in each profile.
3
+ # The ProfileUserStatistic interface enables you to manage user-defined statistics
4
+ # in a profile. The user can define up to 32 user-defined statistics in each profile.
4
5
  class ProfileUserStatistic < IControl::Base
5
6
 
6
7
  set_id_name "profile_names"
@@ -9,70 +10,88 @@ module IControl::LocalLB
9
10
  class ProfileUserStatisticStatistics < IControl::Base::Struct; end
10
11
  class UserStatistic < IControl::Base::Struct; end
11
12
  class UserStatisticName < IControl::Base::Struct; end
13
+ class ProfileUserStatisticStatisticEntrySequence < IControl::Base::Sequence ; end
14
+ class UserStatisticKeySequence < IControl::Base::Sequence ; end
15
+ class UserStatisticKeySequenceSequence < IControl::Base::SequenceSequence ; end
16
+ class UserStatisticNameSequence < IControl::Base::Sequence ; end
17
+ class UserStatisticNameSequenceSequence < IControl::Base::SequenceSequence ; end
18
+ class UserStatisticSequence < IControl::Base::Sequence ; end
12
19
  # A list of user statistic fields in the profile.
13
20
  class UserStatisticKey < IControl::Base::Enumeration; end ##
14
21
  # Creates this user-defined statistic profile.
15
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
22
+ # @rspec_example
23
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
18
26
  def create
19
27
  super
20
28
  end
21
29
 
22
30
  ##
23
31
  # Deletes all user-defined statistic profile.
24
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
32
+ # @rspec_example
33
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
27
36
  def delete_all_profiles
28
37
  super
29
38
  end
30
39
 
31
40
  ##
32
41
  # Deletes this user-defined statistic profile.
33
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
42
+ # @rspec_example
43
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
36
46
  def delete_profile
37
47
  super
38
48
  end
39
49
 
40
50
  ##
41
- # Gets the statistics for all the user-defined statistic profile. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned.
51
+ # Gets the statistics for all the user-defined statistic profile. Only the statistic
52
+ # values of the user-defined statistics will be returned, i.e. even though there are
53
+ # up to 32 custom statistics in any given profile, but if only 3 of those custom statistics
54
+ # have been defined by the user, then only the values of those 3 statistics will be
55
+ # returned.
56
+ # @rspec_example
42
57
  # @return [ProfileUserStatisticStatistics]
43
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
58
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
46
61
  def all_statistics
47
62
  super
48
63
  end
49
64
 
50
65
  ##
51
- # Gets the names of the default profile from which this profile will derive default values for its attributes.
66
+ # Gets the names of the default profile from which this profile will derive default
67
+ # values for its attributes.
68
+ # @rspec_example
52
69
  # @return [String]
53
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
56
73
  def default_profile
57
74
  super
58
75
  end
59
76
 
60
77
  ##
61
78
  # Gets a list of all user-defined statistic profile.
79
+ # @rspec_example
62
80
  # @return [String]
63
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
- # @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.
66
84
  def list
67
85
  super
68
86
  end
69
87
 
70
88
  ##
71
89
  # Gets the user-defined statistic names in this profile.
90
+ # @rspec_example
72
91
  # @return [UserStatisticName[]]
73
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
- # @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.
76
95
  # @param [Hash] opts
77
96
  # @option opts [IControl::LocalLB::ProfileUserStatistic::UserStatisticKey[]] :statistic_keys The statistic keys used to index the statistic names. Each "inner" sequence of statistic keys corresponds to a profile specified in profile_names.
78
97
  def statistic_name(opts)
@@ -81,46 +100,57 @@ module IControl::LocalLB
81
100
  end
82
101
 
83
102
  ##
84
- # Gets the statistics for this user-defined statistic profile. Only the statistic values of the user-defined statistics will be returned, i.e. even though there are up to 32 custom statistics in any given profile, but if only 3 of those custom statistics have been defined by the user, then only the values of those 3 statistics will be returned.
103
+ # Gets the statistics for this user-defined statistic profile. Only the statistic values
104
+ # of the user-defined statistics will be returned, i.e. even though there are up to
105
+ # 32 custom statistics in any given profile, but if only 3 of those custom statistics
106
+ # have been defined by the user, then only the values of those 3 statistics will be
107
+ # returned.
108
+ # @rspec_example
85
109
  # @return [ProfileUserStatisticStatistics]
86
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
110
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
111
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
112
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
89
113
  def statistics
90
114
  super
91
115
  end
92
116
 
93
117
  ##
94
118
  # Gets the version information for this interface.
119
+ # @rspec_example
95
120
  # @return [String]
96
121
  def version
97
122
  super
98
123
  end
99
124
 
100
125
  ##
101
- # Determines whether this profile are base/pre-configured profile, or user-defined profile.
126
+ # Determines whether this profile are base/pre-configured profile, or user-defined
127
+ # profile.
128
+ # @rspec_example
102
129
  # @return [boolean]
103
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
104
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
105
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
130
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
106
133
  def is_base_profile
107
134
  super
108
135
  end
109
136
 
110
137
  ##
111
138
  # Resets the statistics for this user-defined statistic profile.
112
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
113
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
114
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
139
+ # @rspec_example
140
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
141
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
142
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
115
143
  def reset_statistics
116
144
  super
117
145
  end
118
146
 
119
147
  ##
120
- # Sets the names of the default profile from which this profile will derive default values for its attributes.
121
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
122
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
123
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # Sets the names of the default profile from which this profile will derive default
149
+ # values for its attributes.
150
+ # @rspec_example
151
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
152
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
153
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
124
154
  # @param [Hash] opts
125
155
  # @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
126
156
  def set_default_profile(opts)
@@ -130,9 +160,10 @@ module IControl::LocalLB
130
160
 
131
161
  ##
132
162
  # Sets the user-defined statistic names in this profile.
133
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
134
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
135
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
163
+ # @rspec_example
164
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
165
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
166
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
136
167
  # @param [Hash] opts
137
168
  # @option opts [IControl::LocalLB::ProfileUserStatistic::UserStatisticName[]] :statistic_names The user-defined statistic names in the specified profiles. Each "inner" sequence of statistic names corresponds to a profile specified in profile_names.
138
169
  def set_statistic_name(opts)
@@ -143,18 +174,18 @@ module IControl::LocalLB
143
174
  ##
144
175
  # A struct that describes statistics for a particular user-defined statistic profile.
145
176
  # @attr [String] profile_name The profile name.
146
- # @attr [IControl::LocalLB::ProfileUserStatistic::UserStatistic] statistics The statistics for the profile.
177
+ # @attr [IControl::LocalLB::ProfileUserStatistic::UserStatisticSequence] statistics The statistics for the profile.
147
178
  class ProfileUserStatisticStatisticEntry < IControl::Base::Struct
148
179
  icontrol_attribute :profile_name, String
149
- icontrol_attribute :statistics, IControl::LocalLB::ProfileUserStatistic::UserStatistic
180
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileUserStatistic::UserStatisticSequence
150
181
  end
151
182
 
152
183
  ##
153
184
  # A struct that describes profile statistics and timestamp.
154
- # @attr [IControl::LocalLB::ProfileUserStatistic::ProfileUserStatisticStatisticEntry] statistics The statistics for a sequence of profiles.
185
+ # @attr [IControl::LocalLB::ProfileUserStatistic::ProfileUserStatisticStatisticEntrySequence] statistics The statistics for a sequence of profiles.
155
186
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
156
187
  class ProfileUserStatisticStatistics < IControl::Base::Struct
157
- icontrol_attribute :statistics, IControl::LocalLB::ProfileUserStatistic::ProfileUserStatisticStatisticEntry
188
+ icontrol_attribute :statistics, IControl::LocalLB::ProfileUserStatistic::ProfileUserStatisticStatisticEntrySequence
158
189
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
159
190
  end
160
191