icontrol 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. data/lib/icontrol/arx.rb +38 -8
  2. data/lib/icontrol/arx/api.rb +1 -0
  3. data/lib/icontrol/arx/chassis.rb +11 -0
  4. data/lib/icontrol/arx/export.rb +4 -1
  5. data/lib/icontrol/arx/file_change_notification.rb +25 -4
  6. data/lib/icontrol/arx/file_server.rb +2 -0
  7. data/lib/icontrol/arx/namespace.rb +2 -0
  8. data/lib/icontrol/arx/network.rb +3 -0
  9. data/lib/icontrol/arx/policy.rb +3 -0
  10. data/lib/icontrol/arx/share.rb +2 -0
  11. data/lib/icontrol/arx/virtual_service.rb +3 -0
  12. data/lib/icontrol/arx/volume.rb +2 -0
  13. data/lib/icontrol/asm.rb +18 -3
  14. data/lib/icontrol/asm/object_params.rb +12 -6
  15. data/lib/icontrol/asm/policy.rb +118 -79
  16. data/lib/icontrol/asm/system_configuration.rb +27 -19
  17. data/lib/icontrol/asm/web_application.rb +74 -52
  18. data/lib/icontrol/asm/web_application_group.rb +33 -24
  19. data/lib/icontrol/base.rb +1 -0
  20. data/lib/icontrol/base/exception.rb +1 -0
  21. data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
  22. data/lib/icontrol/base/icontrol_overlay.rb +6 -0
  23. data/lib/icontrol/base/predeclarations.rb +5 -4
  24. data/lib/icontrol/base/struct.rb +6 -2
  25. data/lib/icontrol/common.rb +55 -4
  26. data/lib/icontrol/global_lb.rb +22 -3
  27. data/lib/icontrol/global_lb/application.rb +63 -44
  28. data/lib/icontrol/global_lb/data_center.rb +82 -58
  29. data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
  30. data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
  31. data/lib/icontrol/global_lb/globals.rb +662 -430
  32. data/lib/icontrol/global_lb/link.rb +181 -131
  33. data/lib/icontrol/global_lb/monitor.rb +174 -104
  34. data/lib/icontrol/global_lb/pool.rb +290 -203
  35. data/lib/icontrol/global_lb/pool_member.rb +118 -71
  36. data/lib/icontrol/global_lb/region.rb +37 -25
  37. data/lib/icontrol/global_lb/rule.rb +53 -37
  38. data/lib/icontrol/global_lb/server.rb +176 -124
  39. data/lib/icontrol/global_lb/topology.rb +41 -27
  40. data/lib/icontrol/global_lb/virtual_server.rb +118 -84
  41. data/lib/icontrol/global_lb/wide_ip.rb +168 -117
  42. data/lib/icontrol/local_lb.rb +81 -10
  43. data/lib/icontrol/local_lb/klass.rb +233 -153
  44. data/lib/icontrol/local_lb/monitor.rb +158 -96
  45. data/lib/icontrol/local_lb/nat.rb +74 -52
  46. data/lib/icontrol/local_lb/node_address.rb +123 -86
  47. data/lib/icontrol/local_lb/pool.rb +229 -164
  48. data/lib/icontrol/local_lb/pool_member.rb +134 -76
  49. data/lib/icontrol/local_lb/profile_auth.rb +103 -75
  50. data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
  51. data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
  52. data/lib/icontrol/local_lb/profile_dns.rb +65 -46
  53. data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
  54. data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
  55. data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
  56. data/lib/icontrol/local_lb/profile_http.rb +701 -433
  57. data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
  58. data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
  59. data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
  60. data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
  61. data/lib/icontrol/local_lb/profile_radius.rb +94 -62
  62. data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
  63. data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
  64. data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
  65. data/lib/icontrol/local_lb/profile_sip.rb +145 -99
  66. data/lib/icontrol/local_lb/profile_stream.rb +71 -51
  67. data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
  68. data/lib/icontrol/local_lb/profile_udp.rb +109 -78
  69. data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
  70. data/lib/icontrol/local_lb/profile_xml.rb +116 -79
  71. data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
  72. data/lib/icontrol/local_lb/rate_class.rb +523 -318
  73. data/lib/icontrol/local_lb/rule.rb +53 -37
  74. data/lib/icontrol/local_lb/snat.rb +96 -65
  75. data/lib/icontrol/local_lb/snat_pool.rb +54 -39
  76. data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
  77. data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
  78. data/lib/icontrol/local_lb/virtual_address.rb +99 -70
  79. data/lib/icontrol/local_lb/virtual_server.rb +358 -243
  80. data/lib/icontrol/lt_config.rb +8 -1
  81. data/lib/icontrol/lt_config/field.rb +87 -53
  82. data/lib/icontrol/lt_config/klass.rb +59 -43
  83. data/lib/icontrol/management.rb +80 -38
  84. data/lib/icontrol/management/ccldap_configuration.rb +218 -144
  85. data/lib/icontrol/management/change_control.rb +67 -41
  86. data/lib/icontrol/management/crldp_configuration.rb +73 -52
  87. data/lib/icontrol/management/crldp_server.rb +55 -39
  88. data/lib/icontrol/management/db_variable.rb +32 -21
  89. data/lib/icontrol/management/event_notification.rb +19 -8
  90. data/lib/icontrol/management/event_subscription.rb +121 -74
  91. data/lib/icontrol/management/key_certificate.rb +235 -138
  92. data/lib/icontrol/management/ldap_configuration.rb +249 -179
  93. data/lib/icontrol/management/license_administration.rb +97 -56
  94. data/lib/icontrol/management/named.rb +103 -67
  95. data/lib/icontrol/management/ocsp_configuration.rb +33 -24
  96. data/lib/icontrol/management/ocsp_responder.rb +294 -165
  97. data/lib/icontrol/management/partition.rb +42 -23
  98. data/lib/icontrol/management/provision.rb +73 -39
  99. data/lib/icontrol/management/radius_configuration.rb +85 -57
  100. data/lib/icontrol/management/radius_server.rb +51 -37
  101. data/lib/icontrol/management/resource_record.rb +163 -121
  102. data/lib/icontrol/management/snmp_configuration.rb +675 -390
  103. data/lib/icontrol/management/tacacs_configuration.rb +99 -67
  104. data/lib/icontrol/management/tmos_module.rb +20 -8
  105. data/lib/icontrol/management/user_management.rb +198 -124
  106. data/lib/icontrol/management/view.rb +33 -24
  107. data/lib/icontrol/management/zone.rb +49 -34
  108. data/lib/icontrol/management/zone_runner.rb +11 -7
  109. data/lib/icontrol/networking.rb +31 -4
  110. data/lib/icontrol/networking/admin_ip.rb +92 -71
  111. data/lib/icontrol/networking/arp.rb +41 -28
  112. data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
  113. data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
  114. data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
  115. data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
  116. data/lib/icontrol/networking/interfaces.rb +241 -142
  117. data/lib/icontrol/networking/packet_filter.rb +111 -69
  118. data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
  119. data/lib/icontrol/networking/port_mirror.rb +39 -27
  120. data/lib/icontrol/networking/profile_gre.rb +63 -41
  121. data/lib/icontrol/networking/profile_ipip.rb +38 -25
  122. data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
  123. data/lib/icontrol/networking/route_domain.rb +70 -44
  124. data/lib/icontrol/networking/route_table.rb +128 -91
  125. data/lib/icontrol/networking/self_ip.rb +57 -39
  126. data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
  127. data/lib/icontrol/networking/stp_globals.rb +115 -63
  128. data/lib/icontrol/networking/stp_instance.rb +166 -68
  129. data/lib/icontrol/networking/trunk.rb +165 -101
  130. data/lib/icontrol/networking/tunnel.rb +77 -52
  131. data/lib/icontrol/networking/vlan.rb +140 -98
  132. data/lib/icontrol/networking/vlan_group.rb +145 -101
  133. data/lib/icontrol/system.rb +70 -33
  134. data/lib/icontrol/system/cluster.rb +103 -81
  135. data/lib/icontrol/system/config_sync.rb +128 -72
  136. data/lib/icontrol/system/connections.rb +27 -17
  137. data/lib/icontrol/system/disk.rb +134 -67
  138. data/lib/icontrol/system/failover.rb +44 -27
  139. data/lib/icontrol/system/geo_ip.rb +16 -5
  140. data/lib/icontrol/system/inet.rb +47 -30
  141. data/lib/icontrol/system/internal.rb +13 -9
  142. data/lib/icontrol/system/services.rb +75 -42
  143. data/lib/icontrol/system/software_management.rb +132 -83
  144. data/lib/icontrol/system/statistics.rb +443 -298
  145. data/lib/icontrol/system/system_info.rb +137 -95
  146. data/lib/icontrol/web_accelerator/applications.rb +17 -10
  147. data/lib/icontrol/web_accelerator/policies.rb +13 -9
  148. data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
  149. data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
  150. data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
  151. metadata +10 -4
@@ -1,17 +1,22 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The Rule interface enables you to manipulate a local 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 local load balancer's rules. For example,
4
+ # use the Rule interface to get a list of all rules, create rules, delete rules, modify
5
+ # 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::LocalLB::Rule::RuleDefinition] :rules The rules to create.
17
22
  def create(opts)
@@ -21,54 +26,61 @@ module IControl::LocalLB
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::LocalLB
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::LocalLB::Rule::RuleDefinition] :rules The rules to modify.
84
97
  def modify_rule(opts)
@@ -88,29 +101,32 @@ module IControl::LocalLB
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::LocalLB
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::LocalLB::Rule::RuleStatisticEntry] statistics The statistics for a sequence of pools.
158
+ # @attr [IControl::LocalLB::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::LocalLB::Rule::RuleStatisticEntry
161
+ icontrol_attribute :statistics, IControl::LocalLB::Rule::RuleStatisticEntrySequence
146
162
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
147
163
  end
148
164
 
@@ -1,6 +1,10 @@
1
1
  module IControl::LocalLB
2
2
  ##
3
- # The SNAT interface enables you to work with the definitions contained in a local load balancer's top-level secure network address translations (SNAT) object. The top-level SNAT configuration object is a named object in the definition of a standard or a selective SNAT. Standard SNATs translate to a single address, while selective SNATs translate to a pool of translation addresses, i.e. SNAT pool.
3
+ # The SNAT interface enables you to work with the definitions contained in a local
4
+ # load balancer's top-level secure network address translations (SNAT) object. The
5
+ # top-level SNAT configuration object is a named object in the definition of a standard
6
+ # or a selective SNAT. Standard SNATs translate to a single address, while selective
7
+ # SNATs translate to a pool of translation addresses, i.e. SNAT pool.
4
8
  class SNAT < IControl::Base
5
9
 
6
10
  set_id_name "snats"
@@ -9,11 +13,17 @@ module IControl::LocalLB
9
13
  class SNATOriginalAddress < IControl::Base::Struct; end
10
14
  class SNATStatisticEntry < IControl::Base::Struct; end
11
15
  class SNATStatistics < IControl::Base::Struct; end
12
- class Translation < IControl::Base::Struct; end ##
16
+ class Translation < IControl::Base::Struct; end
17
+ class SNATDefinitionSequence < IControl::Base::Sequence ; end
18
+ class SNATOriginalAddressSequence < IControl::Base::Sequence ; end
19
+ class SNATOriginalAddressSequenceSequence < IControl::Base::SequenceSequence ; end
20
+ class SNATStatisticEntrySequence < IControl::Base::Sequence ; end
21
+ class TranslationSequence < IControl::Base::Sequence ; end ##
13
22
  # Adds original client addresses to the filters used to match incoming traffic.
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.
23
+ # @rspec_example
24
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
25
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
26
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
17
27
  # @param [Hash] opts
18
28
  # @option opts [IControl::LocalLB::SNAT::SNATOriginalAddress[]] :addresses The list of original addresses to add to the filters.
19
29
  def add_original_address(opts)
@@ -23,9 +33,10 @@ module IControl::LocalLB
23
33
 
24
34
  ##
25
35
  # Creates this top-level SNAT objects.
26
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
27
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
28
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
36
+ # @rspec_example
37
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
38
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
39
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
29
40
  # @param [Hash] opts
30
41
  # @option opts [IControl::LocalLB::SNAT::SNATOriginalAddress[]] :original_addresses The list of original client addresses used to filter traffic to the SNATs .
31
42
  # @option opts [IControl::Common::VLANFilterList] :vlans The list of VLANs used to filter the client connections on ingress VLAN.
@@ -36,94 +47,105 @@ module IControl::LocalLB
36
47
 
37
48
  ##
38
49
  # Deletes all SNATs.
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.
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.
42
54
  def delete_all_snats
43
55
  super
44
56
  end
45
57
 
46
58
  ##
47
59
  # Deletes a specified list of SNATs.
48
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
49
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
50
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
60
+ # @rspec_example
61
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
62
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
63
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
51
64
  def delete_snat
52
65
  super
53
66
  end
54
67
 
55
68
  ##
56
69
  # Gets the statistics for all top-level SNATs.
70
+ # @rspec_example
57
71
  # @return [SNATStatistics]
58
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
59
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
60
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
72
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
73
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
74
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
61
75
  def all_statistics
62
76
  super
63
77
  end
64
78
 
65
79
  ##
66
80
  # Gets the connection mirror states for a specified SNATs.
81
+ # @rspec_example
67
82
  # @return [EnabledState]
68
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
69
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
70
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
83
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
84
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
85
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
71
86
  def connection_mirror_state
72
87
  super
73
88
  end
74
89
 
75
90
  ##
76
91
  # Gets a list of all top-level SNAT configuration objects.
92
+ # @rspec_example
77
93
  # @return [String]
78
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
79
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
80
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
94
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
95
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
96
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
81
97
  def list
82
98
  super
83
99
  end
84
100
 
85
101
  ##
86
102
  # Gets the list of original client addresses used to filter the traffic to the SNATs.
103
+ # @rspec_example
87
104
  # @return [SNATOriginalAddress[]]
88
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
89
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
90
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
105
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
106
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
107
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
91
108
  def original_address
92
109
  super
93
110
  end
94
111
 
95
112
  ##
96
113
  # Gets the source port behavior for this SNATs.
114
+ # @rspec_example
97
115
  # @return [SourcePortBehavior]
98
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
99
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
100
- # @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.
101
119
  def source_port_behavior
102
120
  super
103
121
  end
104
122
 
105
123
  ##
106
124
  # Gets the statistics for a list of top-level SNATs.
125
+ # @rspec_example
107
126
  # @return [SNATStatistics]
108
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
109
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
110
- # @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.
111
130
  def statistics
112
131
  super
113
132
  end
114
133
 
115
134
  ##
116
- # Gets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty.
135
+ # Gets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP,
136
+ # then the translation object should be empty.
137
+ # @rspec_example
117
138
  # @return [Translation]
118
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
119
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
120
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
139
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
140
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
141
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
121
142
  def translation_target
122
143
  super
123
144
  end
124
145
 
125
146
  ##
126
147
  # Get the version information for this interface.
148
+ # @rspec_example
127
149
  # @return [String]
128
150
  def version
129
151
  super
@@ -131,28 +153,31 @@ module IControl::LocalLB
131
153
 
132
154
  ##
133
155
  # Gets the list of VLANs on which access to this SNATs is disabled/enabled.
156
+ # @rspec_example
134
157
  # @return [VLANFilterList]
135
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
136
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
137
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
158
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
159
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
160
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
138
161
  def vlan
139
162
  super
140
163
  end
141
164
 
142
165
  ##
143
166
  # Removes all original client addresses in the filters.
144
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
145
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
146
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
167
+ # @rspec_example
168
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
169
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
170
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
147
171
  def remove_all_original_addresses
148
172
  super
149
173
  end
150
174
 
151
175
  ##
152
176
  # Removes original client addresses from the filters used to match incoming traffic.
153
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
154
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
155
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
177
+ # @rspec_example
178
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
179
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
180
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
156
181
  # @param [Hash] opts
157
182
  # @option opts [IControl::LocalLB::SNAT::SNATOriginalAddress[]] :addresses The list of original addresses to remove from the filters.
158
183
  def remove_original_address(opts)
@@ -162,18 +187,20 @@ module IControl::LocalLB
162
187
 
163
188
  ##
164
189
  # Resets the statistics for a list of top-level SNATs.
165
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
166
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
167
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
190
+ # @rspec_example
191
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
192
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
193
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
168
194
  def reset_statistics
169
195
  super
170
196
  end
171
197
 
172
198
  ##
173
199
  # Sets the connection mirror state for this SNATs.
174
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
175
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
176
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
200
+ # @rspec_example
201
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
202
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
203
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
177
204
  # @param [Hash] opts
178
205
  # @option opts [IControl::Common::EnabledState] :states The connection mirror states to set.
179
206
  def set_connection_mirror_state(opts)
@@ -183,9 +210,10 @@ module IControl::LocalLB
183
210
 
184
211
  ##
185
212
  # Sets the source port behavior for this SNATs.
186
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
187
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
188
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
213
+ # @rspec_example
214
+ # @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
215
+ # @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
216
+ # @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
189
217
  # @param [Hash] opts
190
218
  # @option opts [IControl::Common::SourcePortBehavior] :source_port_behaviors The source port behaviors to set.
191
219
  def set_source_port_behavior(opts)
@@ -194,10 +222,12 @@ module IControl::LocalLB
194
222
  end
195
223
 
196
224
  ##
197
- # Sets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty.
198
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
199
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
200
- # @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
225
+ # Sets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP,
226
+ # then the translation object should be empty.
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.
201
231
  # @param [Hash] opts
202
232
  # @option opts [IControl::LocalLB::SNAT::Translation] :targets The translation targets to set.
203
233
  def set_translation_target(opts)
@@ -207,9 +237,10 @@ module IControl::LocalLB
207
237
 
208
238
  ##
209
239
  # Sets the VLANSs on which access to this SNATs is disabled/enabled.
210
- # @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
211
- # @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
212
- # @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.
213
244
  # @param [Hash] opts
214
245
  # @option opts [IControl::Common::VLANFilterList] :vlans The list of VLANs used to filter the ingress VLAN.
215
246
  def set_vlan(opts)
@@ -238,18 +269,18 @@ module IControl::LocalLB
238
269
  ##
239
270
  # A struct that describes statistics for a specified top-level SNAT object.
240
271
  # @attr [IControl::LocalLB::SNAT::SNATDefinition] snat The SNAT name.
241
- # @attr [IControl::Common::Statistic] statistics The SNAT statistics.
272
+ # @attr [IControl::Common::StatisticSequence] statistics The SNAT statistics.
242
273
  class SNATStatisticEntry < IControl::Base::Struct
243
274
  icontrol_attribute :snat, IControl::LocalLB::SNAT::SNATDefinition
244
- icontrol_attribute :statistics, IControl::Common::Statistic
275
+ icontrol_attribute :statistics, IControl::Common::StatisticSequence
245
276
  end
246
277
 
247
278
  ##
248
279
  # A struct that describes SNAT pool statistics and timestamp.
249
- # @attr [IControl::LocalLB::SNAT::SNATStatisticEntry] statistics The statistics for a sequence of SNAT pools.
280
+ # @attr [IControl::LocalLB::SNAT::SNATStatisticEntrySequence] statistics The statistics for a sequence of SNAT pools.
250
281
  # @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
251
282
  class SNATStatistics < IControl::Base::Struct
252
- icontrol_attribute :statistics, IControl::LocalLB::SNAT::SNATStatisticEntry
283
+ icontrol_attribute :statistics, IControl::LocalLB::SNAT::SNATStatisticEntrySequence
253
284
  icontrol_attribute :time_stamp, IControl::Common::TimeStamp
254
285
  end
255
286