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,6 +1,7 @@
1
1
  module IControl::System
2
2
  ##
3
- # The SoftwareManagement interface enables you to manage the software installed on the system.
3
+ # The SoftwareManagement interface enables you to manage the software installed on
4
+ # the system.
4
5
  class SoftwareManagement < IControl::Base
5
6
 
6
7
  set_id_name "imageIDs"
@@ -10,30 +11,39 @@ module IControl::System
10
11
  class SoftwareStatus < IControl::Base::Struct; end
11
12
  class RepositoryImageID < IControl::Base::Struct; end
12
13
  class SoftwareRepositoryHotfix < IControl::Base::Struct; end
13
- class SoftwareRepositoryImage < IControl::Base::Struct; end ##
14
+ class SoftwareRepositoryImage < IControl::Base::Struct; end
15
+ class HotFixInformationSequence < IControl::Base::Sequence ; end
16
+ class InstallationIDSequence < IControl::Base::Sequence ; end
17
+ class SoftwareStatusSequence < IControl::Base::Sequence ; end
18
+ class RepositoryImageIDSequence < IControl::Base::Sequence ; end
19
+ class SoftwareRepositoryHotfixSequence < IControl::Base::Sequence ; end
20
+ class SoftwareRepositoryImageSequence < IControl::Base::Sequence ; end ##
14
21
  # Cleanup the ramfs mounted at HF_MNT_LOCATION
15
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
- # @raise [IControl::Common::InvalidArgument]
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]
25
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
18
26
  def cleanup_ramfs
19
27
  super
20
28
  end
21
29
 
22
30
  ##
23
31
  # Create a RAM disk and return its path to the caller.
32
+ # @rspec_example
24
33
  # @return [String]
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument]
27
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
34
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
+ # @raise [IControl::IControl::Common::InvalidArgument]
36
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
28
37
  def create_ramfs
29
38
  super
30
39
  end
31
40
 
32
41
  ##
33
42
  # Deletes software images from the repository.
34
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
43
+ # @rspec_example
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.
37
47
  # @param [Hash] opts
38
48
  # @option opts [String] :image_filenames are the images you want to delete.
39
49
  def delete_software_image(opts)
@@ -42,21 +52,28 @@ module IControl::System
42
52
  end
43
53
 
44
54
  ##
45
- # Gets the software status for all installation ids. This provides a complete picture of software status, for all ids.
55
+ # Gets the software status for all installation ids. This provides a complete picture
56
+ # of software status, for all ids.
57
+ # @rspec_example
46
58
  # @return [SoftwareStatus]
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.
59
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
50
62
  def all_software_status
51
63
  super
52
64
  end
53
65
 
54
66
  ##
55
- # Gets text which contains boot image information, in the form of &amp;quot;name=value" pairs. The text includes information about what's installed in each of the boot locations in the device. While this method is not officially deprecated, it is preferred to use get_software_status, as that method is a newer method which yields much the same information in a more rigorous and controlled manner.
67
+ # Gets text which contains boot image information, in the form of &amp;quot;name=value"
68
+ # pairs. The text includes information about what's installed in each of the boot locations
69
+ # in the device. While this method is not officially deprecated, it is preferred to
70
+ # use get_software_status, as that method is a newer method which yields much the same
71
+ # information in a more rigorous and controlled manner.
72
+ # @rspec_example
56
73
  # @return [char]
57
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
58
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
59
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
74
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
75
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
76
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
60
77
  # @param [Hash] opts
61
78
  # @option opts [boolean] :save_active_config The boolean indicating whether we should backup the configuration on the active boot location for the installer.
62
79
  def boot_image_information(opts)
@@ -65,41 +82,51 @@ module IControl::System
65
82
  end
66
83
 
67
84
  ##
68
- # Gets the configured default boot location, which will be the location that boots after the system reboots.
85
+ # Gets the configured default boot location, which will be the location that boots
86
+ # after the system reboots.
87
+ # @rspec_example
69
88
  # @return [String]
70
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
71
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
72
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
89
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
73
92
  def boot_location
74
93
  super
75
94
  end
76
95
 
77
96
  ##
78
- # Gets the cluster boot location, which will be the location set in the software desired table.
97
+ # Gets the cluster boot location, which will be the location set in the software desired
98
+ # table.
99
+ # @rspec_example
79
100
  # @return [String]
80
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
81
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
82
- # @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.
83
104
  def cluster_boot_location
84
105
  super
85
106
  end
86
107
 
87
108
  ##
88
- # Gets information on any hotfixes applied to the system. There may not be any hotfix installed, in which case the returned sequence is empty.
109
+ # Gets information on any hotfixes applied to the system. There may not be any hotfix
110
+ # installed, in which case the returned sequence is empty.
111
+ # @rspec_example
89
112
  # @return [HotFixInformation]
90
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
91
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
92
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
113
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
93
116
  def hotfix_information
94
117
  super
95
118
  end
96
119
 
97
120
  ##
98
- # Gets the percent complete of the current live install processes. Note: You may wish to use get_software_status instead of this method as it returns more information, such as the product, version, and build, along with the &amp;quot;percent complete"/status field.
121
+ # Gets the percent complete of the current live install processes. Note: You may wish
122
+ # to use get_software_status instead of this method as it returns more information,
123
+ # such as the product, version, and build, along with the &amp;quot;percent complete"/status
124
+ # field.
125
+ # @rspec_example
99
126
  # @return [String]
100
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
101
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
102
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
127
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
128
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
129
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
103
130
  # @param [Hash] opts
104
131
  # @option opts [IControl::System::SoftwareManagement::InstallationID] :installation_ids What locations do you want percent complete.
105
132
  def live_install_completion(opts)
@@ -109,60 +136,67 @@ module IControl::System
109
136
 
110
137
  ##
111
138
  # Gets the RPM packages installed on the device.
139
+ # @rspec_example
112
140
  # @return [String]
113
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
141
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
142
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
143
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
116
144
  def rpm_package_information
117
145
  super
118
146
  end
119
147
 
120
148
  ##
121
149
  # Gets a list of hotfix information about specific hotfix image in the reporitory.
150
+ # @rspec_example
122
151
  # @return [softwareRepositoryHotfix]
123
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
152
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
153
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
154
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
126
155
  def software_hotfix
127
156
  super
128
157
  end
129
158
 
130
159
  ##
131
160
  # Gets a list of hotfix images available in the repository.
161
+ # @rspec_example
132
162
  # @return [repositoryImageID]
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
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
164
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
165
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
136
166
  def software_hotfix_list
137
167
  super
138
168
  end
139
169
 
140
170
  ##
141
171
  # Gets a list of image information about specific image in the reporitory.
172
+ # @rspec_example
142
173
  # @return [softwareRepositoryImage]
143
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
174
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
175
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
176
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
146
177
  def software_image
147
178
  super
148
179
  end
149
180
 
150
181
  ##
151
182
  # Gets a list of software images available in the repository.
183
+ # @rspec_example
152
184
  # @return [repositoryImageID]
153
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
154
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
155
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
185
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
186
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
187
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
156
188
  def software_image_list
157
189
  super
158
190
  end
159
191
 
160
192
  ##
161
- # Gets the software status for given installation ids. This provides a complete picture of software status, per id.
193
+ # Gets the software status for given installation ids. This provides a complete picture
194
+ # of software status, per id.
195
+ # @rspec_example
162
196
  # @return [SoftwareStatus]
163
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
164
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
165
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
197
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
198
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
199
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
166
200
  # @param [Hash] opts
167
201
  # @option opts [IControl::System::SoftwareManagement::InstallationID] :installation_ids Locations for which you want software status.
168
202
  def software_status(opts)
@@ -172,6 +206,7 @@ module IControl::System
172
206
 
173
207
  ##
174
208
  # Gets the version information for this interface.
209
+ # @rspec_example
175
210
  # @return [String]
176
211
  def version
177
212
  super
@@ -179,19 +214,21 @@ module IControl::System
179
214
 
180
215
  ##
181
216
  # Checks to see whether the system disks are managed with logical volumes.
217
+ # @rspec_example
182
218
  # @return [boolean]
183
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
184
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
185
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
219
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
186
222
  def has_logical_volume_management
187
223
  super
188
224
  end
189
225
 
190
226
  ##
191
227
  # Installs this hotfixes.
192
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
193
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
194
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
228
+ # @rspec_example
229
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
195
232
  # @param [Hash] opts
196
233
  # @option opts [String] :hotfix_files The names of the hotfix files to be installed. These hotfix files must already exist on the system.
197
234
  # @option opts [boolean] :reboot_system The flag to indicate whether to reboot the system after the hotfixes have been installed.
@@ -201,10 +238,12 @@ module IControl::System
201
238
  end
202
239
 
203
240
  ##
204
- # Calls bigstart stop and installs this hotfixes. Upon completion, if reboot_system is set to false, bigstart start is called to bring daemons back up.
205
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
241
+ # Calls bigstart stop and installs this hotfixes. Upon completion, if reboot_system
242
+ # is set to false, bigstart start is called to bring daemons back up.
243
+ # @rspec_example
244
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
245
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
246
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
208
247
  # @param [Hash] opts
209
248
  # @option opts [String] :hotfix_files The names of the hotfix files to be installed. These hotfix files must already exist on the system.
210
249
  # @option opts [boolean] :reboot_system The flag to indicate whether to reboot the system after the hotfixes have been installed.
@@ -215,9 +254,10 @@ module IControl::System
215
254
 
216
255
  ##
217
256
  # Initiates an install of SW images on all blades installed on one chassis.
218
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
219
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
220
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
257
+ # @rspec_example
258
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
259
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
260
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
221
261
  # @param [Hash] opts
222
262
  # @option opts [String] :install_volume installation slot (HD slot) to install to. This will be the same on all blades.
223
263
  # @option opts [String] :product The product you are installing (ex: BIGIP)
@@ -229,10 +269,12 @@ module IControl::System
229
269
  end
230
270
 
231
271
  ##
232
- # Sets the boot image information and automatically initiates installation based on the boot image information.
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.
272
+ # Sets the boot image information and automatically initiates installation based on
273
+ # the boot image information.
274
+ # @rspec_example
275
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
276
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
277
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
236
278
  # @param [Hash] opts
237
279
  # @option opts [char] :boot_image_information The boot image information file data.
238
280
  def set_boot_image_information(opts)
@@ -241,10 +283,12 @@ module IControl::System
241
283
  end
242
284
 
243
285
  ##
244
- # Sets the default boot location, which will be the boot location that boots after the next system reboot. This version will not work on a clustered system.
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.
286
+ # Sets the default boot location, which will be the boot location that boots after
287
+ # the next system reboot. This version will not work on a clustered system.
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.
248
292
  # @param [Hash] opts
249
293
  # @option opts [String] :location The boot location name. Short-form names such as CF1 .1, HD1 .1, HD1 .2
250
294
  def set_boot_location(opts)
@@ -253,10 +297,13 @@ module IControl::System
253
297
  end
254
298
 
255
299
  ##
256
- # Sets the cluster wide boot location, which will be the boot location after the next system reboot. Starting with BIG-IP version 9.6.0, clustered systems will reboot immediately.
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, or if attemped on a non clustered system.
300
+ # Sets the cluster wide boot location, which will be the boot location after the next
301
+ # system reboot. Starting with BIG-IP version 9.6.0, clustered systems will reboot
302
+ # immediately.
303
+ # @rspec_example
304
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
305
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
306
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs, or if attemped on a non clustered system.
260
307
  # @param [Hash] opts
261
308
  # @option opts [String] :location The boot location name. Short-form names such as CF1 .1, HD1 .1, HD1 .2
262
309
  def set_cluster_boot_location(opts)
@@ -265,18 +312,19 @@ module IControl::System
265
312
  end
266
313
 
267
314
  ##
268
- # A structure that contains the information on hotfixes that have been applied to the system.
315
+ # A structure that contains the information on hotfixes that have been applied to the
316
+ # system.
269
317
  # @attr [String] description The description of the software fix contained in this hotfix, if available.
270
318
  # @attr [String] product The product name for which this hotfix is applied.
271
319
  # @attr [String] id The unique identifier for this hotfix, i.e. a related CR or subcase ID.
272
320
  # @attr [String] version_resolved The dot-separated major, minor, and maintenance release level in which the same issue was resolved; i.e. the product version in which the original problem no longer occurs. Note that this value is only available when appropriate, due to the fact that at the time the hotfix was created, there might not be exact knowledge of what release the final fix will be in.
273
- # @attr [String] packages The list of the software packages affected and updated by this hotfix.
321
+ # @attr [StringSequence] packages The list of the software packages affected and updated by this hotfix.
274
322
  class HotFixInformation < IControl::Base::Struct
275
323
  icontrol_attribute :description, String
276
324
  icontrol_attribute :product, String
277
325
  icontrol_attribute :id, String
278
326
  icontrol_attribute :version_resolved, String
279
- icontrol_attribute :packages, String
327
+ icontrol_attribute :packages, StringSequence
280
328
  end
281
329
 
282
330
  ##
@@ -289,7 +337,8 @@ module IControl::System
289
337
  end
290
338
 
291
339
  ##
292
- # A structure that contains information on software status. This includes items like product, version, build, and (live install) completion status.
340
+ # A structure that contains information on software status. This includes items like
341
+ # product, version, build, and (live install) completion status.
293
342
  # @attr [IControl::System::SoftwareManagement::InstallationID] installation_id The location for the status.
294
343
  # @attr [String] product The product you are installing (ex: BIGIP) (or, product which is installed).
295
344
  # @attr [String] version The version of product (ex: 9.6.0).
@@ -28,174 +28,220 @@ module IControl::System
28
28
  class TMMStatistics < IControl::Base::Struct; end
29
29
  class VirtualCompressionStatisticEntry < IControl::Base::Struct; end
30
30
  class VirtualCompressionStatistics < IControl::Base::Struct; end
31
+ class GtmIQueryStatisticEntrySequence < IControl::Base::Sequence ; end
32
+ class GtmLdnsStatisticEntrySequence < IControl::Base::Sequence ; end
33
+ class GtmPathStatisticEntrySequence < IControl::Base::Sequence ; end
34
+ class GtmPathStatisticObjectIDSequence < IControl::Base::Sequence ; end
35
+ class HostStatisticEntrySequence < IControl::Base::Sequence ; end
36
+ class PVAStatisticEntrySequence < IControl::Base::Sequence ; end
37
+ class PerformanceGraphDataCSVSequence < IControl::Base::Sequence ; end
38
+ class PerformanceGraphSequence < IControl::Base::Sequence ; end
39
+ class PerformanceStatisticQuerySequence < IControl::Base::Sequence ; end
40
+ class PerformanceTableDataSequence < IControl::Base::Sequence ; end
41
+ class PerformanceTableSequence < IControl::Base::Sequence ; end
42
+ class TMMStatisticEntrySequence < IControl::Base::Sequence ; end
43
+ class VirtualCompressionStatisticEntrySequence < IControl::Base::Sequence ; end
31
44
  # An enumeration of compression methods.
32
45
  class GtmIQueryState < IControl::Base::Enumeration; end
33
46
  # An enumeration of path statistic's object types.
34
47
  class GtmPathStatisticObjectType < IControl::Base::Enumeration; end ##
35
48
  # Gets the statistics for all the iQueries.
49
+ # @rspec_example
36
50
  # @return [GtmIQueryStatistics]
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.
51
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
40
54
  def all_gtm_iquery_statistics
41
55
  super
42
56
  end
43
57
 
44
58
  ##
45
- # Gets all of the system's host statistics. Note that CPU usage statistics by host are available but not retrieved by this method.
59
+ # Gets all of the system's host statistics. Note that CPU usage statistics by host
60
+ # are available but not retrieved by this method.
61
+ # @rspec_example
46
62
  # @return [HostStatistics]
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.
63
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
50
66
  def all_host_statistics
51
67
  super
52
68
  end
53
69
 
54
70
  ##
55
71
  # Gets all of the system's PVA statistics.
72
+ # @rspec_example
56
73
  # @return [PVAStatistics]
57
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
58
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
59
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
74
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
75
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
76
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
60
77
  def all_pva_statistics
61
78
  super
62
79
  end
63
80
 
64
81
  ##
65
82
  # Gets all of the system's TMOS processing agent statistics.
83
+ # @rspec_example
66
84
  # @return [TMMStatistics]
67
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
68
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
69
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
85
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
86
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
87
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
70
88
  def all_tmm_statistics
71
89
  super
72
90
  end
73
91
 
74
92
  ##
75
- # This method has been deprecated, as it represents internal, implementation-specific details. Gets the statistics for all the virtual compression devices.
93
+ # This method has been deprecated, as it represents internal, implementation-specific
94
+ # details. Gets the statistics for all the virtual compression devices.
95
+ # @rspec_example
76
96
  # @return [VirtualCompressionStatistics]
77
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
78
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
97
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
79
99
  def all_virtual_compression_statistics
80
100
  super
81
101
  end
82
102
 
83
103
  ##
84
- # Gets the system's global authentication statistics. These are the roll-ups of all the individual authentication profiles' statistics.
104
+ # Gets the system's global authentication statistics. These are the roll-ups of all
105
+ # the individual authentication profiles' statistics.
106
+ # @rspec_example
85
107
  # @return [SystemStatistics]
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.
108
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
89
111
  def authentication_statistics
90
112
  super
91
113
  end
92
114
 
93
115
  ##
94
- # Gets the system's global client SSL statistics. These are the roll-ups of all the individual client SSL profiles' statistics.
116
+ # Gets the system's global client SSL statistics. These are the roll-ups of all the
117
+ # individual client SSL profiles' statistics.
118
+ # @rspec_example
95
119
  # @return [SystemStatistics]
96
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
97
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
98
- # @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.
99
123
  def client_ssl_statistics
100
124
  super
101
125
  end
102
126
 
103
127
  ##
104
- # Gets the system's global Diameter statistics. These are the roll-ups of all the individual Diameter profiles' statistics.
128
+ # Gets the system's global Diameter statistics. These are the roll-ups of all the individual
129
+ # Diameter profiles' statistics.
130
+ # @rspec_example
105
131
  # @return [SystemStatistics]
106
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
107
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
108
- # @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.
109
135
  def diameter_statistics
110
136
  super
111
137
  end
112
138
 
113
139
  ##
114
- # Gets the system's global DNS profile statistics. These are the roll-ups of all the individual DNS profiles' statistics.
140
+ # Gets the system's global DNS profile statistics. These are the roll-ups of all the
141
+ # individual DNS profiles' statistics.
142
+ # @rspec_example
115
143
  # @return [SystemStatistics]
116
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
117
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
118
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
144
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
145
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
146
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
119
147
  def dns_statistics
120
148
  super
121
149
  end
122
150
 
123
151
  ##
124
- # Gets the system's global Fast HTTP statistics. These are the roll-ups of all the individual Fast HTTP profiles' statistics.
152
+ # Gets the system's global Fast HTTP statistics. These are the roll-ups of all the
153
+ # individual Fast HTTP profiles' statistics.
154
+ # @rspec_example
125
155
  # @return [SystemStatistics]
126
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
127
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
128
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
156
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
157
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
158
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
129
159
  def fasthttp_statistics
130
160
  super
131
161
  end
132
162
 
133
163
  ##
134
- # Gets the system's global FastL4 statistics. These are the roll-ups of all the individual FastL4 profiles' statistics.
164
+ # Gets the system's global FastL4 statistics. These are the roll-ups of all the individual
165
+ # FastL4 profiles' statistics.
166
+ # @rspec_example
135
167
  # @return [SystemStatistics]
136
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
137
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
138
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
168
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
139
171
  def fastl4_statistics
140
172
  super
141
173
  end
142
174
 
143
175
  ##
144
- # Gets the system's global FTP statistics. These are the roll-ups of all the individual FTP profiles' statistics.
176
+ # Gets the system's global FTP statistics. These are the roll-ups of all the individual
177
+ # FTP profiles' statistics.
178
+ # @rspec_example
145
179
  # @return [SystemStatistics]
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.
180
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
181
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
182
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
149
183
  def ftp_statistics
150
184
  super
151
185
  end
152
186
 
153
187
  ##
154
- # Gets the system's global host statistics. Note that global CPU usage statistics are available but not retrieved by this method. This gets one set of combined ("rolled up") statistics for all hosts. It is not to be confused with get_all_host_statistics, which gets all individual host statistics, one for each host.
188
+ # Gets the system's global host statistics. Note that global CPU usage statistics are
189
+ # available but not retrieved by this method. This gets one set of combined ("rolled
190
+ # up") statistics for all hosts. It is not to be confused with get_all_host_statistics,
191
+ # which gets all individual host statistics, one for each host.
192
+ # @rspec_example
155
193
  # @return [GlobalHostStatistics]
156
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
157
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
158
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
194
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
195
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
196
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
159
197
  def global_host_statistics
160
198
  super
161
199
  end
162
200
 
163
201
  ##
164
202
  # Gets the system's global statistics.
203
+ # @rspec_example
165
204
  # @return [SystemStatistics]
166
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
167
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
168
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
205
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
169
208
  def global_statistics
170
209
  super
171
210
  end
172
211
 
173
212
  ##
174
- # Gets the system's global TMOS processing agent statistics. This gets one set of combined ("rolled up") statistics for all TMOS processing agents. It is not to be confused with get_all_tmm_statistics, which gets all individual TMOS processing agent statistics, one for each TMOS processing agent.
213
+ # Gets the system's global TMOS processing agent statistics. This gets one set of combined
214
+ # ("rolled up") statistics for all TMOS processing agents. It is not to be confused
215
+ # with get_all_tmm_statistics, which gets all individual TMOS processing agent statistics,
216
+ # one for each TMOS processing agent.
217
+ # @rspec_example
175
218
  # @return [GlobalTMMStatistics]
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.
219
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
179
222
  def global_tmm_statistics
180
223
  super
181
224
  end
182
225
 
183
226
  ##
184
- # Gets the GTM global statistics. These are the roll-ups of all the individual wide IPs' and iQueries statistics.
227
+ # Gets the GTM global statistics. These are the roll-ups of all the individual wide
228
+ # IPs' and iQueries statistics.
229
+ # @rspec_example
185
230
  # @return [SystemStatistics]
186
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
187
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
188
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
231
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
232
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
233
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
189
234
  def gtm_global_statistics
190
235
  super
191
236
  end
192
237
 
193
238
  ##
194
239
  # Gets the statistics for this iQueries.
240
+ # @rspec_example
195
241
  # @return [GtmIQueryStatistics]
196
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
197
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
198
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
242
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
243
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
244
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
199
245
  # @param [Hash] opts
200
246
  # @option opts [String] :addresses The iQueries to get the statistics from.
201
247
  def gtm_iquery_statistics(opts)
@@ -205,30 +251,33 @@ module IControl::System
205
251
 
206
252
  ##
207
253
  # Gets the statistics for this LDNSes.
254
+ # @rspec_example
208
255
  # @return [GtmLdnsStatistics]
209
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
210
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
211
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
256
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
257
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
258
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
212
259
  def gtm_ldns_statistics
213
260
  super
214
261
  end
215
262
 
216
263
  ##
217
264
  # Gets the memory usage statistics used by GTM.
265
+ # @rspec_example
218
266
  # @return [SystemStatistics]
219
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
220
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
221
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
222
270
  def gtm_memory_usage_statistics
223
271
  super
224
272
  end
225
273
 
226
274
  ##
227
275
  # Gets the statistics for this paths (LDNSes and links).
276
+ # @rspec_example
228
277
  # @return [GtmPathStatistics]
229
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
278
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
279
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
280
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
281
  # @param [Hash] opts
233
282
  # @option opts [IControl::System::Statistics::GtmPathStatisticObjectID] :object_names The link or DC names to get the statistics from.
234
283
  def gtm_path_statistics(opts)
@@ -237,11 +286,13 @@ module IControl::System
237
286
  end
238
287
 
239
288
  ##
240
- # Gets the system's host statistics (by host id). Note that CPU usage statistics by host are available but not retrieved by this method.
289
+ # Gets the system's host statistics (by host id). Note that CPU usage statistics by
290
+ # host are available but not retrieved by this method.
291
+ # @rspec_example
241
292
  # @return [HostStatistics]
242
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
243
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
244
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
293
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
294
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
295
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
245
296
  # @param [Hash] opts
246
297
  # @option opts [String] :host_ids The host ids for which to get statistics.
247
298
  def host_statistics(opts)
@@ -250,111 +301,125 @@ module IControl::System
250
301
  end
251
302
 
252
303
  ##
253
- # Gets the system's global HTTP statistics. These are the roll-ups of all the individual HTTP profiles' statistics.
304
+ # Gets the system's global HTTP statistics. These are the roll-ups of all the individual
305
+ # HTTP profiles' statistics.
306
+ # @rspec_example
254
307
  # @return [SystemStatistics]
255
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
256
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
257
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
308
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
309
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
310
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
258
311
  def http_statistics
259
312
  super
260
313
  end
261
314
 
262
315
  ##
263
316
  # Gets the system's ICMP statistics.
317
+ # @rspec_example
264
318
  # @return [SystemStatistics]
265
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
266
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
267
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
319
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
320
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
321
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
268
322
  def icmp_statistics
269
323
  super
270
324
  end
271
325
 
272
326
  ##
273
327
  # Gets the system's ICMPv6 statistics.
328
+ # @rspec_example
274
329
  # @return [SystemStatistics]
275
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
276
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
277
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
330
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
331
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
332
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
278
333
  def icmpv6_statistics
279
334
  super
280
335
  end
281
336
 
282
337
  ##
283
- # Gets the system's global IIOP statistics. These are the roll-ups of all the individual IIOP profiles' statistics.
338
+ # Gets the system's global IIOP statistics. These are the roll-ups of all the individual
339
+ # IIOP profiles' statistics.
340
+ # @rspec_example
284
341
  # @return [SystemStatistics]
285
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
286
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
287
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
342
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
343
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
344
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
288
345
  def iiop_statistics
289
346
  super
290
347
  end
291
348
 
292
349
  ##
293
350
  # Gets the system's IP statistics.
351
+ # @rspec_example
294
352
  # @return [SystemStatistics]
295
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
296
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
297
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
353
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
354
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
355
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
298
356
  def ip_statistics
299
357
  super
300
358
  end
301
359
 
302
360
  ##
303
361
  # Gets the system's IPv6 statistics.
362
+ # @rspec_example
304
363
  # @return [SystemStatistics]
305
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
306
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
307
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
364
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
365
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
366
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
308
367
  def ipv6_statistics
309
368
  super
310
369
  end
311
370
 
312
371
  ##
313
372
  # Gets a list of all hosts.
373
+ # @rspec_example
314
374
  # @return [String]
315
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
316
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
317
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
375
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
318
378
  def list_of_hosts
319
379
  super
320
380
  end
321
381
 
322
382
  ##
323
383
  # Gets a list of all PVAs.
384
+ # @rspec_example
324
385
  # @return [String]
325
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
326
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
327
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
386
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
387
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
388
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
328
389
  def list_of_pvas
329
390
  super
330
391
  end
331
392
 
332
393
  ##
333
394
  # Gets a list of all TMOS processing agents.
395
+ # @rspec_example
334
396
  # @return [String]
335
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
336
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
337
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
397
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
398
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
399
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
338
400
  def list_of_tmms
339
401
  super
340
402
  end
341
403
 
342
404
  ##
343
- # Gets the system's global OneConnect statistics. These are the roll-ups of all the individual OneConnect profiles' statistics.
405
+ # Gets the system's global OneConnect statistics. These are the roll-ups of all the
406
+ # individual OneConnect profiles' statistics.
407
+ # @rspec_example
344
408
  # @return [SystemStatistics]
345
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
346
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
347
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
409
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
410
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
411
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
348
412
  def oneconnect_statistics
349
413
  super
350
414
  end
351
415
 
352
416
  ##
353
417
  # Gets the statistical data in CSV format for this graphs/tables.
418
+ # @rspec_example
354
419
  # @return [PerformanceGraphDataCSV]
355
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
356
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
357
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
420
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
421
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
422
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
358
423
  # @param [Hash] opts
359
424
  # @option opts [IControl::System::Statistics::PerformanceStatisticQuery] :objects The list of graphs or tables to get the statistics for.
360
425
  def performance_graph_csv_statistics(opts)
@@ -364,30 +429,33 @@ module IControl::System
364
429
 
365
430
  ##
366
431
  # Gets the list of available statistical graphs as seen in the GUI's Performance Graph.
432
+ # @rspec_example
367
433
  # @return [PerformanceGraph]
368
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
369
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
370
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
371
437
  def performance_graph_list
372
438
  super
373
439
  end
374
440
 
375
441
  ##
376
442
  # Gets the list of available statistical tables.
443
+ # @rspec_example
377
444
  # @return [PerformanceTable]
378
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
379
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
380
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
445
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
446
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
447
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
381
448
  def performance_table_list
382
449
  super
383
450
  end
384
451
 
385
452
  ##
386
453
  # Gets the statistical data tables.
454
+ # @rspec_example
387
455
  # @return [PerformanceTableData]
388
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
389
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
390
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
456
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
457
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
458
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
391
459
  # @param [Hash] opts
392
460
  # @option opts [IControl::System::Statistics::PerformanceStatisticQuery] :tables The list of tables to get the statistics for.
393
461
  def performance_table_statistics(opts)
@@ -397,10 +465,11 @@ module IControl::System
397
465
 
398
466
  ##
399
467
  # Gets the system's PVA statistics (by PVA id).
468
+ # @rspec_example
400
469
  # @return [PVAStatistics]
401
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
402
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
403
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
470
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
471
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
472
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
404
473
  # @param [Hash] opts
405
474
  # @option opts [String] :pva_ids The PVA ids for which to get statistics.
406
475
  def pva_statistics(opts)
@@ -409,71 +478,84 @@ module IControl::System
409
478
  end
410
479
 
411
480
  ##
412
- # Gets the system's global RADIUS statistics. These are the roll-ups of all the individual RADIUS profiles' statistics.
481
+ # Gets the system's global RADIUS statistics. These are the roll-ups of all the individual
482
+ # RADIUS profiles' statistics.
483
+ # @rspec_example
413
484
  # @return [SystemStatistics]
414
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
415
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
416
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
485
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
486
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
487
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
417
488
  def radius_statistics
418
489
  super
419
490
  end
420
491
 
421
492
  ##
422
- # Gets the system's global RTSP statistics. These are the roll-ups of all the individual RTSP profiles' statistics.
493
+ # Gets the system's global RTSP statistics. These are the roll-ups of all the individual
494
+ # RTSP profiles' statistics.
495
+ # @rspec_example
423
496
  # @return [SystemStatistics]
424
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
425
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
426
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
497
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
498
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
499
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
427
500
  def rtsp_statistics
428
501
  super
429
502
  end
430
503
 
431
504
  ##
432
- # Gets the system's global SCTP statistics. These are the roll-ups of all the individual SCTP profiles' statistics.
505
+ # Gets the system's global SCTP statistics. These are the roll-ups of all the individual
506
+ # SCTP profiles' statistics.
507
+ # @rspec_example
433
508
  # @return [SystemStatistics]
434
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
435
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
436
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
509
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
510
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
511
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
437
512
  def sctp_statistics
438
513
  super
439
514
  end
440
515
 
441
516
  ##
442
- # Gets the system's global server SSL statistics. These are the roll-ups of all the individual server SSL profiles' statistics.
517
+ # Gets the system's global server SSL statistics. These are the roll-ups of all the
518
+ # individual server SSL profiles' statistics.
519
+ # @rspec_example
443
520
  # @return [SystemStatistics]
444
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
445
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
446
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
521
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
522
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
523
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
447
524
  def server_ssl_statistics
448
525
  super
449
526
  end
450
527
 
451
528
  ##
452
- # Gets the system's global stream statistics. These are the roll-ups of all the individual stream profiles' statistics.
529
+ # Gets the system's global stream statistics. These are the roll-ups of all the individual
530
+ # stream profiles' statistics.
531
+ # @rspec_example
453
532
  # @return [SystemStatistics]
454
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
455
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
456
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
533
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
534
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
535
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
457
536
  def stream_statistics
458
537
  super
459
538
  end
460
539
 
461
540
  ##
462
- # Gets the system's global TCP statistics. These are the roll-ups of all the individual TCP profiles' statistics.
541
+ # Gets the system's global TCP statistics. These are the roll-ups of all the individual
542
+ # TCP profiles' statistics.
543
+ # @rspec_example
463
544
  # @return [SystemStatistics]
464
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
465
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
466
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
545
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
546
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
547
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
467
548
  def tcp_statistics
468
549
  super
469
550
  end
470
551
 
471
552
  ##
472
553
  # Gets the system's TMOS processing agent statistics (by TMOS processing agent id).
554
+ # @rspec_example
473
555
  # @return [TMMStatistics]
474
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
475
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
476
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
556
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
557
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
558
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
477
559
  # @param [Hash] opts
478
560
  # @option opts [String] :tmm_ids The TMOS processing agent ids for which to get statistics.
479
561
  def tmm_statistics(opts)
@@ -482,27 +564,32 @@ module IControl::System
482
564
  end
483
565
 
484
566
  ##
485
- # Gets the system's global UDP statistics. These are the roll-ups of all the individual UDP profiles' statistics.
567
+ # Gets the system's global UDP statistics. These are the roll-ups of all the individual
568
+ # UDP profiles' statistics.
569
+ # @rspec_example
486
570
  # @return [SystemStatistics]
487
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
488
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
489
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
571
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
572
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
573
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
490
574
  def udp_statistics
491
575
  super
492
576
  end
493
577
 
494
578
  ##
495
579
  # Gets the version information for this interface.
580
+ # @rspec_example
496
581
  # @return [String]
497
582
  def version
498
583
  super
499
584
  end
500
585
 
501
586
  ##
502
- # This method has been deprecated, as it represents internal, implementation-specific details. Gets the statistics for this virtual compression devices.
587
+ # This method has been deprecated, as it represents internal, implementation-specific
588
+ # details. Gets the statistics for this virtual compression devices.
589
+ # @rspec_example
503
590
  # @return [VirtualCompressionStatistics]
504
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
505
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
591
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
592
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
506
593
  # @param [Hash] opts
507
594
  # @option opts [String] :device_names The virtual compression devices to get the statistics from.
508
595
  def virtual_compression_statistics(opts)
@@ -511,110 +598,124 @@ module IControl::System
511
598
  end
512
599
 
513
600
  ##
514
- # Gets the system's global XML statistics. These are the roll-ups of all the individual XML profiles' statistics.
601
+ # Gets the system's global XML statistics. These are the roll-ups of all the individual
602
+ # XML profiles' statistics.
603
+ # @rspec_example
515
604
  # @return [SystemStatistics]
516
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
517
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
518
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
605
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
606
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
607
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
519
608
  def xml_statistics
520
609
  super
521
610
  end
522
611
 
523
612
  ##
524
- # Resets all statistics in the system, including all global statistics as well as all object-level statistics such as pool, virtual server statistics....
525
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
526
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
527
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
613
+ # Resets all statistics in the system, including all global statistics as well as all
614
+ # object-level statistics such as pool, virtual server statistics....
615
+ # @rspec_example
616
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
617
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
618
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
528
619
  def reset_all_statistics
529
620
  super
530
621
  end
531
622
 
532
623
  ##
533
624
  # Resets the system's global authentication statistics.
534
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
535
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
536
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
625
+ # @rspec_example
626
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
627
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
628
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
537
629
  def reset_authentication_statistics
538
630
  super
539
631
  end
540
632
 
541
633
  ##
542
634
  # Resets the system's global client SSL statistics.
543
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
544
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
545
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
635
+ # @rspec_example
636
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
637
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
638
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
546
639
  def reset_client_ssl_statistics
547
640
  super
548
641
  end
549
642
 
550
643
  ##
551
644
  # Resets the system's global Diameter statistics.
552
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
553
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
554
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
645
+ # @rspec_example
646
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
647
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
648
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
555
649
  def reset_diameter_statistics
556
650
  super
557
651
  end
558
652
 
559
653
  ##
560
654
  # Resets the system's global DNS statistics.
561
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
562
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
563
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
655
+ # @rspec_example
656
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
657
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
658
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
564
659
  def reset_dns_statistics
565
660
  super
566
661
  end
567
662
 
568
663
  ##
569
664
  # Resets the system's global Fast HTTP statistics.
570
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
571
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
572
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
665
+ # @rspec_example
666
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
667
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
668
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
573
669
  def reset_fasthttp_statistics
574
670
  super
575
671
  end
576
672
 
577
673
  ##
578
674
  # Resets the system's global FastL4 statistics.
579
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
580
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
581
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
675
+ # @rspec_example
676
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
677
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
678
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
582
679
  def reset_fastl4_statistics
583
680
  super
584
681
  end
585
682
 
586
683
  ##
587
684
  # Resets the system's global FTP statistics.
588
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
589
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
590
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
685
+ # @rspec_example
686
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
687
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
688
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
591
689
  def reset_ftp_statistics
592
690
  super
593
691
  end
594
692
 
595
693
  ##
596
694
  # Resets the system's global statistics.
597
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
598
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
599
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
695
+ # @rspec_example
696
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
697
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
698
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
600
699
  def reset_global_statistics
601
700
  super
602
701
  end
603
702
 
604
703
  ##
605
704
  # Resets the GTM global statistics.
606
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
607
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
608
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
705
+ # @rspec_example
706
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
707
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
708
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
609
709
  def reset_gtm_global_statistics
610
710
  super
611
711
  end
612
712
 
613
713
  ##
614
714
  # Resets the statistics for this iQueries.
615
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
616
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
617
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
715
+ # @rspec_example
716
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
717
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
718
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
618
719
  # @param [Hash] opts
619
720
  # @option opts [String] :addresses The iQueries indicated by their addresses. If "addresses" list if empty, then all iQuery statistics regardless of address will be reset..
620
721
  def reset_gtm_iquery_statistics(opts)
@@ -624,18 +725,20 @@ module IControl::System
624
725
 
625
726
  ##
626
727
  # Resets the statistics for this LDNSes.
627
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
628
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
629
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
728
+ # @rspec_example
729
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
730
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
731
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
630
732
  def reset_gtm_ldns_statistics
631
733
  super
632
734
  end
633
735
 
634
736
  ##
635
737
  # Resets the statistics for this paths.
636
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
637
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
638
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
738
+ # @rspec_example
739
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
740
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
741
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
639
742
  # @param [Hash] opts
640
743
  # @option opts [IControl::System::Statistics::GtmPathStatisticObjectID] :object_names The link or DC names to reset the statistics. If "object_names" is empty, then statistics for all paths under "ldns_ips" will be reset. Note that if "ldns_ips" and "object_names" are both empty, then all path statistics will be reset.
641
744
  def reset_gtm_path_statistics(opts)
@@ -645,134 +748,150 @@ module IControl::System
645
748
 
646
749
  ##
647
750
  # Resets the system's global HTTP statistics.
648
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
649
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
650
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
751
+ # @rspec_example
752
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
753
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
754
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
651
755
  def reset_http_statistics
652
756
  super
653
757
  end
654
758
 
655
759
  ##
656
760
  # Resets the system's ICMP statistics.
657
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
658
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
659
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
761
+ # @rspec_example
762
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
763
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
764
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
660
765
  def reset_icmp_statistics
661
766
  super
662
767
  end
663
768
 
664
769
  ##
665
770
  # Resets the system's ICMPv6 statistics.
666
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
667
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
668
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
771
+ # @rspec_example
772
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
773
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
774
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
669
775
  def reset_icmpv6_statistics
670
776
  super
671
777
  end
672
778
 
673
779
  ##
674
780
  # Resets the system's global IIOP statistics.
675
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
676
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
677
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
781
+ # @rspec_example
782
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
783
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
784
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
678
785
  def reset_iiop_statistics
679
786
  super
680
787
  end
681
788
 
682
789
  ##
683
790
  # Resets the system's IP statistics.
684
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
685
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
686
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
791
+ # @rspec_example
792
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
793
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
794
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
687
795
  def reset_ip_statistics
688
796
  super
689
797
  end
690
798
 
691
799
  ##
692
800
  # Resets the system's IPv6 statistics.
693
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
694
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
695
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
801
+ # @rspec_example
802
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
803
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
804
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
696
805
  def reset_ipv6_statistics
697
806
  super
698
807
  end
699
808
 
700
809
  ##
701
810
  # Resets the system's global OneConnect statistics.
702
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
703
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
704
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
811
+ # @rspec_example
812
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
813
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
814
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
705
815
  def reset_oneconnect_statistics
706
816
  super
707
817
  end
708
818
 
709
819
  ##
710
820
  # Resets the system's global RADIUS statistics.
711
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
712
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
713
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
821
+ # @rspec_example
822
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
823
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
824
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
714
825
  def reset_radius_statistics
715
826
  super
716
827
  end
717
828
 
718
829
  ##
719
830
  # Resets the system's global RTSP statistics.
720
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
721
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
722
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
831
+ # @rspec_example
832
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
833
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
834
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
723
835
  def reset_rtsp_statistics
724
836
  super
725
837
  end
726
838
 
727
839
  ##
728
840
  # Resets the system's global SCTP statistics.
729
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
730
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
731
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
841
+ # @rspec_example
842
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
843
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
844
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
732
845
  def reset_sctp_statistics
733
846
  super
734
847
  end
735
848
 
736
849
  ##
737
850
  # Resets the system's global server SSL statistics.
738
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
739
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
740
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
851
+ # @rspec_example
852
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
853
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
854
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
741
855
  def reset_server_ssl_statistics
742
856
  super
743
857
  end
744
858
 
745
859
  ##
746
860
  # Resets the system's global stream statistics.
747
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
748
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
749
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
861
+ # @rspec_example
862
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
863
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
864
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
750
865
  def reset_stream_statistics
751
866
  super
752
867
  end
753
868
 
754
869
  ##
755
870
  # Resets the system's global TCP statistics.
756
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
757
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
758
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
871
+ # @rspec_example
872
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
873
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
874
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
759
875
  def reset_tcp_statistics
760
876
  super
761
877
  end
762
878
 
763
879
  ##
764
880
  # Resets the system's global UDP statistics.
765
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
766
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
767
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
881
+ # @rspec_example
882
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
883
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
884
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
768
885
  def reset_udp_statistics
769
886
  super
770
887
  end
771
888
 
772
889
  ##
773
- # This method has been deprecated, as it represents internal, implementation-specific details. Resets the statistics for this virtual compression devices.
774
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
775
- # @raise [IControl::Common::NotImplemented] raised if the method is not supported or implemented.
890
+ # This method has been deprecated, as it represents internal, implementation-specific
891
+ # details. Resets the statistics for this virtual compression devices.
892
+ # @rspec_example
893
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
894
+ # @raise [IControl::IControl::Common::NotImplemented] raised if the method is not supported or implemented.
776
895
  # @param [Hash] opts
777
896
  # @option opts [String] :device_names The names of the virtual compression devices. If devices_names list if empty, then all virtual compression statistics regardless of device will be reset.
778
897
  def reset_virtual_compression_statistics(opts)
@@ -782,28 +901,31 @@ module IControl::System
782
901
 
783
902
  ##
784
903
  # Resets the system's global XML statistics.
785
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
786
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
787
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
904
+ # @rspec_example
905
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
906
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
907
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
788
908
  def reset_xml_statistics
789
909
  super
790
910
  end
791
911
 
792
912
  ##
793
- # A struct that describes global host statistics. This is one set of combined ("rolled up") statistics for all hosts.
794
- # @attr [IControl::Common::Statistic] statistics The global host statistics.
913
+ # A struct that describes global host statistics. This is one set of combined ("rolled
914
+ # up") statistics for all hosts.
915
+ # @attr [IControl::Common::StatisticSequence] statistics The global host statistics.
795
916
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
796
917
  class GlobalHostStatistics < IControl::Base::Struct
797
- icontrol_attribute :statistics, IControl::Common::Statistic
918
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
798
919
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
799
920
  end
800
921
 
801
922
  ##
802
- # A struct that describes global TMOS processing agent statistics. This is one set of combined ("rolled up") statistics for all TMOS processing agents.
803
- # @attr [IControl::Common::Statistic] statistics The global TMOS processing agent statistics.
923
+ # A struct that describes global TMOS processing agent statistics. This is one set
924
+ # of combined ("rolled up") statistics for all TMOS processing agents.
925
+ # @attr [IControl::Common::StatisticSequence] statistics The global TMOS processing agent statistics.
804
926
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
805
927
  class GlobalTMMStatistics < IControl::Base::Struct
806
- icontrol_attribute :statistics, IControl::Common::Statistic
928
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
807
929
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
808
930
  end
809
931
 
@@ -811,19 +933,19 @@ module IControl::System
811
933
  # A struct that describes statistics for a particular iQuery.
812
934
  # @attr [String] ip_address The iQuery target IP address.
813
935
  # @attr [IControl::System::Statistics::GtmIQueryState] connection_state The connection state of this iQuery.
814
- # @attr [IControl::Common::Statistic] statistics The statistics for the iQuery.
936
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the iQuery.
815
937
  class GtmIQueryStatisticEntry < IControl::Base::Struct
816
938
  icontrol_attribute :ip_address, String
817
939
  icontrol_attribute :connection_state, IControl::System::Statistics::GtmIQueryState
818
- icontrol_attribute :statistics, IControl::Common::Statistic
940
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
819
941
  end
820
942
 
821
943
  ##
822
944
  # A struct that describes iQuery statistics and timestamp.
823
- # @attr [IControl::System::Statistics::GtmIQueryStatisticEntry] statistics The statistics for a sequence of iQueries.
945
+ # @attr [IControl::System::Statistics::GtmIQueryStatisticEntrySequence] statistics The statistics for a sequence of iQueries.
824
946
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
825
947
  class GtmIQueryStatistics < IControl::Base::Struct
826
- icontrol_attribute :statistics, IControl::System::Statistics::GtmIQueryStatisticEntry
948
+ icontrol_attribute :statistics, IControl::System::Statistics::GtmIQueryStatisticEntrySequence
827
949
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
828
950
  end
829
951
 
@@ -835,7 +957,7 @@ module IControl::System
835
957
  # @attr [String] country The country name.
836
958
  # @attr [String] state The state name.
837
959
  # @attr [String] city The city name.
838
- # @attr [IControl::Common::Statistic] statistics The statistics for the LDNS.
960
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the LDNS.
839
961
  class GtmLdnsStatisticEntry < IControl::Base::Struct
840
962
  icontrol_attribute :ldns_ip, String
841
963
  icontrol_attribute :last_accessed, Numeric
@@ -843,15 +965,15 @@ module IControl::System
843
965
  icontrol_attribute :country, String
844
966
  icontrol_attribute :state, String
845
967
  icontrol_attribute :city, String
846
- icontrol_attribute :statistics, IControl::Common::Statistic
968
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
847
969
  end
848
970
 
849
971
  ##
850
972
  # A struct that describes LDNS statistics and timestamp.
851
- # @attr [IControl::System::Statistics::GtmLdnsStatisticEntry] statistics The statistics for a sequence of LDNSes .
973
+ # @attr [IControl::System::Statistics::GtmLdnsStatisticEntrySequence] statistics The statistics for a sequence of LDNSes .
852
974
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
853
975
  class GtmLdnsStatistics < IControl::Base::Struct
854
- icontrol_attribute :statistics, IControl::System::Statistics::GtmLdnsStatisticEntry
976
+ icontrol_attribute :statistics, IControl::System::Statistics::GtmLdnsStatisticEntrySequence
855
977
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
856
978
  end
857
979
 
@@ -860,12 +982,12 @@ module IControl::System
860
982
  # @attr [String] ldns_ip The LDNS IP address.
861
983
  # @attr [IControl::System::Statistics::GtmPathStatisticObjectID] object_name The object name, either a link name or a data center
862
984
  # @attr [Numeric] last_probe_time The timestamp of last time this LDNS was probed.
863
- # @attr [IControl::Common::Statistic] statistics The statistics for the path.
985
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the path.
864
986
  class GtmPathStatisticEntry < IControl::Base::Struct
865
987
  icontrol_attribute :ldns_ip, String
866
988
  icontrol_attribute :object_name, IControl::System::Statistics::GtmPathStatisticObjectID
867
989
  icontrol_attribute :last_probe_time, Numeric
868
- icontrol_attribute :statistics, IControl::Common::Statistic
990
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
869
991
  end
870
992
 
871
993
  ##
@@ -879,51 +1001,52 @@ module IControl::System
879
1001
 
880
1002
  ##
881
1003
  # A struct that describes path statistics and timestamp.
882
- # @attr [IControl::System::Statistics::GtmPathStatisticEntry] statistics The statistics for a sequence of paths.
1004
+ # @attr [IControl::System::Statistics::GtmPathStatisticEntrySequence] statistics The statistics for a sequence of paths.
883
1005
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
884
1006
  class GtmPathStatistics < IControl::Base::Struct
885
- icontrol_attribute :statistics, IControl::System::Statistics::GtmPathStatisticEntry
1007
+ icontrol_attribute :statistics, IControl::System::Statistics::GtmPathStatisticEntrySequence
886
1008
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
887
1009
  end
888
1010
 
889
1011
  ##
890
1012
  # A struct that describes statistics for a particular host.
891
1013
  # @attr [String] host_id The host id.
892
- # @attr [IControl::Common::Statistic] statistics The statistics for the host.
1014
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the host.
893
1015
  class HostStatisticEntry < IControl::Base::Struct
894
1016
  icontrol_attribute :host_id, String
895
- icontrol_attribute :statistics, IControl::Common::Statistic
1017
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
896
1018
  end
897
1019
 
898
1020
  ##
899
1021
  # A struct that describes host statistics and timestamp.
900
- # @attr [IControl::System::Statistics::HostStatisticEntry] statistics The statistics for a sequence of hosts.
1022
+ # @attr [IControl::System::Statistics::HostStatisticEntrySequence] statistics The statistics for a sequence of hosts.
901
1023
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
902
1024
  class HostStatistics < IControl::Base::Struct
903
- icontrol_attribute :statistics, IControl::System::Statistics::HostStatisticEntry
1025
+ icontrol_attribute :statistics, IControl::System::Statistics::HostStatisticEntrySequence
904
1026
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
905
1027
  end
906
1028
 
907
1029
  ##
908
1030
  # A struct that describes statistics for a particular PVA.
909
1031
  # @attr [String] pva_id The PVA id.
910
- # @attr [IControl::Common::Statistic] statistics The statistics for the PVA.
1032
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the PVA.
911
1033
  class PVAStatisticEntry < IControl::Base::Struct
912
1034
  icontrol_attribute :pva_id, String
913
- icontrol_attribute :statistics, IControl::Common::Statistic
1035
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
914
1036
  end
915
1037
 
916
1038
  ##
917
1039
  # A struct that describes PVA statistics and timestamp.
918
- # @attr [IControl::System::Statistics::PVAStatisticEntry] statistics The statistics for a sequence of PVAs .
1040
+ # @attr [IControl::System::Statistics::PVAStatisticEntrySequence] statistics The statistics for a sequence of PVAs .
919
1041
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
920
1042
  class PVAStatistics < IControl::Base::Struct
921
- icontrol_attribute :statistics, IControl::System::Statistics::PVAStatisticEntry
1043
+ icontrol_attribute :statistics, IControl::System::Statistics::PVAStatisticEntrySequence
922
1044
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
923
1045
  end
924
1046
 
925
1047
  ##
926
- # A struct that describes the contents of a performance graph as seen in the Performance Graph in the GUI.
1048
+ # A struct that describes the contents of a performance graph as seen in the Performance
1049
+ # Graph in the GUI.
927
1050
  # @attr [String] graph_name The key or name of the graph.
928
1051
  # @attr [String] graph_title The title of the graph as appeared in the GUI's Performance Graph.
929
1052
  # @attr [String] graph_description The text description of this graph.
@@ -934,22 +1057,37 @@ module IControl::System
934
1057
  end
935
1058
 
936
1059
  ##
937
- # A struct that describes details of a statistical graph or table in a file, currently in CSV format. During queries, if the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user in this structure.
1060
+ # A struct that describes details of a statistical graph or table in a file, currently
1061
+ # in CSV format. During queries, if the user specifies a start_time, end_time, and
1062
+ # interval that does not exactly match the corresponding value used within the database,
1063
+ # the database will attempt to use to closest time or interval as requested. The actual
1064
+ # values used will be returned to the user in this structure.
938
1065
  # @attr [String] object_name The key or name of the statistical graph/table.
939
1066
  # @attr [Numeric] start_time The actual starting time (seconds since Jan 1, 1970) used to start retrieving data for the graph/table.
940
1067
  # @attr [Numeric] end_time The actual ending time (seconds since Jan 1, 1970) used to stop retrieving data for the graph/table.
941
1068
  # @attr [Numeric] interval The actual sampling interval in seconds used in creating the graph/table.
942
- # @attr [String] statistic_data The statistics for the specified graph/table in CSV format.
1069
+ # @attr [StringSequence] statistic_data The statistics for the specified graph/table in CSV format.
943
1070
  class PerformanceGraphDataCSV < IControl::Base::Struct
944
1071
  icontrol_attribute :object_name, String
945
1072
  icontrol_attribute :start_time, Numeric
946
1073
  icontrol_attribute :end_time, Numeric
947
1074
  icontrol_attribute :interval, Numeric
948
- icontrol_attribute :statistic_data, String
949
- end
950
-
951
- ##
952
- # A struct that describes a query for details of a statistical graph or table. If the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user on output. For querying purposes, the start_time can be specified as: 0: in which case by default, it means 24 hours ago. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds For querying purposes, the end_time can be specified as: 0: in which case by default, it means now. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds
1075
+ icontrol_attribute :statistic_data, StringSequence
1076
+ end
1077
+
1078
+ ##
1079
+ # A struct that describes a query for details of a statistical graph or table. If the
1080
+ # user specifies a start_time, end_time, and interval that does not exactly match the
1081
+ # corresponding value used within the database, the database will attempt to use to
1082
+ # closest time or interval as requested. The actual values used will be returned to
1083
+ # the user on output. For querying purposes, the start_time can be specified as: 0:
1084
+ # in which case by default, it means 24 hours ago. N: where N represents the number
1085
+ # of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before
1086
+ # now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds For querying
1087
+ # purposes, the end_time can be specified as: 0: in which case by default, it means
1088
+ # now. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N
1089
+ # represents the number of seconds before now, for example: -3600 means 3600 seconds
1090
+ # ago, or now - 3600 seconds
953
1091
  # @attr [String] object_name The key or name of the statistical graph/table.
954
1092
  # @attr [Numeric] start_time The suggested starting time to start retrieving data for the graph/table.
955
1093
  # @attr [Numeric] end_time The suggested ending time to stop retrieving data for the graph/table.
@@ -973,62 +1111,69 @@ module IControl::System
973
1111
  end
974
1112
 
975
1113
  ##
976
- # A struct that describes details of a statistical table. During queries, if the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user in this structure.
1114
+ # A struct that describes details of a statistical table. During queries, if the user
1115
+ # specifies a start_time, end_time, and interval that does not exactly match the corresponding
1116
+ # value used within the database, the database will attempt to use to closest time
1117
+ # or interval as requested. The actual values used will be returned to the user in
1118
+ # this structure.
977
1119
  # @attr [String] table_name The table name of the statistical table.
978
1120
  # @attr [Numeric] start_time The actual starting time (seconds since Jan 1, 1970) used to start retrieving data for the graph/table.
979
1121
  # @attr [Numeric] end_time The actual ending time (seconds since Jan 1, 1970) used to stop retrieving data for the graph/table.
980
1122
  # @attr [Numeric] interval The actual sampling interval in seconds used in creating the table.
981
- # @attr [Numeric] statistic_data The statistics for the specified table.
1123
+ # @attr [DoubleSequence] statistic_data The statistics for the specified table.
982
1124
  class PerformanceTableData < IControl::Base::Struct
983
1125
  icontrol_attribute :table_name, String
984
1126
  icontrol_attribute :start_time, Numeric
985
1127
  icontrol_attribute :end_time, Numeric
986
1128
  icontrol_attribute :interval, Numeric
987
- icontrol_attribute :statistic_data, Numeric
1129
+ icontrol_attribute :statistic_data, DoubleSequence
988
1130
  end
989
1131
 
990
1132
  ##
991
1133
  # A struct that describes some types of system statistics and timestamp.
992
- # @attr [IControl::Common::Statistic] statistics The system statistics.
1134
+ # @attr [IControl::Common::StatisticSequence] statistics The system statistics.
993
1135
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
994
1136
  class SystemStatistics < IControl::Base::Struct
995
- icontrol_attribute :statistics, IControl::Common::Statistic
1137
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
996
1138
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
997
1139
  end
998
1140
 
999
1141
  ##
1000
1142
  # A struct that describes statistics for a particular TMOS processing agent.
1001
1143
  # @attr [String] tmm_id The TMOS processing agent id.
1002
- # @attr [IControl::Common::Statistic] statistics The statistics for the TMOS processing agent.
1144
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the TMOS processing agent.
1003
1145
  class TMMStatisticEntry < IControl::Base::Struct
1004
1146
  icontrol_attribute :tmm_id, String
1005
- icontrol_attribute :statistics, IControl::Common::Statistic
1147
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
1006
1148
  end
1007
1149
 
1008
1150
  ##
1009
1151
  # A struct that describes TMOS processing agent statistics and timestamp.
1010
- # @attr [IControl::System::Statistics::TMMStatisticEntry] statistics The statistics for a sequence of TMOS processing agents.
1152
+ # @attr [IControl::System::Statistics::TMMStatisticEntrySequence] statistics The statistics for a sequence of TMOS processing agents.
1011
1153
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
1012
1154
  class TMMStatistics < IControl::Base::Struct
1013
- icontrol_attribute :statistics, IControl::System::Statistics::TMMStatisticEntry
1155
+ icontrol_attribute :statistics, IControl::System::Statistics::TMMStatisticEntrySequence
1014
1156
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
1015
1157
  end
1016
1158
 
1017
1159
  ##
1018
- # This structure has been deprecated, as it represents internal, implementation-specific details. A struct that describes statistics for a particular virtual compression device.
1160
+ # This structure has been deprecated, as it represents internal, implementation-specific
1161
+ # details. A struct that describes statistics for a particular virtual compression
1162
+ # device.
1019
1163
  # @attr [String] device_name The virtual compression device name.
1020
- # @attr [IControl::Common::Statistic] statistics The statistics for the device.
1164
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the device.
1021
1165
  class VirtualCompressionStatisticEntry < IControl::Base::Struct
1022
1166
  icontrol_attribute :device_name, String
1023
- icontrol_attribute :statistics, IControl::Common::Statistic
1167
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
1024
1168
  end
1025
1169
 
1026
1170
  ##
1027
- # This structure has been deprecated, as it represents internal, implementation-specific details. A struct that describes virtual compression statistics and timestamp.
1028
- # @attr [IControl::System::Statistics::VirtualCompressionStatisticEntry] statistics The statistics for a sequence of virtual compression devices.
1171
+ # This structure has been deprecated, as it represents internal, implementation-specific
1172
+ # details. A struct that describes virtual compression statistics and timestamp.
1173
+ # @attr [IControl::System::Statistics::VirtualCompressionStatisticEntrySequence] statistics The statistics for a sequence of virtual compression devices.
1029
1174
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
1030
1175
  class VirtualCompressionStatistics < IControl::Base::Struct
1031
- icontrol_attribute :statistics, IControl::System::Statistics::VirtualCompressionStatisticEntry
1176
+ icontrol_attribute :statistics, IControl::System::Statistics::VirtualCompressionStatisticEntrySequence
1032
1177
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
1033
1178
  end
1034
1179