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,16 +1,20 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The SNATPool interface enables you to work with the definitions contained in a local load balancer's SNAT pool, which is a set of translation addresses. Either a virtual server, an iRule or a top-level SNAT object can reference a SNAT pool.
3
+ # The SNATPool interface enables you to work with the definitions contained in a local
4
+ # load balancer's SNAT pool, which is a set of translation addresses. Either a virtual
5
+ # server, an iRule or a top-level SNAT object can reference a SNAT pool.
4
6
  class SNATPool < IControl::Base
5
7
 
6
8
  set_id_name "snat_pools"
7
9
 
8
10
  class SNATPoolStatisticEntry < IControl::Base::Struct; end
9
- class SNATPoolStatistics < IControl::Base::Struct; end ##
11
+ class SNATPoolStatistics < IControl::Base::Struct; end
12
+ class SNATPoolStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
13
  # Adds members to this SNAT pools.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
14
+ # @rspec_example
15
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
18
  # @param [Hash] opts
15
19
  # @option opts [String[]] :members The members to add to the specified SNAT pools.
16
20
  def add_member(opts)
@@ -20,9 +24,10 @@ module IControl::LocalLB
20
24
 
21
25
  ##
22
26
  # Creates this SNAT pools.
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.
27
+ # @rspec_example
28
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
31
  # @param [Hash] opts
27
32
  # @option opts [String[]] :translation_addresses The translation addresses associated with the SNAT pools. If the referenced SNAT translation addresses do not exist, they are created automatically using the global SNAT defaults.
28
33
  def create(opts)
@@ -32,64 +37,71 @@ module IControl::LocalLB
32
37
 
33
38
  ##
34
39
  # Deletes all SNAT pools.
35
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
36
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
37
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
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.
38
44
  def delete_all_snat_pools
39
45
  super
40
46
  end
41
47
 
42
48
  ##
43
49
  # Deletes a specified list of SNAT pools.
44
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
45
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
46
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
50
+ # @rspec_example
51
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
52
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
53
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
47
54
  def delete_snat_pool
48
55
  super
49
56
  end
50
57
 
51
58
  ##
52
59
  # Gets the statistics for all SNAT pools.
60
+ # @rspec_example
53
61
  # @return [SNATPoolStatistics]
54
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
55
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
56
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
62
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
63
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
64
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
57
65
  def all_statistics
58
66
  super
59
67
  end
60
68
 
61
69
  ##
62
70
  # Gets a list of all SNAT pools.
71
+ # @rspec_example
63
72
  # @return [String]
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
  def list
68
77
  super
69
78
  end
70
79
 
71
80
  ##
72
81
  # Gets the list of members belonging to this SNAT pools.
82
+ # @rspec_example
73
83
  # @return [String[]]
74
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
75
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
76
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
84
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
85
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
86
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
77
87
  def member
78
88
  super
79
89
  end
80
90
 
81
91
  ##
82
92
  # Gets the statistics for a list of SNAT pools.
93
+ # @rspec_example
83
94
  # @return [SNATPoolStatistics]
84
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
85
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
86
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
95
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
96
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
97
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
87
98
  def statistics
88
99
  super
89
100
  end
90
101
 
91
102
  ##
92
103
  # Get the version information for this interface.
104
+ # @rspec_example
93
105
  # @return [String]
94
106
  def version
95
107
  super
@@ -97,18 +109,20 @@ module IControl::LocalLB
97
109
 
98
110
  ##
99
111
  # Removes all members from this SNAT pools.
100
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
101
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
102
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
112
+ # @rspec_example
113
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
114
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
115
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
103
116
  def remove_all_members
104
117
  super
105
118
  end
106
119
 
107
120
  ##
108
121
  # Removes members from this SNAT pools.
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.
122
+ # @rspec_example
123
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
124
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
125
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
112
126
  # @param [Hash] opts
113
127
  # @option opts [String[]] :members The members to remove from the specified SNAT pools.
114
128
  def remove_member(opts)
@@ -118,9 +132,10 @@ module IControl::LocalLB
118
132
 
119
133
  ##
120
134
  # Resets the statistics for a list of SNAT pools.
121
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
122
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
123
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
135
+ # @rspec_example
136
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
137
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
138
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
124
139
  def reset_statistics
125
140
  super
126
141
  end
@@ -128,18 +143,18 @@ module IControl::LocalLB
128
143
  ##
129
144
  # A struct that describes statistics for a specified SNAT pool.
130
145
  # @attr [String] snat_pool The SNAT pool name.
131
- # @attr [IControl::Common::Statistic] statistics The SNAT pool statistics.
146
+ # @attr [IControl::Common::StatisticSequence] statistics The SNAT pool statistics.
132
147
  class SNATPoolStatisticEntry < IControl::Base::Struct
133
148
  icontrol_attribute :snat_pool, String
134
- icontrol_attribute :statistics, IControl::Common::Statistic
149
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
135
150
  end
136
151
 
137
152
  ##
138
153
  # A struct that describes SNAT pool statistics and timestamp.
139
- # @attr [IControl::LocalLB::SNATPool::SNATPoolStatisticEntry] statistics The statistics for a sequence of SNAT pools.
154
+ # @attr [IControl::LocalLB::SNATPool::SNATPoolStatisticEntrySequence] statistics The statistics for a sequence of SNAT pools.
140
155
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
141
156
  class SNATPoolStatistics < IControl::Base::Struct
142
- icontrol_attribute :statistics, IControl::LocalLB::SNATPool::SNATPoolStatisticEntry
157
+ icontrol_attribute :statistics, IControl::LocalLB::SNATPool::SNATPoolStatisticEntrySequence
143
158
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
144
159
  end
145
160
 
@@ -1,27 +1,32 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The SNATPoolMember interface enables you to work with the SNATPool members and their settings, and statistics.
3
+ # The SNATPoolMember interface enables you to work with the SNATPool members and their
4
+ # settings, and statistics.
4
5
  class SNATPoolMember < IControl::Base
5
6
 
6
7
  set_id_name "snat_pools"
7
8
 
8
9
  class SNATPoolMemberStatisticEntry < IControl::Base::Struct; end
9
- class SNATPoolMemberStatistics < IControl::Base::Struct; end ##
10
+ class SNATPoolMemberStatistics < IControl::Base::Struct; end
11
+ class SNATPoolMemberStatisticEntrySequence < IControl::Base::Sequence ; end
12
+ class SNATPoolMemberStatisticsSequence < IControl::Base::Sequence ; end ##
10
13
  # Gets the statistics for all SNATPool members in this SNAT pools.
14
+ # @rspec_example
11
15
  # @return [SNATPoolMemberStatistics]
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
+ # @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 all_statistics
16
20
  super
17
21
  end
18
22
 
19
23
  ##
20
24
  # Gets the statistics for a list of SNATPool members in this SNAT pools.
25
+ # @rspec_example
21
26
  # @return [SNATPoolMemberStatistics]
22
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
23
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
24
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
27
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
28
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
29
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
25
30
  # @param [Hash] opts
26
31
  # @option opts [String[]] :members The SNATPool member addresses.
27
32
  def statistics(opts)
@@ -31,6 +36,7 @@ module IControl::LocalLB
31
36
 
32
37
  ##
33
38
  # Gets the version information for this interface.
39
+ # @rspec_example
34
40
  # @return [String]
35
41
  def version
36
42
  super
@@ -38,9 +44,10 @@ module IControl::LocalLB
38
44
 
39
45
  ##
40
46
  # Resets the statistics for a list of SNATPool members in this SNAT pools.
41
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
42
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
43
- # @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.
44
51
  # @param [Hash] opts
45
52
  # @option opts [String[]] :members The SNATPool member addresses.
46
53
  def reset_statistics(opts)
@@ -51,18 +58,18 @@ module IControl::LocalLB
51
58
  ##
52
59
  # A struct that describes statistics for a particular SNATPool member.
53
60
  # @attr [String] member The SNATPool member definition.
54
- # @attr [IControl::Common::Statistic] statistics The statistics for the SNATPool member.
61
+ # @attr [IControl::Common::StatisticSequence] statistics The statistics for the SNATPool member.
55
62
  class SNATPoolMemberStatisticEntry < IControl::Base::Struct
56
63
  icontrol_attribute :member, String
57
- icontrol_attribute :statistics, IControl::Common::Statistic
64
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
58
65
  end
59
66
 
60
67
  ##
61
68
  # A struct that describes SNATPool member statistics and timestamp.
62
- # @attr [IControl::LocalLB::SNATPoolMember::SNATPoolMemberStatisticEntry] statistics The statistics for a sequence of SNATPool members.
69
+ # @attr [IControl::LocalLB::SNATPoolMember::SNATPoolMemberStatisticEntrySequence] statistics The statistics for a sequence of SNATPool members.
63
70
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
64
71
  class SNATPoolMemberStatistics < IControl::Base::Struct
65
- icontrol_attribute :statistics, IControl::LocalLB::SNATPoolMember::SNATPoolMemberStatisticEntry
72
+ icontrol_attribute :statistics, IControl::LocalLB::SNATPoolMember::SNATPoolMemberStatisticEntrySequence
66
73
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
67
74
  end
68
75
 
@@ -1,16 +1,20 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The SNATTranslationAddress interface enables you to work with the definitions contained in a local load balancer's SNAT translation address. A translation address defines an address to which a client address may be translated on the server side.
3
+ # The SNATTranslationAddress interface enables you to work with the definitions contained
4
+ # in a local load balancer's SNAT translation address. A translation address defines
5
+ # an address to which a client address may be translated on the server side.
4
6
  class SNATTranslationAddress < IControl::Base
5
7
 
6
8
  set_id_name "translation_addresses"
7
9
 
8
10
  class SNATTranslationAddressStatisticEntry < IControl::Base::Struct; end
9
- class SNATTranslationAddressStatistics < IControl::Base::Struct; end ##
11
+ class SNATTranslationAddressStatistics < IControl::Base::Struct; end
12
+ class SNATTranslationAddressStatisticEntrySequence < IControl::Base::Sequence ; end ##
10
13
  # Creates this SNAT translation addresse.
11
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
12
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
13
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
14
+ # @rspec_example
15
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
16
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
17
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
14
18
  # @param [Hash] opts
15
19
  # @option opts [long] :unit_ids The unit IDs associated with the translation addresses. If the unit ID of a translation address is not active on a BIG-IP, the BIG-IP does not respond to ARP requests or send gratuitous ARPs for that translation address.
16
20
  def create(opts)
@@ -20,124 +24,137 @@ module IControl::LocalLB
20
24
 
21
25
  ##
22
26
  # Deletes all SNAT translation addresse.
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.
27
+ # @rspec_example
28
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
29
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
30
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
26
31
  def delete_all_translation_addresses
27
32
  super
28
33
  end
29
34
 
30
35
  ##
31
36
  # Deletes a specified list of SNAT translation addresse.
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.
37
+ # @rspec_example
38
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
39
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
40
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
35
41
  def delete_translation_address
36
42
  super
37
43
  end
38
44
 
39
45
  ##
40
46
  # Gets the statistics for all SNAT translation addresse..
47
+ # @rspec_example
41
48
  # @return [SNATTranslationAddressStatistics]
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.
49
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
50
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
51
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
45
52
  def all_statistics
46
53
  super
47
54
  end
48
55
 
49
56
  ##
50
57
  # Gets the ARP states for this translation SNAT addresses.
58
+ # @rspec_example
51
59
  # @return [EnabledState]
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.
60
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
61
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
62
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
55
63
  def arp_state
56
64
  super
57
65
  end
58
66
 
59
67
  ##
60
68
  # Gets the connection limits of this original SNAT translation addresse.
69
+ # @rspec_example
61
70
  # @return [ULong64]
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.
71
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
72
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
73
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
65
74
  def connection_limit
66
75
  super
67
76
  end
68
77
 
69
78
  ##
70
79
  # Gets the states of this SNAT translation addresse.
80
+ # @rspec_example
71
81
  # @return [EnabledState]
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.
82
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
83
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
84
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
75
85
  def enabled_state
76
86
  super
77
87
  end
78
88
 
79
89
  ##
80
90
  # Gets the IP idle timeouts of this SNAT translation addresse.
91
+ # @rspec_example
81
92
  # @return [long]
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.
93
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
94
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
95
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
85
96
  def ip_timeout
86
97
  super
87
98
  end
88
99
 
89
100
  ##
90
101
  # Gets a list of all SNAT translation addresse.
102
+ # @rspec_example
91
103
  # @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.
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.
95
107
  def list
96
108
  super
97
109
  end
98
110
 
99
111
  ##
100
112
  # Gets the statistics for a list of SNAT translation addresse.
113
+ # @rspec_example
101
114
  # @return [SNATTranslationAddressStatistics]
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.
115
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
116
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
117
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
105
118
  def statistics
106
119
  super
107
120
  end
108
121
 
109
122
  ##
110
123
  # Gets the TCP idle timeouts of this SNAT translation addresse.
124
+ # @rspec_example
111
125
  # @return [long]
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.
126
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
127
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
128
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
115
129
  def tcp_timeout
116
130
  super
117
131
  end
118
132
 
119
133
  ##
120
134
  # Gets the UDP idle timeouts of this SNAT translation addresse.
135
+ # @rspec_example
121
136
  # @return [long]
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.
137
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
138
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
139
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
125
140
  def udp_timeout
126
141
  super
127
142
  end
128
143
 
129
144
  ##
130
145
  # Gets the unit IDs for a specified SNAT translation addresse.
146
+ # @rspec_example
131
147
  # @return [long]
132
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
133
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
134
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
148
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
135
151
  def unit_id
136
152
  super
137
153
  end
138
154
 
139
155
  ##
140
156
  # Get the version information for this interface.
157
+ # @rspec_example
141
158
  # @return [String]
142
159
  def version
143
160
  super
@@ -145,18 +162,20 @@ module IControl::LocalLB
145
162
 
146
163
  ##
147
164
  # Resets the statistics for a list of SNAT translation addresse.
148
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
149
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
150
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
165
+ # @rspec_example
166
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
167
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
168
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
151
169
  def reset_statistics
152
170
  super
153
171
  end
154
172
 
155
173
  ##
156
174
  # Sets the ARP states for this tranlation SNAT addresses.
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.
175
+ # @rspec_example
176
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
177
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
178
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
160
179
  # @param [Hash] opts
161
180
  # @option opts [IControl::Common::EnabledState] :states The ARP states to set.
162
181
  def set_arp_state(opts)
@@ -166,9 +185,10 @@ module IControl::LocalLB
166
185
 
167
186
  ##
168
187
  # Sets the connection limits of this original SNAT translation addresse.
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.
188
+ # @rspec_example
189
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
190
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
191
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
172
192
  # @param [Hash] opts
173
193
  # @option opts [IControl::Common::ULong64] :limits The connection limits to set.
174
194
  def set_connection_limit(opts)
@@ -178,9 +198,10 @@ module IControl::LocalLB
178
198
 
179
199
  ##
180
200
  # Sets the state for a list of SNAT translation addresse.
181
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
182
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
183
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
201
+ # @rspec_example
202
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
203
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
204
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
184
205
  # @param [Hash] opts
185
206
  # @option opts [IControl::Common::EnabledState] :states Enable or disable the specified SNAT translation addresses.
186
207
  def set_enabled_state(opts)
@@ -190,9 +211,10 @@ module IControl::LocalLB
190
211
 
191
212
  ##
192
213
  # Sets the IP idle timeouts of this SNAT translation addresse.
193
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
194
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
195
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
214
+ # @rspec_example
215
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
216
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
217
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
196
218
  # @param [Hash] opts
197
219
  # @option opts [long] :timeouts The IP timeouts to set.
198
220
  def set_ip_timeout(opts)
@@ -202,9 +224,10 @@ module IControl::LocalLB
202
224
 
203
225
  ##
204
226
  # Sets the TCP idle timeouts of this SNAT translation addresse.
205
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
206
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
207
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
227
+ # @rspec_example
228
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
229
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
230
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
208
231
  # @param [Hash] opts
209
232
  # @option opts [long] :timeouts The TCP timeouts to set.
210
233
  def set_tcp_timeout(opts)
@@ -214,9 +237,10 @@ module IControl::LocalLB
214
237
 
215
238
  ##
216
239
  # Sets the UDP idle timeouts of this SNAT translation addresse.
217
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
218
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
219
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
240
+ # @rspec_example
241
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
242
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
243
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
220
244
  # @param [Hash] opts
221
245
  # @option opts [long] :timeouts The UDP timeouts to set.
222
246
  def set_udp_timeout(opts)
@@ -226,9 +250,10 @@ module IControl::LocalLB
226
250
 
227
251
  ##
228
252
  # Sets the unit IDs for this tranlation SNAT addresses.
229
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
230
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
231
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
253
+ # @rspec_example
254
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
255
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
256
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
232
257
  # @param [Hash] opts
233
258
  # @option opts [long] :unit_ids The unit IDs to set.
234
259
  def set_unit_id(opts)
@@ -239,18 +264,18 @@ module IControl::LocalLB
239
264
  ##
240
265
  # A struct that describes statistics for a specified SNAT translation address.
241
266
  # @attr [String] translation_address The translation address.
242
- # @attr [IControl::Common::Statistic] statistics The SNAT translation address statistics.
267
+ # @attr [IControl::Common::StatisticSequence] statistics The SNAT translation address statistics.
243
268
  class SNATTranslationAddressStatisticEntry < IControl::Base::Struct
244
269
  icontrol_attribute :translation_address, String
245
- icontrol_attribute :statistics, IControl::Common::Statistic
270
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
246
271
  end
247
272
 
248
273
  ##
249
274
  # A struct that describes SNAT translation address statistics and timestamp.
250
- # @attr [IControl::LocalLB::SNATTranslationAddress::SNATTranslationAddressStatisticEntry] statistics The statistics for a sequence of SNAT translation addresses.
275
+ # @attr [IControl::LocalLB::SNATTranslationAddress::SNATTranslationAddressStatisticEntrySequence] statistics The statistics for a sequence of SNAT translation addresses.
251
276
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
252
277
  class SNATTranslationAddressStatistics < IControl::Base::Struct
253
- icontrol_attribute :statistics, IControl::LocalLB::SNATTranslationAddress::SNATTranslationAddressStatisticEntry
278
+ icontrol_attribute :statistics, IControl::LocalLB::SNATTranslationAddress::SNATTranslationAddressStatisticEntrySequence
254
279
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
255
280
  end
256
281