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.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The RateClass interface enables you to work with the definitions and attributes of
|
|
3
|
+
# The RateClass interface enables you to work with the definitions and attributes of
|
|
4
|
+
# a rate class class. Rate filtering refers to the ability to enforce configurable
|
|
5
|
+
# bandwidth consumption limitations upon user-defined traffic classes. The purpose
|
|
6
|
+
# of a Rate class is to allow the network administrator to effectively divide a single
|
|
7
|
+
# bandwidth resource through a gateway among preferred applications or traffic classes.
|
|
8
|
+
# Rate filtering is somewhat related to packet filtering. The key difference between
|
|
9
|
+
# the two is that packet filters seek to enforce an access policy on traffic, and Rate
|
|
10
|
+
# Filter classes seek to enforce a throughput policy on traffic.
|
|
4
11
|
class RateClass < IControl::Base
|
|
5
12
|
|
|
6
13
|
set_id_name "rate_classes"
|
|
@@ -8,6 +15,12 @@ module IControl::LocalLB
|
|
|
8
15
|
class RateClassStatisticEntry < IControl::Base::Struct; end
|
|
9
16
|
class RateClassStatistics < IControl::Base::Struct; end
|
|
10
17
|
class RateUnit < IControl::Base::Struct; end
|
|
18
|
+
class DirectionTypeSequence < IControl::Base::Sequence ; end
|
|
19
|
+
class DropPolicyTypeSequence < IControl::Base::Sequence ; end
|
|
20
|
+
class QueueTypeSequence < IControl::Base::Sequence ; end
|
|
21
|
+
class RateClassStatisticEntrySequence < IControl::Base::Sequence ; end
|
|
22
|
+
class RateUnitSequence < IControl::Base::Sequence ; end
|
|
23
|
+
class UnitTypeSequence < IControl::Base::Sequence ; end
|
|
11
24
|
# A list of different directions to indicate how rate shaping should be applied to.
|
|
12
25
|
class DirectionType < IControl::Base::Enumeration; end
|
|
13
26
|
# A list of drop policy types
|
|
@@ -17,9 +30,10 @@ module IControl::LocalLB
|
|
|
17
30
|
# A list of unit types.
|
|
18
31
|
class UnitType < IControl::Base::Enumeration; end ##
|
|
19
32
|
# Creates this rate classe.
|
|
20
|
-
# @
|
|
21
|
-
# @raise [IControl::Common::
|
|
22
|
-
# @raise [IControl::Common::
|
|
33
|
+
# @rspec_example
|
|
34
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
35
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
36
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
23
37
|
# @param [Hash] opts
|
|
24
38
|
# @option opts [IControl::LocalLB::RateClass::RateUnit] :base_rates The base rates at which the maximum throughput to allot to traffic handled by the Rate Classes. Packets in excess of the posted rate will be dropped.
|
|
25
39
|
def create(opts)
|
|
@@ -28,10 +42,14 @@ module IControl::LocalLB
|
|
|
28
42
|
end
|
|
29
43
|
|
|
30
44
|
##
|
|
31
|
-
# Creates this drop policies, given the drop policy type, the general strategy used
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
45
|
+
# Creates this drop policies, given the drop policy type, the general strategy used
|
|
46
|
+
# by the rate filter to throttle traffic. Note that pre-defined drop policies exist
|
|
47
|
+
# with a basic configuration for each type - &quot;tail", &quot;red", and &quot;fred".
|
|
48
|
+
# Also note that a rate filter class defaults to using a &quot;tail" drop policy.
|
|
49
|
+
# @rspec_example
|
|
50
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
51
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
52
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
35
53
|
# @param [Hash] opts
|
|
36
54
|
# @option opts [String] :drop_policies Names of the drop policies to create
|
|
37
55
|
# @option opts [IControl::LocalLB::RateClass::DropPolicyType] :types Type for each created drop policy
|
|
@@ -42,9 +60,10 @@ module IControl::LocalLB
|
|
|
42
60
|
|
|
43
61
|
##
|
|
44
62
|
# Creates this queueing methods, given their queueing method type.
|
|
45
|
-
# @
|
|
46
|
-
# @raise [IControl::Common::
|
|
47
|
-
# @raise [IControl::Common::
|
|
63
|
+
# @rspec_example
|
|
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.
|
|
48
67
|
# @param [Hash] opts
|
|
49
68
|
# @option opts [String] :queues Names of the queueing methods to create
|
|
50
69
|
# @option opts [IControl::LocalLB::RateClass::QueueType] :types Type for each created queueing method
|
|
@@ -55,9 +74,10 @@ module IControl::LocalLB
|
|
|
55
74
|
|
|
56
75
|
##
|
|
57
76
|
# Creates this shaping policies.
|
|
58
|
-
# @
|
|
59
|
-
# @raise [IControl::Common::
|
|
60
|
-
# @raise [IControl::Common::
|
|
77
|
+
# @rspec_example
|
|
78
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
79
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
80
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
61
81
|
# @param [Hash] opts
|
|
62
82
|
# @option opts [String] :policies Names of the shaping policies to create
|
|
63
83
|
def create_shaping_policy(opts)
|
|
@@ -67,45 +87,50 @@ module IControl::LocalLB
|
|
|
67
87
|
|
|
68
88
|
##
|
|
69
89
|
# Deletes all drop policies
|
|
70
|
-
# @
|
|
71
|
-
# @raise [IControl::Common::
|
|
72
|
-
# @raise [IControl::Common::
|
|
90
|
+
# @rspec_example
|
|
91
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
92
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
93
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
73
94
|
def delete_all_drop_policies
|
|
74
95
|
super
|
|
75
96
|
end
|
|
76
97
|
|
|
77
98
|
##
|
|
78
99
|
# Deletes all queueing methods.
|
|
79
|
-
# @
|
|
80
|
-
# @raise [IControl::Common::
|
|
81
|
-
# @raise [IControl::Common::
|
|
100
|
+
# @rspec_example
|
|
101
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
102
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
103
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
82
104
|
def delete_all_queueing_methods
|
|
83
105
|
super
|
|
84
106
|
end
|
|
85
107
|
|
|
86
108
|
##
|
|
87
109
|
# Deletes all rate classe.
|
|
88
|
-
# @
|
|
89
|
-
# @raise [IControl::Common::
|
|
90
|
-
# @raise [IControl::Common::
|
|
110
|
+
# @rspec_example
|
|
111
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
112
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
113
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
91
114
|
def delete_all_rate_classes
|
|
92
115
|
super
|
|
93
116
|
end
|
|
94
117
|
|
|
95
118
|
##
|
|
96
119
|
# Deletes all shaping policies.
|
|
97
|
-
# @
|
|
98
|
-
# @raise [IControl::Common::
|
|
99
|
-
# @raise [IControl::Common::
|
|
120
|
+
# @rspec_example
|
|
121
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
122
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
123
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
100
124
|
def delete_all_shaping_policies
|
|
101
125
|
super
|
|
102
126
|
end
|
|
103
127
|
|
|
104
128
|
##
|
|
105
129
|
# Deletes this drop policies
|
|
106
|
-
# @
|
|
107
|
-
# @raise [IControl::Common::
|
|
108
|
-
# @raise [IControl::Common::
|
|
130
|
+
# @rspec_example
|
|
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.
|
|
109
134
|
# @param [Hash] opts
|
|
110
135
|
# @option opts [String] :drop_policies Names of the drop policies to delete
|
|
111
136
|
def delete_drop_policy(opts)
|
|
@@ -115,9 +140,10 @@ module IControl::LocalLB
|
|
|
115
140
|
|
|
116
141
|
##
|
|
117
142
|
# Deletes this queueing methods.
|
|
118
|
-
# @
|
|
119
|
-
# @raise [IControl::Common::
|
|
120
|
-
# @raise [IControl::Common::
|
|
143
|
+
# @rspec_example
|
|
144
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
145
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
146
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
121
147
|
# @param [Hash] opts
|
|
122
148
|
# @option opts [String] :queues Names of the queueing methods to delete
|
|
123
149
|
def delete_queueing_method(opts)
|
|
@@ -127,18 +153,20 @@ module IControl::LocalLB
|
|
|
127
153
|
|
|
128
154
|
##
|
|
129
155
|
# Deletes this rate classe.
|
|
130
|
-
# @
|
|
131
|
-
# @raise [IControl::Common::
|
|
132
|
-
# @raise [IControl::Common::
|
|
156
|
+
# @rspec_example
|
|
157
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
158
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
159
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
133
160
|
def delete_rate_class
|
|
134
161
|
super
|
|
135
162
|
end
|
|
136
163
|
|
|
137
164
|
##
|
|
138
165
|
# Deletes this shaping policies.
|
|
139
|
-
# @
|
|
140
|
-
# @raise [IControl::Common::
|
|
141
|
-
# @raise [IControl::Common::
|
|
166
|
+
# @rspec_example
|
|
167
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
168
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
169
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
142
170
|
# @param [Hash] opts
|
|
143
171
|
# @option opts [String] :policies Names of the shaping policies to delete
|
|
144
172
|
def delete_shaping_policy(opts)
|
|
@@ -148,80 +176,99 @@ module IControl::LocalLB
|
|
|
148
176
|
|
|
149
177
|
##
|
|
150
178
|
# Gets the statistics for all the rate classe.
|
|
179
|
+
# @rspec_example
|
|
151
180
|
# @return [RateClassStatistics]
|
|
152
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
153
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
154
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
181
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
182
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
183
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
155
184
|
def all_statistics
|
|
156
185
|
super
|
|
157
186
|
end
|
|
158
187
|
|
|
159
188
|
##
|
|
160
|
-
# Gets the base rates for this rate classe. The base rate specifies the maximum throughput
|
|
189
|
+
# Gets the base rates for this rate classe. The base rate specifies the maximum throughput
|
|
190
|
+
# to allot to traffic handled by the Rate Class. Packets in excess of the posted rate
|
|
191
|
+
# will be dropped.
|
|
192
|
+
# @rspec_example
|
|
161
193
|
# @return [RateUnit]
|
|
162
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
163
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
164
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
194
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
195
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
196
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
165
197
|
def base_rate
|
|
166
198
|
super
|
|
167
199
|
end
|
|
168
200
|
|
|
169
201
|
##
|
|
170
|
-
# Gets the burst sizes for this rate classe. The burst size specifies maximum number
|
|
202
|
+
# Gets the burst sizes for this rate classe. The burst size specifies maximum number
|
|
203
|
+
# of bytes that traffic is allowed to burst beyond the base rate.
|
|
204
|
+
# @rspec_example
|
|
171
205
|
# @return [long]
|
|
172
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
173
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
174
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
206
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
207
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
208
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
175
209
|
def burst_size
|
|
176
210
|
super
|
|
177
211
|
end
|
|
178
212
|
|
|
179
213
|
##
|
|
180
|
-
# Gets the ceiling rates for this rate classe. The ceiling rate specifies how far beyond
|
|
214
|
+
# Gets the ceiling rates for this rate classe. The ceiling rate specifies how far beyond
|
|
215
|
+
# the base rate the traffic is allowed to flow when bursting. The ceiling rate is an
|
|
216
|
+
# absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling
|
|
217
|
+
# rate, even when bursting. If the ceiling rate is omitted or is equal to the base
|
|
218
|
+
# rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate
|
|
219
|
+
# to be less than the base rate.
|
|
220
|
+
# @rspec_example
|
|
181
221
|
# @return [RateUnit]
|
|
182
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
183
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
184
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
222
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
223
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
224
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
185
225
|
def ceiling_rate
|
|
186
226
|
super
|
|
187
227
|
end
|
|
188
228
|
|
|
189
229
|
##
|
|
190
230
|
# Gets the direction types being used by this rate classe.
|
|
231
|
+
# @rspec_example
|
|
191
232
|
# @return [DirectionType]
|
|
192
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
193
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
194
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
233
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
234
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
235
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
195
236
|
def direction
|
|
196
237
|
super
|
|
197
238
|
end
|
|
198
239
|
|
|
199
240
|
##
|
|
200
|
-
# Gets the VLAN whose outbound traffic is rate filtered. This is only valid for the
|
|
241
|
+
# Gets the VLAN whose outbound traffic is rate filtered. This is only valid for the
|
|
242
|
+
# DIRECTION_VLAN direction.
|
|
243
|
+
# @rspec_example
|
|
201
244
|
# @return [String]
|
|
202
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
203
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
204
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
245
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
246
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
247
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
205
248
|
def direction_vlan
|
|
206
249
|
super
|
|
207
250
|
end
|
|
208
251
|
|
|
209
252
|
##
|
|
210
|
-
# Gets the name of the drop policy, specifying how a rate filter drops packets when
|
|
253
|
+
# Gets the name of the drop policy, specifying how a rate filter drops packets when
|
|
254
|
+
# the rate filter is throttling traffic.
|
|
255
|
+
# @rspec_example
|
|
211
256
|
# @return [String]
|
|
212
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
213
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
214
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
257
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
258
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
259
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
215
260
|
def drop_policy
|
|
216
261
|
super
|
|
217
262
|
end
|
|
218
263
|
|
|
219
264
|
##
|
|
220
|
-
# Gets the average packet (maximum transmission unit (MTU)) size. This is only valid
|
|
265
|
+
# Gets the average packet (maximum transmission unit (MTU)) size. This is only valid
|
|
266
|
+
# for the &quot;fred" and &quot;red" types.
|
|
267
|
+
# @rspec_example
|
|
221
268
|
# @return [long]
|
|
222
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
223
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
224
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
269
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
270
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
271
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
225
272
|
# @param [Hash] opts
|
|
226
273
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
227
274
|
def drop_policy_average_packet_size(opts)
|
|
@@ -231,10 +278,11 @@ module IControl::LocalLB
|
|
|
231
278
|
|
|
232
279
|
##
|
|
233
280
|
# Gets the drop limit factor. This is only valid for the &quot;fred" type.
|
|
281
|
+
# @rspec_example
|
|
234
282
|
# @return [long]
|
|
235
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
236
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
237
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
283
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
284
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
285
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
238
286
|
# @param [Hash] opts
|
|
239
287
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
240
288
|
def drop_policy_drop_limit_factor(opts)
|
|
@@ -244,20 +292,23 @@ module IControl::LocalLB
|
|
|
244
292
|
|
|
245
293
|
##
|
|
246
294
|
# Gets a list of all drop policies
|
|
295
|
+
# @rspec_example
|
|
247
296
|
# @return [String]
|
|
248
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
249
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
250
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
297
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
298
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
299
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
251
300
|
def drop_policy_list
|
|
252
301
|
super
|
|
253
302
|
end
|
|
254
303
|
|
|
255
304
|
##
|
|
256
|
-
# Gets the maximum number of active connections for each queue. This is only valid
|
|
305
|
+
# Gets the maximum number of active connections for each queue. This is only valid
|
|
306
|
+
# for the &quot;fred" type.
|
|
307
|
+
# @rspec_example
|
|
257
308
|
# @return [long]
|
|
258
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
259
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
260
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
309
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
310
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
311
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
261
312
|
# @param [Hash] opts
|
|
262
313
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
263
314
|
def drop_policy_maximum_active_connections(opts)
|
|
@@ -266,11 +317,14 @@ module IControl::LocalLB
|
|
|
266
317
|
end
|
|
267
318
|
|
|
268
319
|
##
|
|
269
|
-
# Gets the maximum probability for dropping packets when the average queue length is
|
|
320
|
+
# Gets the maximum probability for dropping packets when the average queue length is
|
|
321
|
+
# between the minimum and maximum thresholds. This is only valid for the &quot;red"
|
|
322
|
+
# and &quot;fred" types.
|
|
323
|
+
# @rspec_example
|
|
270
324
|
# @return [long]
|
|
271
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
272
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
273
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
325
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
326
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
327
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
274
328
|
# @param [Hash] opts
|
|
275
329
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
276
330
|
def drop_policy_maximum_probability(opts)
|
|
@@ -280,10 +334,11 @@ module IControl::LocalLB
|
|
|
280
334
|
|
|
281
335
|
##
|
|
282
336
|
# Gets the maximum queue size. This is only valid for the &quot;red" type.
|
|
337
|
+
# @rspec_example
|
|
283
338
|
# @return [long]
|
|
284
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
285
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
286
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
339
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
340
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
341
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
287
342
|
# @param [Hash] opts
|
|
288
343
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
289
344
|
def drop_policy_maximum_queue_size(opts)
|
|
@@ -292,11 +347,14 @@ module IControl::LocalLB
|
|
|
292
347
|
end
|
|
293
348
|
|
|
294
349
|
##
|
|
295
|
-
# Gets the queue length threshold above which packets are dropped when the rate filter
|
|
350
|
+
# Gets the queue length threshold above which packets are dropped when the rate filter
|
|
351
|
+
# is throttling traffic. This is only valid for the &quot;red" and &quot;fred"
|
|
352
|
+
# types.
|
|
353
|
+
# @rspec_example
|
|
296
354
|
# @return [long]
|
|
297
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
298
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
299
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
355
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
356
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
357
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
300
358
|
# @param [Hash] opts
|
|
301
359
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
302
360
|
def drop_policy_maximum_queue_threshold(opts)
|
|
@@ -305,11 +363,14 @@ module IControl::LocalLB
|
|
|
305
363
|
end
|
|
306
364
|
|
|
307
365
|
##
|
|
308
|
-
# Gets the queue length threshold below which packets are not dropped when the rate
|
|
366
|
+
# Gets the queue length threshold below which packets are not dropped when the rate
|
|
367
|
+
# filter is throttling traffic. This is only valid for the &quot;red" and &quot;fred"
|
|
368
|
+
# types.
|
|
369
|
+
# @rspec_example
|
|
309
370
|
# @return [long]
|
|
310
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
311
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
312
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
371
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
372
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
373
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
313
374
|
# @param [Hash] opts
|
|
314
375
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
315
376
|
def drop_policy_minimum_queue_threshold(opts)
|
|
@@ -319,10 +380,11 @@ module IControl::LocalLB
|
|
|
319
380
|
|
|
320
381
|
##
|
|
321
382
|
# Gets the no-drop limit factor. This is only valid for the &quot;fred" type.
|
|
383
|
+
# @rspec_example
|
|
322
384
|
# @return [long]
|
|
323
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
324
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
325
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
385
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
386
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
387
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
326
388
|
# @param [Hash] opts
|
|
327
389
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
328
390
|
def drop_policy_no_drop_limit_factor(opts)
|
|
@@ -332,10 +394,11 @@ module IControl::LocalLB
|
|
|
332
394
|
|
|
333
395
|
##
|
|
334
396
|
# Gets the drop policy type
|
|
397
|
+
# @rspec_example
|
|
335
398
|
# @return [DropPolicyType]
|
|
336
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
337
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
338
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
399
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
400
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
401
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
339
402
|
# @param [Hash] opts
|
|
340
403
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
341
404
|
def drop_policy_type(opts)
|
|
@@ -344,11 +407,13 @@ module IControl::LocalLB
|
|
|
344
407
|
end
|
|
345
408
|
|
|
346
409
|
##
|
|
347
|
-
# Gets the weight used to calculate the average queue lengths. This is only valid for
|
|
410
|
+
# Gets the weight used to calculate the average queue lengths. This is only valid for
|
|
411
|
+
# the &quot;red" and &quot;fred" types.
|
|
412
|
+
# @rspec_example
|
|
348
413
|
# @return [long]
|
|
349
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
350
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
351
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
414
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
415
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
416
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
352
417
|
# @param [Hash] opts
|
|
353
418
|
# @option opts [String] :drop_policies Names of the drop policies to query
|
|
354
419
|
def drop_policy_weight(opts)
|
|
@@ -358,70 +423,85 @@ module IControl::LocalLB
|
|
|
358
423
|
|
|
359
424
|
##
|
|
360
425
|
# Gets a list of all rate classe.
|
|
426
|
+
# @rspec_example
|
|
361
427
|
# @return [String]
|
|
362
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
363
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
364
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
428
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
429
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
430
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
365
431
|
def list
|
|
366
432
|
super
|
|
367
433
|
end
|
|
368
434
|
|
|
369
435
|
##
|
|
370
|
-
# Gets the name of the parent rate class. Any child Rate Class has the ability to borrow
|
|
436
|
+
# Gets the name of the parent rate class. Any child Rate Class has the ability to borrow
|
|
437
|
+
# bandwidth from its parent. If the parent rate class is not specified in the definition
|
|
438
|
+
# of a rate class, the Rate Class is not a child, but may be a parent if another Rate
|
|
439
|
+
# Class refers to it as such.
|
|
440
|
+
# @rspec_example
|
|
371
441
|
# @return [String]
|
|
372
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
373
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
374
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
442
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
443
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
444
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
375
445
|
def parent
|
|
376
446
|
super
|
|
377
447
|
end
|
|
378
448
|
|
|
379
449
|
##
|
|
380
|
-
# Gets the base rate, if specified as a percentage of the parent rate filter class'
|
|
450
|
+
# Gets the base rate, if specified as a percentage of the parent rate filter class'
|
|
451
|
+
# base rate. This is zero if the base rate is specified as bandwidth (see set/get_base_rate).
|
|
452
|
+
# @rspec_example
|
|
381
453
|
# @return [long]
|
|
382
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
383
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
384
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
454
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
455
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
456
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
385
457
|
def percent_of_parent_base_rate
|
|
386
458
|
super
|
|
387
459
|
end
|
|
388
460
|
|
|
389
461
|
##
|
|
390
|
-
# Gets the ceiling rate, if specified as a percentage of the parent's ceiling rate.
|
|
462
|
+
# Gets the ceiling rate, if specified as a percentage of the parent's ceiling rate.
|
|
463
|
+
# This is zero if the ceiling rate is specified as a throughput (see set/get_ceiling_rate).
|
|
464
|
+
# @rspec_example
|
|
391
465
|
# @return [long]
|
|
392
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
393
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
394
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
466
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
467
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
468
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
395
469
|
def percent_of_parent_ceiling_rate
|
|
396
470
|
super
|
|
397
471
|
end
|
|
398
472
|
|
|
399
473
|
##
|
|
400
|
-
# Gets the queue types being used by this rate classe. See also the get_queueing_method
|
|
474
|
+
# Gets the queue types being used by this rate classe. See also the get_queueing_method
|
|
475
|
+
# method.
|
|
476
|
+
# @rspec_example
|
|
401
477
|
# @return [QueueType]
|
|
402
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
403
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
404
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
478
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
479
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
480
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
405
481
|
def queue_type
|
|
406
482
|
super
|
|
407
483
|
end
|
|
408
484
|
|
|
409
485
|
##
|
|
410
|
-
# Gets the queueing method, specifying how packets are queued for rate filtering, effectively
|
|
486
|
+
# Gets the queueing method, specifying how packets are queued for rate filtering, effectively
|
|
487
|
+
# determining the class of traffic which is dropped if necessary.
|
|
488
|
+
# @rspec_example
|
|
411
489
|
# @return [String]
|
|
412
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
413
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
414
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
490
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
491
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
492
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
415
493
|
def queueing_method
|
|
416
494
|
super
|
|
417
495
|
end
|
|
418
496
|
|
|
419
497
|
##
|
|
420
|
-
# Gets the number of the buckets used to divide the traffic for each queue. This is
|
|
498
|
+
# Gets the number of the buckets used to divide the traffic for each queue. This is
|
|
499
|
+
# only valid for the stochastic fair queueing type.
|
|
500
|
+
# @rspec_example
|
|
421
501
|
# @return [long]
|
|
422
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
423
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
424
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
502
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
503
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
504
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
425
505
|
# @param [Hash] opts
|
|
426
506
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
427
507
|
def queueing_method_bucket_count(opts)
|
|
@@ -430,11 +510,13 @@ module IControl::LocalLB
|
|
|
430
510
|
end
|
|
431
511
|
|
|
432
512
|
##
|
|
433
|
-
# Gets the size of the buckets used to divide the traffic for each queue. This is only
|
|
513
|
+
# Gets the size of the buckets used to divide the traffic for each queue. This is only
|
|
514
|
+
# valid for the stochastic fair queueing type.
|
|
515
|
+
# @rspec_example
|
|
434
516
|
# @return [long]
|
|
435
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
436
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
437
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
517
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
518
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
519
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
438
520
|
# @param [Hash] opts
|
|
439
521
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
440
522
|
def queueing_method_bucket_size(opts)
|
|
@@ -444,20 +526,22 @@ module IControl::LocalLB
|
|
|
444
526
|
|
|
445
527
|
##
|
|
446
528
|
# Gets a list of all queueing methods
|
|
529
|
+
# @rspec_example
|
|
447
530
|
# @return [String]
|
|
448
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
449
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
450
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
531
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
532
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
533
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
451
534
|
def queueing_method_list
|
|
452
535
|
super
|
|
453
536
|
end
|
|
454
537
|
|
|
455
538
|
##
|
|
456
539
|
# Gets the maximum queue size. This is only valid for the Priority FIFO queueing type.
|
|
540
|
+
# @rspec_example
|
|
457
541
|
# @return [long]
|
|
458
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
459
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
460
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
542
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
543
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
544
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
461
545
|
# @param [Hash] opts
|
|
462
546
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
463
547
|
def queueing_method_maximum_queue_size(opts)
|
|
@@ -467,10 +551,11 @@ module IControl::LocalLB
|
|
|
467
551
|
|
|
468
552
|
##
|
|
469
553
|
# Gets the minimum queue size. This is only valid for the Priority FIFO queueing type.
|
|
554
|
+
# @rspec_example
|
|
470
555
|
# @return [long]
|
|
471
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
472
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
473
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
556
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
557
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
558
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
474
559
|
# @param [Hash] opts
|
|
475
560
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
476
561
|
def queueing_method_minimum_queue_size(opts)
|
|
@@ -479,11 +564,13 @@ module IControl::LocalLB
|
|
|
479
564
|
end
|
|
480
565
|
|
|
481
566
|
##
|
|
482
|
-
# Gets the perburation interval, the interval at which the system reconfigures the
|
|
567
|
+
# Gets the perburation interval, the interval at which the system reconfigures the
|
|
568
|
+
# bucket hash function. This is only valid for the stochastic fair queueing type.
|
|
569
|
+
# @rspec_example
|
|
483
570
|
# @return [long]
|
|
484
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
485
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
486
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
571
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
572
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
573
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
487
574
|
# @param [Hash] opts
|
|
488
575
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
489
576
|
def queueing_method_perturbation_interval(opts)
|
|
@@ -492,11 +579,13 @@ module IControl::LocalLB
|
|
|
492
579
|
end
|
|
493
580
|
|
|
494
581
|
##
|
|
495
|
-
# Gets the queueing method types, i.e., the method use to store and remove traffic
|
|
582
|
+
# Gets the queueing method types, i.e., the method use to store and remove traffic
|
|
583
|
+
# from the queues managed by a rate filter.
|
|
584
|
+
# @rspec_example
|
|
496
585
|
# @return [QueueType]
|
|
497
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
498
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
499
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
586
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
587
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
588
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
500
589
|
# @param [Hash] opts
|
|
501
590
|
# @option opts [String] :queues Names of the queueing methods to query
|
|
502
591
|
def queueing_method_type(opts)
|
|
@@ -505,21 +594,25 @@ module IControl::LocalLB
|
|
|
505
594
|
end
|
|
506
595
|
|
|
507
596
|
##
|
|
508
|
-
# Gets the name of shaping policy, used to specify custom drop policies and queueing
|
|
597
|
+
# Gets the name of shaping policy, used to specify custom drop policies and queueing
|
|
598
|
+
# methods.
|
|
599
|
+
# @rspec_example
|
|
509
600
|
# @return [String]
|
|
510
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
511
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
512
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
601
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
602
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
603
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
513
604
|
def shaping_policy
|
|
514
605
|
super
|
|
515
606
|
end
|
|
516
607
|
|
|
517
608
|
##
|
|
518
|
-
# Gets the burst size for a shaping policy, the maximum number of bytes that traffic
|
|
609
|
+
# Gets the burst size for a shaping policy, the maximum number of bytes that traffic
|
|
610
|
+
# is allowed to burst beyond the base rate.
|
|
611
|
+
# @rspec_example
|
|
519
612
|
# @return [long]
|
|
520
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
521
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
522
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
613
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
614
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
615
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
523
616
|
# @param [Hash] opts
|
|
524
617
|
# @option opts [String] :policies Names of the shaping policies to query
|
|
525
618
|
def shaping_policy_burst_size(opts)
|
|
@@ -528,11 +621,13 @@ module IControl::LocalLB
|
|
|
528
621
|
end
|
|
529
622
|
|
|
530
623
|
##
|
|
531
|
-
# Gets the name of the drop policy for a shaping policy, specifying how a rate filter
|
|
624
|
+
# Gets the name of the drop policy for a shaping policy, specifying how a rate filter
|
|
625
|
+
# drops packets when the rate filter is throttling traffic.
|
|
626
|
+
# @rspec_example
|
|
532
627
|
# @return [String]
|
|
533
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
534
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
535
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
628
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
629
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
630
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
536
631
|
# @param [Hash] opts
|
|
537
632
|
# @option opts [String] :policies Names of the shaping policies to query
|
|
538
633
|
def shaping_policy_drop_policy(opts)
|
|
@@ -542,20 +637,23 @@ module IControl::LocalLB
|
|
|
542
637
|
|
|
543
638
|
##
|
|
544
639
|
# Gets a list of all shaping policies
|
|
640
|
+
# @rspec_example
|
|
545
641
|
# @return [String]
|
|
546
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
547
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
548
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
642
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
643
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
644
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
549
645
|
def shaping_policy_list
|
|
550
646
|
super
|
|
551
647
|
end
|
|
552
648
|
|
|
553
649
|
##
|
|
554
|
-
# Gets the base rate for a shaping policy, if specified as a percentage of the parent
|
|
650
|
+
# Gets the base rate for a shaping policy, if specified as a percentage of the parent
|
|
651
|
+
# rate filter class' base rate.
|
|
652
|
+
# @rspec_example
|
|
555
653
|
# @return [long]
|
|
556
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
557
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
558
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
654
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
655
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
656
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
559
657
|
# @param [Hash] opts
|
|
560
658
|
# @option opts [String] :policies Names of the shaping policies to query
|
|
561
659
|
def shaping_policy_percent_of_parent_base_rate(opts)
|
|
@@ -564,11 +662,13 @@ module IControl::LocalLB
|
|
|
564
662
|
end
|
|
565
663
|
|
|
566
664
|
##
|
|
567
|
-
# Gets the ceiling rate for a shaping policy, if specified as a percentage of the parent
|
|
665
|
+
# Gets the ceiling rate for a shaping policy, if specified as a percentage of the parent
|
|
666
|
+
# rate filter class' ceiling rate.
|
|
667
|
+
# @rspec_example
|
|
568
668
|
# @return [long]
|
|
569
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
570
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
571
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
669
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
670
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
671
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
572
672
|
# @param [Hash] opts
|
|
573
673
|
# @option opts [String] :policies Names of the shaping policies to query
|
|
574
674
|
def shaping_policy_percent_of_parent_ceiling_rate(opts)
|
|
@@ -577,11 +677,14 @@ module IControl::LocalLB
|
|
|
577
677
|
end
|
|
578
678
|
|
|
579
679
|
##
|
|
580
|
-
# Gets the queueing method for a shaping policy, specifying how packets are queued
|
|
680
|
+
# Gets the queueing method for a shaping policy, specifying how packets are queued
|
|
681
|
+
# for rate filtering, effectively determining the class of traffic which is dropped
|
|
682
|
+
# if necessary.
|
|
683
|
+
# @rspec_example
|
|
581
684
|
# @return [String]
|
|
582
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
583
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
584
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
685
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
686
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
687
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
585
688
|
# @param [Hash] opts
|
|
586
689
|
# @option opts [String] :policies Names of the shaping policies to query
|
|
587
690
|
def shaping_policy_queueing_method(opts)
|
|
@@ -591,16 +694,18 @@ module IControl::LocalLB
|
|
|
591
694
|
|
|
592
695
|
##
|
|
593
696
|
# Gets the statistics for this rate classe.
|
|
697
|
+
# @rspec_example
|
|
594
698
|
# @return [RateClassStatistics]
|
|
595
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
596
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
597
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
699
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
700
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
701
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
598
702
|
def statistics
|
|
599
703
|
super
|
|
600
704
|
end
|
|
601
705
|
|
|
602
706
|
##
|
|
603
707
|
# Gets the version information for this interface.
|
|
708
|
+
# @rspec_example
|
|
604
709
|
# @return [String]
|
|
605
710
|
def version
|
|
606
711
|
super
|
|
@@ -608,18 +713,22 @@ module IControl::LocalLB
|
|
|
608
713
|
|
|
609
714
|
##
|
|
610
715
|
# Resets the statistics for this rate classe.
|
|
611
|
-
# @
|
|
612
|
-
# @raise [IControl::Common::
|
|
613
|
-
# @raise [IControl::Common::
|
|
716
|
+
# @rspec_example
|
|
717
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
718
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
719
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
614
720
|
def reset_statistics
|
|
615
721
|
super
|
|
616
722
|
end
|
|
617
723
|
|
|
618
724
|
##
|
|
619
|
-
# Sets the base rates for this rate classe. The base rate specifies the maximum throughput
|
|
620
|
-
#
|
|
621
|
-
#
|
|
622
|
-
# @
|
|
725
|
+
# Sets the base rates for this rate classe. The base rate specifies the maximum throughput
|
|
726
|
+
# to allot to traffic handled by the Rate Class. Packets in excess of the posted rate
|
|
727
|
+
# will be dropped.
|
|
728
|
+
# @rspec_example
|
|
729
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
730
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
731
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
623
732
|
# @param [Hash] opts
|
|
624
733
|
# @option opts [IControl::LocalLB::RateClass::RateUnit] :rates The base rates to set for the rate classes.
|
|
625
734
|
def set_base_rate(opts)
|
|
@@ -628,10 +737,12 @@ module IControl::LocalLB
|
|
|
628
737
|
end
|
|
629
738
|
|
|
630
739
|
##
|
|
631
|
-
# Sets the burst sizes for this rate classe. The burst size specifies maximum number
|
|
632
|
-
#
|
|
633
|
-
# @
|
|
634
|
-
# @raise [IControl::Common::
|
|
740
|
+
# Sets the burst sizes for this rate classe. The burst size specifies maximum number
|
|
741
|
+
# of bytes that traffic is allowed to burst beyond the base rate.
|
|
742
|
+
# @rspec_example
|
|
743
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
744
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
745
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
635
746
|
# @param [Hash] opts
|
|
636
747
|
# @option opts [long] :burst_sizes The burst sizes to set for the rate classes.
|
|
637
748
|
def set_burst_size(opts)
|
|
@@ -640,10 +751,16 @@ module IControl::LocalLB
|
|
|
640
751
|
end
|
|
641
752
|
|
|
642
753
|
##
|
|
643
|
-
# Sets the ceiling rates for this rate classe. The ceiling rate specifies how far beyond
|
|
644
|
-
#
|
|
645
|
-
#
|
|
646
|
-
#
|
|
754
|
+
# Sets the ceiling rates for this rate classe. The ceiling rate specifies how far beyond
|
|
755
|
+
# the base rate the traffic is allowed to flow when bursting. The ceiling rate is an
|
|
756
|
+
# absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling
|
|
757
|
+
# rate, even when bursting. If the ceiling rate is omitted or is equal to the base
|
|
758
|
+
# rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate
|
|
759
|
+
# to be less than the base rate.
|
|
760
|
+
# @rspec_example
|
|
761
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
762
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
763
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
647
764
|
# @param [Hash] opts
|
|
648
765
|
# @option opts [IControl::LocalLB::RateClass::RateUnit] :rates The ceiling rates to set for the rate classes.
|
|
649
766
|
def set_ceiling_rate(opts)
|
|
@@ -652,10 +769,12 @@ module IControl::LocalLB
|
|
|
652
769
|
end
|
|
653
770
|
|
|
654
771
|
##
|
|
655
|
-
# Sets the direction types to be used by this rate classe. For the DIRECTION_VLAN type,
|
|
656
|
-
#
|
|
657
|
-
# @
|
|
658
|
-
# @raise [IControl::Common::
|
|
772
|
+
# Sets the direction types to be used by this rate classe. For the DIRECTION_VLAN type,
|
|
773
|
+
# it is best to use set_direction_vlan.
|
|
774
|
+
# @rspec_example
|
|
775
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
776
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
777
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
659
778
|
# @param [Hash] opts
|
|
660
779
|
# @option opts [IControl::LocalLB::RateClass::DirectionType] :direction_types The direction types to set for the rate classes.
|
|
661
780
|
def set_direction(opts)
|
|
@@ -664,10 +783,12 @@ module IControl::LocalLB
|
|
|
664
783
|
end
|
|
665
784
|
|
|
666
785
|
##
|
|
667
|
-
# Sets the direction type to apply rate filtering to traffic leaving via a specified
|
|
668
|
-
#
|
|
669
|
-
# @
|
|
670
|
-
# @raise [IControl::Common::
|
|
786
|
+
# Sets the direction type to apply rate filtering to traffic leaving via a specified
|
|
787
|
+
# VLAN.
|
|
788
|
+
# @rspec_example
|
|
789
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
790
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
791
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
671
792
|
# @param [Hash] opts
|
|
672
793
|
# @option opts [String] :vlans Name of the egress VLAN for each specified rate filter class (default: none, i.e., this must be specified)
|
|
673
794
|
def set_direction_vlan(opts)
|
|
@@ -676,10 +797,17 @@ module IControl::LocalLB
|
|
|
676
797
|
end
|
|
677
798
|
|
|
678
799
|
##
|
|
679
|
-
# A drop policy controls which packets are dropped when a rate filter needs to throttle
|
|
680
|
-
#
|
|
681
|
-
#
|
|
682
|
-
#
|
|
800
|
+
# A drop policy controls which packets are dropped when a rate filter needs to throttle
|
|
801
|
+
# traffic. A rate filter collects traffic in a number of queues, classified according
|
|
802
|
+
# to the rate filter's queueing method (see set_queueing_method). The drop policy determines
|
|
803
|
+
# how traffic is dropped from each queue with each queue's being treated the same.
|
|
804
|
+
# This method sets the name of the drop policy. Three pre-defined drop policies exist.
|
|
805
|
+
# &quot;fred" drops packets according to the type of traffic. &quot;red" drops
|
|
806
|
+
# packets randomly. &quot;tail" drops packets from the end of the queues.
|
|
807
|
+
# @rspec_example
|
|
808
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
809
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
810
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
683
811
|
# @param [Hash] opts
|
|
684
812
|
# @option opts [String] :policies Name of the drop policy for each specified rate filter class (default: "tail")
|
|
685
813
|
def set_drop_policy(opts)
|
|
@@ -688,10 +816,12 @@ module IControl::LocalLB
|
|
|
688
816
|
end
|
|
689
817
|
|
|
690
818
|
##
|
|
691
|
-
# Sets the average packet (maximum transmission unit (MTU)) size. This is only valid
|
|
692
|
-
#
|
|
693
|
-
# @
|
|
694
|
-
# @raise [IControl::Common::
|
|
819
|
+
# Sets the average packet (maximum transmission unit (MTU)) size. This is only valid
|
|
820
|
+
# for the &quot;fred" and &quot;red" types.
|
|
821
|
+
# @rspec_example
|
|
822
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
823
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
824
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
695
825
|
# @param [Hash] opts
|
|
696
826
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
697
827
|
# @option opts [long] :mtus Average packet (MTU) size for each specified drop policy (maximum: 10000 default: zero)
|
|
@@ -701,10 +831,12 @@ module IControl::LocalLB
|
|
|
701
831
|
end
|
|
702
832
|
|
|
703
833
|
##
|
|
704
|
-
# Sets the drop limit factor. A larger value increases the hard drop limit. This is
|
|
705
|
-
#
|
|
706
|
-
# @
|
|
707
|
-
# @raise [IControl::Common::
|
|
834
|
+
# Sets the drop limit factor. A larger value increases the hard drop limit. This is
|
|
835
|
+
# only valid for the &quot;fred" type.
|
|
836
|
+
# @rspec_example
|
|
837
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
838
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
839
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
708
840
|
# @param [Hash] opts
|
|
709
841
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
710
842
|
# @option opts [long] :factors Drop limit factor for each specified drop policy (arbitrary units 0-400, default: zero)
|
|
@@ -714,10 +846,12 @@ module IControl::LocalLB
|
|
|
714
846
|
end
|
|
715
847
|
|
|
716
848
|
##
|
|
717
|
-
# Sets the maximum number of active connections for each queue. This is only valid
|
|
718
|
-
#
|
|
719
|
-
# @
|
|
720
|
-
# @raise [IControl::Common::
|
|
849
|
+
# Sets the maximum number of active connections for each queue. This is only valid
|
|
850
|
+
# for the &quot;fred" type.
|
|
851
|
+
# @rspec_example
|
|
852
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
853
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
854
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
721
855
|
# @param [Hash] opts
|
|
722
856
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
723
857
|
# @option opts [long] :max_conns Maximum number of connections for each specified drop policy (maximum: 10000. default: zero (disables the active connection limitation))
|
|
@@ -727,10 +861,13 @@ module IControl::LocalLB
|
|
|
727
861
|
end
|
|
728
862
|
|
|
729
863
|
##
|
|
730
|
-
# Sets the maximum probability for dropping packets when the average queue length is
|
|
731
|
-
#
|
|
732
|
-
#
|
|
733
|
-
# @
|
|
864
|
+
# Sets the maximum probability for dropping packets when the average queue length is
|
|
865
|
+
# between the minimum and maximum thresholds. This is only used for the &quot;red"
|
|
866
|
+
# and &quot;fred" types.
|
|
867
|
+
# @rspec_example
|
|
868
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
869
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
870
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
734
871
|
# @param [Hash] opts
|
|
735
872
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
736
873
|
# @option opts [long] :probabilities Maximum probability (percent) for each specified drop policy (default: zero)
|
|
@@ -740,10 +877,13 @@ module IControl::LocalLB
|
|
|
740
877
|
end
|
|
741
878
|
|
|
742
879
|
##
|
|
743
|
-
# Sets the maximum queue size. If a queue exceeds that size, any additional packets
|
|
744
|
-
#
|
|
745
|
-
#
|
|
746
|
-
# @
|
|
880
|
+
# Sets the maximum queue size. If a queue exceeds that size, any additional packets
|
|
881
|
+
# are dropped if the rate filter is throttling traffic. This is only valid for the
|
|
882
|
+
# &quot;red" type.
|
|
883
|
+
# @rspec_example
|
|
884
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
885
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
886
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
747
887
|
# @param [Hash] opts
|
|
748
888
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
749
889
|
# @option opts [long] :max_sizes Maximum queue size for each specified drop policy (bytes) (default: zero)
|
|
@@ -753,10 +893,13 @@ module IControl::LocalLB
|
|
|
753
893
|
end
|
|
754
894
|
|
|
755
895
|
##
|
|
756
|
-
# Sets the queue length threshold above which packets are dropped when the rate filter
|
|
757
|
-
#
|
|
758
|
-
#
|
|
759
|
-
# @
|
|
896
|
+
# Sets the queue length threshold above which packets are dropped when the rate filter
|
|
897
|
+
# is throttling traffic. This is only used for the &quot;red" and &quot;fred"
|
|
898
|
+
# types.
|
|
899
|
+
# @rspec_example
|
|
900
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
901
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
902
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
760
903
|
# @param [Hash] opts
|
|
761
904
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
762
905
|
# @option opts [long] :thresholds Queue length above which packets are dropped for each specified drop policy (default: zero)
|
|
@@ -766,10 +909,13 @@ module IControl::LocalLB
|
|
|
766
909
|
end
|
|
767
910
|
|
|
768
911
|
##
|
|
769
|
-
# Sets the queue length threshold below which packets are not dropped when the rate
|
|
770
|
-
#
|
|
771
|
-
#
|
|
772
|
-
# @
|
|
912
|
+
# Sets the queue length threshold below which packets are not dropped when the rate
|
|
913
|
+
# filter is throttling traffic. This is only used for the &quot;red" and &quot;fred"
|
|
914
|
+
# types.
|
|
915
|
+
# @rspec_example
|
|
916
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
917
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
918
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
773
919
|
# @param [Hash] opts
|
|
774
920
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
775
921
|
# @option opts [long] :thresholds Queue length below which packets are not dropped for each specified drop policy (default: zero)
|
|
@@ -779,10 +925,12 @@ module IControl::LocalLB
|
|
|
779
925
|
end
|
|
780
926
|
|
|
781
927
|
##
|
|
782
|
-
# Sets the no-drop limit factor. A larger value prevents packets from being dropped.
|
|
783
|
-
#
|
|
784
|
-
# @
|
|
785
|
-
# @raise [IControl::Common::
|
|
928
|
+
# Sets the no-drop limit factor. A larger value prevents packets from being dropped.
|
|
929
|
+
# This is only valid for the &quot;fred" type.
|
|
930
|
+
# @rspec_example
|
|
931
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
932
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
933
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
786
934
|
# @param [Hash] opts
|
|
787
935
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
788
936
|
# @option opts [long] :factors No-drop limit factor for each specified drop policy (arbitrary units 0-100, default: zero)
|
|
@@ -792,10 +940,12 @@ module IControl::LocalLB
|
|
|
792
940
|
end
|
|
793
941
|
|
|
794
942
|
##
|
|
795
|
-
# Sets the drop policy type, i.e., the general strategy for a rate filter's dropping
|
|
796
|
-
#
|
|
797
|
-
# @
|
|
798
|
-
# @raise [IControl::Common::
|
|
943
|
+
# Sets the drop policy type, i.e., the general strategy for a rate filter's dropping
|
|
944
|
+
# packets when throttling traffic. See the DropPolicyType enumeration for details.
|
|
945
|
+
# @rspec_example
|
|
946
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
947
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
948
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
799
949
|
# @param [Hash] opts
|
|
800
950
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
801
951
|
# @option opts [IControl::LocalLB::RateClass::DropPolicyType] :types Drop policy type for each specified drop policy (default: DROP_TAIL)
|
|
@@ -805,10 +955,12 @@ module IControl::LocalLB
|
|
|
805
955
|
end
|
|
806
956
|
|
|
807
957
|
##
|
|
808
|
-
# Sets the weight used to calculate the average lengths of the rate filter's queues.
|
|
809
|
-
#
|
|
810
|
-
# @
|
|
811
|
-
# @raise [IControl::Common::
|
|
958
|
+
# Sets the weight used to calculate the average lengths of the rate filter's queues.
|
|
959
|
+
# This is only used for the &quot;red" and &quot;fred" types.
|
|
960
|
+
# @rspec_example
|
|
961
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
962
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
963
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
812
964
|
# @param [Hash] opts
|
|
813
965
|
# @option opts [String] :drop_policies Names of the drop policies to modify
|
|
814
966
|
# @option opts [long] :weights Weight used to calculate the average queue length for each specified drop policy (valid: 0, 64, 128, 256, 512. default: zero).
|
|
@@ -818,10 +970,14 @@ module IControl::LocalLB
|
|
|
818
970
|
end
|
|
819
971
|
|
|
820
972
|
##
|
|
821
|
-
# Sets the name of the parent rate class. Any child Rate Class has the ability to borrow
|
|
822
|
-
#
|
|
823
|
-
#
|
|
824
|
-
#
|
|
973
|
+
# Sets the name of the parent rate class. Any child Rate Class has the ability to borrow
|
|
974
|
+
# bandwidth from its parent. If the parent rate class is not specified in the definition
|
|
975
|
+
# of a rate class, the Rate Class is not a child, but may be a parent if another Rate
|
|
976
|
+
# Class refers to it as such.
|
|
977
|
+
# @rspec_example
|
|
978
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
979
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
980
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
825
981
|
# @param [Hash] opts
|
|
826
982
|
# @option opts [String] :parents The parent rate class names.
|
|
827
983
|
def set_parent(opts)
|
|
@@ -830,10 +986,12 @@ module IControl::LocalLB
|
|
|
830
986
|
end
|
|
831
987
|
|
|
832
988
|
##
|
|
833
|
-
# Sets base rate by specifying a percentage of the parent's base rate. The base rate
|
|
834
|
-
#
|
|
835
|
-
# @
|
|
836
|
-
# @raise [IControl::Common::
|
|
989
|
+
# Sets base rate by specifying a percentage of the parent's base rate. The base rate
|
|
990
|
+
# is the maximum throughput for traffic handled by the rate filter.
|
|
991
|
+
# @rspec_example
|
|
992
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
993
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
994
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
837
995
|
# @param [Hash] opts
|
|
838
996
|
# @option opts [long] :percents Percent of the parent's base rate for each specified rate filter class (default: zero, i.e., the base rate is specified as bandwidth (see set_base_rate))
|
|
839
997
|
def set_percent_of_parent_base_rate(opts)
|
|
@@ -842,10 +1000,13 @@ module IControl::LocalLB
|
|
|
842
1000
|
end
|
|
843
1001
|
|
|
844
1002
|
##
|
|
845
|
-
# Sets the ceiling rate by specifying a percentage of the parent's ceiling rate. The
|
|
846
|
-
#
|
|
847
|
-
#
|
|
848
|
-
# @
|
|
1003
|
+
# Sets the ceiling rate by specifying a percentage of the parent's ceiling rate. The
|
|
1004
|
+
# ceiling rate specifies the absolute throughput limit for traffic handled by the rate
|
|
1005
|
+
# filter.
|
|
1006
|
+
# @rspec_example
|
|
1007
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1008
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1009
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
849
1010
|
# @param [Hash] opts
|
|
850
1011
|
# @option opts [long] :percents Percent of the parent's ceiling rate for each specified rate filter class (default: zero, i.e., the ceiling rate is specified as bandwidth (see set_ceiling_rate)
|
|
851
1012
|
def set_percent_of_parent_ceiling_rate(opts)
|
|
@@ -854,10 +1015,12 @@ module IControl::LocalLB
|
|
|
854
1015
|
end
|
|
855
1016
|
|
|
856
1017
|
##
|
|
857
|
-
# Sets the queue types to be used by this rate classe. See also the set_queueing_method
|
|
858
|
-
#
|
|
859
|
-
# @
|
|
860
|
-
# @raise [IControl::Common::
|
|
1018
|
+
# Sets the queue types to be used by this rate classe. See also the set_queueing_method
|
|
1019
|
+
# method.
|
|
1020
|
+
# @rspec_example
|
|
1021
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1022
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1023
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
861
1024
|
# @param [Hash] opts
|
|
862
1025
|
# @option opts [IControl::LocalLB::RateClass::QueueType] :queue_types The queue types to set for the rate classes.
|
|
863
1026
|
def set_queue_type(opts)
|
|
@@ -866,10 +1029,17 @@ module IControl::LocalLB
|
|
|
866
1029
|
end
|
|
867
1030
|
|
|
868
1031
|
##
|
|
869
|
-
# Sets the queueing method, specifying how packets are queued for rate filtering, effectively
|
|
870
|
-
#
|
|
871
|
-
#
|
|
872
|
-
#
|
|
1032
|
+
# Sets the queueing method, specifying how packets are queued for rate filtering, effectively
|
|
1033
|
+
# determining the class of traffic which is dropped, if necessary. Two pre-defined
|
|
1034
|
+
# methods exist. &quot;sfq" queues traffic according to the connection information,
|
|
1035
|
+
# i.e., being fair to individual connections. &quot;pfifo" queues traffic according
|
|
1036
|
+
# to the Type of Service (ToS) packet field. This method is a more expansive version
|
|
1037
|
+
# of the set_queue_type method, whose two enumerated types map exactly to the pre-defined
|
|
1038
|
+
# &quot;pfifo" and &quot;sfq" objects.
|
|
1039
|
+
# @rspec_example
|
|
1040
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1041
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1042
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
873
1043
|
# @param [Hash] opts
|
|
874
1044
|
# @option opts [String] :methods Name of the queueing method object for each specified rate filter class (default: "sfq")
|
|
875
1045
|
def set_queueing_method(opts)
|
|
@@ -878,10 +1048,12 @@ module IControl::LocalLB
|
|
|
878
1048
|
end
|
|
879
1049
|
|
|
880
1050
|
##
|
|
881
|
-
# Sets the number of the buckets used to divide the traffic for each queue. This is
|
|
882
|
-
#
|
|
883
|
-
# @
|
|
884
|
-
# @raise [IControl::Common::
|
|
1051
|
+
# Sets the number of the buckets used to divide the traffic for each queue. This is
|
|
1052
|
+
# only used by the stochastic fair queueing type.
|
|
1053
|
+
# @rspec_example
|
|
1054
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1055
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1056
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
885
1057
|
# @param [Hash] opts
|
|
886
1058
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
887
1059
|
# @option opts [long] :bucket_counts Number of buckets for each specified queueing method (valid: 0, 16, 32, 64, 128, 256, 512, 1024 default: zero)
|
|
@@ -891,10 +1063,12 @@ module IControl::LocalLB
|
|
|
891
1063
|
end
|
|
892
1064
|
|
|
893
1065
|
##
|
|
894
|
-
# Sets the size of the buckets used to divide the traffic for each queue. This is only
|
|
895
|
-
#
|
|
896
|
-
# @
|
|
897
|
-
# @raise [IControl::Common::
|
|
1066
|
+
# Sets the size of the buckets used to divide the traffic for each queue. This is only
|
|
1067
|
+
# used by the stochastic fair queueing type.
|
|
1068
|
+
# @rspec_example
|
|
1069
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1070
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1071
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
898
1072
|
# @param [Hash] opts
|
|
899
1073
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
900
1074
|
# @option opts [long] :bucket_sizes Bucket size (bytes) for each specified queueing method (default: zero)
|
|
@@ -905,9 +1079,10 @@ module IControl::LocalLB
|
|
|
905
1079
|
|
|
906
1080
|
##
|
|
907
1081
|
# Sets the maximum queue size. This is only used by the Priority FIFO queueing type.
|
|
908
|
-
# @
|
|
909
|
-
# @raise [IControl::Common::
|
|
910
|
-
# @raise [IControl::Common::
|
|
1082
|
+
# @rspec_example
|
|
1083
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1084
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1085
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
911
1086
|
# @param [Hash] opts
|
|
912
1087
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
913
1088
|
# @option opts [long] :max_sizes Maximum queue size (bytes) for each specified queueing method (default: zero)
|
|
@@ -918,9 +1093,10 @@ module IControl::LocalLB
|
|
|
918
1093
|
|
|
919
1094
|
##
|
|
920
1095
|
# Sets the minimum queue size. This is only used by the Priority FIFO queueing type.
|
|
921
|
-
# @
|
|
922
|
-
# @raise [IControl::Common::
|
|
923
|
-
# @raise [IControl::Common::
|
|
1096
|
+
# @rspec_example
|
|
1097
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1098
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1099
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
924
1100
|
# @param [Hash] opts
|
|
925
1101
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
926
1102
|
# @option opts [long] :min_sizes Minimum queue size (bytes) for each specified queueing method (default: zero)
|
|
@@ -930,10 +1106,12 @@ module IControl::LocalLB
|
|
|
930
1106
|
end
|
|
931
1107
|
|
|
932
1108
|
##
|
|
933
|
-
# Sets the perturbation interval, i.e. the interval at which the rate filter reconfigures
|
|
934
|
-
#
|
|
935
|
-
# @
|
|
936
|
-
# @raise [IControl::Common::
|
|
1109
|
+
# Sets the perturbation interval, i.e. the interval at which the rate filter reconfigures
|
|
1110
|
+
# the bucket hash function. This is only used by the stochastic fair queueing type.
|
|
1111
|
+
# @rspec_example
|
|
1112
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1113
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1114
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
937
1115
|
# @param [Hash] opts
|
|
938
1116
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
939
1117
|
# @option opts [long] :intervals Perturbation interval (seconds) for each specified queueing method (default: 10sec)
|
|
@@ -943,10 +1121,12 @@ module IControl::LocalLB
|
|
|
943
1121
|
end
|
|
944
1122
|
|
|
945
1123
|
##
|
|
946
|
-
# Sets the queueing method type, i.e., the method use to store and remove traffic from
|
|
947
|
-
#
|
|
948
|
-
# @
|
|
949
|
-
# @raise [IControl::Common::
|
|
1124
|
+
# Sets the queueing method type, i.e., the method use to store and remove traffic from
|
|
1125
|
+
# the queues managed by a rate filter. See the QueueType enumeration for more details.
|
|
1126
|
+
# @rspec_example
|
|
1127
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1128
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1129
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
950
1130
|
# @param [Hash] opts
|
|
951
1131
|
# @option opts [String] :queues Names of the queueing methods to modify
|
|
952
1132
|
# @option opts [IControl::LocalLB::RateClass::QueueType] :types Queueing method type for each specified queueing method (default: none, i.e., this must be specified)
|
|
@@ -956,10 +1136,16 @@ module IControl::LocalLB
|
|
|
956
1136
|
end
|
|
957
1137
|
|
|
958
1138
|
##
|
|
959
|
-
# Sets the shaping policy, used to specify custom drop policies and queueing methods.
|
|
960
|
-
#
|
|
961
|
-
#
|
|
962
|
-
#
|
|
1139
|
+
# Sets the shaping policy, used to specify custom drop policies and queueing methods.
|
|
1140
|
+
# A shaping policy encapsulates a set of rate filter class configuration attributes
|
|
1141
|
+
# into a single object. Once created, this object can be used to create rate filter
|
|
1142
|
+
# classes more easily, by specifying a shaping policy rather than all of its attributes
|
|
1143
|
+
# individually. Note that this is purely a convenience interface. There is nothing
|
|
1144
|
+
# in a shaping policy which cannot also be done via a rate filter class object.
|
|
1145
|
+
# @rspec_example
|
|
1146
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1147
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1148
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
963
1149
|
# @param [Hash] opts
|
|
964
1150
|
# @option opts [String] :policies Name of the shaping policy object for each specified rate filter class (default: none)
|
|
965
1151
|
def set_shaping_policy(opts)
|
|
@@ -968,10 +1154,12 @@ module IControl::LocalLB
|
|
|
968
1154
|
end
|
|
969
1155
|
|
|
970
1156
|
##
|
|
971
|
-
# Sets the burst size in a shaping policy, the maximum number of bytes that traffic
|
|
972
|
-
#
|
|
973
|
-
# @
|
|
974
|
-
# @raise [IControl::Common::
|
|
1157
|
+
# Sets the burst size in a shaping policy, the maximum number of bytes that traffic
|
|
1158
|
+
# is allowed to burst beyond the base rate.
|
|
1159
|
+
# @rspec_example
|
|
1160
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1161
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1162
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
975
1163
|
# @param [Hash] opts
|
|
976
1164
|
# @option opts [String] :policies Names of the shaping policies to modify
|
|
977
1165
|
# @option opts [long] :burst_sizes Burst size (bytes) for each specified shaping policy
|
|
@@ -981,10 +1169,15 @@ module IControl::LocalLB
|
|
|
981
1169
|
end
|
|
982
1170
|
|
|
983
1171
|
##
|
|
984
|
-
# Sets the name of the drop policy in a shaping policy, specifying how the rate filter
|
|
985
|
-
#
|
|
986
|
-
#
|
|
987
|
-
#
|
|
1172
|
+
# Sets the name of the drop policy in a shaping policy, specifying how the rate filter
|
|
1173
|
+
# drops packets when throttling traffic. Three pre-defined drop policies exist. &quot;fred"
|
|
1174
|
+
# drops packets according to the type of traffic. &quot;red" drops packets randomly.
|
|
1175
|
+
# &quot;tail" drops packets from the end of the queues. See the drop policy methods
|
|
1176
|
+
# for more information.
|
|
1177
|
+
# @rspec_example
|
|
1178
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1179
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1180
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
988
1181
|
# @param [Hash] opts
|
|
989
1182
|
# @option opts [String] :policies Names of the shaping policies to modify
|
|
990
1183
|
# @option opts [String] :drop_policies Name of the drop policy for each specified shaping policy (default: "tail")
|
|
@@ -994,10 +1187,13 @@ module IControl::LocalLB
|
|
|
994
1187
|
end
|
|
995
1188
|
|
|
996
1189
|
##
|
|
997
|
-
# Sets base rate in a shaping policy by specifying a percentage of the parent's rate
|
|
998
|
-
#
|
|
999
|
-
#
|
|
1000
|
-
# @
|
|
1190
|
+
# Sets base rate in a shaping policy by specifying a percentage of the parent's rate
|
|
1191
|
+
# filter class' base rate. The base rate is the maximum throughput for traffic handled
|
|
1192
|
+
# by the rate filter.
|
|
1193
|
+
# @rspec_example
|
|
1194
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1195
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1196
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1001
1197
|
# @param [Hash] opts
|
|
1002
1198
|
# @option opts [String] :policies Names of the shaping policies to modify
|
|
1003
1199
|
# @option opts [long] :percents Percent of parent base rates for each specified shaping policy (default: zero)
|
|
@@ -1007,10 +1203,13 @@ module IControl::LocalLB
|
|
|
1007
1203
|
end
|
|
1008
1204
|
|
|
1009
1205
|
##
|
|
1010
|
-
# Sets the ceiling rate for a shaping policy by specifying a percentage of the parent's
|
|
1011
|
-
#
|
|
1012
|
-
#
|
|
1013
|
-
# @
|
|
1206
|
+
# Sets the ceiling rate for a shaping policy by specifying a percentage of the parent's
|
|
1207
|
+
# rate filter class' ceiling rate. The ceiling rate specifies the absolute throughput
|
|
1208
|
+
# limit for traffic handled by the rate filter.
|
|
1209
|
+
# @rspec_example
|
|
1210
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1211
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1212
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1014
1213
|
# @param [Hash] opts
|
|
1015
1214
|
# @option opts [String] :policies Names of the shaping policies to modify
|
|
1016
1215
|
# @option opts [long] :percents Percent of parent base rates (default: zero) for each specified shaping policy
|
|
@@ -1020,10 +1219,16 @@ module IControl::LocalLB
|
|
|
1020
1219
|
end
|
|
1021
1220
|
|
|
1022
1221
|
##
|
|
1023
|
-
# Sets the queueing method for a shaping policy, specifying how packets are queued
|
|
1024
|
-
#
|
|
1025
|
-
#
|
|
1026
|
-
#
|
|
1222
|
+
# Sets the queueing method for a shaping policy, specifying how packets are queued
|
|
1223
|
+
# for rate filtering, effectively determining the class of traffic which is dropped
|
|
1224
|
+
# if necessary. Two pre-defined methods exist. &quot;sfq" queues traffic according
|
|
1225
|
+
# to the connection information, i.e., fair to individual connections. &quot;pfifo"
|
|
1226
|
+
# queues traffic according to the Type of Service (ToS) packet field. See the queueing
|
|
1227
|
+
# method methods for more details.
|
|
1228
|
+
# @rspec_example
|
|
1229
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1230
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1231
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1027
1232
|
# @param [Hash] opts
|
|
1028
1233
|
# @option opts [String] :policies Names of the shaping policies to modify
|
|
1029
1234
|
# @option opts [String] :methods Name of the queueing method object for each shaping policy (default: "sfq")
|
|
@@ -1035,18 +1240,18 @@ module IControl::LocalLB
|
|
|
1035
1240
|
##
|
|
1036
1241
|
# A struct that describes statistics for a particular rate class.
|
|
1037
1242
|
# @attr [String] rate_class The rate class class name.
|
|
1038
|
-
# @attr [IControl::Common::
|
|
1243
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the rate class.
|
|
1039
1244
|
class RateClassStatisticEntry < IControl::Base::Struct
|
|
1040
1245
|
icontrol_attribute :rate_class, String
|
|
1041
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
1246
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
1042
1247
|
end
|
|
1043
1248
|
|
|
1044
1249
|
##
|
|
1045
1250
|
# A struct that describes rate class statistics and timestamp.
|
|
1046
|
-
# @attr [IControl::LocalLB::RateClass::
|
|
1251
|
+
# @attr [IControl::LocalLB::RateClass::RateClassStatisticEntrySequence] statistics The statistics for a sequence of rate classes.
|
|
1047
1252
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
1048
1253
|
class RateClassStatistics < IControl::Base::Struct
|
|
1049
|
-
icontrol_attribute :statistics, IControl::LocalLB::RateClass::
|
|
1254
|
+
icontrol_attribute :statistics, IControl::LocalLB::RateClass::RateClassStatisticEntrySequence
|
|
1050
1255
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
1051
1256
|
end
|
|
1052
1257
|
|