icontrol 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,16 +1,21 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The Topology interface enables you to work with topology attributes. For example, you can create and delete a topology. You can also use the Topology interface to add virtual server entries to, or remove virtual server entries from, a topology.
3
+ # The Topology interface enables you to work with topology attributes. For example,
4
+ # you can create and delete a topology. You can also use the Topology interface to
5
+ # add virtual server entries to, or remove virtual server entries from, a topology.
4
6
  class Topology < IControl::Base
5
7
 
6
8
  set_id_name "records"
7
9
 
8
10
  class TopologyEndpoint < IControl::Base::Struct; end
9
- class TopologyRecord < IControl::Base::Struct; end ##
11
+ class TopologyRecord < IControl::Base::Struct; end
12
+ class TopologyEndpointSequence < IControl::Base::Sequence ; end
13
+ class TopologyRecordSequence < IControl::Base::Sequence ; end ##
10
14
  # Adds or creates this topology record.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
15
+ # @rspec_example
16
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
17
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
18
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
19
  # @param [Hash] opts
15
20
  # @option opts [long] :weights The weights for the records.
16
21
  # @option opts [long] :orders The sort orders for the records. These sort orders are used when longest match sorting is not available.
@@ -21,44 +26,49 @@ module IControl::GlobalLB
21
26
 
22
27
  ##
23
28
  # Deletes all topology record.
24
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
29
+ # @rspec_example
30
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
31
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
32
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
27
33
  def delete_all_topology_records
28
34
  super
29
35
  end
30
36
 
31
37
  ##
32
38
  # Deletes this topology record.
33
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
34
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
35
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
39
+ # @rspec_example
40
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
41
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
42
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
36
43
  def delete_topology_record
37
44
  super
38
45
  end
39
46
 
40
47
  ##
41
48
  # Gets a list of of topology record.
49
+ # @rspec_example
42
50
  # @return [TopologyRecord]
43
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
44
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
45
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
46
54
  def list
47
55
  super
48
56
  end
49
57
 
50
58
  ##
51
59
  # Gets the sort orders for this topology record.
60
+ # @rspec_example
52
61
  # @return [long]
53
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
62
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
56
65
  def order
57
66
  super
58
67
  end
59
68
 
60
69
  ##
61
70
  # Gets the version information for this interface.
71
+ # @rspec_example
62
72
  # @return [String]
63
73
  def version
64
74
  super
@@ -66,19 +76,22 @@ module IControl::GlobalLB
66
76
 
67
77
  ##
68
78
  # Gets the weights for this links.
79
+ # @rspec_example
69
80
  # @return [long]
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.
81
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
82
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
83
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
73
84
  def weight
74
85
  super
75
86
  end
76
87
 
77
88
  ##
78
- # Sets the sort orders used when longest match sorting is not available for this topology record.
79
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
80
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
81
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
89
+ # Sets the sort orders used when longest match sorting is not available for this topology
90
+ # record.
91
+ # @rspec_example
92
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
93
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
94
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
82
95
  # @param [Hash] opts
83
96
  # @option opts [long] :orders The sort orders to set.
84
97
  def set_order(opts)
@@ -88,9 +101,10 @@ module IControl::GlobalLB
88
101
 
89
102
  ##
90
103
  # Sets the weights for this topology record.
91
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
92
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
93
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
104
+ # @rspec_example
105
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
94
108
  # @param [Hash] opts
95
109
  # @option opts [long] :weights The weights to set.
96
110
  def set_weight(opts)
@@ -1,6 +1,7 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The VirtualServer interface enables you to work with virtual servers associated with a server.
3
+ # The VirtualServer interface enables you to work with virtual servers associated with
4
+ # a server.
4
5
  class VirtualServer < IControl::Base
5
6
 
6
7
  set_id_name "virtual_servers"
@@ -8,11 +9,15 @@ module IControl::GlobalLB
8
9
  class MonitorAssociation < IControl::Base::Struct; end
9
10
  class VirtualServerMetricLimit < IControl::Base::Struct; end
10
11
  class VirtualServerStatisticEntry < IControl::Base::Struct; end
11
- class VirtualServerStatistics < IControl::Base::Struct; end ##
12
+ class VirtualServerStatistics < IControl::Base::Struct; end
13
+ class MonitorAssociationSequence < IControl::Base::Sequence ; end
14
+ class VirtualServerMetricLimitSequence < IControl::Base::Sequence ; end
15
+ class VirtualServerStatisticEntrySequence < IControl::Base::Sequence ; end ##
12
16
  # Adds the virtual server to the dependency list that this virtual server depend on.
13
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
14
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
15
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
17
+ # @rspec_example
18
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
19
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
20
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
16
21
  # @param [Hash] opts
17
22
  # @option opts [IControl::GlobalLB::VirtualServerDefinition[]] :dependencies The dependency list of VSes that the specified virtual servers depend on.
18
23
  def add_dependency(opts)
@@ -22,9 +27,10 @@ module IControl::GlobalLB
22
27
 
23
28
  ##
24
29
  # Creates this virtual server.
25
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
26
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
27
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
30
+ # @rspec_example
31
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
32
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
33
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
28
34
  # @param [Hash] opts
29
35
  # @option opts [String] :servers The servers that the virtual servers belong to.
30
36
  def create(opts)
@@ -34,134 +40,149 @@ module IControl::GlobalLB
34
40
 
35
41
  ##
36
42
  # Deletes all virtual server.
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.
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.
40
47
  def delete_all_virtual_servers
41
48
  super
42
49
  end
43
50
 
44
51
  ##
45
52
  # Deletes this virtual server.
46
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
53
+ # @rspec_example
54
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
55
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
56
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
49
57
  def delete_virtual_server
50
58
  super
51
59
  end
52
60
 
53
61
  ##
54
62
  # Gets the statistics for all the virtual server.
63
+ # @rspec_example
55
64
  # @return [VirtualServerStatistics]
56
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
57
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
58
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
65
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
66
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
67
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
59
68
  def all_statistics
60
69
  super
61
70
  end
62
71
 
63
72
  ##
64
73
  # Gets the list of virtual server that this virtual server depend on.
74
+ # @rspec_example
65
75
  # @return [VirtualServerDefinition[]]
66
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
67
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
68
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
76
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
77
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
78
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
69
79
  def dependency
70
80
  super
71
81
  end
72
82
 
73
83
  ##
74
84
  # Gets the enabled states for this virtual server.
85
+ # @rspec_example
75
86
  # @return [EnabledState]
76
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
77
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
78
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
87
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
88
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
89
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
79
90
  def enabled_state
80
91
  super
81
92
  end
82
93
 
83
94
  ##
84
95
  # Gets all metrics limits for a sequence of virtual server.
96
+ # @rspec_example
85
97
  # @return [VirtualServerMetricLimit]
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.
98
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
99
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
100
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
89
101
  def limit
90
102
  super
91
103
  end
92
104
 
93
105
  ##
94
106
  # Gets a list of virtual server.
107
+ # @rspec_example
95
108
  # @return [VirtualServerDefinition]
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.
109
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
99
112
  def list
100
113
  super
101
114
  end
102
115
 
103
116
  ##
104
- # Gets the monitor associations for this virtual server, i.e. the monitor rules used by the virtual server.
117
+ # Gets the monitor associations for this virtual server, i.e. the monitor rules used
118
+ # by the virtual server.
119
+ # @rspec_example
105
120
  # @return [MonitorAssociation]
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.
121
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
122
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
123
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
109
124
  def monitor_association
110
125
  super
111
126
  end
112
127
 
113
128
  ##
114
129
  # Gets the statuses of this virtual server.
130
+ # @rspec_example
115
131
  # @return [ObjectStatus]
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.
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.
119
135
  def object_status
120
136
  super
121
137
  end
122
138
 
123
139
  ##
124
140
  # Gets a parent links this virtual server belong to.
141
+ # @rspec_example
125
142
  # @return [String]
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.
143
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
144
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
145
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
129
146
  def parent_link
130
147
  super
131
148
  end
132
149
 
133
150
  ##
134
151
  # Gets a list of servers this virtual server belong to.
152
+ # @rspec_example
135
153
  # @return [String]
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.
154
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
155
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
156
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
139
157
  def server
140
158
  super
141
159
  end
142
160
 
143
161
  ##
144
162
  # Gets the statistics for this virtual server.
163
+ # @rspec_example
145
164
  # @return [VirtualServerStatistics]
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.
165
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
166
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
167
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
149
168
  def statistics
150
169
  super
151
170
  end
152
171
 
153
172
  ##
154
173
  # Gets the translation IP addresses and ports for this virtual server.
174
+ # @rspec_example
155
175
  # @return [IPPortDefinition]
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.
176
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
177
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
178
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
159
179
  def translation
160
180
  super
161
181
  end
162
182
 
163
183
  ##
164
184
  # Gets the version information for this interface.
185
+ # @rspec_example
165
186
  # @return [String]
166
187
  def version
167
188
  super
@@ -169,18 +190,21 @@ module IControl::GlobalLB
169
190
 
170
191
  ##
171
192
  # Removes any and all dependencies of this virtual server.
172
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
193
+ # @rspec_example
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.
175
197
  def remove_all_dependencies
176
198
  super
177
199
  end
178
200
 
179
201
  ##
180
- # Removes the virtual server from the dependency list that this virtual server depend on.
181
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
182
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
183
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
202
+ # Removes the virtual server from the dependency list that this virtual server depend
203
+ # on.
204
+ # @rspec_example
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.
184
208
  # @param [Hash] opts
185
209
  # @option opts [IControl::GlobalLB::VirtualServerDefinition[]] :dependencies The dependency list of VSes that the specified virtual servers depend on.
186
210
  def remove_dependency(opts)
@@ -189,28 +213,33 @@ module IControl::GlobalLB
189
213
  end
190
214
 
191
215
  ##
192
- # Removes the monitor associations for this virtual server. This basically deletes the monitor associations between a virtual server and a monitor rule, i.e. this virtual server will no longer be monitored.
193
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
194
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
195
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
216
+ # Removes the monitor associations for this virtual server. This basically deletes
217
+ # the monitor associations between a virtual server and a monitor rule, i.e. this virtual
218
+ # server will no longer be monitored.
219
+ # @rspec_example
220
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
221
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
222
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
196
223
  def remove_monitor_association
197
224
  super
198
225
  end
199
226
 
200
227
  ##
201
228
  # Resets the statistics for this virtual server.
202
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
203
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
204
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
229
+ # @rspec_example
230
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
231
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
232
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
205
233
  def reset_statistics
206
234
  super
207
235
  end
208
236
 
209
237
  ##
210
238
  # Sets the enabled states for this virtual server.
211
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
212
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
213
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
239
+ # @rspec_example
240
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
241
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
242
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
214
243
  # @param [Hash] opts
215
244
  # @option opts [IControl::Common::EnabledState] :states The states to set.
216
245
  def set_enabled_state(opts)
@@ -220,9 +249,10 @@ module IControl::GlobalLB
220
249
 
221
250
  ##
222
251
  # Sets the limits for virtual server metrics.
223
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
224
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
225
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
252
+ # @rspec_example
253
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
254
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
255
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
226
256
  # @param [Hash] opts
227
257
  # @option opts [IControl::GlobalLB::VirtualServer::VirtualServerMetricLimit] :limits The virtual servers' metric limits.
228
258
  def set_limit(opts)
@@ -231,10 +261,12 @@ module IControl::GlobalLB
231
261
  end
232
262
 
233
263
  ##
234
- # Sets/creates the monitor associations for this virtual server. This basically creates the monitor associations between a virtual server and a monitor rule.
235
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
236
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
237
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
264
+ # Sets/creates the monitor associations for this virtual server. This basically creates
265
+ # the monitor associations between a virtual server and a monitor rule.
266
+ # @rspec_example
267
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
268
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
269
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
238
270
  # @param [Hash] opts
239
271
  # @option opts [IControl::GlobalLB::VirtualServer::MonitorAssociation] :monitor_associations The monitor associations that will be used to evaluate the specified virtual servers.
240
272
  def set_monitor_association(opts)
@@ -244,9 +276,10 @@ module IControl::GlobalLB
244
276
 
245
277
  ##
246
278
  # Sets the servers this virtual server belong to.
247
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
248
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
249
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
279
+ # @rspec_example
280
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
281
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
282
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
250
283
  # @param [Hash] opts
251
284
  # @option opts [String] :servers The servers that the virtual servers belong to.
252
285
  def set_server(opts)
@@ -256,9 +289,10 @@ module IControl::GlobalLB
256
289
 
257
290
  ##
258
291
  # Sets the translation IP addresses and ports for this virtual server.
259
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
260
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
261
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
292
+ # @rspec_example
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.
262
296
  # @param [Hash] opts
263
297
  # @option opts [IControl::Common::IPPortDefinition] :translations The translation IP addresses and ports.
264
298
  def set_translation(opts)
@@ -278,27 +312,27 @@ module IControl::GlobalLB
278
312
  ##
279
313
  # A struct that contains metric limits for a virtual server.
280
314
  # @attr [IControl::GlobalLB::VirtualServerDefinition] virtual_server The virtual server.
281
- # @attr [IControl::GlobalLB::MetricLimit] metric_limits Metric limits of the virtual server.
315
+ # @attr [IControl::GlobalLB::MetricLimitSequence] metric_limits Metric limits of the virtual server.
282
316
  class VirtualServerMetricLimit < IControl::Base::Struct
283
317
  icontrol_attribute :virtual_server, IControl::GlobalLB::VirtualServerDefinition
284
- icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimit
318
+ icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimitSequence
285
319
  end
286
320
 
287
321
  ##
288
322
  # A struct that describes statistics for a particular virtual server.
289
323
  # @attr [IControl::GlobalLB::VirtualServerDefinition] virtual_server The virtual server.
290
- # @attr [IControl::Common::Statistic] statistics The statistics for the virtual server.
324
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the virtual server.
291
325
  class VirtualServerStatisticEntry < IControl::Base::Struct
292
326
  icontrol_attribute :virtual_server, IControl::GlobalLB::VirtualServerDefinition
293
- icontrol_attribute :statistics, IControl::Common::Statistic
327
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
294
328
  end
295
329
 
296
330
  ##
297
331
  # A struct that describes virtual server statistics and timestamp.
298
- # @attr [IControl::GlobalLB::VirtualServer::VirtualServerStatisticEntry] statistics The statistics for a sequence of virtual servers.
332
+ # @attr [IControl::GlobalLB::VirtualServer::VirtualServerStatisticEntrySequence] statistics The statistics for a sequence of virtual servers.
299
333
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
300
334
  class VirtualServerStatistics < IControl::Base::Struct
301
- icontrol_attribute :statistics, IControl::GlobalLB::VirtualServer::VirtualServerStatisticEntry
335
+ icontrol_attribute :statistics, IControl::GlobalLB::VirtualServer::VirtualServerStatisticEntrySequence
302
336
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
303
337
  end
304
338