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
@@ -6,6 +6,24 @@ module IControl::GlobalLB
6
6
  class MonitorInstanceState < IControl::Base::Struct; end
7
7
  class MonitorRule < IControl::Base::Struct; end
8
8
  class VirtualServerDefinition < IControl::Base::Struct; end
9
+ class AddressTypeSequence < IControl::Base::Sequence ; end
10
+ class AutoConfigurationStateSequence < IControl::Base::Sequence ; end
11
+ class AvailabilityDependencySequence < IControl::Base::Sequence ; end
12
+ class LBMethodSequence < IControl::Base::Sequence ; end
13
+ class LDNSProbeProtocolSequence < IControl::Base::Sequence ; end
14
+ class LinkWeightTypeSequence < IControl::Base::Sequence ; end
15
+ class MetricLimitSequence < IControl::Base::Sequence ; end
16
+ class MonitorIPPortSequence < IControl::Base::Sequence ; end
17
+ class MonitorInstanceSequence < IControl::Base::Sequence ; end
18
+ class MonitorInstanceStateSequence < IControl::Base::Sequence ; end
19
+ class MonitorInstanceStateSequenceSequence < IControl::Base::SequenceSequence ; end
20
+ class MonitorInstanceStateTypeSequence < IControl::Base::Sequence ; end
21
+ class MonitorRuleSequence < IControl::Base::Sequence ; end
22
+ class RegionDBTypeSequence < IControl::Base::Sequence ; end
23
+ class RegionTypeSequence < IControl::Base::Sequence ; end
24
+ class ServerTypeSequence < IControl::Base::Sequence ; end
25
+ class VirtualServerSequence < IControl::Base::Sequence ; end
26
+ class VirtualServerSequenceSequence < IControl::Base::SequenceSequence ; end
9
27
  class Application < IControl::Base; end
10
28
  class DNSSECKey < IControl::Base; end
11
29
  class DNSSECZone < IControl::Base; end
@@ -56,7 +74,8 @@ module IControl::GlobalLB
56
74
  end
57
75
 
58
76
  ##
59
- # A struct that describes a monitored member definition, used in the destination address:port of the monitor template.
77
+ # A struct that describes a monitored member definition, used in the destination address:port
78
+ # of the monitor template.
60
79
  # @attr [IControl::GlobalLB::AddressType] address_type The address type of the IP:port specified in ipport.
61
80
  # @attr [IControl::Common::IPPortDefinition] ipport The IP:port definition.
62
81
  class MonitorIPPort < IControl::Base::Struct
@@ -88,11 +107,11 @@ module IControl::GlobalLB
88
107
  # An struct that specifies a monitor rule.
89
108
  # @attr [IControl::GlobalLB::MonitorRuleType] type An indicator of how to deal/interpret with the list of monitors in monitor_templates.
90
109
  # @attr [Numeric] quorum A value to be used when type is MONITOR_RULE_TYPE_M_OF_N, i.e. this value is the M in M of N. This value is ignored for other rule types.
91
- # @attr [String] monitor_templates The list of monitors that constitute this monitor rule.
110
+ # @attr [StringSequence] monitor_templates The list of monitors that constitute this monitor rule.
92
111
  class MonitorRule < IControl::Base::Struct
93
112
  icontrol_attribute :type, IControl::GlobalLB::MonitorRuleType
94
113
  icontrol_attribute :quorum, Numeric
95
- icontrol_attribute :monitor_templates, String
114
+ icontrol_attribute :monitor_templates, StringSequence
96
115
  end
97
116
 
98
117
  ##
@@ -1,44 +1,51 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The Application interface enables you to work with applications running within Wide IPs.
3
+ # The Application interface enables you to work with applications running within Wide
4
+ # IPs.
4
5
  class Application < IControl::Base
5
6
 
6
7
  set_id_name "applications"
7
8
 
8
9
  class ApplicationContextObject < IControl::Base::Struct; end
10
+ class ApplicationContextObjectSequence < IControl::Base::Sequence ; end
11
+ class ApplicationObjectTypeSequence < IControl::Base::Sequence ; end
9
12
  # A list of object types that can be used within an application context.
10
13
  class ApplicationObjectType < IControl::Base::Enumeration; end ##
11
14
  # Creates this application.
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.
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.
15
19
  def create
16
20
  super
17
21
  end
18
22
 
19
23
  ##
20
24
  # Deletes all application.
21
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
22
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
23
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
25
+ # @rspec_example
26
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
27
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
28
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
24
29
  def delete_all_applications
25
30
  super
26
31
  end
27
32
 
28
33
  ##
29
34
  # Deletes this application.
30
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
31
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
32
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
35
+ # @rspec_example
36
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
37
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
38
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
33
39
  def delete_application
34
40
  super
35
41
  end
36
42
 
37
43
  ##
38
44
  # Disables this objects within the application' context.
39
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
40
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
41
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
45
+ # @rspec_example
46
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
47
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
48
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
42
49
  # @param [Hash] opts
43
50
  # @option opts [IControl::GlobalLB::Application::ApplicationContextObject] :application_objects The list of application context objects.
44
51
  def disable_application_context_object(opts)
@@ -48,9 +55,10 @@ module IControl::GlobalLB
48
55
 
49
56
  ##
50
57
  # Enables this objects within the application' context.
51
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
58
+ # @rspec_example
59
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
60
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
61
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
54
62
  # @param [Hash] opts
55
63
  # @option opts [IControl::GlobalLB::Application::ApplicationContextObject] :application_objects The list of application context objects.
56
64
  def enable_application_context_object(opts)
@@ -60,10 +68,11 @@ module IControl::GlobalLB
60
68
 
61
69
  ##
62
70
  # Gets the statuses of this application context objects.
71
+ # @rspec_example
63
72
  # @return [ObjectStatus]
64
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
65
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
66
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
73
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
74
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
75
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
67
76
  # @param [Hash] opts
68
77
  # @option opts [IControl::GlobalLB::Application::ApplicationContextObject] :application_objects The list of application context objects.
69
78
  def application_context_status(opts)
@@ -73,56 +82,62 @@ module IControl::GlobalLB
73
82
 
74
83
  ##
75
84
  # Gets the availability dependency for this application.
85
+ # @rspec_example
76
86
  # @return [AvailabilityDependency]
77
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
78
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
79
- # @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.
80
90
  def availability_dependency
81
91
  super
82
92
  end
83
93
 
84
94
  ##
85
95
  # Gets a list of application.
96
+ # @rspec_example
86
97
  # @return [String]
87
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
88
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
89
- # @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.
90
101
  def list
91
102
  super
92
103
  end
93
104
 
94
105
  ##
95
106
  # Gets the statuses of this application.
107
+ # @rspec_example
96
108
  # @return [ObjectStatus]
97
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
99
- # @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.
100
112
  def object_status
101
113
  super
102
114
  end
103
115
 
104
116
  ##
105
117
  # Gets the persistence states for this application.
118
+ # @rspec_example
106
119
  # @return [EnabledState]
107
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
108
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
109
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
120
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
121
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
122
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
110
123
  def persistence_state
111
124
  super
112
125
  end
113
126
 
114
127
  ##
115
128
  # Gets the persistence TTL values of this application.
129
+ # @rspec_example
116
130
  # @return [long]
117
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
118
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
119
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
131
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
132
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
133
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
120
134
  def persistence_ttl
121
135
  super
122
136
  end
123
137
 
124
138
  ##
125
139
  # Gets the version information for this interface.
140
+ # @rspec_example
126
141
  # @return [String]
127
142
  def version
128
143
  super
@@ -130,9 +145,10 @@ module IControl::GlobalLB
130
145
 
131
146
  ##
132
147
  # Sets the availability dependency for this application.
133
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
134
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
135
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @rspec_example
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.
136
152
  # @param [Hash] opts
137
153
  # @option opts [IControl::GlobalLB::AvailabilityDependency] :values The availability dependency for the specified applications.
138
154
  def set_availability_dependency(opts)
@@ -142,9 +158,10 @@ module IControl::GlobalLB
142
158
 
143
159
  ##
144
160
  # Sets the persistence states for this application.
145
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
146
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
147
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
161
+ # @rspec_example
162
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
163
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
164
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
148
165
  # @param [Hash] opts
149
166
  # @option opts [IControl::Common::EnabledState] :states The states to set for the applications.
150
167
  def set_persistence_state(opts)
@@ -154,9 +171,10 @@ module IControl::GlobalLB
154
171
 
155
172
  ##
156
173
  # Sets the persistence TTL values of this application.
157
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
158
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
159
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
174
+ # @rspec_example
175
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
176
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
177
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
160
178
  # @param [Hash] opts
161
179
  # @option opts [long] :values The persistence TTLs of the specified applications.
162
180
  def set_persistence_ttl(opts)
@@ -165,7 +183,8 @@ module IControl::GlobalLB
165
183
  end
166
184
 
167
185
  ##
168
- # A struct that contains definition for the application context object. This is used for enabling/disabling a specified object within the application's context.
186
+ # A struct that contains definition for the application context object. This is used
187
+ # for enabling/disabling a specified object within the application's context.
169
188
  # @attr [String] application_name The name of the application within whose context the object will be enabled/disabled.
170
189
  # @attr [String] object_name The name of the object.
171
190
  # @attr [IControl::GlobalLB::Application::ApplicationObjectType] object_type The type of the object.
@@ -1,6 +1,9 @@
1
1
  module IControl::GlobalLB
2
2
  ##
3
- # The DataCenter interface enables you to manipulate the data center attributes for a Global TM. For example, use the DataCenter interface to add or remove a data center, transfer server assignments from one data center to another, get and set data center attributes, remove a server from a data center, and so on.
3
+ # The DataCenter interface enables you to manipulate the data center attributes for
4
+ # a Global TM. For example, use the DataCenter interface to add or remove a data center,
5
+ # transfer server assignments from one data center to another, get and set data center
6
+ # attributes, remove a server from a data center, and so on.
4
7
  class DataCenter < IControl::Base
5
8
 
6
9
  set_id_name "data_centers"
@@ -9,125 +12,142 @@ module IControl::GlobalLB
9
12
  class DataCenterLinkDefinition < IControl::Base::Struct; end
10
13
  class DataCenterServerDefinition < IControl::Base::Struct; end
11
14
  class DataCenterStatisticEntry < IControl::Base::Struct; end
12
- class DataCenterStatistics < IControl::Base::Struct; end ##
15
+ class DataCenterStatistics < IControl::Base::Struct; end
16
+ class DataCenterAttributeSequence < IControl::Base::Sequence ; end
17
+ class DataCenterLinkSequence < IControl::Base::Sequence ; end
18
+ class DataCenterServerSequence < IControl::Base::Sequence ; end
19
+ class DataCenterStatisticEntrySequence < IControl::Base::Sequence ; end ##
13
20
  # Creates this data center.
14
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
15
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
16
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
21
+ # @rspec_example
22
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
17
25
  def create
18
26
  super
19
27
  end
20
28
 
21
29
  ##
22
30
  # Deletes all data center.
23
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
24
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
25
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
31
+ # @rspec_example
32
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
35
  def delete_all_data_centers
27
36
  super
28
37
  end
29
38
 
30
39
  ##
31
40
  # Deletes this data center.
32
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
33
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
34
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
41
+ # @rspec_example
42
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
43
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
44
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
35
45
  def delete_data_center
36
46
  super
37
47
  end
38
48
 
39
49
  ##
40
50
  # Gets the statistics for all the data center.
51
+ # @rspec_example
41
52
  # @return [DataCenterStatistics]
42
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
43
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
44
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
53
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
54
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
55
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
45
56
  def all_statistics
46
57
  super
47
58
  end
48
59
 
49
60
  ##
50
61
  # Gets contact information for this data center.
62
+ # @rspec_example
51
63
  # @return [String]
52
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
53
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
54
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
64
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
65
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
66
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
55
67
  def contact_information
56
68
  super
57
69
  end
58
70
 
59
71
  ##
60
72
  # Gets the enabled state of this data center.
73
+ # @rspec_example
61
74
  # @return [EnabledState]
62
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
75
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
76
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
77
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
65
78
  def enabled_state
66
79
  super
67
80
  end
68
81
 
69
82
  ##
70
83
  # Gets a list of links of this data center.
84
+ # @rspec_example
71
85
  # @return [DataCenterLinkDefinition]
72
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
86
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
87
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
88
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
75
89
  def link
76
90
  super
77
91
  end
78
92
 
79
93
  ##
80
94
  # Gets a list of data center.
95
+ # @rspec_example
81
96
  # @return [String]
82
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
97
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
98
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
99
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
85
100
  def list
86
101
  super
87
102
  end
88
103
 
89
104
  ##
90
105
  # Gets location information for this data center.
106
+ # @rspec_example
91
107
  # @return [String]
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.
108
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
95
111
  def location_information
96
112
  super
97
113
  end
98
114
 
99
115
  ##
100
116
  # Gets the statuses of this data center.
117
+ # @rspec_example
101
118
  # @return [ObjectStatus]
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.
119
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
120
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
121
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
105
122
  def object_status
106
123
  super
107
124
  end
108
125
 
109
126
  ##
110
127
  # Gets a list of servers of this data center.
128
+ # @rspec_example
111
129
  # @return [DataCenterServerDefinition]
112
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
113
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
114
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
130
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
131
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
132
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
115
133
  def server
116
134
  super
117
135
  end
118
136
 
119
137
  ##
120
138
  # Gets the statistics for this data center.
139
+ # @rspec_example
121
140
  # @return [DataCenterStatistics]
122
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
123
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
124
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
141
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
142
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
143
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
125
144
  def statistics
126
145
  super
127
146
  end
128
147
 
129
148
  ##
130
149
  # Get the version information for this interface.
150
+ # @rspec_example
131
151
  # @return [String]
132
152
  def version
133
153
  super
@@ -135,18 +155,20 @@ module IControl::GlobalLB
135
155
 
136
156
  ##
137
157
  # Resets the statistics for this data center.
138
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
139
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
140
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
158
+ # @rspec_example
159
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
160
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
161
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
141
162
  def reset_statistics
142
163
  super
143
164
  end
144
165
 
145
166
  ##
146
167
  # Sets contact information for this data center.
147
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
148
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
149
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
168
+ # @rspec_example
169
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
170
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
171
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
150
172
  # @param [Hash] opts
151
173
  # @option opts [String] :contacts The contact information.
152
174
  def set_contact_information(opts)
@@ -156,9 +178,10 @@ module IControl::GlobalLB
156
178
 
157
179
  ##
158
180
  # Sets the enabled state of this data center.
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.
181
+ # @rspec_example
182
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
183
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
184
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
162
185
  # @param [Hash] opts
163
186
  # @option opts [IControl::Common::EnabledState] :states The enabled states to set.
164
187
  def set_enabled_state(opts)
@@ -168,9 +191,10 @@ module IControl::GlobalLB
168
191
 
169
192
  ##
170
193
  # Sets location information for this data center.
171
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
172
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
173
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
194
+ # @rspec_example
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.
174
198
  # @param [Hash] opts
175
199
  # @option opts [String] :locations The location information.
176
200
  def set_location_information(opts)
@@ -192,36 +216,36 @@ module IControl::GlobalLB
192
216
  ##
193
217
  # A struct that contains definition for the data center and the associated links.
194
218
  # @attr [String] data_center The name that identifies a data center.
195
- # @attr [String] links The links in the data center.
219
+ # @attr [StringSequence] links The links in the data center.
196
220
  class DataCenterLinkDefinition < IControl::Base::Struct
197
221
  icontrol_attribute :data_center, String
198
- icontrol_attribute :links, String
222
+ icontrol_attribute :links, StringSequence
199
223
  end
200
224
 
201
225
  ##
202
226
  # A struct that contains definition for the data center and the associated servers.
203
227
  # @attr [String] data_center The name that identifies a data center.
204
- # @attr [String] servers The servers in the data center.
228
+ # @attr [StringSequence] servers The servers in the data center.
205
229
  class DataCenterServerDefinition < IControl::Base::Struct
206
230
  icontrol_attribute :data_center, String
207
- icontrol_attribute :servers, String
231
+ icontrol_attribute :servers, StringSequence
208
232
  end
209
233
 
210
234
  ##
211
235
  # A struct that describes statistics for a particular data center.
212
236
  # @attr [String] data_center The name that identifies a data center.
213
- # @attr [IControl::Common::Statistic] statistics The statistics for the data center.
237
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the data center.
214
238
  class DataCenterStatisticEntry < IControl::Base::Struct
215
239
  icontrol_attribute :data_center, String
216
- icontrol_attribute :statistics, IControl::Common::Statistic
240
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
217
241
  end
218
242
 
219
243
  ##
220
244
  # A struct that describes data center statistics and timestamp.
221
- # @attr [IControl::GlobalLB::DataCenter::DataCenterStatisticEntry] statistics The statistics for a sequence of data centers.
245
+ # @attr [IControl::GlobalLB::DataCenter::DataCenterStatisticEntrySequence] statistics The statistics for a sequence of data centers.
222
246
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
223
247
  class DataCenterStatistics < IControl::Base::Struct
224
- icontrol_attribute :statistics, IControl::GlobalLB::DataCenter::DataCenterStatisticEntry
248
+ icontrol_attribute :statistics, IControl::GlobalLB::DataCenter::DataCenterStatisticEntrySequence
225
249
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
226
250
  end
227
251