icontrol 0.3.1 → 0.3.2
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
@@ -1,16 +1,19 @@
|
|
1
1
|
module IControl::LocalLB
|
2
2
|
##
|
3
|
-
# The ProfileClientSSL interface enables you to manipulate a local load balancer's
|
3
|
+
# The ProfileClientSSL interface enables you to manipulate a local load balancer's
|
4
|
+
# client SSL profile.
|
4
5
|
class ProfileClientSSL < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "profile_names"
|
7
8
|
|
8
9
|
class ProfileClientSSLStatisticEntry < IControl::Base::Struct; end
|
9
|
-
class ProfileClientSSLStatistics < IControl::Base::Struct; end
|
10
|
+
class ProfileClientSSLStatistics < IControl::Base::Struct; end
|
11
|
+
class ProfileClientSSLStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
10
12
|
# Creates this client SSL profile.
|
11
|
-
# @
|
12
|
-
# @raise [IControl::Common::
|
13
|
-
# @raise [IControl::Common::
|
13
|
+
# @rspec_example
|
14
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
15
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
16
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
14
17
|
# @param [Hash] opts
|
15
18
|
# @option opts [IControl::LocalLB::ProfileString] :keys The key filenames to be used by BIG-IP acting as an SSL server.
|
16
19
|
# @option opts [IControl::LocalLB::ProfileString] :certs The certificate filenames to be used by BIG-IP acting as an SSL server.
|
@@ -21,343 +24,386 @@ module IControl::LocalLB
|
|
21
24
|
|
22
25
|
##
|
23
26
|
# Deletes all client SSL profile.
|
24
|
-
# @
|
25
|
-
# @raise [IControl::Common::
|
26
|
-
# @raise [IControl::Common::
|
27
|
+
# @rspec_example
|
28
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
29
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
30
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
27
31
|
def delete_all_profiles
|
28
32
|
super
|
29
33
|
end
|
30
34
|
|
31
35
|
##
|
32
36
|
# Deletes this client SSL profile.
|
33
|
-
# @
|
34
|
-
# @raise [IControl::Common::
|
35
|
-
# @raise [IControl::Common::
|
37
|
+
# @rspec_example
|
38
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
39
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
40
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
36
41
|
def delete_profile
|
37
42
|
super
|
38
43
|
end
|
39
44
|
|
40
45
|
##
|
41
|
-
# Gets the connection timeouts (in seconds) after sending an alert for this client
|
46
|
+
# Gets the connection timeouts (in seconds) after sending an alert for this client
|
47
|
+
# SSL profile.
|
48
|
+
# @rspec_example
|
42
49
|
# @return [ProfileULong]
|
43
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
44
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
45
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
50
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
51
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
52
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
46
53
|
def alert_timeout
|
47
54
|
super
|
48
55
|
end
|
49
56
|
|
50
57
|
##
|
51
58
|
# Gets the statistics for all the client SSL profile.
|
59
|
+
# @rspec_example
|
52
60
|
# @return [ProfileClientSSLStatistics]
|
53
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
54
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
55
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
61
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
62
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
63
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
56
64
|
def all_statistics
|
57
65
|
super
|
58
66
|
end
|
59
67
|
|
60
68
|
##
|
61
|
-
# Gets the states to indicate whether to allow non-SSL connections to pass through
|
69
|
+
# Gets the states to indicate whether to allow non-SSL connections to pass through
|
70
|
+
# as cleartext.
|
71
|
+
# @rspec_example
|
62
72
|
# @return [ProfileEnabledState]
|
63
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
64
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
65
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
73
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
74
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
75
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
66
76
|
def allow_nonssl_state
|
67
77
|
super
|
68
78
|
end
|
69
79
|
|
70
80
|
##
|
71
81
|
# Gets the client certificate chain maximum traversal depth for this client SSL profile.
|
82
|
+
# @rspec_example
|
72
83
|
# @return [ProfileULong]
|
73
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
74
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
75
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
84
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
85
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
86
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
76
87
|
def authenticate_depth
|
77
88
|
super
|
78
89
|
end
|
79
90
|
|
80
91
|
##
|
81
92
|
# Gets the states to request the client certificate once for this client SSL profile.
|
93
|
+
# @rspec_example
|
82
94
|
# @return [ProfileEnabledState]
|
83
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
84
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
85
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
95
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
96
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
97
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
86
98
|
def authenticate_once_state
|
87
99
|
super
|
88
100
|
end
|
89
101
|
|
90
102
|
##
|
91
103
|
# Gets the CA filenames for this client SSL profile.
|
104
|
+
# @rspec_example
|
92
105
|
# @return [ProfileString]
|
93
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
94
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
95
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
106
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
107
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
108
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
96
109
|
def ca_file
|
97
110
|
super
|
98
111
|
end
|
99
112
|
|
100
113
|
##
|
101
114
|
# Gets the SSL session cache sizes for this client SSL profile.
|
115
|
+
# @rspec_example
|
102
116
|
# @return [ProfileULong]
|
103
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
104
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
105
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
117
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
118
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
119
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
106
120
|
def cache_size
|
107
121
|
super
|
108
122
|
end
|
109
123
|
|
110
124
|
##
|
111
125
|
# Gets the SSL session cache timeouts for this client SSL profile.
|
126
|
+
# @rspec_example
|
112
127
|
# @return [ProfileULong]
|
113
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
114
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
115
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
128
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
129
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
130
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
116
131
|
def cache_timeout
|
117
132
|
super
|
118
133
|
end
|
119
134
|
|
120
135
|
##
|
121
136
|
# Gets the certificate filenames to be used by BIG-IP acting as an SSL server.
|
137
|
+
# @rspec_example
|
122
138
|
# @return [ProfileString]
|
123
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
124
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
125
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
139
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
140
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
141
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
126
142
|
def certificate_file
|
127
143
|
super
|
128
144
|
end
|
129
145
|
|
130
146
|
##
|
131
147
|
# Gets the certificate chain filenames for this client SSL profile.
|
148
|
+
# @rspec_example
|
132
149
|
# @return [ProfileString]
|
133
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
134
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
135
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
150
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
151
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
152
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
136
153
|
def chain_file
|
137
154
|
super
|
138
155
|
end
|
139
156
|
|
140
157
|
##
|
141
158
|
# Gets the cipher lists for this client SSL profile.
|
159
|
+
# @rspec_example
|
142
160
|
# @return [ProfileStringArray]
|
143
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
144
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
145
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
161
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
162
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
163
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
146
164
|
def cipher_list
|
147
165
|
super
|
148
166
|
end
|
149
167
|
|
150
168
|
##
|
151
169
|
# Gets the client certificate CA filenames for this client SSL profile.
|
170
|
+
# @rspec_example
|
152
171
|
# @return [ProfileString]
|
153
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
154
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
155
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
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.
|
156
175
|
def client_certificate_ca_file
|
157
176
|
super
|
158
177
|
end
|
159
178
|
|
160
179
|
##
|
161
180
|
# Gets the CRL filenames for this client SSL profile.
|
181
|
+
# @rspec_example
|
162
182
|
# @return [ProfileString]
|
163
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
164
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
165
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
183
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
184
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
185
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
166
186
|
def crl_file
|
167
187
|
super
|
168
188
|
end
|
169
189
|
|
170
190
|
##
|
171
|
-
# Gets the names of the default profile from which this profile will derive default
|
191
|
+
# Gets the names of the default profile from which this profile will derive default
|
192
|
+
# values for its attributes.
|
193
|
+
# @rspec_example
|
172
194
|
# @return [String]
|
173
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
174
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
175
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
195
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
196
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
197
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
176
198
|
def default_profile
|
177
199
|
super
|
178
200
|
end
|
179
201
|
|
180
202
|
##
|
181
|
-
# Gets the connection timeouts (in seconds) during handshake phase for this client
|
203
|
+
# Gets the connection timeouts (in seconds) during handshake phase for this client
|
204
|
+
# SSL profile.
|
205
|
+
# @rspec_example
|
182
206
|
# @return [ProfileULong]
|
183
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
184
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
185
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
207
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
208
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
209
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
186
210
|
def handshake_timeout
|
187
211
|
super
|
188
212
|
end
|
189
213
|
|
190
214
|
##
|
191
215
|
# Gets the key filenames to be used by BIG-IP acting as an SSL server.
|
216
|
+
# @rspec_example
|
192
217
|
# @return [ProfileString]
|
193
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
194
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
195
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
218
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
219
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
220
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
196
221
|
def key_file
|
197
222
|
super
|
198
223
|
end
|
199
224
|
|
200
225
|
##
|
201
226
|
# Gets a list of all client SSL profile.
|
227
|
+
# @rspec_example
|
202
228
|
# @return [String]
|
203
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
204
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
205
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
229
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
230
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
231
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
206
232
|
def list
|
207
233
|
super
|
208
234
|
end
|
209
235
|
|
210
236
|
##
|
211
237
|
# Gets the states to emulate modSSL for this client SSL profile.
|
238
|
+
# @rspec_example
|
212
239
|
# @return [ProfileEnabledState]
|
213
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
214
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
215
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
240
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
241
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
242
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
216
243
|
def modssl_emulation_state
|
217
244
|
super
|
218
245
|
end
|
219
246
|
|
220
247
|
##
|
221
248
|
# Gets the key passphrases (if any) for this client SSL profile.
|
249
|
+
# @rspec_example
|
222
250
|
# @return [ProfileString]
|
223
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
224
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
225
|
-
# @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.
|
226
254
|
def passphrase
|
227
255
|
super
|
228
256
|
end
|
229
257
|
|
230
258
|
##
|
231
259
|
# Gets the peer certification modes for this client SSL profile.
|
260
|
+
# @rspec_example
|
232
261
|
# @return [ProfileClientSSLCertificateMode]
|
233
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
234
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
235
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
262
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
263
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
264
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
236
265
|
def peer_certification_mode
|
237
266
|
super
|
238
267
|
end
|
239
268
|
|
240
269
|
##
|
241
270
|
# Gets the modes for this client SSL profile.
|
271
|
+
# @rspec_example
|
242
272
|
# @return [ProfileProfileMode]
|
243
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
244
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
245
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
273
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
274
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
275
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
246
276
|
def profile_mode
|
247
277
|
super
|
248
278
|
end
|
249
279
|
|
250
280
|
##
|
251
281
|
# Gets the SSL renegotiation maximum record delay for this client SSL profile.
|
282
|
+
# @rspec_example
|
252
283
|
# @return [ProfileULong]
|
253
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
254
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
255
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
284
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
285
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
286
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
256
287
|
def renegotiation_maximum_record_delay
|
257
288
|
super
|
258
289
|
end
|
259
290
|
|
260
291
|
##
|
261
292
|
# Gets the SSL renegotiation periods for this client SSL profile.
|
293
|
+
# @rspec_example
|
262
294
|
# @return [ProfileULong]
|
263
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
264
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
265
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
295
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
296
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
297
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
266
298
|
def renegotiation_period
|
267
299
|
super
|
268
300
|
end
|
269
301
|
|
270
302
|
##
|
271
|
-
# Gets the states controlling whether mid-stream renegotiation is allowed for this
|
303
|
+
# Gets the states controlling whether mid-stream renegotiation is allowed for this
|
304
|
+
# client SSL profile.
|
305
|
+
# @rspec_example
|
272
306
|
# @return [ProfileEnabledState]
|
273
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
274
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
275
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
307
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
308
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
309
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
276
310
|
def renegotiation_state
|
277
311
|
super
|
278
312
|
end
|
279
313
|
|
280
314
|
##
|
281
315
|
# Gets the SSL renegotiation throughputs for this client SSL profile.
|
316
|
+
# @rspec_example
|
282
317
|
# @return [ProfileULong]
|
283
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
284
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
285
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
318
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
319
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
320
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
286
321
|
def renegotiation_throughput
|
287
322
|
super
|
288
323
|
end
|
289
324
|
|
290
325
|
##
|
291
326
|
# Gets the SSL options for this client SSL profile.
|
327
|
+
# @rspec_example
|
292
328
|
# @return [ProfileSSLOption]
|
293
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
294
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
295
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
329
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
330
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
331
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
296
332
|
def ssl_option
|
297
333
|
super
|
298
334
|
end
|
299
335
|
|
300
336
|
##
|
301
337
|
# Gets the statistics for this client SSL profile.
|
338
|
+
# @rspec_example
|
302
339
|
# @return [ProfileClientSSLStatistics]
|
303
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
304
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
305
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
340
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
341
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
342
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
306
343
|
def statistics
|
307
344
|
super
|
308
345
|
end
|
309
346
|
|
310
347
|
##
|
311
|
-
# Gets the states to enforce strict SSL session resumption per RFC2246 for this client
|
348
|
+
# Gets the states to enforce strict SSL session resumption per RFC2246 for this client
|
349
|
+
# SSL profile.
|
350
|
+
# @rspec_example
|
312
351
|
# @return [ProfileEnabledState]
|
313
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
314
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
315
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
352
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
353
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
354
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
316
355
|
def strict_resume_state
|
317
356
|
super
|
318
357
|
end
|
319
358
|
|
320
359
|
##
|
321
360
|
# Gets the states to do an unclean shutdown for this client SSL profile.
|
361
|
+
# @rspec_example
|
322
362
|
# @return [ProfileEnabledState]
|
323
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
324
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
325
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
363
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
364
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
365
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
326
366
|
def unclean_shutdown_state
|
327
367
|
super
|
328
368
|
end
|
329
369
|
|
330
370
|
##
|
331
371
|
# Gets the version information for this interface.
|
372
|
+
# @rspec_example
|
332
373
|
# @return [String]
|
333
374
|
def version
|
334
375
|
super
|
335
376
|
end
|
336
377
|
|
337
378
|
##
|
338
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
379
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
380
|
+
# profile.
|
381
|
+
# @rspec_example
|
339
382
|
# @return [boolean]
|
340
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
341
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
342
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
383
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
384
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
385
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
343
386
|
def is_base_profile
|
344
387
|
super
|
345
388
|
end
|
346
389
|
|
347
390
|
##
|
348
391
|
# Resets the statistics for this client SSL profile.
|
349
|
-
# @
|
350
|
-
# @raise [IControl::Common::
|
351
|
-
# @raise [IControl::Common::
|
392
|
+
# @rspec_example
|
393
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
394
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
395
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
352
396
|
def reset_statistics
|
353
397
|
super
|
354
398
|
end
|
355
399
|
|
356
400
|
##
|
357
|
-
# Sets the connection timeouts (in seconds) after sending an alert for this client
|
358
|
-
#
|
359
|
-
# @
|
360
|
-
# @raise [IControl::Common::
|
401
|
+
# Sets the connection timeouts (in seconds) after sending an alert for this client
|
402
|
+
# SSL profile.
|
403
|
+
# @rspec_example
|
404
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
405
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
406
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
361
407
|
# @param [Hash] opts
|
362
408
|
# @option opts [IControl::LocalLB::ProfileULong] :timeouts The connection timeouts (in seconds) after sending an alert for the specified client SSL profiles.
|
363
409
|
def set_alert_timeout(opts)
|
@@ -366,10 +412,12 @@ module IControl::LocalLB
|
|
366
412
|
end
|
367
413
|
|
368
414
|
##
|
369
|
-
# Sets the states to indicate whether to allow non-SSL connections to pass through
|
370
|
-
#
|
371
|
-
# @
|
372
|
-
# @raise [IControl::Common::
|
415
|
+
# Sets the states to indicate whether to allow non-SSL connections to pass through
|
416
|
+
# as cleartext.
|
417
|
+
# @rspec_example
|
418
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
419
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
420
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
373
421
|
# @param [Hash] opts
|
374
422
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to indicate whether to allow non-SSL connections to pass through as cleartext.
|
375
423
|
def set_allow_nonssl_state(opts)
|
@@ -379,9 +427,10 @@ module IControl::LocalLB
|
|
379
427
|
|
380
428
|
##
|
381
429
|
# Sets the client certificate chain maximum traversal depth for this client SSL profile.
|
382
|
-
# @
|
383
|
-
# @raise [IControl::Common::
|
384
|
-
# @raise [IControl::Common::
|
430
|
+
# @rspec_example
|
431
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
432
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
433
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
385
434
|
# @param [Hash] opts
|
386
435
|
# @option opts [IControl::LocalLB::ProfileULong] :depths The client certificate chain maximum traversal depth for the specified client SSL profiles.
|
387
436
|
def set_authenticate_depth(opts)
|
@@ -390,10 +439,13 @@ module IControl::LocalLB
|
|
390
439
|
end
|
391
440
|
|
392
441
|
##
|
393
|
-
# Sets the states to request the client certificate once for this client SSL profile.
|
394
|
-
#
|
395
|
-
#
|
396
|
-
# @
|
442
|
+
# Sets the states to request the client certificate once for this client SSL profile.
|
443
|
+
# If the state is false/disabled, client certificate is requested for each SSL session
|
444
|
+
# renegotiation.
|
445
|
+
# @rspec_example
|
446
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
447
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
448
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
397
449
|
# @param [Hash] opts
|
398
450
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to request the client certificate once for the specified client SSL profiles.
|
399
451
|
def set_authenticate_once_state(opts)
|
@@ -403,9 +455,10 @@ module IControl::LocalLB
|
|
403
455
|
|
404
456
|
##
|
405
457
|
# Sets the CA filenames for this client SSL profile.
|
406
|
-
# @
|
407
|
-
# @raise [IControl::Common::
|
408
|
-
# @raise [IControl::Common::
|
458
|
+
# @rspec_example
|
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.
|
409
462
|
# @param [Hash] opts
|
410
463
|
# @option opts [IControl::LocalLB::ProfileString] :cas The CA filenames for the specified client SSL profiles.
|
411
464
|
def set_ca_file(opts)
|
@@ -415,9 +468,10 @@ module IControl::LocalLB
|
|
415
468
|
|
416
469
|
##
|
417
470
|
# Sets the SSL session cache sizes for this client SSL profile.
|
418
|
-
# @
|
419
|
-
# @raise [IControl::Common::
|
420
|
-
# @raise [IControl::Common::
|
471
|
+
# @rspec_example
|
472
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
473
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
474
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
421
475
|
# @param [Hash] opts
|
422
476
|
# @option opts [IControl::LocalLB::ProfileULong] :cache_sizes The SSL session cache sizes for the specified client SSL profiles.
|
423
477
|
def set_cache_size(opts)
|
@@ -427,9 +481,10 @@ module IControl::LocalLB
|
|
427
481
|
|
428
482
|
##
|
429
483
|
# Sets the SSL session cache timeouts for this client SSL profile.
|
430
|
-
# @
|
431
|
-
# @raise [IControl::Common::
|
432
|
-
# @raise [IControl::Common::
|
484
|
+
# @rspec_example
|
485
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
486
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
487
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
433
488
|
# @param [Hash] opts
|
434
489
|
# @option opts [IControl::LocalLB::ProfileULong] :timeouts The SSL session cache timeouts for the specified client SSL profiles.
|
435
490
|
def set_cache_timeout(opts)
|
@@ -439,9 +494,10 @@ module IControl::LocalLB
|
|
439
494
|
|
440
495
|
##
|
441
496
|
# Sets the certificate filenames to be used by BIG-IP acting as an SSL server.
|
442
|
-
# @
|
443
|
-
# @raise [IControl::Common::
|
444
|
-
# @raise [IControl::Common::
|
497
|
+
# @rspec_example
|
498
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
499
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
500
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
445
501
|
# @param [Hash] opts
|
446
502
|
# @option opts [IControl::LocalLB::ProfileString] :certs The certificate filenames to be used by BIG-IP acting as an SSL server.
|
447
503
|
def set_certificate_file(opts)
|
@@ -451,9 +507,10 @@ module IControl::LocalLB
|
|
451
507
|
|
452
508
|
##
|
453
509
|
# Sets the certificate chain filenames for this client SSL profile.
|
454
|
-
# @
|
455
|
-
# @raise [IControl::Common::
|
456
|
-
# @raise [IControl::Common::
|
510
|
+
# @rspec_example
|
511
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
512
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
513
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
457
514
|
# @param [Hash] opts
|
458
515
|
# @option opts [IControl::LocalLB::ProfileString] :chains The certificate chain filenames for the specified client SSL profiles.
|
459
516
|
def set_chain_file(opts)
|
@@ -463,9 +520,10 @@ module IControl::LocalLB
|
|
463
520
|
|
464
521
|
##
|
465
522
|
# Sets the cipher lists for this client SSL profile.
|
466
|
-
# @
|
467
|
-
# @raise [IControl::Common::
|
468
|
-
# @raise [IControl::Common::
|
523
|
+
# @rspec_example
|
524
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
525
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
526
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
469
527
|
# @param [Hash] opts
|
470
528
|
# @option opts [IControl::LocalLB::ProfileStringArray] :ciphers The cipher lists for the specified client SSL profiles.
|
471
529
|
def set_cipher_list(opts)
|
@@ -475,9 +533,10 @@ module IControl::LocalLB
|
|
475
533
|
|
476
534
|
##
|
477
535
|
# Sets the client certificate CA filenames for this client SSL profile.
|
478
|
-
# @
|
479
|
-
# @raise [IControl::Common::
|
480
|
-
# @raise [IControl::Common::
|
536
|
+
# @rspec_example
|
537
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
538
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
539
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
481
540
|
# @param [Hash] opts
|
482
541
|
# @option opts [IControl::LocalLB::ProfileString] :client_cert_cas The client certificate CA filenames for the specified client SSL profiles.
|
483
542
|
def set_client_certificate_ca_file(opts)
|
@@ -487,9 +546,10 @@ module IControl::LocalLB
|
|
487
546
|
|
488
547
|
##
|
489
548
|
# Sets the CRL filenames for this client SSL profile.
|
490
|
-
# @
|
491
|
-
# @raise [IControl::Common::
|
492
|
-
# @raise [IControl::Common::
|
549
|
+
# @rspec_example
|
550
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
551
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
552
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
493
553
|
# @param [Hash] opts
|
494
554
|
# @option opts [IControl::LocalLB::ProfileString] :crls The CRL filenames to be used by BIG-IP acting as an SSL server.
|
495
555
|
def set_crl_file(opts)
|
@@ -498,10 +558,12 @@ module IControl::LocalLB
|
|
498
558
|
end
|
499
559
|
|
500
560
|
##
|
501
|
-
# Sets the names of the default profile from which this profile will derive default
|
502
|
-
#
|
503
|
-
# @
|
504
|
-
# @raise [IControl::Common::
|
561
|
+
# Sets the names of the default profile from which this profile will derive default
|
562
|
+
# values for its attributes.
|
563
|
+
# @rspec_example
|
564
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
565
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
566
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
505
567
|
# @param [Hash] opts
|
506
568
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
507
569
|
def set_default_profile(opts)
|
@@ -510,10 +572,12 @@ module IControl::LocalLB
|
|
510
572
|
end
|
511
573
|
|
512
574
|
##
|
513
|
-
# Sets the connection timeouts (in seconds) during handshake phase for this client
|
514
|
-
#
|
515
|
-
# @
|
516
|
-
# @raise [IControl::Common::
|
575
|
+
# Sets the connection timeouts (in seconds) during handshake phase for this client
|
576
|
+
# SSL profile.
|
577
|
+
# @rspec_example
|
578
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
579
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
580
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
517
581
|
# @param [Hash] opts
|
518
582
|
# @option opts [IControl::LocalLB::ProfileULong] :timeouts The connection timeouts (in seconds) during handshake phase for the specified client SSL profiles.
|
519
583
|
def set_handshake_timeout(opts)
|
@@ -523,9 +587,10 @@ module IControl::LocalLB
|
|
523
587
|
|
524
588
|
##
|
525
589
|
# Sets the key filenames to be used by BIG-IP acting as an SSL server.
|
526
|
-
# @
|
527
|
-
# @raise [IControl::Common::
|
528
|
-
# @raise [IControl::Common::
|
590
|
+
# @rspec_example
|
591
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
592
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
593
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
529
594
|
# @param [Hash] opts
|
530
595
|
# @option opts [IControl::LocalLB::ProfileString] :keys The key filenames to be used by BIG-IP acting as an SSL server.
|
531
596
|
def set_key_file(opts)
|
@@ -535,9 +600,10 @@ module IControl::LocalLB
|
|
535
600
|
|
536
601
|
##
|
537
602
|
# Sets the states to emulate modSSL for this client SSL profile.
|
538
|
-
# @
|
539
|
-
# @raise [IControl::Common::
|
540
|
-
# @raise [IControl::Common::
|
603
|
+
# @rspec_example
|
604
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
605
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
606
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
541
607
|
# @param [Hash] opts
|
542
608
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to emulate modSSL for the specified client SSL profiles.
|
543
609
|
def set_modssl_emulation_state(opts)
|
@@ -547,9 +613,10 @@ module IControl::LocalLB
|
|
547
613
|
|
548
614
|
##
|
549
615
|
# Sets the key passphrases (if any) for this client SSL profile.
|
550
|
-
# @
|
551
|
-
# @raise [IControl::Common::
|
552
|
-
# @raise [IControl::Common::
|
616
|
+
# @rspec_example
|
617
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
618
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
619
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
553
620
|
# @param [Hash] opts
|
554
621
|
# @option opts [IControl::LocalLB::ProfileString] :passphrases The key passphrases (if any) for the specified client SSL profiles.
|
555
622
|
def set_passphrase(opts)
|
@@ -559,9 +626,10 @@ module IControl::LocalLB
|
|
559
626
|
|
560
627
|
##
|
561
628
|
# Sets the peer certification modes for this client SSL profile.
|
562
|
-
# @
|
563
|
-
# @raise [IControl::Common::
|
564
|
-
# @raise [IControl::Common::
|
629
|
+
# @rspec_example
|
630
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
631
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
632
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
565
633
|
# @param [Hash] opts
|
566
634
|
# @option opts [IControl::LocalLB::ProfileClientSSLCertificateMode] :modes The peer certification modes for the specified client SSL profiles.
|
567
635
|
def set_peer_certificate_mode(opts)
|
@@ -571,9 +639,10 @@ module IControl::LocalLB
|
|
571
639
|
|
572
640
|
##
|
573
641
|
# Sets the modes for this client SSL profile.
|
574
|
-
# @
|
575
|
-
# @raise [IControl::Common::
|
576
|
-
# @raise [IControl::Common::
|
642
|
+
# @rspec_example
|
643
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
644
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
645
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
577
646
|
# @param [Hash] opts
|
578
647
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The modes of the specified client SSL profiles.
|
579
648
|
def set_profile_mode(opts)
|
@@ -583,9 +652,10 @@ module IControl::LocalLB
|
|
583
652
|
|
584
653
|
##
|
585
654
|
# Sets the SSL renegotiation maximum record delay for this client SSL profile.
|
586
|
-
# @
|
587
|
-
# @raise [IControl::Common::
|
588
|
-
# @raise [IControl::Common::
|
655
|
+
# @rspec_example
|
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.
|
589
659
|
# @param [Hash] opts
|
590
660
|
# @option opts [IControl::LocalLB::ProfileULong] :delays The SSL renegotiation maximum record delay for the specified client SSL profiles.
|
591
661
|
def set_renegotiation_maximum_record_delay(opts)
|
@@ -595,9 +665,10 @@ module IControl::LocalLB
|
|
595
665
|
|
596
666
|
##
|
597
667
|
# Sets the SSL renegotiation periods for this client SSL profile.
|
598
|
-
# @
|
599
|
-
# @raise [IControl::Common::
|
600
|
-
# @raise [IControl::Common::
|
668
|
+
# @rspec_example
|
669
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
670
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
671
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
601
672
|
# @param [Hash] opts
|
602
673
|
# @option opts [IControl::LocalLB::ProfileULong] :periods The SSL renegotiation periods for the specified client SSL profiles.
|
603
674
|
def set_renegotiation_period(opts)
|
@@ -606,10 +677,15 @@ module IControl::LocalLB
|
|
606
677
|
end
|
607
678
|
|
608
679
|
##
|
609
|
-
# Sets the states controlling whether mid-stream renegotiation is allowed for this
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
680
|
+
# Sets the states controlling whether mid-stream renegotiation is allowed for this
|
681
|
+
# client SSL profile. If renegotiations are enabled, the behavior is unchanged from
|
682
|
+
# previous releases, and mid-stream SSL renegotiations are allowed. If renegotiations
|
683
|
+
# are disabled, and we are acting as an SSL server, we will abort the connection. For
|
684
|
+
# ClientSSL, renegotiations are disabled by default.
|
685
|
+
# @rspec_example
|
686
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
687
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
688
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
613
689
|
# @param [Hash] opts
|
614
690
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
615
691
|
def set_renegotiation_state(opts)
|
@@ -619,9 +695,10 @@ module IControl::LocalLB
|
|
619
695
|
|
620
696
|
##
|
621
697
|
# Sets the SSL renegotiation throughputs for this client SSL profile.
|
622
|
-
# @
|
623
|
-
# @raise [IControl::Common::
|
624
|
-
# @raise [IControl::Common::
|
698
|
+
# @rspec_example
|
699
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
700
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
701
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
625
702
|
# @param [Hash] opts
|
626
703
|
# @option opts [IControl::LocalLB::ProfileULong] :throughputs The SSL renegotiation throughputs for the specified client SSL profiles.
|
627
704
|
def set_renegotiation_throughput(opts)
|
@@ -631,9 +708,10 @@ module IControl::LocalLB
|
|
631
708
|
|
632
709
|
##
|
633
710
|
# Sets the SSL options for this client SSL profile.
|
634
|
-
# @
|
635
|
-
# @raise [IControl::Common::
|
636
|
-
# @raise [IControl::Common::
|
711
|
+
# @rspec_example
|
712
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
713
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
714
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
637
715
|
# @param [Hash] opts
|
638
716
|
# @option opts [IControl::LocalLB::ProfileSSLOption] :options The list of SSL options for the specified client SSL profiles.
|
639
717
|
def set_ssl_option(opts)
|
@@ -642,10 +720,13 @@ module IControl::LocalLB
|
|
642
720
|
end
|
643
721
|
|
644
722
|
##
|
645
|
-
# Sets the states to enforce strict SSL session resumption per RFC2246 for this client
|
646
|
-
#
|
647
|
-
#
|
648
|
-
# @
|
723
|
+
# Sets the states to enforce strict SSL session resumption per RFC2246 for this client
|
724
|
+
# SSL profile. If the state is true/enabled, don't send a close notify alert when closing
|
725
|
+
# connection.
|
726
|
+
# @rspec_example
|
727
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
728
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
729
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
649
730
|
# @param [Hash] opts
|
650
731
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to enforce strict SSL session resumption per RFC2246 for the specified client SSL profiles.
|
651
732
|
def set_strict_resume_state(opts)
|
@@ -654,10 +735,12 @@ module IControl::LocalLB
|
|
654
735
|
end
|
655
736
|
|
656
737
|
##
|
657
|
-
# Sets the states to do an unclean shutdown for this client SSL profile. If the state
|
658
|
-
#
|
659
|
-
# @
|
660
|
-
# @raise [IControl::Common::
|
738
|
+
# Sets the states to do an unclean shutdown for this client SSL profile. If the state
|
739
|
+
# is true/enabled, don't send a close notify alert when closing connection.
|
740
|
+
# @rspec_example
|
741
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
742
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
743
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
661
744
|
# @param [Hash] opts
|
662
745
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to do an unclean shutdown for the specified client SSL profiles.
|
663
746
|
def set_unclean_shutdown_state(opts)
|
@@ -668,18 +751,18 @@ module IControl::LocalLB
|
|
668
751
|
##
|
669
752
|
# A struct that describes statistics for a particular client SSL profile.
|
670
753
|
# @attr [String] profile_name The profile name.
|
671
|
-
# @attr [IControl::Common::
|
754
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
672
755
|
class ProfileClientSSLStatisticEntry < IControl::Base::Struct
|
673
756
|
icontrol_attribute :profile_name, String
|
674
|
-
icontrol_attribute :statistics, IControl::Common::
|
757
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
675
758
|
end
|
676
759
|
|
677
760
|
##
|
678
761
|
# A struct that describes profile statistics and timestamp.
|
679
|
-
# @attr [IControl::LocalLB::ProfileClientSSL::
|
762
|
+
# @attr [IControl::LocalLB::ProfileClientSSL::ProfileClientSSLStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
680
763
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
681
764
|
class ProfileClientSSLStatistics < IControl::Base::Struct
|
682
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileClientSSL::
|
765
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileClientSSL::ProfileClientSSLStatisticEntrySequence
|
683
766
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
684
767
|
end
|
685
768
|
|