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,17 +1,22 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The Rule interface enables you to manipulate a Global load balancer's rules. For example, use the Rule interface to get a list of all rules, create rules, delete rules, modify rules, and query rules.
3
+ # The Rule interface enables you to manipulate a Global load balancer's rules. For
4
+ # example, use the Rule interface to get a list of all rules, create rules, delete
5
+ # rules, modify rules, and query rules.
4
6
  class Rule < IControl::Base
5
7
 
6
8
  set_id_name "rule_names"
7
9
 
8
10
  class RuleDefinition < IControl::Base::Struct; end
9
11
  class RuleStatisticEntry < IControl::Base::Struct; end
10
- class RuleStatistics < IControl::Base::Struct; end ##
12
+ class RuleStatistics < IControl::Base::Struct; end
13
+ class RuleDefinitionSequence < IControl::Base::Sequence ; end
14
+ class RuleStatisticEntrySequence < IControl::Base::Sequence ; end ##
11
15
  # Creates this rule.
12
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
13
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
14
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
16
+ # @rspec_example
17
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
18
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
19
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
15
20
  # @param [Hash] opts
16
21
  # @option opts [IControl::GlobalLB::Rule::RuleDefinition] :rules The rules to create.
17
22
  def create(opts)
@@ -21,54 +26,61 @@ module IControl::GlobalLB
21
26
 
22
27
  ##
23
28
  # Deletes all user-defined rule.
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_rules
28
34
  super
29
35
  end
30
36
 
31
37
  ##
32
- # Deletes this rule. An exception will be raised when attempting to delete a default system rule.
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.
38
+ # Deletes this rule. An exception will be raised when attempting to delete a default
39
+ # system rule.
40
+ # @rspec_example
41
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
36
44
  def delete_rule
37
45
  super
38
46
  end
39
47
 
40
48
  ##
41
49
  # Gets the statistics for all the rule.
50
+ # @rspec_example
42
51
  # @return [RuleStatistics]
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.
52
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
46
55
  def all_statistics
47
56
  super
48
57
  end
49
58
 
50
59
  ##
51
60
  # Gets a list of all rule.
61
+ # @rspec_example
52
62
  # @return [String]
53
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
56
66
  def list
57
67
  super
58
68
  end
59
69
 
60
70
  ##
61
71
  # Gets the statistics for this rule.
72
+ # @rspec_example
62
73
  # @return [RuleStatistics]
63
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
64
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
65
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
66
77
  def statistics
67
78
  super
68
79
  end
69
80
 
70
81
  ##
71
82
  # Gets the version information for this interface.
83
+ # @rspec_example
72
84
  # @return [String]
73
85
  def version
74
86
  super
@@ -76,9 +88,10 @@ module IControl::GlobalLB
76
88
 
77
89
  ##
78
90
  # Modifies this rule.
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.
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 [IControl::GlobalLB::Rule::RuleDefinition] :rules The rules to modify.
84
97
  def modify_rule(opts)
@@ -88,29 +101,32 @@ module IControl::GlobalLB
88
101
 
89
102
  ##
90
103
  # Queries all rule.
104
+ # @rspec_example
91
105
  # @return [RuleDefinition]
92
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
93
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
94
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
106
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
107
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
108
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
95
109
  def query_all_rules
96
110
  super
97
111
  end
98
112
 
99
113
  ##
100
114
  # Queries this rule.
115
+ # @rspec_example
101
116
  # @return [RuleDefinition]
102
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
103
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
104
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
117
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
118
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
119
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
105
120
  def query_rule
106
121
  super
107
122
  end
108
123
 
109
124
  ##
110
125
  # Resets the statistics for this rule.
111
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
112
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
113
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
126
+ # @rspec_example
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.
114
130
  def reset_statistics
115
131
  super
116
132
  end
@@ -129,20 +145,20 @@ module IControl::GlobalLB
129
145
  # @attr [String] rule_name The rule name.
130
146
  # @attr [String] event_name The rule event name.
131
147
  # @attr [Numeric] priority The rule execution priority.
132
- # @attr [IControl::Common::Statistic] statistics The statistics for the rule.
148
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the rule.
133
149
  class RuleStatisticEntry < IControl::Base::Struct
134
150
  icontrol_attribute :rule_name, String
135
151
  icontrol_attribute :event_name, String
136
152
  icontrol_attribute :priority, Numeric
137
- icontrol_attribute :statistics, IControl::Common::Statistic
153
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
138
154
  end
139
155
 
140
156
  ##
141
157
  # A struct that describes pool statistics and timestamp.
142
- # @attr [IControl::GlobalLB::Rule::RuleStatisticEntry] statistics The statistics for a sequence of pools.
158
+ # @attr [IControl::GlobalLB::Rule::RuleStatisticEntrySequence] statistics The statistics for a sequence of pools.
143
159
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
144
160
  class RuleStatistics < IControl::Base::Struct
145
- icontrol_attribute :statistics, IControl::GlobalLB::Rule::RuleStatisticEntry
161
+ icontrol_attribute :statistics, IControl::GlobalLB::Rule::RuleStatisticEntrySequence
146
162
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
147
163
  end
148
164
 
@@ -10,11 +10,17 @@ module IControl::GlobalLB
10
10
  class ServerIPsForUnitID < IControl::Base::Struct; end
11
11
  class ServerMetricLimit < IControl::Base::Struct; end
12
12
  class ServerStatisticEntry < IControl::Base::Struct; end
13
- class ServerStatistics < IControl::Base::Struct; end ##
13
+ class ServerStatistics < IControl::Base::Struct; end
14
+ class MonitorAssociationSequence < IControl::Base::Sequence ; end
15
+ class ServerIPSequence < IControl::Base::Sequence ; end
16
+ class ServerIPsForUnitIDSequence < IControl::Base::Sequence ; end
17
+ class ServerMetricLimitSequence < IControl::Base::Sequence ; end
18
+ class ServerStatisticEntrySequence < IControl::Base::Sequence ; end ##
14
19
  # Adds the IP addresses to this server.
15
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
20
+ # @rspec_example
21
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
18
24
  # @param [Hash] opts
19
25
  # @option opts [IControl::GlobalLB::Server::ServerIPDefinition] :ips The IP addresses to add to the servers.
20
26
  def add_ip(opts)
@@ -24,9 +30,10 @@ module IControl::GlobalLB
24
30
 
25
31
  ##
26
32
  # Creates this server.
27
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
28
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
29
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
33
+ # @rspec_example
34
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
35
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
36
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
30
37
  # @param [Hash] opts
31
38
  # @option opts [IControl::GlobalLB::ServerType] :types The server types.
32
39
  # @option opts [String] :data_centers The data centers associated with the servers.
@@ -37,138 +44,157 @@ module IControl::GlobalLB
37
44
 
38
45
  ##
39
46
  # Deletes all server.
40
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
41
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
42
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
47
+ # @rspec_example
48
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
43
51
  def delete_all_servers
44
52
  super
45
53
  end
46
54
 
47
55
  ##
48
56
  # Deletes this server.
49
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
57
+ # @rspec_example
58
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
52
61
  def delete_server
53
62
  super
54
63
  end
55
64
 
56
65
  ##
57
66
  # Gets the statistics for all the server.
67
+ # @rspec_example
58
68
  # @return [ServerStatistics]
59
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
69
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
62
72
  def all_statistics
63
73
  super
64
74
  end
65
75
 
66
76
  ##
67
- # Gets the states indicating whether path information gathering is allowed for this server.
77
+ # Gets the states indicating whether path information gathering is allowed for this
78
+ # server.
79
+ # @rspec_example
68
80
  # @return [EnabledState]
69
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
70
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
71
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
72
84
  def allow_path_state
73
85
  super
74
86
  end
75
87
 
76
88
  ##
77
89
  # Gets the states indicating whether service check is allowed for this server.
90
+ # @rspec_example
78
91
  # @return [EnabledState]
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.
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
  def allow_service_check_state
83
96
  super
84
97
  end
85
98
 
86
99
  ##
87
- # Gets the states indicating whether SNMP information gathering is allowed for this server.
100
+ # Gets the states indicating whether SNMP information gathering is allowed for this
101
+ # server.
102
+ # @rspec_example
88
103
  # @return [EnabledState]
89
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
90
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
91
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
104
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
105
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
106
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
92
107
  def allow_snmp_state
93
108
  super
94
109
  end
95
110
 
96
111
  ##
97
- # Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual server based on this server.
112
+ # Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM
113
+ # will attempt to gather all virtual server based on this server.
114
+ # @rspec_example
98
115
  # @return [AutoConfigurationState]
99
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
100
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
101
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
116
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
117
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
118
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
102
119
  def auto_configuration_state
103
120
  super
104
121
  end
105
122
 
106
123
  ##
107
124
  # Gets the data centers that this server belong to.
125
+ # @rspec_example
108
126
  # @return [String]
109
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
110
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
111
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
112
130
  def data_center
113
131
  super
114
132
  end
115
133
 
116
134
  ##
117
135
  # Gets the enabled states for this server.
136
+ # @rspec_example
118
137
  # @return [EnabledState]
119
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
138
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
122
141
  def enabled_state
123
142
  super
124
143
  end
125
144
 
126
145
  ##
127
146
  # Gets the IP addresses that belong to this server.
147
+ # @rspec_example
128
148
  # @return [ServerIPDefinition]
129
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
130
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
131
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
149
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
132
152
  def ip
133
153
  super
134
154
  end
135
155
 
136
156
  ##
137
157
  # Gets all metrics limits for a sequence of server.
158
+ # @rspec_example
138
159
  # @return [ServerMetricLimit]
139
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
140
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
141
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
160
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
161
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
162
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
142
163
  def limit
143
164
  super
144
165
  end
145
166
 
146
167
  ##
147
- # Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to look up the links's default gateways.
168
+ # Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM
169
+ # will attempt to look up the links's default gateways.
170
+ # @rspec_example
148
171
  # @return [AutoConfigurationState]
149
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
150
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
151
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
172
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
173
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
174
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
152
175
  def link_auto_configuration_state
153
176
  super
154
177
  end
155
178
 
156
179
  ##
157
180
  # Gets a list of server.
181
+ # @rspec_example
158
182
  # @return [String]
159
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
183
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
184
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
185
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
186
  def list
163
187
  super
164
188
  end
165
189
 
166
190
  ##
167
- # Gets the monitor associations for this server, i.e. the monitor rules used by the server.
191
+ # Gets the monitor associations for this server, i.e. the monitor rules used by the
192
+ # server.
193
+ # @rspec_example
168
194
  # @return [MonitorAssociation]
169
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
195
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
196
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
197
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
198
  # @param [Hash] opts
173
199
  # @option opts [String] :server_names The names of the servers.
174
200
  def monitor_association(opts)
@@ -178,40 +204,44 @@ module IControl::GlobalLB
178
204
 
179
205
  ##
180
206
  # Gets the statuses of this server.
207
+ # @rspec_example
181
208
  # @return [ObjectStatus]
182
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
183
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
184
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
209
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
210
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
211
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
185
212
  def object_status
186
213
  super
187
214
  end
188
215
 
189
216
  ##
190
217
  # Gets the prober addresses for this server.
218
+ # @rspec_example
191
219
  # @return [String]
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.
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.
195
223
  def prober_address
196
224
  super
197
225
  end
198
226
 
199
227
  ##
200
228
  # Gets the server types of this server.
229
+ # @rspec_example
201
230
  # @return [ServerType]
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.
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.
205
234
  def server_type
206
235
  super
207
236
  end
208
237
 
209
238
  ##
210
239
  # Gets the statistics for this server.
240
+ # @rspec_example
211
241
  # @return [ServerStatistics]
212
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
213
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
214
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
215
245
  # @param [Hash] opts
216
246
  # @option opts [String] :server_names The names of the servers.
217
247
  def statistics(opts)
@@ -221,6 +251,7 @@ module IControl::GlobalLB
221
251
 
222
252
  ##
223
253
  # Gets the version information for this interface.
254
+ # @rspec_example
224
255
  # @return [String]
225
256
  def version
226
257
  super
@@ -228,9 +259,10 @@ module IControl::GlobalLB
228
259
 
229
260
  ##
230
261
  # Removes the IP addresses from this server.
231
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
232
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
233
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
262
+ # @rspec_example
263
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
264
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
265
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
234
266
  # @param [Hash] opts
235
267
  # @option opts [IControl::GlobalLB::Server::ServerIPDefinition] :ips The IP addresses to remove from the servers.
236
268
  def remove_ip(opts)
@@ -239,10 +271,13 @@ module IControl::GlobalLB
239
271
  end
240
272
 
241
273
  ##
242
- # Removes the monitor associations for this server. This basically deletes the monitor associations between a server and a monitor rule, i.e. this server will no longer be monitored.
243
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
244
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
245
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
274
+ # Removes the monitor associations for this server. This basically deletes the monitor
275
+ # associations between a server and a monitor rule, i.e. this server will no longer
276
+ # be monitored.
277
+ # @rspec_example
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.
246
281
  # @param [Hash] opts
247
282
  # @option opts [String] :server_names The names of the servers.
248
283
  def remove_monitor_association(opts)
@@ -252,9 +287,10 @@ module IControl::GlobalLB
252
287
 
253
288
  ##
254
289
  # Resets the statistics for this server.
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.
290
+ # @rspec_example
291
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
292
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
293
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
258
294
  # @param [Hash] opts
259
295
  # @option opts [String] :server_names The names of the servers.
260
296
  def reset_statistics(opts)
@@ -263,10 +299,12 @@ module IControl::GlobalLB
263
299
  end
264
300
 
265
301
  ##
266
- # Sets the states indicating whether path information gathering is allowed for this server.
267
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
268
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
269
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
302
+ # Sets the states indicating whether path information gathering is allowed for this
303
+ # server.
304
+ # @rspec_example
305
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
306
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
307
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
270
308
  # @param [Hash] opts
271
309
  # @option opts [IControl::Common::EnabledState] :states The states to set.
272
310
  def set_allow_path_state(opts)
@@ -276,9 +314,10 @@ module IControl::GlobalLB
276
314
 
277
315
  ##
278
316
  # Sets the states indicating whether service check is allowed for this server.
279
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
280
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
281
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
317
+ # @rspec_example
318
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
319
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
320
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
282
321
  # @param [Hash] opts
283
322
  # @option opts [IControl::Common::EnabledState] :states The states to set.
284
323
  def set_allow_service_check_state(opts)
@@ -287,10 +326,12 @@ module IControl::GlobalLB
287
326
  end
288
327
 
289
328
  ##
290
- # Sets the states indicating whether SNMP information gathering is allowed for this server.
291
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
292
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
293
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
329
+ # Sets the states indicating whether SNMP information gathering is allowed for this
330
+ # server.
331
+ # @rspec_example
332
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
333
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
334
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
294
335
  # @param [Hash] opts
295
336
  # @option opts [IControl::Common::EnabledState] :states The states to set.
296
337
  def set_allow_snmp_state(opts)
@@ -299,10 +340,12 @@ module IControl::GlobalLB
299
340
  end
300
341
 
301
342
  ##
302
- # Sets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual server based on this server.
303
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
304
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
305
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
343
+ # Sets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM
344
+ # will attempt to gather all virtual server based on this server.
345
+ # @rspec_example
346
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
347
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
348
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
306
349
  # @param [Hash] opts
307
350
  # @option opts [IControl::GlobalLB::AutoConfigurationState] :states The states to set.
308
351
  def set_auto_configuration_state(opts)
@@ -312,9 +355,10 @@ module IControl::GlobalLB
312
355
 
313
356
  ##
314
357
  # Moves this server to the new data centers.
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.
358
+ # @rspec_example
359
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
360
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
361
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
318
362
  # @param [Hash] opts
319
363
  # @option opts [String] :data_centers The names of the new data centers.
320
364
  def set_data_center(opts)
@@ -324,9 +368,10 @@ module IControl::GlobalLB
324
368
 
325
369
  ##
326
370
  # Sets the enabled states for this server.
327
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
328
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
329
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
371
+ # @rspec_example
372
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
373
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
374
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
330
375
  # @param [Hash] opts
331
376
  # @option opts [IControl::Common::EnabledState] :states The states to set.
332
377
  def set_enabled_state(opts)
@@ -336,9 +381,10 @@ module IControl::GlobalLB
336
381
 
337
382
  ##
338
383
  # Sets the limits for server metrics.
339
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
340
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
341
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
384
+ # @rspec_example
385
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
386
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
387
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
342
388
  # @param [Hash] opts
343
389
  # @option opts [IControl::GlobalLB::Server::ServerMetricLimit] :limits The servers' metric limits.
344
390
  def set_limit(opts)
@@ -347,10 +393,12 @@ module IControl::GlobalLB
347
393
  end
348
394
 
349
395
  ##
350
- # Sets the states indicating whether autoconfig is enabled/disabled for the server' links. If enabled, GTM will attempt to look up the links's default gateways.
351
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
352
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
353
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
396
+ # Sets the states indicating whether autoconfig is enabled/disabled for the server'
397
+ # links. If enabled, GTM will attempt to look up the links's default gateways.
398
+ # @rspec_example
399
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
400
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
401
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
354
402
  # @param [Hash] opts
355
403
  # @option opts [IControl::GlobalLB::AutoConfigurationState] :states The states to set.
356
404
  def set_link_auto_configuration_state(opts)
@@ -359,10 +407,12 @@ module IControl::GlobalLB
359
407
  end
360
408
 
361
409
  ##
362
- # Sets/creates the monitor associations for this server. This basically creates the monitor associations between a server and a monitor rule.
363
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
364
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
365
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
410
+ # Sets/creates the monitor associations for this server. This basically creates the
411
+ # monitor associations between a server and a monitor rule.
412
+ # @rspec_example
413
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
414
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
415
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
366
416
  # @param [Hash] opts
367
417
  # @option opts [IControl::GlobalLB::Server::MonitorAssociation] :monitor_associations The monitor associations that will be used to evaluate the specified servers.
368
418
  def set_monitor_association(opts)
@@ -372,9 +422,10 @@ module IControl::GlobalLB
372
422
 
373
423
  ##
374
424
  # Sets the prober addresses for this server.
375
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
376
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
377
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
425
+ # @rspec_example
426
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
427
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
428
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
378
429
  # @param [Hash] opts
379
430
  # @option opts [String] :addresses The prober addresses
380
431
  def set_prober_address(opts)
@@ -384,9 +435,10 @@ module IControl::GlobalLB
384
435
 
385
436
  ##
386
437
  # Sets the server types of this server.
387
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
388
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
389
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
438
+ # @rspec_example
439
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
440
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
441
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
390
442
  # @param [Hash] opts
391
443
  # @option opts [IControl::GlobalLB::ServerType] :types The server types to set.
392
444
  def set_server_type(opts)
@@ -406,45 +458,45 @@ module IControl::GlobalLB
406
458
  ##
407
459
  # A struct that contains definition for the server and the associated IP addresses.
408
460
  # @attr [String] server The server name.
409
- # @attr [IControl::GlobalLB::Server::ServerIPsForUnitID] addresses The IP addresses associated with this instance of the server.
461
+ # @attr [IControl::GlobalLB::Server::ServerIPsForUnitIDSequence] addresses The IP addresses associated with this instance of the server.
410
462
  class ServerIPDefinition < IControl::Base::Struct
411
463
  icontrol_attribute :server, String
412
- icontrol_attribute :addresses, IControl::GlobalLB::Server::ServerIPsForUnitID
464
+ icontrol_attribute :addresses, IControl::GlobalLB::Server::ServerIPsForUnitIDSequence
413
465
  end
414
466
 
415
467
  ##
416
468
  # A struct that contains definition for the server.
417
469
  # @attr [Numeric] unit_id The unit ID of the server.
418
- # @attr [String] addresses_on_unit The IP addresses associated with the server's unit ID.
470
+ # @attr [StringSequence] addresses_on_unit The IP addresses associated with the server's unit ID.
419
471
  class ServerIPsForUnitID < IControl::Base::Struct
420
472
  icontrol_attribute :unit_id, Numeric
421
- icontrol_attribute :addresses_on_unit, String
473
+ icontrol_attribute :addresses_on_unit, StringSequence
422
474
  end
423
475
 
424
476
  ##
425
477
  # A struct that contains metric limits for a server.
426
478
  # @attr [String] server_name The name that identifies a server.
427
- # @attr [IControl::GlobalLB::MetricLimit] metric_limits Metric limits of the server.
479
+ # @attr [IControl::GlobalLB::MetricLimitSequence] metric_limits Metric limits of the server.
428
480
  class ServerMetricLimit < IControl::Base::Struct
429
481
  icontrol_attribute :server_name, String
430
- icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimit
482
+ icontrol_attribute :metric_limits, IControl::GlobalLB::MetricLimitSequence
431
483
  end
432
484
 
433
485
  ##
434
486
  # A struct that describes statistics for a particular server.
435
487
  # @attr [String] server_name The server name.
436
- # @attr [IControl::Common::Statistic] statistics The statistics for the server.
488
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the server.
437
489
  class ServerStatisticEntry < IControl::Base::Struct
438
490
  icontrol_attribute :server_name, String
439
- icontrol_attribute :statistics, IControl::Common::Statistic
491
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
440
492
  end
441
493
 
442
494
  ##
443
495
  # A struct that describes server statistics and timestamp.
444
- # @attr [IControl::GlobalLB::Server::ServerStatisticEntry] statistics The statistics for a sequence of servers.
496
+ # @attr [IControl::GlobalLB::Server::ServerStatisticEntrySequence] statistics The statistics for a sequence of servers.
445
497
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
446
498
  class ServerStatistics < IControl::Base::Struct
447
- icontrol_attribute :statistics, IControl::GlobalLB::Server::ServerStatisticEntry
499
+ icontrol_attribute :statistics, IControl::GlobalLB::Server::ServerStatisticEntrySequence
448
500
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
449
501
  end
450
502