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
|
@@ -6,134 +6,152 @@ module IControl::LocalLB
|
|
|
6
6
|
set_id_name "profile_names"
|
|
7
7
|
|
|
8
8
|
class ProfileFTPStatisticEntry < IControl::Base::Struct; end
|
|
9
|
-
class ProfileFTPStatistics < IControl::Base::Struct; end
|
|
9
|
+
class ProfileFTPStatistics < IControl::Base::Struct; end
|
|
10
|
+
class ProfileFTPStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
10
11
|
# Creates this FTP profile.
|
|
11
|
-
# @
|
|
12
|
-
# @raise [IControl::Common::
|
|
13
|
-
# @raise [IControl::Common::
|
|
12
|
+
# @rspec_example
|
|
13
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
14
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
15
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
16
|
def create
|
|
15
17
|
super
|
|
16
18
|
end
|
|
17
19
|
|
|
18
20
|
##
|
|
19
21
|
# Deletes all FTP profile.
|
|
20
|
-
# @
|
|
21
|
-
# @raise [IControl::Common::
|
|
22
|
-
# @raise [IControl::Common::
|
|
22
|
+
# @rspec_example
|
|
23
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
24
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
25
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
23
26
|
def delete_all_profiles
|
|
24
27
|
super
|
|
25
28
|
end
|
|
26
29
|
|
|
27
30
|
##
|
|
28
31
|
# Deletes this FTP profile.
|
|
29
|
-
# @
|
|
30
|
-
# @raise [IControl::Common::
|
|
31
|
-
# @raise [IControl::Common::
|
|
32
|
+
# @rspec_example
|
|
33
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
34
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
35
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
32
36
|
def delete_profile
|
|
33
37
|
super
|
|
34
38
|
end
|
|
35
39
|
|
|
36
40
|
##
|
|
37
41
|
# Gets the statistics for all the FTP profile.
|
|
42
|
+
# @rspec_example
|
|
38
43
|
# @return [ProfileFTPStatistics]
|
|
39
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
40
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
41
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
44
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
45
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
46
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
42
47
|
def all_statistics
|
|
43
48
|
super
|
|
44
49
|
end
|
|
45
50
|
|
|
46
51
|
##
|
|
47
52
|
# Gets the data channel port for this FTP profile.
|
|
53
|
+
# @rspec_example
|
|
48
54
|
# @return [ProfilePortNumber]
|
|
49
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
50
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
51
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
55
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
56
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
57
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
52
58
|
def data_channel_port
|
|
53
59
|
super
|
|
54
60
|
end
|
|
55
61
|
|
|
56
62
|
##
|
|
57
|
-
# Gets the names of the default profile from which this profile will derive default
|
|
63
|
+
# Gets the names of the default profile from which this profile will derive default
|
|
64
|
+
# values for its attributes.
|
|
65
|
+
# @rspec_example
|
|
58
66
|
# @return [String]
|
|
59
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
60
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
61
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
67
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
68
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
69
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
62
70
|
def default_profile
|
|
63
71
|
super
|
|
64
72
|
end
|
|
65
73
|
|
|
66
74
|
##
|
|
67
75
|
# Gets a list of all FTP profile.
|
|
76
|
+
# @rspec_example
|
|
68
77
|
# @return [String]
|
|
69
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
70
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
71
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
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.
|
|
72
81
|
def list
|
|
73
82
|
super
|
|
74
83
|
end
|
|
75
84
|
|
|
76
85
|
##
|
|
77
86
|
# Gets the state that if true, enable horizontal security for this FTP profile.
|
|
87
|
+
# @rspec_example
|
|
78
88
|
# @return [ProfileEnabledState]
|
|
79
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
80
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
81
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
89
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
90
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
91
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
82
92
|
def security_enabled_request_state
|
|
83
93
|
super
|
|
84
94
|
end
|
|
85
95
|
|
|
86
96
|
##
|
|
87
97
|
# Gets the statistics for this FTP profile.
|
|
98
|
+
# @rspec_example
|
|
88
99
|
# @return [ProfileFTPStatistics]
|
|
89
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
90
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
91
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
100
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
101
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
102
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
92
103
|
def statistics
|
|
93
104
|
super
|
|
94
105
|
end
|
|
95
106
|
|
|
96
107
|
##
|
|
97
|
-
# Gets the state that if true, automatically translate RFC2428 extended requests EPSV
|
|
108
|
+
# Gets the state that if true, automatically translate RFC2428 extended requests EPSV
|
|
109
|
+
# and EPRT to PASV and PORT when talking to IPv4 servers.
|
|
110
|
+
# @rspec_example
|
|
98
111
|
# @return [ProfileEnabledState]
|
|
99
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
100
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
101
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
112
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
113
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
114
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
102
115
|
def translated_extended_request_state
|
|
103
116
|
super
|
|
104
117
|
end
|
|
105
118
|
|
|
106
119
|
##
|
|
107
120
|
# Gets the version information for this interface.
|
|
121
|
+
# @rspec_example
|
|
108
122
|
# @return [String]
|
|
109
123
|
def version
|
|
110
124
|
super
|
|
111
125
|
end
|
|
112
126
|
|
|
113
127
|
##
|
|
114
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
128
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
129
|
+
# profile.
|
|
130
|
+
# @rspec_example
|
|
115
131
|
# @return [boolean]
|
|
116
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
117
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
118
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
132
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
133
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
134
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
119
135
|
def is_base_profile
|
|
120
136
|
super
|
|
121
137
|
end
|
|
122
138
|
|
|
123
139
|
##
|
|
124
140
|
# Resets the statistics for this FTP profile.
|
|
125
|
-
# @
|
|
126
|
-
# @raise [IControl::Common::
|
|
127
|
-
# @raise [IControl::Common::
|
|
141
|
+
# @rspec_example
|
|
142
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
143
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
144
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
128
145
|
def reset_statistics
|
|
129
146
|
super
|
|
130
147
|
end
|
|
131
148
|
|
|
132
149
|
##
|
|
133
150
|
# Sets the data channel port for this FTP profile.
|
|
134
|
-
# @
|
|
135
|
-
# @raise [IControl::Common::
|
|
136
|
-
# @raise [IControl::Common::
|
|
151
|
+
# @rspec_example
|
|
152
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
153
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
154
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
137
155
|
# @param [Hash] opts
|
|
138
156
|
# @option opts [IControl::LocalLB::ProfilePortNumber] :ports The data channel port for the specified FTP profiles.
|
|
139
157
|
def set_data_channel_port(opts)
|
|
@@ -142,10 +160,12 @@ module IControl::LocalLB
|
|
|
142
160
|
end
|
|
143
161
|
|
|
144
162
|
##
|
|
145
|
-
# Sets the names of the default profile from which this profile will derive default
|
|
146
|
-
#
|
|
147
|
-
# @
|
|
148
|
-
# @raise [IControl::Common::
|
|
163
|
+
# Sets the names of the default profile from which this profile will derive default
|
|
164
|
+
# values for its attributes.
|
|
165
|
+
# @rspec_example
|
|
166
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
167
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
168
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
149
169
|
# @param [Hash] opts
|
|
150
170
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
|
151
171
|
def set_default_profile(opts)
|
|
@@ -155,9 +175,10 @@ module IControl::LocalLB
|
|
|
155
175
|
|
|
156
176
|
##
|
|
157
177
|
# Sets the state that if true, enable horizontal security for this FTP profile.
|
|
158
|
-
# @
|
|
159
|
-
# @raise [IControl::Common::
|
|
160
|
-
# @raise [IControl::Common::
|
|
178
|
+
# @rspec_example
|
|
179
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
180
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
181
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
161
182
|
# @param [Hash] opts
|
|
162
183
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The translate extended request states for the specified profiles.
|
|
163
184
|
def set_security_enabled_request_state(opts)
|
|
@@ -166,10 +187,12 @@ module IControl::LocalLB
|
|
|
166
187
|
end
|
|
167
188
|
|
|
168
189
|
##
|
|
169
|
-
# Sets the state that if true, automatically translate RFC2428 extended requests EPSV
|
|
170
|
-
#
|
|
171
|
-
# @
|
|
172
|
-
# @raise [IControl::Common::
|
|
190
|
+
# Sets the state that if true, automatically translate RFC2428 extended requests EPSV
|
|
191
|
+
# and EPRT to PASV and PORT when talking to IPv4 servers.
|
|
192
|
+
# @rspec_example
|
|
193
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
194
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
195
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
173
196
|
# @param [Hash] opts
|
|
174
197
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The translate extended request states for the specified profiles.
|
|
175
198
|
def set_translated_extended_request_state(opts)
|
|
@@ -180,18 +203,18 @@ module IControl::LocalLB
|
|
|
180
203
|
##
|
|
181
204
|
# A struct that describes statistics for a particular FTP profile.
|
|
182
205
|
# @attr [String] profile_name The profile name.
|
|
183
|
-
# @attr [IControl::Common::
|
|
206
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
|
184
207
|
class ProfileFTPStatisticEntry < IControl::Base::Struct
|
|
185
208
|
icontrol_attribute :profile_name, String
|
|
186
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
209
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
187
210
|
end
|
|
188
211
|
|
|
189
212
|
##
|
|
190
213
|
# A struct that describes profile statistics and timestamp.
|
|
191
|
-
# @attr [IControl::LocalLB::ProfileFTP::
|
|
214
|
+
# @attr [IControl::LocalLB::ProfileFTP::ProfileFTPStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
|
192
215
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
193
216
|
class ProfileFTPStatistics < IControl::Base::Struct
|
|
194
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileFTP::
|
|
217
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileFTP::ProfileFTPStatisticEntrySequence
|
|
195
218
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
196
219
|
end
|
|
197
220
|
|
|
@@ -1,16 +1,23 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The ProfileHttp interface enables you to manipulate a local load balancer's HTTP
|
|
3
|
+
# The ProfileHttp interface enables you to manipulate a local load balancer's HTTP
|
|
4
|
+
# profile.
|
|
4
5
|
class ProfileHttp < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "profile_names"
|
|
7
8
|
|
|
8
9
|
class ProfileHttpStatisticEntry < IControl::Base::Struct; end
|
|
9
|
-
class ProfileHttpStatistics < IControl::Base::Struct; end
|
|
10
|
-
|
|
11
|
-
#
|
|
12
|
-
#
|
|
13
|
-
#
|
|
10
|
+
class ProfileHttpStatistics < IControl::Base::Struct; end
|
|
11
|
+
class ProfileHttpStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
12
|
+
# Adds to the lists of regular expressions used to match the MIME types in the server
|
|
13
|
+
# response's &quot;Content-Type:" headers. No match may be found in any of the
|
|
14
|
+
# &quot;exclude" fields. For example, to disable compression on all PDF and image
|
|
15
|
+
# files, one would use the following in the content_type exclue fields: : &quot;application/pdf"
|
|
16
|
+
# &quot;image/*".
|
|
17
|
+
# @rspec_example
|
|
18
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
19
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
20
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
21
|
# @param [Hash] opts
|
|
15
22
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "exclude" list.
|
|
16
23
|
def add_compression_content_type_exclude(opts)
|
|
@@ -19,10 +26,15 @@ module IControl::LocalLB
|
|
|
19
26
|
end
|
|
20
27
|
|
|
21
28
|
##
|
|
22
|
-
# Adds to the lists of regular expressions used to match the MIME types in the server
|
|
23
|
-
#
|
|
24
|
-
#
|
|
25
|
-
#
|
|
29
|
+
# Adds to the lists of regular expressions used to match the MIME types in the server
|
|
30
|
+
# response's &quot;Content-Type:" headers. A match must be found in at least one
|
|
31
|
+
# of the &quot;include" fields. For example, to enable compression on all PDF and
|
|
32
|
+
# image files, one would use the following in the content_type include fields: : &quot;application/pdf"
|
|
33
|
+
# &quot;image/*".
|
|
34
|
+
# @rspec_example
|
|
35
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
36
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
37
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
26
38
|
# @param [Hash] opts
|
|
27
39
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "include" list.
|
|
28
40
|
def add_compression_content_type_include(opts)
|
|
@@ -31,10 +43,16 @@ module IControl::LocalLB
|
|
|
31
43
|
end
|
|
32
44
|
|
|
33
45
|
##
|
|
34
|
-
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
#
|
|
46
|
+
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
47
|
+
# client requests during compression. (see section 5.1 of RFC2616). No match may be
|
|
48
|
+
# found in any of the &quot;exclude" fields. For example, to disable compressing
|
|
49
|
+
# requests ending in &quot;.txt", &quot;.htm" and &quot;.html", one would
|
|
50
|
+
# use the following in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm"
|
|
51
|
+
# &quot;*.html"
|
|
52
|
+
# @rspec_example
|
|
53
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
54
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
55
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
38
56
|
# @param [Hash] opts
|
|
39
57
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "exclude" list.
|
|
40
58
|
def add_compression_uri_exclude(opts)
|
|
@@ -43,10 +61,15 @@ module IControl::LocalLB
|
|
|
43
61
|
end
|
|
44
62
|
|
|
45
63
|
##
|
|
46
|
-
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
64
|
+
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
65
|
+
# client requests during compression. (see section 5.1 of RFC2616). A match must be
|
|
66
|
+
# found in at least one of the &quot;include" fields. For example, to include requests
|
|
67
|
+
# ending in &quot;.txt", &quot;.htm" and &quot;.html", one would use the
|
|
68
|
+
# following in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
69
|
+
# @rspec_example
|
|
70
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
71
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
72
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
50
73
|
# @param [Hash] opts
|
|
51
74
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "include" list.
|
|
52
75
|
def add_compression_uri_include(opts)
|
|
@@ -56,9 +79,10 @@ module IControl::LocalLB
|
|
|
56
79
|
|
|
57
80
|
##
|
|
58
81
|
# Adds to the lists of cookies to be encrypted before sending them to the clients.
|
|
59
|
-
# @
|
|
60
|
-
# @raise [IControl::Common::
|
|
61
|
-
# @raise [IControl::Common::
|
|
82
|
+
# @rspec_example
|
|
83
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
84
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
85
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
62
86
|
# @param [Hash] opts
|
|
63
87
|
# @option opts [String[]] :cookies The lists of cookies to be encrypted.
|
|
64
88
|
def add_cookie_encryption(opts)
|
|
@@ -67,10 +91,13 @@ module IControl::LocalLB
|
|
|
67
91
|
end
|
|
68
92
|
|
|
69
93
|
##
|
|
70
|
-
# Adds to the lists of status codes that when matched, traffic will be sent to the
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
# @
|
|
94
|
+
# Adds to the lists of status codes that when matched, traffic will be sent to the
|
|
95
|
+
# &quot;fallback_host". An exception will be thrown if fallback status codes are
|
|
96
|
+
# set when &quot;fallback_host" has not been specified.
|
|
97
|
+
# @rspec_example
|
|
98
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
99
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
100
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
74
101
|
# @param [Hash] opts
|
|
75
102
|
# @option opts [String[]] :status_codes The lists of status codes.
|
|
76
103
|
def add_fallback_status_code(opts)
|
|
@@ -80,9 +107,10 @@ module IControl::LocalLB
|
|
|
80
107
|
|
|
81
108
|
##
|
|
82
109
|
# Adds to the lists of permitted headers in the responses for this HTTP profile.
|
|
83
|
-
# @
|
|
84
|
-
# @raise [IControl::Common::
|
|
85
|
-
# @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.
|
|
86
114
|
# @param [Hash] opts
|
|
87
115
|
# @option opts [String[]] :headers The lists of permitted response headers.
|
|
88
116
|
def add_permitted_response_header(opts)
|
|
@@ -91,10 +119,16 @@ module IControl::LocalLB
|
|
|
91
119
|
end
|
|
92
120
|
|
|
93
121
|
##
|
|
94
|
-
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
122
|
+
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
123
|
+
# client requests during caching. (see section 5.1 of RFC2616). No match may be found
|
|
124
|
+
# in any of the &quot;exclude" fields. For example, to disable compressing requests
|
|
125
|
+
# ending in &quot;.txt", &quot;.htm" and &quot;.html", one would use the
|
|
126
|
+
# following in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm"
|
|
127
|
+
# &quot;*.html"
|
|
128
|
+
# @rspec_example
|
|
129
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
130
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
131
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
98
132
|
# @param [Hash] opts
|
|
99
133
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "exclude" list.
|
|
100
134
|
def add_ramcache_uri_exclude(opts)
|
|
@@ -103,10 +137,15 @@ module IControl::LocalLB
|
|
|
103
137
|
end
|
|
104
138
|
|
|
105
139
|
##
|
|
106
|
-
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
#
|
|
140
|
+
# Adds to the lists of regular expressions used to match the request URI part of the
|
|
141
|
+
# client requests during caching. (see section 5.1 of RFC2616). A match must be found
|
|
142
|
+
# in at least one of the &quot;include" fields. For example, to include requests
|
|
143
|
+
# ending in &quot;.txt", &quot;.htm" and &quot;.html", one would use the
|
|
144
|
+
# following in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
145
|
+
# @rspec_example
|
|
146
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
147
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
148
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
110
149
|
# @param [Hash] opts
|
|
111
150
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "include" list.
|
|
112
151
|
def add_ramcache_uri_include(opts)
|
|
@@ -116,9 +155,10 @@ module IControl::LocalLB
|
|
|
116
155
|
|
|
117
156
|
##
|
|
118
157
|
# Adds to the lists of cachable document URIs that will never be evicted from the cache.
|
|
119
|
-
# @
|
|
120
|
-
# @raise [IControl::Common::
|
|
121
|
-
# @raise [IControl::Common::
|
|
158
|
+
# @rspec_example
|
|
159
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
160
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
161
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
122
162
|
# @param [Hash] opts
|
|
123
163
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be added to the "pinned" list.
|
|
124
164
|
def add_ramcache_uri_pinned(opts)
|
|
@@ -128,573 +168,690 @@ module IControl::LocalLB
|
|
|
128
168
|
|
|
129
169
|
##
|
|
130
170
|
# Creates this HTTP profile.
|
|
131
|
-
# @
|
|
132
|
-
# @raise [IControl::Common::
|
|
133
|
-
# @raise [IControl::Common::
|
|
171
|
+
# @rspec_example
|
|
172
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
173
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
174
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
134
175
|
def create
|
|
135
176
|
super
|
|
136
177
|
end
|
|
137
178
|
|
|
138
179
|
##
|
|
139
180
|
# Deletes all HTTP profile.
|
|
140
|
-
# @
|
|
141
|
-
# @raise [IControl::Common::
|
|
142
|
-
# @raise [IControl::Common::
|
|
181
|
+
# @rspec_example
|
|
182
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
183
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
184
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
143
185
|
def delete_all_profiles
|
|
144
186
|
super
|
|
145
187
|
end
|
|
146
188
|
|
|
147
189
|
##
|
|
148
190
|
# Deletes this HTTP profile.
|
|
149
|
-
# @
|
|
150
|
-
# @raise [IControl::Common::
|
|
151
|
-
# @raise [IControl::Common::
|
|
191
|
+
# @rspec_example
|
|
192
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
193
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
194
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
152
195
|
def delete_profile
|
|
153
196
|
super
|
|
154
197
|
end
|
|
155
198
|
|
|
156
199
|
##
|
|
157
200
|
# Gets the statistics for all the HTTP profile.
|
|
201
|
+
# @rspec_example
|
|
158
202
|
# @return [ProfileHttpStatistics]
|
|
159
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
160
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
161
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
203
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
204
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
205
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
162
206
|
def all_statistics
|
|
163
207
|
super
|
|
164
208
|
end
|
|
165
209
|
|
|
166
210
|
##
|
|
167
211
|
# Gets the basic authentication realms for this HTTP profile.
|
|
212
|
+
# @rspec_example
|
|
168
213
|
# @return [ProfileString]
|
|
169
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
170
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
171
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
214
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
215
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
216
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
172
217
|
def basic_auth_realm
|
|
173
218
|
super
|
|
174
219
|
end
|
|
175
220
|
|
|
176
221
|
##
|
|
177
|
-
# Gets the states that specify whether we will allow compression on responses to HTTP
|
|
222
|
+
# Gets the states that specify whether we will allow compression on responses to HTTP
|
|
223
|
+
# 1.0 requests. Default will be &quot;false", i.e. disallowing compression on HTTP
|
|
224
|
+
# 1.0 responses.
|
|
225
|
+
# @rspec_example
|
|
178
226
|
# @return [ProfileEnabledState]
|
|
179
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
180
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
181
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
227
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
228
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
229
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
182
230
|
def compression_allow_http_10_state
|
|
183
231
|
super
|
|
184
232
|
end
|
|
185
233
|
|
|
186
234
|
##
|
|
187
235
|
# Gets the states that specify whether to workaround browser bugs when doing compression.
|
|
236
|
+
# @rspec_example
|
|
188
237
|
# @return [ProfileEnabledState]
|
|
189
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
190
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
191
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
238
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
239
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
240
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
192
241
|
def compression_browser_workaround_state
|
|
193
242
|
super
|
|
194
243
|
end
|
|
195
244
|
|
|
196
245
|
##
|
|
197
|
-
# Gets the values that specify the maximum number of uncompressed bytes that the compression
|
|
246
|
+
# Gets the values that specify the maximum number of uncompressed bytes that the compression
|
|
247
|
+
# proxy will buffer before it decides whether or not to compress the server's response,
|
|
248
|
+
# in case the server's response headers don't specify the content length of the response.
|
|
249
|
+
# @rspec_example
|
|
198
250
|
# @return [ProfileULong]
|
|
199
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
200
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
201
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
251
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
252
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
253
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
202
254
|
def compression_buffer_size
|
|
203
255
|
super
|
|
204
256
|
end
|
|
205
257
|
|
|
206
258
|
##
|
|
207
|
-
# Gets the lists of regular expressions used to match the MIME types in the server
|
|
259
|
+
# Gets the lists of regular expressions used to match the MIME types in the server
|
|
260
|
+
# response's &quot;Content-Type:" headers. No match may be found in any of the
|
|
261
|
+
# &quot;exclude" fields. For example, to disable compression on all PDF and image
|
|
262
|
+
# files, one would use the following in the content_type exclue fields: : &quot;application/pdf"
|
|
263
|
+
# &quot;image/*".
|
|
264
|
+
# @rspec_example
|
|
208
265
|
# @return [ProfileStringArray]
|
|
209
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
210
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
211
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
266
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
267
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
268
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
212
269
|
def compression_content_type_exclude
|
|
213
270
|
super
|
|
214
271
|
end
|
|
215
272
|
|
|
216
273
|
##
|
|
217
|
-
# Gets the lists of regular expressions used to match the MIME types in the server
|
|
274
|
+
# Gets the lists of regular expressions used to match the MIME types in the server
|
|
275
|
+
# response's &quot;Content-Type:" headers. A match must be found in at least one
|
|
276
|
+
# of the &quot;include" fields. For example, to enable compression on all PDF and
|
|
277
|
+
# image files, one would use the following in the content_type include fields: : &quot;application/pdf"
|
|
278
|
+
# &quot;image/*".
|
|
279
|
+
# @rspec_example
|
|
218
280
|
# @return [ProfileStringArray]
|
|
219
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
220
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
221
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
281
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
282
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
283
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
222
284
|
def compression_content_type_include
|
|
223
285
|
super
|
|
224
286
|
end
|
|
225
287
|
|
|
226
288
|
##
|
|
227
|
-
# Gets the CPU saver high threshold that basically switches to NULL compression when
|
|
289
|
+
# Gets the CPU saver high threshold that basically switches to NULL compression when
|
|
290
|
+
# CPU utilization exceeds this value.
|
|
291
|
+
# @rspec_example
|
|
228
292
|
# @return [ProfileULong]
|
|
229
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
230
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
231
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
293
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
294
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
295
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
232
296
|
def compression_cpu_saver_high_threshold
|
|
233
297
|
super
|
|
234
298
|
end
|
|
235
299
|
|
|
236
300
|
##
|
|
237
|
-
# Gets the CPU saver low threshold that basically enables full throttle on compression
|
|
301
|
+
# Gets the CPU saver low threshold that basically enables full throttle on compression
|
|
302
|
+
# when CPU utilization drops below this value.
|
|
303
|
+
# @rspec_example
|
|
238
304
|
# @return [ProfileULong]
|
|
239
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
240
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
241
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
305
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
306
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
307
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
242
308
|
def compression_cpu_saver_low_threshold
|
|
243
309
|
super
|
|
244
310
|
end
|
|
245
311
|
|
|
246
312
|
##
|
|
247
313
|
# Gets the states that specify whether to enable CPU saving mode when doing compression.
|
|
314
|
+
# @rspec_example
|
|
248
315
|
# @return [ProfileEnabledState]
|
|
249
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
250
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
251
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
316
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
317
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
318
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
252
319
|
def compression_cpu_saver_state
|
|
253
320
|
super
|
|
254
321
|
end
|
|
255
322
|
|
|
256
323
|
##
|
|
257
324
|
# Gets the compression level used by this HTTP profile.
|
|
325
|
+
# @rspec_example
|
|
258
326
|
# @return [ProfileULong]
|
|
259
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
260
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
261
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
327
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
328
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
329
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
262
330
|
def compression_level
|
|
263
331
|
super
|
|
264
332
|
end
|
|
265
333
|
|
|
266
334
|
##
|
|
267
|
-
# Gets the amount of memory (in bytes) that the will be used for the internal compression
|
|
335
|
+
# Gets the amount of memory (in bytes) that the will be used for the internal compression
|
|
336
|
+
# state for each compressed response. Smaller values will be slower and will produce
|
|
337
|
+
# smaller compression ratios, whereas larger values will be faster and produce larger
|
|
338
|
+
# compression ratios. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K,
|
|
339
|
+
# 256K and represent power-of-2 values (kilobytes). The default value will be 8K.
|
|
340
|
+
# @rspec_example
|
|
268
341
|
# @return [ProfileULong]
|
|
269
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
270
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
271
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
342
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
343
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
344
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
272
345
|
def compression_memory_level
|
|
273
346
|
super
|
|
274
347
|
end
|
|
275
348
|
|
|
276
349
|
##
|
|
277
|
-
# Gets the values that specify the minimmum length of the server responses (in bytes)
|
|
350
|
+
# Gets the values that specify the minimmum length of the server responses (in bytes)
|
|
351
|
+
# to be considered acceptable for compression.
|
|
352
|
+
# @rspec_example
|
|
278
353
|
# @return [ProfileULong]
|
|
279
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
280
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
281
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
354
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
355
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
356
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
282
357
|
def compression_minimum_size
|
|
283
358
|
super
|
|
284
359
|
end
|
|
285
360
|
|
|
286
361
|
##
|
|
287
362
|
# Gets the HTTP compression modes for this HTTP profile.
|
|
363
|
+
# @rspec_example
|
|
288
364
|
# @return [ProfileHttpCompressionMode]
|
|
289
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
290
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
291
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
365
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
366
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
367
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
292
368
|
def compression_mode
|
|
293
369
|
super
|
|
294
370
|
end
|
|
295
371
|
|
|
296
372
|
##
|
|
297
|
-
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
373
|
+
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
374
|
+
# requests during compression. (see section 5.1 of RFC2616). No match may be found
|
|
375
|
+
# in any of the &quot;exclude" fields. For example, to disable compressing requests
|
|
376
|
+
# ending in &quot;.txt", &quot;.htm" and &quot;.html", one would use the
|
|
377
|
+
# following in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm"
|
|
378
|
+
# &quot;*.html"
|
|
379
|
+
# @rspec_example
|
|
298
380
|
# @return [ProfileStringArray]
|
|
299
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
300
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
301
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
381
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
382
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
383
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
302
384
|
def compression_uri_exclude
|
|
303
385
|
super
|
|
304
386
|
end
|
|
305
387
|
|
|
306
388
|
##
|
|
307
|
-
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
389
|
+
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
390
|
+
# requests during compression. (see section 5.1 of RFC2616). A match must be found
|
|
391
|
+
# in at least one of the &quot;include" fields. For example, to include requests
|
|
392
|
+
# ending in &quot;.txt", &quot;.htm" and &quot;.html", one would use the
|
|
393
|
+
# following in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
394
|
+
# @rspec_example
|
|
308
395
|
# @return [ProfileStringArray]
|
|
309
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
310
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
311
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
396
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
397
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
398
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
312
399
|
def compression_uri_include
|
|
313
400
|
super
|
|
314
401
|
end
|
|
315
402
|
|
|
316
403
|
##
|
|
317
|
-
# Gets the states that specify whether we will insert the header &quot;Vary: Accept-Encoding"
|
|
404
|
+
# Gets the states that specify whether we will insert the header &quot;Vary: Accept-Encoding"
|
|
405
|
+
# in the server response for responses that have been compressed. If the &quot;Vary:"
|
|
406
|
+
# header already exists in the server response, then the value &quot;Accept-Encoding"
|
|
407
|
+
# will be appended to it.
|
|
408
|
+
# @rspec_example
|
|
318
409
|
# @return [ProfileEnabledState]
|
|
319
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
320
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
321
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
410
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
411
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
412
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
322
413
|
def compression_vary_header_state
|
|
323
414
|
super
|
|
324
415
|
end
|
|
325
416
|
|
|
326
417
|
##
|
|
327
|
-
# Gets the amount of memory (in bytes) for the window size (the compression history
|
|
418
|
+
# Gets the amount of memory (in bytes) for the window size (the compression history
|
|
419
|
+
# buffer) that will be used when compressing the server response. Higher values produce
|
|
420
|
+
# better compression ratios at the expense of more memory usage. The value must be
|
|
421
|
+
# one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K and represent power-of-2 values (kilobytes).
|
|
422
|
+
# The default value will be 16K.
|
|
423
|
+
# @rspec_example
|
|
328
424
|
# @return [ProfileULong]
|
|
329
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
330
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
331
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
425
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
426
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
427
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
332
428
|
def compression_window_size
|
|
333
429
|
super
|
|
334
430
|
end
|
|
335
431
|
|
|
336
432
|
##
|
|
337
433
|
# Gets the lists of cookies to be encrypted before sending them to the clients.
|
|
434
|
+
# @rspec_example
|
|
338
435
|
# @return [ProfileStringArray]
|
|
339
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
340
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
341
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
436
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
437
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
438
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
342
439
|
def cookie_encryption
|
|
343
440
|
super
|
|
344
441
|
end
|
|
345
442
|
|
|
346
443
|
##
|
|
347
444
|
# Gets the passphrases used to encrypt the cookies for this profile.
|
|
445
|
+
# @rspec_example
|
|
348
446
|
# @return [ProfileString]
|
|
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.
|
|
447
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
448
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
449
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
352
450
|
def cookie_encryption_passphrase
|
|
353
451
|
super
|
|
354
452
|
end
|
|
355
453
|
|
|
356
454
|
##
|
|
357
|
-
# Gets the names of the default profile from which this profile will derive default
|
|
455
|
+
# Gets the names of the default profile from which this profile will derive default
|
|
456
|
+
# values for its attributes.
|
|
457
|
+
# @rspec_example
|
|
358
458
|
# @return [String]
|
|
359
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
360
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
361
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
459
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
460
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
461
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
362
462
|
def default_profile
|
|
363
463
|
super
|
|
364
464
|
end
|
|
365
465
|
|
|
366
466
|
##
|
|
367
467
|
# Gets the fallback host names used in HTTP redirect for this HTTP profile.
|
|
468
|
+
# @rspec_example
|
|
368
469
|
# @return [ProfileString]
|
|
369
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
370
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
371
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
470
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
471
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
472
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
372
473
|
def fallback_host_name
|
|
373
474
|
super
|
|
374
475
|
end
|
|
375
476
|
|
|
376
477
|
##
|
|
377
|
-
# Gets the lists of status codes that when matched, traffic will be sent to the &quot;fallback_host".
|
|
478
|
+
# Gets the lists of status codes that when matched, traffic will be sent to the &quot;fallback_host".
|
|
479
|
+
# An exception will be thrown if fallback status codes are set when &quot;fallback_host"
|
|
480
|
+
# has not been specified.
|
|
481
|
+
# @rspec_example
|
|
378
482
|
# @return [ProfileStringArray]
|
|
379
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
380
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
381
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
483
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
484
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
485
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
382
486
|
def fallback_status_code
|
|
383
487
|
super
|
|
384
488
|
end
|
|
385
489
|
|
|
386
490
|
##
|
|
387
491
|
# Gets the headers to be erased for this HTTP profile.
|
|
492
|
+
# @rspec_example
|
|
388
493
|
# @return [ProfileString]
|
|
389
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
390
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
391
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
494
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
495
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
496
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
392
497
|
def header_erase
|
|
393
498
|
super
|
|
394
499
|
end
|
|
395
500
|
|
|
396
501
|
##
|
|
397
502
|
# Gets the headers to be inserted for this HTTP profile.
|
|
503
|
+
# @rspec_example
|
|
398
504
|
# @return [ProfileString]
|
|
399
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
400
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
401
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
505
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
506
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
507
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
402
508
|
def header_insert
|
|
403
509
|
super
|
|
404
510
|
end
|
|
405
511
|
|
|
406
512
|
##
|
|
407
513
|
# Gets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
|
|
514
|
+
# @rspec_example
|
|
408
515
|
# @return [ProfileProfileMode]
|
|
409
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
410
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
411
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
516
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
517
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
518
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
412
519
|
def insert_xforwarded_for_header_mode
|
|
413
520
|
super
|
|
414
521
|
end
|
|
415
522
|
|
|
416
523
|
##
|
|
417
|
-
# Gets the states that specify how we handle the &quot;Accept-Encoding:" header.
|
|
524
|
+
# Gets the states that specify how we handle the &quot;Accept-Encoding:" header.
|
|
525
|
+
# If set to false, we will strip the &quot;Accept-Encoding:" header before passing
|
|
526
|
+
# the request on to the server (so that the server doesn't also compress the response).
|
|
527
|
+
# If it is set to true, we will leave the &quot;Accept-Encoding:" header in the
|
|
528
|
+
# request so that servers are able to do compression. We will not compress responses
|
|
529
|
+
# that have already been compressed.
|
|
530
|
+
# @rspec_example
|
|
418
531
|
# @return [ProfileEnabledState]
|
|
419
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
420
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
421
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
532
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
533
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
534
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
422
535
|
def keep_accept_encoding_header_state
|
|
423
536
|
super
|
|
424
537
|
end
|
|
425
538
|
|
|
426
539
|
##
|
|
427
540
|
# Gets a list of all HTTP profile.
|
|
541
|
+
# @rspec_example
|
|
428
542
|
# @return [String]
|
|
429
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
430
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
431
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
543
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
544
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
545
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
432
546
|
def list
|
|
433
547
|
super
|
|
434
548
|
end
|
|
435
549
|
|
|
436
550
|
##
|
|
437
|
-
# Gets the linear white space maximum column sizes used to support multi-line header
|
|
551
|
+
# Gets the linear white space maximum column sizes used to support multi-line header
|
|
552
|
+
# insertion.
|
|
553
|
+
# @rspec_example
|
|
438
554
|
# @return [ProfileULong]
|
|
439
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
440
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
441
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
555
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
556
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
557
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
442
558
|
def lws_maximum_column
|
|
443
559
|
super
|
|
444
560
|
end
|
|
445
561
|
|
|
446
562
|
##
|
|
447
563
|
# Gets the linear white space separator strings for this HTTP profile.
|
|
564
|
+
# @rspec_example
|
|
448
565
|
# @return [ProfileString]
|
|
449
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
450
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
451
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
566
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
567
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
568
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
452
569
|
def lws_separator
|
|
453
570
|
super
|
|
454
571
|
end
|
|
455
572
|
|
|
456
573
|
##
|
|
457
574
|
# Gets the maximum header sizes for this HTTP profile.
|
|
575
|
+
# @rspec_example
|
|
458
576
|
# @return [ProfileULong]
|
|
459
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
460
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
461
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
577
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
578
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
579
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
462
580
|
def maximum_header_size
|
|
463
581
|
super
|
|
464
582
|
end
|
|
465
583
|
|
|
466
584
|
##
|
|
467
|
-
# Gets the maximum number of HTTP requests allowed in the connection before it is closed
|
|
585
|
+
# Gets the maximum number of HTTP requests allowed in the connection before it is closed
|
|
586
|
+
# automatically.
|
|
587
|
+
# @rspec_example
|
|
468
588
|
# @return [ProfileULong]
|
|
469
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
470
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
471
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
589
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
590
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
591
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
472
592
|
def maximum_requests
|
|
473
593
|
super
|
|
474
594
|
end
|
|
475
595
|
|
|
476
596
|
##
|
|
477
|
-
# Gets the states that specify that OneConnect HTTP header transformation feature is
|
|
597
|
+
# Gets the states that specify that OneConnect HTTP header transformation feature is
|
|
598
|
+
# used or not.
|
|
599
|
+
# @rspec_example
|
|
478
600
|
# @return [ProfileEnabledState]
|
|
479
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
480
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
481
|
-
# @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.
|
|
482
604
|
def oneconnect_header_transformation_state
|
|
483
605
|
super
|
|
484
606
|
end
|
|
485
607
|
|
|
486
608
|
##
|
|
487
609
|
# Gets the lists of permitted headers in the responses for this HTTP profile.
|
|
610
|
+
# @rspec_example
|
|
488
611
|
# @return [ProfileStringArray]
|
|
489
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
490
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
491
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
612
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
613
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
614
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
492
615
|
def permitted_response_header
|
|
493
616
|
super
|
|
494
617
|
end
|
|
495
618
|
|
|
496
619
|
##
|
|
497
620
|
# Gets the pipelining mode for this profile.
|
|
621
|
+
# @rspec_example
|
|
498
622
|
# @return [ProfileProfileMode]
|
|
499
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
500
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
501
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
623
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
624
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
625
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
502
626
|
def pipelining_mode
|
|
503
627
|
super
|
|
504
628
|
end
|
|
505
629
|
|
|
506
630
|
##
|
|
507
631
|
# Gets the preferred compression methods.
|
|
632
|
+
# @rspec_example
|
|
508
633
|
# @return [ProfileCompressionMethod]
|
|
509
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
510
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
511
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
634
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
635
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
636
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
512
637
|
def preferred_compression_method
|
|
513
638
|
super
|
|
514
639
|
end
|
|
515
640
|
|
|
516
641
|
##
|
|
517
642
|
# Gets the aging rate for the RAM cache.
|
|
643
|
+
# @rspec_example
|
|
518
644
|
# @return [ProfileULong]
|
|
519
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
520
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
521
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
645
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
646
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
647
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
522
648
|
def ramcache_aging_rate
|
|
523
649
|
super
|
|
524
650
|
end
|
|
525
651
|
|
|
526
652
|
##
|
|
527
653
|
# Gets the mode to indicate whether to ignore the client cache control headers.
|
|
654
|
+
# @rspec_example
|
|
528
655
|
# @return [ProfileRamCacheCacheControlMode]
|
|
529
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
530
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
531
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
656
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
657
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
658
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
532
659
|
def ramcache_ignore_client_cache_control_mode
|
|
533
660
|
super
|
|
534
661
|
end
|
|
535
662
|
|
|
536
663
|
##
|
|
537
664
|
# Gets the mode that indicates whether to insert the Age headers for this profile.
|
|
665
|
+
# @rspec_example
|
|
538
666
|
# @return [ProfileProfileMode]
|
|
539
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
540
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
541
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
667
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
668
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
669
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
542
670
|
def ramcache_insert_age_header_mode
|
|
543
671
|
super
|
|
544
672
|
end
|
|
545
673
|
|
|
546
674
|
##
|
|
547
675
|
# Gets the maximum age of a cached object in the RAM cache.
|
|
676
|
+
# @rspec_example
|
|
548
677
|
# @return [ProfileULong]
|
|
549
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
550
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
551
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
678
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
679
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
680
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
552
681
|
def ramcache_maximum_age
|
|
553
682
|
super
|
|
554
683
|
end
|
|
555
684
|
|
|
556
685
|
##
|
|
557
686
|
# Gets the maximum number of cache entries allowed in the RAM cache.
|
|
687
|
+
# @rspec_example
|
|
558
688
|
# @return [ProfileULong]
|
|
559
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
560
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
561
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
689
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
690
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
691
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
562
692
|
def ramcache_maximum_entry
|
|
563
693
|
super
|
|
564
694
|
end
|
|
565
695
|
|
|
566
696
|
##
|
|
567
697
|
# Gets the RAM cache mode for this profile.
|
|
698
|
+
# @rspec_example
|
|
568
699
|
# @return [ProfileProfileMode]
|
|
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.
|
|
700
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
701
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
702
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
572
703
|
def ramcache_mode
|
|
573
704
|
super
|
|
574
705
|
end
|
|
575
706
|
|
|
576
707
|
##
|
|
577
708
|
# Gets the maximum size requirement of a cached object in the RAM cache.
|
|
709
|
+
# @rspec_example
|
|
578
710
|
# @return [ProfileULong]
|
|
579
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
580
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
581
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
711
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
712
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
713
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
582
714
|
def ramcache_object_maximum_size
|
|
583
715
|
super
|
|
584
716
|
end
|
|
585
717
|
|
|
586
718
|
##
|
|
587
719
|
# Gets the minimum size requirement of a cached object in the RAM cache.
|
|
720
|
+
# @rspec_example
|
|
588
721
|
# @return [ProfileULong]
|
|
589
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
590
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
591
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
722
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
723
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
724
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
592
725
|
def ramcache_object_minimum_size
|
|
593
726
|
super
|
|
594
727
|
end
|
|
595
728
|
|
|
596
729
|
##
|
|
597
730
|
# Gets the size (MB) of the RAM cache.
|
|
731
|
+
# @rspec_example
|
|
598
732
|
# @return [ProfileULong]
|
|
599
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
600
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
601
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
733
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
734
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
735
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
602
736
|
def ramcache_size
|
|
603
737
|
super
|
|
604
738
|
end
|
|
605
739
|
|
|
606
740
|
##
|
|
607
|
-
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
741
|
+
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
742
|
+
# requests during caching. (see section 5.1 of RFC2616). No match may be found in any
|
|
743
|
+
# of the &quot;exclude" fields. For example, to disable compressing requests ending
|
|
744
|
+
# in &quot;.txt", &quot;.htm" and &quot;.html", one would use the following
|
|
745
|
+
# in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm" &quot;*.html"
|
|
746
|
+
# @rspec_example
|
|
608
747
|
# @return [ProfileStringArray]
|
|
609
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
610
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
611
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
748
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
749
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
750
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
612
751
|
def ramcache_uri_exclude
|
|
613
752
|
super
|
|
614
753
|
end
|
|
615
754
|
|
|
616
755
|
##
|
|
617
|
-
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
756
|
+
# Gets the lists of regular expressions used to match the request URI part of the client
|
|
757
|
+
# requests during caching. (see section 5.1 of RFC2616). A match must be found in at
|
|
758
|
+
# least one of the &quot;include" fields. For example, to include requests ending
|
|
759
|
+
# in &quot;.txt", &quot;.htm" and &quot;.html", one would use the following
|
|
760
|
+
# in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
761
|
+
# @rspec_example
|
|
618
762
|
# @return [ProfileStringArray]
|
|
619
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
620
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
621
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
763
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
764
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
765
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
622
766
|
def ramcache_uri_include
|
|
623
767
|
super
|
|
624
768
|
end
|
|
625
769
|
|
|
626
770
|
##
|
|
627
771
|
# Gets the lists of cachable document URIs that will never be evicted from the cache.
|
|
772
|
+
# @rspec_example
|
|
628
773
|
# @return [ProfileStringArray]
|
|
629
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
630
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
631
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
774
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
775
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
776
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
632
777
|
def ramcache_uri_pinned
|
|
633
778
|
super
|
|
634
779
|
end
|
|
635
780
|
|
|
636
781
|
##
|
|
637
782
|
# Gets the HTTP redirect/rewrite mode for the responses.
|
|
783
|
+
# @rspec_example
|
|
638
784
|
# @return [ProfileHttpRedirectRewriteMode]
|
|
639
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
640
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
641
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
785
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
786
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
787
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
642
788
|
def redirect_rewrite_mode
|
|
643
789
|
super
|
|
644
790
|
end
|
|
645
791
|
|
|
646
792
|
##
|
|
647
793
|
# Gets the HTTP chunk mode for the responses.
|
|
794
|
+
# @rspec_example
|
|
648
795
|
# @return [ProfileHttpChunkMode]
|
|
649
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
650
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
651
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
796
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
797
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
798
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
652
799
|
def response_chunk_mode
|
|
653
800
|
super
|
|
654
801
|
end
|
|
655
802
|
|
|
656
803
|
##
|
|
657
804
|
# Gets the state that if true, enable horizontal security for this HTTP profile.
|
|
805
|
+
# @rspec_example
|
|
658
806
|
# @return [ProfileEnabledState]
|
|
659
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
660
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
661
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
807
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
808
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
809
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
662
810
|
def security_enabled_request_state
|
|
663
811
|
super
|
|
664
812
|
end
|
|
665
813
|
|
|
666
814
|
##
|
|
667
815
|
# Gets the statistics for this HTTP profile.
|
|
816
|
+
# @rspec_example
|
|
668
817
|
# @return [ProfileHttpStatistics]
|
|
669
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
670
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
671
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
818
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
819
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
820
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
672
821
|
def statistics
|
|
673
822
|
super
|
|
674
823
|
end
|
|
675
824
|
|
|
676
825
|
##
|
|
677
826
|
# Gets the version information for this interface.
|
|
827
|
+
# @rspec_example
|
|
678
828
|
# @return [String]
|
|
679
829
|
def version
|
|
680
830
|
super
|
|
681
831
|
end
|
|
682
832
|
|
|
683
833
|
##
|
|
684
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
834
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
835
|
+
# profile.
|
|
836
|
+
# @rspec_example
|
|
685
837
|
# @return [boolean]
|
|
686
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
687
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
688
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
838
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
839
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
840
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
689
841
|
def is_base_profile
|
|
690
842
|
super
|
|
691
843
|
end
|
|
692
844
|
|
|
693
845
|
##
|
|
694
|
-
# Removes from the lists of regular expressions used to match the MIME types in the
|
|
695
|
-
#
|
|
696
|
-
#
|
|
697
|
-
#
|
|
846
|
+
# Removes from the lists of regular expressions used to match the MIME types in the
|
|
847
|
+
# server response's &quot;Content-Type:" headers. No match may be found in any
|
|
848
|
+
# of the &quot;exclude" fields. For example, to disable compression on all PDF
|
|
849
|
+
# and image files, one would use the following in the content_type exclue fields: :
|
|
850
|
+
# &quot;application/pdf" &quot;image/*".
|
|
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.
|
|
698
855
|
# @param [Hash] opts
|
|
699
856
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "exclude" list.
|
|
700
857
|
def remove_compression_content_type_exclude(opts)
|
|
@@ -703,10 +860,15 @@ module IControl::LocalLB
|
|
|
703
860
|
end
|
|
704
861
|
|
|
705
862
|
##
|
|
706
|
-
# Removes from the lists of regular expressions used to match the MIME types in the
|
|
707
|
-
#
|
|
708
|
-
#
|
|
709
|
-
#
|
|
863
|
+
# Removes from the lists of regular expressions used to match the MIME types in the
|
|
864
|
+
# server response's &quot;Content-Type:" headers. A match must be found in at least
|
|
865
|
+
# one of the &quot;include" fields. For example, to enable compression on all PDF
|
|
866
|
+
# and image files, one would use the following in the content_type include fields:
|
|
867
|
+
# : &quot;application/pdf" &quot;image/*".
|
|
868
|
+
# @rspec_example
|
|
869
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
870
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
871
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
710
872
|
# @param [Hash] opts
|
|
711
873
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "include" list.
|
|
712
874
|
def remove_compression_content_type_include(opts)
|
|
@@ -715,10 +877,16 @@ module IControl::LocalLB
|
|
|
715
877
|
end
|
|
716
878
|
|
|
717
879
|
##
|
|
718
|
-
# Removes from the lists of regular expressions used to match the request URI part
|
|
719
|
-
#
|
|
720
|
-
#
|
|
721
|
-
#
|
|
880
|
+
# Removes from the lists of regular expressions used to match the request URI part
|
|
881
|
+
# of the client requests during compression. (see section 5.1 of RFC2616). No match
|
|
882
|
+
# may be found in any of the &quot;exclude" fields. For example, to disable compressing
|
|
883
|
+
# requests ending in &quot;.txt", &quot;.htm" and &quot;.html", one would
|
|
884
|
+
# use the following in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm"
|
|
885
|
+
# &quot;*.html"
|
|
886
|
+
# @rspec_example
|
|
887
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
888
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
889
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
722
890
|
# @param [Hash] opts
|
|
723
891
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "exclude" list.
|
|
724
892
|
def remove_compression_uri_exclude(opts)
|
|
@@ -727,10 +895,15 @@ module IControl::LocalLB
|
|
|
727
895
|
end
|
|
728
896
|
|
|
729
897
|
##
|
|
730
|
-
# Removes from the lists of regular expressions used to match the request URI part
|
|
731
|
-
#
|
|
732
|
-
#
|
|
733
|
-
#
|
|
898
|
+
# Removes from the lists of regular expressions used to match the request URI part
|
|
899
|
+
# of the client requests during compression. (see section 5.1 of RFC2616). A match
|
|
900
|
+
# must be found in at least one of the &quot;include" fields. For example, to include
|
|
901
|
+
# requests ending in &quot;.txt", &quot;.htm" and &quot;.html", one would
|
|
902
|
+
# use the following in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
903
|
+
# @rspec_example
|
|
904
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
905
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
906
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
734
907
|
# @param [Hash] opts
|
|
735
908
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "include" list.
|
|
736
909
|
def remove_compression_uri_include(opts)
|
|
@@ -740,9 +913,10 @@ module IControl::LocalLB
|
|
|
740
913
|
|
|
741
914
|
##
|
|
742
915
|
# Removes from the lists of cookies to be encrypted before sending them to the clients.
|
|
743
|
-
# @
|
|
744
|
-
# @raise [IControl::Common::
|
|
745
|
-
# @raise [IControl::Common::
|
|
916
|
+
# @rspec_example
|
|
917
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
918
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
919
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
746
920
|
# @param [Hash] opts
|
|
747
921
|
# @option opts [String[]] :cookies The lists of cookies to be encrypted.
|
|
748
922
|
def remove_cookie_encryption(opts)
|
|
@@ -751,10 +925,13 @@ module IControl::LocalLB
|
|
|
751
925
|
end
|
|
752
926
|
|
|
753
927
|
##
|
|
754
|
-
# Removes from the lists of status codes that when matched, traffic will be sent to
|
|
755
|
-
#
|
|
756
|
-
#
|
|
757
|
-
# @
|
|
928
|
+
# Removes from the lists of status codes that when matched, traffic will be sent to
|
|
929
|
+
# the &quot;fallback_host". An exception will be thrown if fallback status codes
|
|
930
|
+
# are set when &quot;fallback_host" has not been specified.
|
|
931
|
+
# @rspec_example
|
|
932
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
933
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
934
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
758
935
|
# @param [Hash] opts
|
|
759
936
|
# @option opts [String[]] :status_codes The lists of status codes.
|
|
760
937
|
def remove_fallback_status_code(opts)
|
|
@@ -764,9 +941,10 @@ module IControl::LocalLB
|
|
|
764
941
|
|
|
765
942
|
##
|
|
766
943
|
# Removes from the lists of permitted headers in the responses for this HTTP profile.
|
|
767
|
-
# @
|
|
768
|
-
# @raise [IControl::Common::
|
|
769
|
-
# @raise [IControl::Common::
|
|
944
|
+
# @rspec_example
|
|
945
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
946
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
947
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
770
948
|
# @param [Hash] opts
|
|
771
949
|
# @option opts [String[]] :headers The lists of permitted response headers.
|
|
772
950
|
def remove_permitted_response_header(opts)
|
|
@@ -775,10 +953,16 @@ module IControl::LocalLB
|
|
|
775
953
|
end
|
|
776
954
|
|
|
777
955
|
##
|
|
778
|
-
# Removes from the lists of regular expressions used to match the request URI part
|
|
779
|
-
#
|
|
780
|
-
#
|
|
781
|
-
#
|
|
956
|
+
# Removes from the lists of regular expressions used to match the request URI part
|
|
957
|
+
# of the client requests during caching. (see section 5.1 of RFC2616). No match may
|
|
958
|
+
# be found in any of the &quot;exclude" fields. For example, to disable compressing
|
|
959
|
+
# requests ending in &quot;.txt", &quot;.htm" and &quot;.html", one would
|
|
960
|
+
# use the following in the URI &quot;exclude" fields: &quot;*.txt" &quot;*.htm"
|
|
961
|
+
# &quot;*.html"
|
|
962
|
+
# @rspec_example
|
|
963
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
964
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
965
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
782
966
|
# @param [Hash] opts
|
|
783
967
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "exclude" list.
|
|
784
968
|
def remove_ramcache_uri_exclude(opts)
|
|
@@ -787,10 +971,15 @@ module IControl::LocalLB
|
|
|
787
971
|
end
|
|
788
972
|
|
|
789
973
|
##
|
|
790
|
-
# Removes from the lists of regular expressions used to match the request URI part
|
|
791
|
-
#
|
|
792
|
-
#
|
|
793
|
-
#
|
|
974
|
+
# Removes from the lists of regular expressions used to match the request URI part
|
|
975
|
+
# of the client requests during caching. (see section 5.1 of RFC2616). A match must
|
|
976
|
+
# be found in at least one of the &quot;include" fields. For example, to include
|
|
977
|
+
# requests ending in &quot;.txt", &quot;.htm" and &quot;.html", one would
|
|
978
|
+
# use the following in the uri include field: &quot;*.txt" &quot;*.htm" &quot;*.html".
|
|
979
|
+
# @rspec_example
|
|
980
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
981
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
982
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
794
983
|
# @param [Hash] opts
|
|
795
984
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "include" list.
|
|
796
985
|
def remove_ramcache_uri_include(opts)
|
|
@@ -799,10 +988,12 @@ module IControl::LocalLB
|
|
|
799
988
|
end
|
|
800
989
|
|
|
801
990
|
##
|
|
802
|
-
# Removes from the lists of cachable document URIs that will never be evicted from
|
|
803
|
-
#
|
|
804
|
-
# @
|
|
805
|
-
# @raise [IControl::Common::
|
|
991
|
+
# Removes from the lists of cachable document URIs that will never be evicted from
|
|
992
|
+
# the cache.
|
|
993
|
+
# @rspec_example
|
|
994
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
995
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
996
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
806
997
|
# @param [Hash] opts
|
|
807
998
|
# @option opts [String[]] :reg_expressions The lists of regular expressions to be removed from the "pinned" list.
|
|
808
999
|
def remove_ramcache_uri_pinned(opts)
|
|
@@ -812,18 +1003,20 @@ module IControl::LocalLB
|
|
|
812
1003
|
|
|
813
1004
|
##
|
|
814
1005
|
# Resets the statistics for this HTTP profile.
|
|
815
|
-
# @
|
|
816
|
-
# @raise [IControl::Common::
|
|
817
|
-
# @raise [IControl::Common::
|
|
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.
|
|
818
1010
|
def reset_statistics
|
|
819
1011
|
super
|
|
820
1012
|
end
|
|
821
1013
|
|
|
822
1014
|
##
|
|
823
1015
|
# Sets the basic authentication realms for this HTTP profile.
|
|
824
|
-
# @
|
|
825
|
-
# @raise [IControl::Common::
|
|
826
|
-
# @raise [IControl::Common::
|
|
1016
|
+
# @rspec_example
|
|
1017
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1018
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1019
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
827
1020
|
# @param [Hash] opts
|
|
828
1021
|
# @option opts [IControl::LocalLB::ProfileString] :realms The basic authentication realms of the specified HTTP profiles.
|
|
829
1022
|
def set_basic_auth_realm(opts)
|
|
@@ -832,10 +1025,13 @@ module IControl::LocalLB
|
|
|
832
1025
|
end
|
|
833
1026
|
|
|
834
1027
|
##
|
|
835
|
-
# Sets the states that specify whether we will allow compression on responses to HTTP
|
|
836
|
-
#
|
|
837
|
-
#
|
|
838
|
-
# @
|
|
1028
|
+
# Sets the states that specify whether we will allow compression on responses to HTTP
|
|
1029
|
+
# 1.0 requests. Default will be &quot;false", i.e. disallowing compression on HTTP
|
|
1030
|
+
# 1.0 responses.
|
|
1031
|
+
# @rspec_example
|
|
1032
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1033
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1034
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
839
1035
|
# @param [Hash] opts
|
|
840
1036
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states indicating whether to allow compression on HTTP 1.0 responses.
|
|
841
1037
|
def set_compression_allow_http_10_state(opts)
|
|
@@ -845,9 +1041,10 @@ module IControl::LocalLB
|
|
|
845
1041
|
|
|
846
1042
|
##
|
|
847
1043
|
# Sets the states that specify whether to workaround browser bugs when doing compression.
|
|
848
|
-
# @
|
|
849
|
-
# @raise [IControl::Common::
|
|
850
|
-
# @raise [IControl::Common::
|
|
1044
|
+
# @rspec_example
|
|
1045
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1046
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1047
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
851
1048
|
# @param [Hash] opts
|
|
852
1049
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states that specify whether to workaround browser bugs when doing compression.
|
|
853
1050
|
def set_compression_browser_workaround_state(opts)
|
|
@@ -856,10 +1053,13 @@ module IControl::LocalLB
|
|
|
856
1053
|
end
|
|
857
1054
|
|
|
858
1055
|
##
|
|
859
|
-
# Sets the values that specify the maximum number of uncompressed bytes that the compression
|
|
860
|
-
#
|
|
861
|
-
#
|
|
862
|
-
# @
|
|
1056
|
+
# Sets the values that specify the maximum number of uncompressed bytes that the compression
|
|
1057
|
+
# proxy will buffer before it decides whether or not to compress the server's response,
|
|
1058
|
+
# in case the server's response headers don't specify the content length of the response.
|
|
1059
|
+
# @rspec_example
|
|
1060
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1061
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1062
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
863
1063
|
# @param [Hash] opts
|
|
864
1064
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The compression buffer sizes.
|
|
865
1065
|
def set_compression_buffer_size(opts)
|
|
@@ -868,10 +1068,12 @@ module IControl::LocalLB
|
|
|
868
1068
|
end
|
|
869
1069
|
|
|
870
1070
|
##
|
|
871
|
-
# Sets the CPU saver high threshold that basically switches to NULL compression when
|
|
872
|
-
#
|
|
873
|
-
# @
|
|
874
|
-
# @raise [IControl::Common::
|
|
1071
|
+
# Sets the CPU saver high threshold that basically switches to NULL compression when
|
|
1072
|
+
# CPU utilization exceeds this value.
|
|
1073
|
+
# @rspec_example
|
|
1074
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1075
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1076
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
875
1077
|
# @param [Hash] opts
|
|
876
1078
|
# @option opts [IControl::LocalLB::ProfileULong] :thresholds The high threshold in CPU saving mode.
|
|
877
1079
|
def set_compression_cpu_saver_high_threshold(opts)
|
|
@@ -880,10 +1082,12 @@ module IControl::LocalLB
|
|
|
880
1082
|
end
|
|
881
1083
|
|
|
882
1084
|
##
|
|
883
|
-
# Sets the CPU saver low threshold that basically enables full throttle on compression
|
|
884
|
-
#
|
|
885
|
-
# @
|
|
886
|
-
# @raise [IControl::Common::
|
|
1085
|
+
# Sets the CPU saver low threshold that basically enables full throttle on compression
|
|
1086
|
+
# when CPU utilization drops below this value.
|
|
1087
|
+
# @rspec_example
|
|
1088
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1089
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1090
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
887
1091
|
# @param [Hash] opts
|
|
888
1092
|
# @option opts [IControl::LocalLB::ProfileULong] :thresholds The low threshold in CPU saving mode.
|
|
889
1093
|
def set_compression_cpu_saver_low_threshold(opts)
|
|
@@ -893,9 +1097,10 @@ module IControl::LocalLB
|
|
|
893
1097
|
|
|
894
1098
|
##
|
|
895
1099
|
# Sets the states that specify whether to enable CPU saving mode when doing compression.
|
|
896
|
-
# @
|
|
897
|
-
# @raise [IControl::Common::
|
|
898
|
-
# @raise [IControl::Common::
|
|
1100
|
+
# @rspec_example
|
|
1101
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1102
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1103
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
899
1104
|
# @param [Hash] opts
|
|
900
1105
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states that specify whether to enable CPU saving mode when doing compression.
|
|
901
1106
|
def set_compression_cpu_saver_state(opts)
|
|
@@ -905,9 +1110,10 @@ module IControl::LocalLB
|
|
|
905
1110
|
|
|
906
1111
|
##
|
|
907
1112
|
# Sets the compression level used by this HTTP profile.
|
|
908
|
-
# @
|
|
909
|
-
# @raise [IControl::Common::
|
|
910
|
-
# @raise [IControl::Common::
|
|
1113
|
+
# @rspec_example
|
|
1114
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1115
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1116
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
911
1117
|
# @param [Hash] opts
|
|
912
1118
|
# @option opts [IControl::LocalLB::ProfileULong] :levels The compression GZIP levels.
|
|
913
1119
|
def set_compression_level(opts)
|
|
@@ -916,10 +1122,15 @@ module IControl::LocalLB
|
|
|
916
1122
|
end
|
|
917
1123
|
|
|
918
1124
|
##
|
|
919
|
-
# Sets the amount of memory (in bytes) that the will be used for the internal compression
|
|
920
|
-
#
|
|
921
|
-
#
|
|
922
|
-
#
|
|
1125
|
+
# Sets the amount of memory (in bytes) that the will be used for the internal compression
|
|
1126
|
+
# state for each compressed response. Smaller values will be slower and will produce
|
|
1127
|
+
# smaller compression ratios, whereas larger values will be faster and produce larger
|
|
1128
|
+
# compression ratios. The value must be one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K,
|
|
1129
|
+
# 256K and represent power-of-2 values (kilobytes). The default value will be 8K.
|
|
1130
|
+
# @rspec_example
|
|
1131
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1132
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1133
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
923
1134
|
# @param [Hash] opts
|
|
924
1135
|
# @option opts [IControl::LocalLB::ProfileULong] :levels The compression memory levels.
|
|
925
1136
|
def set_compression_memory_level(opts)
|
|
@@ -928,10 +1139,12 @@ module IControl::LocalLB
|
|
|
928
1139
|
end
|
|
929
1140
|
|
|
930
1141
|
##
|
|
931
|
-
# Sets the values that specify the minimmum length of the server responses (in bytes)
|
|
932
|
-
#
|
|
933
|
-
# @
|
|
934
|
-
# @raise [IControl::Common::
|
|
1142
|
+
# Sets the values that specify the minimmum length of the server responses (in bytes)
|
|
1143
|
+
# to be considered acceptable for compression.
|
|
1144
|
+
# @rspec_example
|
|
1145
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1146
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1147
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
935
1148
|
# @param [Hash] opts
|
|
936
1149
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The minimum lengths of server responses.
|
|
937
1150
|
def set_compression_minimum_size(opts)
|
|
@@ -941,9 +1154,10 @@ module IControl::LocalLB
|
|
|
941
1154
|
|
|
942
1155
|
##
|
|
943
1156
|
# Sets the HTTP compression modes for this HTTP profile.
|
|
944
|
-
# @
|
|
945
|
-
# @raise [IControl::Common::
|
|
946
|
-
# @raise [IControl::Common::
|
|
1157
|
+
# @rspec_example
|
|
1158
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1159
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1160
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
947
1161
|
# @param [Hash] opts
|
|
948
1162
|
# @option opts [IControl::LocalLB::ProfileHttpCompressionMode] :modes The HTTP compression modes for the specified HTTP profiles.
|
|
949
1163
|
def set_compression_mode(opts)
|
|
@@ -952,10 +1166,14 @@ module IControl::LocalLB
|
|
|
952
1166
|
end
|
|
953
1167
|
|
|
954
1168
|
##
|
|
955
|
-
# Sets the states that specify whether we will insert the header &quot;Vary: Accept-Encoding"
|
|
956
|
-
#
|
|
957
|
-
#
|
|
958
|
-
#
|
|
1169
|
+
# Sets the states that specify whether we will insert the header &quot;Vary: Accept-Encoding"
|
|
1170
|
+
# in the server response for responses that have been compressed. If the &quot;Vary:"
|
|
1171
|
+
# header already exists in the server response, then the value &quot;Accept-Encoding"
|
|
1172
|
+
# will be appended to it.
|
|
1173
|
+
# @rspec_example
|
|
1174
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1175
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1176
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
959
1177
|
# @param [Hash] opts
|
|
960
1178
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states indicating whether to insert the "Vary:" headers in the server responses.
|
|
961
1179
|
def set_compression_vary_header_state(opts)
|
|
@@ -964,10 +1182,15 @@ module IControl::LocalLB
|
|
|
964
1182
|
end
|
|
965
1183
|
|
|
966
1184
|
##
|
|
967
|
-
# Sets the amount of memory (in bytes) for the window size (the compression history
|
|
968
|
-
#
|
|
969
|
-
#
|
|
970
|
-
#
|
|
1185
|
+
# Sets the amount of memory (in bytes) for the window size (the compression history
|
|
1186
|
+
# buffer) that will be used when compressing the server response. Higher values produce
|
|
1187
|
+
# better compression ratios at the expense of more memory usage. The value must be
|
|
1188
|
+
# one of 1K, 2K, 4K, 8K, 16K, 32K, 64K, 128K and represent power-of-2 values (kilobytes).
|
|
1189
|
+
# The default value will be 16K.
|
|
1190
|
+
# @rspec_example
|
|
1191
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1192
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1193
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
971
1194
|
# @param [Hash] opts
|
|
972
1195
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The compression window sizes.
|
|
973
1196
|
def set_compression_window_size(opts)
|
|
@@ -977,9 +1200,10 @@ module IControl::LocalLB
|
|
|
977
1200
|
|
|
978
1201
|
##
|
|
979
1202
|
# Sets the passphrases used to encrypt the cookies for this profile.
|
|
980
|
-
# @
|
|
981
|
-
# @raise [IControl::Common::
|
|
982
|
-
# @raise [IControl::Common::
|
|
1203
|
+
# @rspec_example
|
|
1204
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1205
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1206
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
983
1207
|
# @param [Hash] opts
|
|
984
1208
|
# @option opts [IControl::LocalLB::ProfileString] :passphrases The passphrases used to encrypt the cookies.
|
|
985
1209
|
def set_cookie_encryption_passphrase(opts)
|
|
@@ -989,72 +1213,81 @@ module IControl::LocalLB
|
|
|
989
1213
|
|
|
990
1214
|
##
|
|
991
1215
|
# Resets the lists to parent defaults.
|
|
992
|
-
# @
|
|
993
|
-
# @raise [IControl::Common::
|
|
994
|
-
# @raise [IControl::Common::
|
|
1216
|
+
# @rspec_example
|
|
1217
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1218
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1219
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
995
1220
|
def set_default_compression_content_type_exclude
|
|
996
1221
|
super
|
|
997
1222
|
end
|
|
998
1223
|
|
|
999
1224
|
##
|
|
1000
1225
|
# Resets the lists to parent defaults.
|
|
1001
|
-
# @
|
|
1002
|
-
# @raise [IControl::Common::
|
|
1003
|
-
# @raise [IControl::Common::
|
|
1226
|
+
# @rspec_example
|
|
1227
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1228
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1229
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1004
1230
|
def set_default_compression_content_type_include
|
|
1005
1231
|
super
|
|
1006
1232
|
end
|
|
1007
1233
|
|
|
1008
1234
|
##
|
|
1009
1235
|
# Resets the lists to parent defaults.
|
|
1010
|
-
# @
|
|
1011
|
-
# @raise [IControl::Common::
|
|
1012
|
-
# @raise [IControl::Common::
|
|
1236
|
+
# @rspec_example
|
|
1237
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1238
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1239
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1013
1240
|
def set_default_compression_uri_exclude
|
|
1014
1241
|
super
|
|
1015
1242
|
end
|
|
1016
1243
|
|
|
1017
1244
|
##
|
|
1018
1245
|
# Resets the list to the parent defaults.
|
|
1019
|
-
# @
|
|
1020
|
-
# @raise [IControl::Common::
|
|
1021
|
-
# @raise [IControl::Common::
|
|
1246
|
+
# @rspec_example
|
|
1247
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1248
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1249
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1022
1250
|
def set_default_compression_uri_include
|
|
1023
1251
|
super
|
|
1024
1252
|
end
|
|
1025
1253
|
|
|
1026
1254
|
##
|
|
1027
1255
|
# Resets the list to the parent defaults.
|
|
1028
|
-
# @
|
|
1029
|
-
# @raise [IControl::Common::
|
|
1030
|
-
# @raise [IControl::Common::
|
|
1256
|
+
# @rspec_example
|
|
1257
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1258
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1259
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1031
1260
|
def set_default_cookie_encryption
|
|
1032
1261
|
super
|
|
1033
1262
|
end
|
|
1034
1263
|
|
|
1035
1264
|
##
|
|
1036
1265
|
# Resets the list to the parent defaults.
|
|
1037
|
-
# @
|
|
1038
|
-
# @raise [IControl::Common::
|
|
1039
|
-
# @raise [IControl::Common::
|
|
1266
|
+
# @rspec_example
|
|
1267
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1268
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1269
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1040
1270
|
def set_default_fallback_status_code
|
|
1041
1271
|
super
|
|
1042
1272
|
end
|
|
1043
1273
|
|
|
1044
1274
|
##
|
|
1045
1275
|
# Resets the list to the parent defaults.
|
|
1046
|
-
# @
|
|
1047
|
-
# @raise [IControl::Common::
|
|
1048
|
-
# @raise [IControl::Common::
|
|
1276
|
+
# @rspec_example
|
|
1277
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1278
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1279
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1049
1280
|
def set_default_permitted_response_header
|
|
1050
1281
|
super
|
|
1051
1282
|
end
|
|
1052
1283
|
|
|
1053
1284
|
##
|
|
1054
|
-
# Sets the names of the default profile from which this profile will derive default
|
|
1055
|
-
#
|
|
1056
|
-
# @
|
|
1057
|
-
# @raise [IControl::Common::
|
|
1285
|
+
# Sets the names of the default profile from which this profile will derive default
|
|
1286
|
+
# values for its attributes.
|
|
1287
|
+
# @rspec_example
|
|
1288
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1289
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1290
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1058
1291
|
# @param [Hash] opts
|
|
1059
1292
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
|
1060
1293
|
def set_default_profile(opts)
|
|
@@ -1064,36 +1297,40 @@ module IControl::LocalLB
|
|
|
1064
1297
|
|
|
1065
1298
|
##
|
|
1066
1299
|
# Resets the lists to parent defaults.
|
|
1067
|
-
# @
|
|
1068
|
-
# @raise [IControl::Common::
|
|
1069
|
-
# @raise [IControl::Common::
|
|
1300
|
+
# @rspec_example
|
|
1301
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1302
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1303
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1070
1304
|
def set_default_ramcache_uri_exclude
|
|
1071
1305
|
super
|
|
1072
1306
|
end
|
|
1073
1307
|
|
|
1074
1308
|
##
|
|
1075
1309
|
# Resets the list to the parent defaults.
|
|
1076
|
-
# @
|
|
1077
|
-
# @raise [IControl::Common::
|
|
1078
|
-
# @raise [IControl::Common::
|
|
1310
|
+
# @rspec_example
|
|
1311
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1312
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1313
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1079
1314
|
def set_default_ramcache_uri_include
|
|
1080
1315
|
super
|
|
1081
1316
|
end
|
|
1082
1317
|
|
|
1083
1318
|
##
|
|
1084
1319
|
# Resets the lists to parent defaults.
|
|
1085
|
-
# @
|
|
1086
|
-
# @raise [IControl::Common::
|
|
1087
|
-
# @raise [IControl::Common::
|
|
1320
|
+
# @rspec_example
|
|
1321
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1322
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1323
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1088
1324
|
def set_default_ramcache_uri_pinned
|
|
1089
1325
|
super
|
|
1090
1326
|
end
|
|
1091
1327
|
|
|
1092
1328
|
##
|
|
1093
1329
|
# Sets the fallback host names used in HTTP redirect for this HTTP profile.
|
|
1094
|
-
# @
|
|
1095
|
-
# @raise [IControl::Common::
|
|
1096
|
-
# @raise [IControl::Common::
|
|
1330
|
+
# @rspec_example
|
|
1331
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1332
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1333
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1097
1334
|
# @param [Hash] opts
|
|
1098
1335
|
# @option opts [IControl::LocalLB::ProfileString] :fallbacks The fallback host names.
|
|
1099
1336
|
def set_fallback_host_name(opts)
|
|
@@ -1103,9 +1340,10 @@ module IControl::LocalLB
|
|
|
1103
1340
|
|
|
1104
1341
|
##
|
|
1105
1342
|
# Sets the headers to be erased into the HTTP headers for this HTTP profile.
|
|
1106
|
-
# @
|
|
1107
|
-
# @raise [IControl::Common::
|
|
1108
|
-
# @raise [IControl::Common::
|
|
1343
|
+
# @rspec_example
|
|
1344
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1345
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1346
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1109
1347
|
# @param [Hash] opts
|
|
1110
1348
|
# @option opts [IControl::LocalLB::ProfileString] :headers The headers to be erased for the specified HTTP profiles.
|
|
1111
1349
|
def set_header_erase(opts)
|
|
@@ -1115,9 +1353,10 @@ module IControl::LocalLB
|
|
|
1115
1353
|
|
|
1116
1354
|
##
|
|
1117
1355
|
# Sets the headers to be inserted into the HTTP headers for this HTTP profile.
|
|
1118
|
-
# @
|
|
1119
|
-
# @raise [IControl::Common::
|
|
1120
|
-
# @raise [IControl::Common::
|
|
1356
|
+
# @rspec_example
|
|
1357
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1358
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1359
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1121
1360
|
# @param [Hash] opts
|
|
1122
1361
|
# @option opts [IControl::LocalLB::ProfileString] :headers The headers to be inserted for the specified HTTP profiles.
|
|
1123
1362
|
def set_header_insert(opts)
|
|
@@ -1127,9 +1366,10 @@ module IControl::LocalLB
|
|
|
1127
1366
|
|
|
1128
1367
|
##
|
|
1129
1368
|
# Sets the mode to indicate whether to insert X-Forwarded-For headers for this profile.
|
|
1130
|
-
# @
|
|
1131
|
-
# @raise [IControl::Common::
|
|
1132
|
-
# @raise [IControl::Common::
|
|
1369
|
+
# @rspec_example
|
|
1370
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1371
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1372
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1133
1373
|
# @param [Hash] opts
|
|
1134
1374
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The insert X-Forwarded-For header mode for the specified profiles.
|
|
1135
1375
|
def set_insert_xforwarded_for_header_mode(opts)
|
|
@@ -1138,10 +1378,16 @@ module IControl::LocalLB
|
|
|
1138
1378
|
end
|
|
1139
1379
|
|
|
1140
1380
|
##
|
|
1141
|
-
# Sets the states that specify how we handle the &quot;Accept-Encoding:" header.
|
|
1142
|
-
#
|
|
1143
|
-
#
|
|
1144
|
-
#
|
|
1381
|
+
# Sets the states that specify how we handle the &quot;Accept-Encoding:" header.
|
|
1382
|
+
# If set to false, we will strip the &quot;Accept-Encoding:" header before passing
|
|
1383
|
+
# the request on to the server (so that the server doesn't also compress the response).
|
|
1384
|
+
# If it is set to true, we will leave the &quot;Accept-Encoding:" header in the
|
|
1385
|
+
# request so that servers are able to do compression. We will not compress responses
|
|
1386
|
+
# that have already been compressed.
|
|
1387
|
+
# @rspec_example
|
|
1388
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1389
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1390
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1145
1391
|
# @param [Hash] opts
|
|
1146
1392
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states indicating how we handle the "Accept-Encoding:" header.
|
|
1147
1393
|
def set_keep_accept_encoding_header_state(opts)
|
|
@@ -1150,10 +1396,12 @@ module IControl::LocalLB
|
|
|
1150
1396
|
end
|
|
1151
1397
|
|
|
1152
1398
|
##
|
|
1153
|
-
# Sets the linear white space maximum column sizes used to support multi-line header
|
|
1154
|
-
#
|
|
1155
|
-
# @
|
|
1156
|
-
# @raise [IControl::Common::
|
|
1399
|
+
# Sets the linear white space maximum column sizes used to support multi-line header
|
|
1400
|
+
# insertion.
|
|
1401
|
+
# @rspec_example
|
|
1402
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1403
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1404
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1157
1405
|
# @param [Hash] opts
|
|
1158
1406
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The LWS maximum column sizes.
|
|
1159
1407
|
def set_lws_maximum_column(opts)
|
|
@@ -1163,9 +1411,10 @@ module IControl::LocalLB
|
|
|
1163
1411
|
|
|
1164
1412
|
##
|
|
1165
1413
|
# Sets the linear white space separator strings for this HTTP profile.
|
|
1166
|
-
# @
|
|
1167
|
-
# @raise [IControl::Common::
|
|
1168
|
-
# @raise [IControl::Common::
|
|
1414
|
+
# @rspec_example
|
|
1415
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1416
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1417
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1169
1418
|
# @param [Hash] opts
|
|
1170
1419
|
# @option opts [IControl::LocalLB::ProfileString] :separators The LWS separators of the specified HTTP profiles.
|
|
1171
1420
|
def set_lws_separator(opts)
|
|
@@ -1175,9 +1424,10 @@ module IControl::LocalLB
|
|
|
1175
1424
|
|
|
1176
1425
|
##
|
|
1177
1426
|
# Sets the maximum header sizes for this HTTP profile.
|
|
1178
|
-
# @
|
|
1179
|
-
# @raise [IControl::Common::
|
|
1180
|
-
# @raise [IControl::Common::
|
|
1427
|
+
# @rspec_example
|
|
1428
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1429
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1430
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1181
1431
|
# @param [Hash] opts
|
|
1182
1432
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum header sizes.
|
|
1183
1433
|
def set_maximum_header_size(opts)
|
|
@@ -1186,10 +1436,12 @@ module IControl::LocalLB
|
|
|
1186
1436
|
end
|
|
1187
1437
|
|
|
1188
1438
|
##
|
|
1189
|
-
# Sets the maximum number of HTTP requests allowed in the connection before it is closed
|
|
1190
|
-
#
|
|
1191
|
-
# @
|
|
1192
|
-
# @raise [IControl::Common::
|
|
1439
|
+
# Sets the maximum number of HTTP requests allowed in the connection before it is closed
|
|
1440
|
+
# automatically.
|
|
1441
|
+
# @rspec_example
|
|
1442
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1443
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1444
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1193
1445
|
# @param [Hash] opts
|
|
1194
1446
|
# @option opts [IControl::LocalLB::ProfileULong] :maximum_requests The maximum number of HTTP requests allowed in a connection.
|
|
1195
1447
|
def set_maximum_requests(opts)
|
|
@@ -1198,10 +1450,12 @@ module IControl::LocalLB
|
|
|
1198
1450
|
end
|
|
1199
1451
|
|
|
1200
1452
|
##
|
|
1201
|
-
# Sets the states that specify whether OneConnect HTTP header transformation is used
|
|
1202
|
-
#
|
|
1203
|
-
# @
|
|
1204
|
-
# @raise [IControl::Common::
|
|
1453
|
+
# Sets the states that specify whether OneConnect HTTP header transformation is used
|
|
1454
|
+
# for this HTTP profile.
|
|
1455
|
+
# @rspec_example
|
|
1456
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1457
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1458
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1205
1459
|
# @param [Hash] opts
|
|
1206
1460
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The OneConnect HTTP header transformation states for the specified HTTP profiles.
|
|
1207
1461
|
def set_oneconnect_header_transformation_state(opts)
|
|
@@ -1211,9 +1465,10 @@ module IControl::LocalLB
|
|
|
1211
1465
|
|
|
1212
1466
|
##
|
|
1213
1467
|
# Sets the pipelining mode for this profile.
|
|
1214
|
-
# @
|
|
1215
|
-
# @raise [IControl::Common::
|
|
1216
|
-
# @raise [IControl::Common::
|
|
1468
|
+
# @rspec_example
|
|
1469
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1470
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1471
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1217
1472
|
# @param [Hash] opts
|
|
1218
1473
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The pipelining mode for the specified profiles.
|
|
1219
1474
|
def set_pipelining_mode(opts)
|
|
@@ -1223,9 +1478,10 @@ module IControl::LocalLB
|
|
|
1223
1478
|
|
|
1224
1479
|
##
|
|
1225
1480
|
# Sets the preferred compression methods.
|
|
1226
|
-
# @
|
|
1227
|
-
# @raise [IControl::Common::
|
|
1228
|
-
# @raise [IControl::Common::
|
|
1481
|
+
# @rspec_example
|
|
1482
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1483
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1484
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1229
1485
|
# @param [Hash] opts
|
|
1230
1486
|
# @option opts [IControl::LocalLB::ProfileCompressionMethod] :compression_methods The preferred compression methods.
|
|
1231
1487
|
def set_preferred_compression_method(opts)
|
|
@@ -1235,9 +1491,10 @@ module IControl::LocalLB
|
|
|
1235
1491
|
|
|
1236
1492
|
##
|
|
1237
1493
|
# Sets the aging rate for the RAM cache.
|
|
1238
|
-
# @
|
|
1239
|
-
# @raise [IControl::Common::
|
|
1240
|
-
# @raise [IControl::Common::
|
|
1494
|
+
# @rspec_example
|
|
1495
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1496
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1497
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1241
1498
|
# @param [Hash] opts
|
|
1242
1499
|
# @option opts [IControl::LocalLB::ProfileULong] :aging_rates The aging rate for the RAM cache.
|
|
1243
1500
|
def set_ramcache_aging_rate(opts)
|
|
@@ -1247,9 +1504,10 @@ module IControl::LocalLB
|
|
|
1247
1504
|
|
|
1248
1505
|
##
|
|
1249
1506
|
# Sets the mode to indicate whether to ignore the client cache control headers.
|
|
1250
|
-
# @
|
|
1251
|
-
# @raise [IControl::Common::
|
|
1252
|
-
# @raise [IControl::Common::
|
|
1507
|
+
# @rspec_example
|
|
1508
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1509
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1510
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1253
1511
|
# @param [Hash] opts
|
|
1254
1512
|
# @option opts [IControl::LocalLB::ProfileRamCacheCacheControlMode] :modes The client cache control mode.
|
|
1255
1513
|
def set_ramcache_ignore_client_cache_control_mode(opts)
|
|
@@ -1259,9 +1517,10 @@ module IControl::LocalLB
|
|
|
1259
1517
|
|
|
1260
1518
|
##
|
|
1261
1519
|
# Sets the mode that indicates whether to insert the Age headers for this profile.
|
|
1262
|
-
# @
|
|
1263
|
-
# @raise [IControl::Common::
|
|
1264
|
-
# @raise [IControl::Common::
|
|
1520
|
+
# @rspec_example
|
|
1521
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1522
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1523
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1265
1524
|
# @param [Hash] opts
|
|
1266
1525
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The mode that indicates whether to insert the Age headers for the specified profiles.
|
|
1267
1526
|
def set_ramcache_insert_age_header_mode(opts)
|
|
@@ -1271,9 +1530,10 @@ module IControl::LocalLB
|
|
|
1271
1530
|
|
|
1272
1531
|
##
|
|
1273
1532
|
# Sets the maximum age of a cached object in the RAM cache.
|
|
1274
|
-
# @
|
|
1275
|
-
# @raise [IControl::Common::
|
|
1276
|
-
# @raise [IControl::Common::
|
|
1533
|
+
# @rspec_example
|
|
1534
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1535
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1536
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1277
1537
|
# @param [Hash] opts
|
|
1278
1538
|
# @option opts [IControl::LocalLB::ProfileULong] :maximum_age The maximum age of a cached object in the RAM cache.
|
|
1279
1539
|
def set_ramcache_maximum_age(opts)
|
|
@@ -1283,9 +1543,10 @@ module IControl::LocalLB
|
|
|
1283
1543
|
|
|
1284
1544
|
##
|
|
1285
1545
|
# Sets the maximum number of cache entries allowed in the RAM cache.
|
|
1286
|
-
# @
|
|
1287
|
-
# @raise [IControl::Common::
|
|
1288
|
-
# @raise [IControl::Common::
|
|
1546
|
+
# @rspec_example
|
|
1547
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1548
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1549
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1289
1550
|
# @param [Hash] opts
|
|
1290
1551
|
# @option opts [IControl::LocalLB::ProfileULong] :maximum_entries The maximum number of cache entries allowed in the RAM cache.
|
|
1291
1552
|
def set_ramcache_maximum_entry(opts)
|
|
@@ -1295,9 +1556,10 @@ module IControl::LocalLB
|
|
|
1295
1556
|
|
|
1296
1557
|
##
|
|
1297
1558
|
# Sets the RAM cache mode for this profile.
|
|
1298
|
-
# @
|
|
1299
|
-
# @raise [IControl::Common::
|
|
1300
|
-
# @raise [IControl::Common::
|
|
1559
|
+
# @rspec_example
|
|
1560
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1561
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1562
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1301
1563
|
# @param [Hash] opts
|
|
1302
1564
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The RAM cache mode for the specified profiles.
|
|
1303
1565
|
def set_ramcache_mode(opts)
|
|
@@ -1307,9 +1569,10 @@ module IControl::LocalLB
|
|
|
1307
1569
|
|
|
1308
1570
|
##
|
|
1309
1571
|
# Sets the maximum size requirement of a cached object in the RAM cache.
|
|
1310
|
-
# @
|
|
1311
|
-
# @raise [IControl::Common::
|
|
1312
|
-
# @raise [IControl::Common::
|
|
1572
|
+
# @rspec_example
|
|
1573
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1574
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1575
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1313
1576
|
# @param [Hash] opts
|
|
1314
1577
|
# @option opts [IControl::LocalLB::ProfileULong] :maximum_size The maximum size requirement of a cached object in the RAM cache.
|
|
1315
1578
|
def set_ramcache_object_maximum_size(opts)
|
|
@@ -1319,9 +1582,10 @@ module IControl::LocalLB
|
|
|
1319
1582
|
|
|
1320
1583
|
##
|
|
1321
1584
|
# Sets the minimum size requirement of a cached object in the RAM cache.
|
|
1322
|
-
# @
|
|
1323
|
-
# @raise [IControl::Common::
|
|
1324
|
-
# @raise [IControl::Common::
|
|
1585
|
+
# @rspec_example
|
|
1586
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1587
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1588
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1325
1589
|
# @param [Hash] opts
|
|
1326
1590
|
# @option opts [IControl::LocalLB::ProfileULong] :minimum_size The minimum size requirement of a cached object in the RAM cache.
|
|
1327
1591
|
def set_ramcache_object_minimum_size(opts)
|
|
@@ -1331,9 +1595,10 @@ module IControl::LocalLB
|
|
|
1331
1595
|
|
|
1332
1596
|
##
|
|
1333
1597
|
# Sets the size (MB) of the RAM cache.
|
|
1334
|
-
# @
|
|
1335
|
-
# @raise [IControl::Common::
|
|
1336
|
-
# @raise [IControl::Common::
|
|
1598
|
+
# @rspec_example
|
|
1599
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1600
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1601
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1337
1602
|
# @param [Hash] opts
|
|
1338
1603
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The size (MB) of the RAM cache.
|
|
1339
1604
|
def set_ramcache_size(opts)
|
|
@@ -1343,9 +1608,10 @@ module IControl::LocalLB
|
|
|
1343
1608
|
|
|
1344
1609
|
##
|
|
1345
1610
|
# Sets the HTTP redirect/rewrite mode for the responses.
|
|
1346
|
-
# @
|
|
1347
|
-
# @raise [IControl::Common::
|
|
1348
|
-
# @raise [IControl::Common::
|
|
1611
|
+
# @rspec_example
|
|
1612
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1613
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1614
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1349
1615
|
# @param [Hash] opts
|
|
1350
1616
|
# @option opts [IControl::LocalLB::ProfileHttpRedirectRewriteMode] :modes The HTTP redirect/rewrite modes.
|
|
1351
1617
|
def set_redirect_rewrite_mode(opts)
|
|
@@ -1355,9 +1621,10 @@ module IControl::LocalLB
|
|
|
1355
1621
|
|
|
1356
1622
|
##
|
|
1357
1623
|
# Sets the HTTP chunk mode for the responses.
|
|
1358
|
-
# @
|
|
1359
|
-
# @raise [IControl::Common::
|
|
1360
|
-
# @raise [IControl::Common::
|
|
1624
|
+
# @rspec_example
|
|
1625
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1626
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1627
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1361
1628
|
# @param [Hash] opts
|
|
1362
1629
|
# @option opts [IControl::LocalLB::ProfileHttpChunkMode] :modes The HTTP chunk modes.
|
|
1363
1630
|
def set_response_chunk_mode(opts)
|
|
@@ -1367,9 +1634,10 @@ module IControl::LocalLB
|
|
|
1367
1634
|
|
|
1368
1635
|
##
|
|
1369
1636
|
# Sets the state that if true, enable horizontal security for this HTTP profile.
|
|
1370
|
-
# @
|
|
1371
|
-
# @raise [IControl::Common::
|
|
1372
|
-
# @raise [IControl::Common::
|
|
1637
|
+
# @rspec_example
|
|
1638
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
1639
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
1640
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
1373
1641
|
# @param [Hash] opts
|
|
1374
1642
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The translate extended request states for the specified profiles.
|
|
1375
1643
|
def set_security_enabled_request_state(opts)
|
|
@@ -1380,18 +1648,18 @@ module IControl::LocalLB
|
|
|
1380
1648
|
##
|
|
1381
1649
|
# A struct that describes statistics for a particular HTTP profile.
|
|
1382
1650
|
# @attr [String] profile_name The profile name.
|
|
1383
|
-
# @attr [IControl::Common::
|
|
1651
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
|
1384
1652
|
class ProfileHttpStatisticEntry < IControl::Base::Struct
|
|
1385
1653
|
icontrol_attribute :profile_name, String
|
|
1386
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
1654
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
1387
1655
|
end
|
|
1388
1656
|
|
|
1389
1657
|
##
|
|
1390
1658
|
# A struct that describes profile statistics and timestamp.
|
|
1391
|
-
# @attr [IControl::LocalLB::ProfileHttp::
|
|
1659
|
+
# @attr [IControl::LocalLB::ProfileHttp::ProfileHttpStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
|
1392
1660
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
1393
1661
|
class ProfileHttpStatistics < IControl::Base::Struct
|
|
1394
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileHttp::
|
|
1662
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileHttp::ProfileHttpStatisticEntrySequence
|
|
1395
1663
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
1396
1664
|
end
|
|
1397
1665
|
|