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,6 +1,7 @@
|
|
1
1
|
module IControl::LocalLB
|
2
2
|
##
|
3
|
-
# The PoolMember interface enables you to work with the pool members and their settings,
|
3
|
+
# The PoolMember interface enables you to work with the pool members and their settings,
|
4
|
+
# and statistics.
|
4
5
|
class PoolMember < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "pool_names"
|
@@ -18,122 +19,162 @@ module IControl::LocalLB
|
|
18
19
|
class MemberSessionState < IControl::Base::Struct; end
|
19
20
|
class MemberSessionStatus < IControl::Base::Struct; end
|
20
21
|
class MemberStatisticEntry < IControl::Base::Struct; end
|
21
|
-
class MemberStatistics < IControl::Base::Struct; end
|
22
|
+
class MemberStatistics < IControl::Base::Struct; end
|
23
|
+
class MemberConnectionLimitSequence < IControl::Base::Sequence ; end
|
24
|
+
class MemberConnectionLimitSequenceSequence < IControl::Base::SequenceSequence ; end
|
25
|
+
class MemberDynamicRatioSequence < IControl::Base::Sequence ; end
|
26
|
+
class MemberDynamicRatioSequenceSequence < IControl::Base::SequenceSequence ; end
|
27
|
+
class MemberMonitorAssociationRemovalSequence < IControl::Base::Sequence ; end
|
28
|
+
class MemberMonitorAssociationRemovalSequenceSequence < IControl::Base::SequenceSequence ; end
|
29
|
+
class MemberMonitorAssociationSequence < IControl::Base::Sequence ; end
|
30
|
+
class MemberMonitorAssociationSequenceSequence < IControl::Base::SequenceSequence ; end
|
31
|
+
class MemberMonitorInstanceStateSequence < IControl::Base::Sequence ; end
|
32
|
+
class MemberMonitorInstanceStateSequenceSequence < IControl::Base::SequenceSequence ; end
|
33
|
+
class MemberMonitorStateSequence < IControl::Base::Sequence ; end
|
34
|
+
class MemberMonitorStateSequenceSequence < IControl::Base::SequenceSequence ; end
|
35
|
+
class MemberMonitorStatusSequence < IControl::Base::Sequence ; end
|
36
|
+
class MemberMonitorStatusSequenceSequence < IControl::Base::SequenceSequence ; end
|
37
|
+
class MemberObjectStatusSequence < IControl::Base::Sequence ; end
|
38
|
+
class MemberObjectStatusSequenceSequence < IControl::Base::SequenceSequence ; end
|
39
|
+
class MemberPrioritySequence < IControl::Base::Sequence ; end
|
40
|
+
class MemberPrioritySequenceSequence < IControl::Base::SequenceSequence ; end
|
41
|
+
class MemberRatioSequence < IControl::Base::Sequence ; end
|
42
|
+
class MemberRatioSequenceSequence < IControl::Base::SequenceSequence ; end
|
43
|
+
class MemberSessionStateSequence < IControl::Base::Sequence ; end
|
44
|
+
class MemberSessionStateSequenceSequence < IControl::Base::SequenceSequence ; end
|
45
|
+
class MemberSessionStatusSequence < IControl::Base::Sequence ; end
|
46
|
+
class MemberSessionStatusSequenceSequence < IControl::Base::SequenceSequence ; end
|
47
|
+
class MemberStatisticEntrySequence < IControl::Base::Sequence ; end
|
48
|
+
class MemberStatisticsSequence < IControl::Base::Sequence ; end ##
|
22
49
|
# Gets the statistics for all pool members of this pool.
|
50
|
+
# @rspec_example
|
23
51
|
# @return [MemberStatistics]
|
24
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
25
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
26
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
52
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
53
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
54
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
27
55
|
def all_statistics
|
28
56
|
super
|
29
57
|
end
|
30
58
|
|
31
59
|
##
|
32
60
|
# Gets the connection limits for all members in this pool.
|
61
|
+
# @rspec_example
|
33
62
|
# @return [MemberConnectionLimit[]]
|
34
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
35
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
36
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
63
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
64
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
65
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
37
66
|
def connection_limit
|
38
67
|
super
|
39
68
|
end
|
40
69
|
|
41
70
|
##
|
42
71
|
# Gets the dynamic ratios for all members of this pool.
|
72
|
+
# @rspec_example
|
43
73
|
# @return [MemberDynamicRatio[]]
|
44
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
45
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
46
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
74
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
75
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
76
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
47
77
|
def dynamic_ratio
|
48
78
|
super
|
49
79
|
end
|
50
80
|
|
51
81
|
##
|
52
|
-
# Gets the monitor associations used by this pool members, i.e. the monitor rules used
|
82
|
+
# Gets the monitor associations used by this pool members, i.e. the monitor rules used
|
83
|
+
# by the pool members.
|
84
|
+
# @rspec_example
|
53
85
|
# @return [MemberMonitorAssociation[]]
|
54
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
55
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
56
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
86
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
87
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
88
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
57
89
|
def monitor_association
|
58
90
|
super
|
59
91
|
end
|
60
92
|
|
61
93
|
##
|
62
94
|
# Gets the monitor instance information for the pool members in this pool.
|
95
|
+
# @rspec_example
|
63
96
|
# @return [MemberMonitorInstanceState[]]
|
64
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
65
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
66
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
97
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
98
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
99
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
67
100
|
def monitor_instance
|
68
101
|
super
|
69
102
|
end
|
70
103
|
|
71
104
|
##
|
72
105
|
# Gets the monitor/availability status for all members of this pool.
|
106
|
+
# @rspec_example
|
73
107
|
# @return [MemberMonitorStatus[]]
|
74
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
75
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
76
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
108
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
109
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
110
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
77
111
|
def monitor_status
|
78
112
|
super
|
79
113
|
end
|
80
114
|
|
81
115
|
##
|
82
116
|
# Gets the object statuses for all members of this pool.
|
117
|
+
# @rspec_example
|
83
118
|
# @return [MemberObjectStatus[]]
|
84
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
85
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
86
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
119
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
120
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
121
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
87
122
|
def object_status
|
88
123
|
super
|
89
124
|
end
|
90
125
|
|
91
126
|
##
|
92
127
|
# Gets the priorities for all members in this pool.
|
128
|
+
# @rspec_example
|
93
129
|
# @return [MemberPriority[]]
|
94
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
95
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
96
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
130
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
131
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
132
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
97
133
|
def priority
|
98
134
|
super
|
99
135
|
end
|
100
136
|
|
101
137
|
##
|
102
138
|
# Gets the ratios for all members in this pool.
|
139
|
+
# @rspec_example
|
103
140
|
# @return [MemberRatio[]]
|
104
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
105
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
106
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
141
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
142
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
143
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
107
144
|
def ratio
|
108
145
|
super
|
109
146
|
end
|
110
147
|
|
111
148
|
##
|
112
|
-
# Note: This function has been deprecated. Please use get_session_status. Gets the
|
149
|
+
# Note: This function has been deprecated. Please use get_session_status. Gets the
|
150
|
+
# session states for all members of this pool.
|
151
|
+
# @rspec_example
|
113
152
|
# @return [MemberSessionState[]]
|
114
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
115
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
116
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
153
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
154
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
155
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
117
156
|
def session_enabled_state
|
118
157
|
super
|
119
158
|
end
|
120
159
|
|
121
160
|
##
|
122
161
|
# Gets the session status for all members of this pool.
|
162
|
+
# @rspec_example
|
123
163
|
# @return [MemberSessionStatus[]]
|
124
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
125
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
126
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
164
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
165
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
166
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
127
167
|
def session_status
|
128
168
|
super
|
129
169
|
end
|
130
170
|
|
131
171
|
##
|
132
172
|
# Gets the statistics for this set of pool members.
|
173
|
+
# @rspec_example
|
133
174
|
# @return [MemberStatistics]
|
134
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
135
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
136
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
175
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
176
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
177
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
137
178
|
# @param [Hash] opts
|
138
179
|
# @option opts [IControl::Common::IPPortDefinition[]] :members The members to get statistics from.
|
139
180
|
def statistics(opts)
|
@@ -143,16 +184,23 @@ module IControl::LocalLB
|
|
143
184
|
|
144
185
|
##
|
145
186
|
# Gets the version information for this interface.
|
187
|
+
# @rspec_example
|
146
188
|
# @return [String]
|
147
189
|
def version
|
148
190
|
super
|
149
191
|
end
|
150
192
|
|
151
193
|
##
|
152
|
-
# Removes the monitor associations for this pool members. Depending on the monitor
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
194
|
+
# Removes the monitor associations for this pool members. Depending on the monitor
|
195
|
+
# association removal rule specified, this basically deletes any explicit monitor associations
|
196
|
+
# between a pool member and a monitor rule and thus causing the pool member to use
|
197
|
+
# the default monitor association of its parent pool, or this will delete any monitor
|
198
|
+
# association for the pool members altogether, i.e. this pool members will no longer
|
199
|
+
# be monitored.
|
200
|
+
# @rspec_example
|
201
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
202
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
203
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
156
204
|
# @param [Hash] opts
|
157
205
|
# @option opts [IControl::LocalLB::PoolMember::MemberMonitorAssociationRemoval[]] :monitor_associations The monitor association removal rules that will be used to remove the monitor associations for the specified pool members.
|
158
206
|
def remove_monitor_association(opts)
|
@@ -162,9 +210,10 @@ module IControl::LocalLB
|
|
162
210
|
|
163
211
|
##
|
164
212
|
# Resets the statistics for this set of pool members.
|
165
|
-
# @
|
166
|
-
# @raise [IControl::Common::
|
167
|
-
# @raise [IControl::Common::
|
213
|
+
# @rspec_example
|
214
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
215
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
216
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
168
217
|
# @param [Hash] opts
|
169
218
|
# @option opts [IControl::Common::IPPortDefinition[]] :members The members to get statistics from.
|
170
219
|
def reset_statistics(opts)
|
@@ -174,9 +223,10 @@ module IControl::LocalLB
|
|
174
223
|
|
175
224
|
##
|
176
225
|
# Sets the connection limits for this pool members.
|
177
|
-
# @
|
178
|
-
# @raise [IControl::Common::
|
179
|
-
# @raise [IControl::Common::
|
226
|
+
# @rspec_example
|
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.
|
180
230
|
# @param [Hash] opts
|
181
231
|
# @option opts [IControl::LocalLB::PoolMember::MemberConnectionLimit[]] :limits The members and the connection limits to be set.
|
182
232
|
def set_connection_limit(opts)
|
@@ -186,9 +236,10 @@ module IControl::LocalLB
|
|
186
236
|
|
187
237
|
##
|
188
238
|
# Sets the dynamic ratios for this pool members.
|
189
|
-
# @
|
190
|
-
# @raise [IControl::Common::
|
191
|
-
# @raise [IControl::Common::
|
239
|
+
# @rspec_example
|
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.
|
192
243
|
# @param [Hash] opts
|
193
244
|
# @option opts [IControl::LocalLB::PoolMember::MemberDynamicRatio[]] :dynamic_ratios The members and the dynamic ratios to be set.
|
194
245
|
def set_dynamic_ratio(opts)
|
@@ -197,10 +248,12 @@ module IControl::LocalLB
|
|
197
248
|
end
|
198
249
|
|
199
250
|
##
|
200
|
-
# Sets/creates the monitor associations for this pool members. This basically creates
|
201
|
-
#
|
202
|
-
# @
|
203
|
-
# @raise [IControl::Common::
|
251
|
+
# Sets/creates the monitor associations for this pool members. This basically creates
|
252
|
+
# the monitor associations between a pool member and a monitor rule.
|
253
|
+
# @rspec_example
|
254
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
255
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
256
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
204
257
|
# @param [Hash] opts
|
205
258
|
# @option opts [IControl::LocalLB::PoolMember::MemberMonitorAssociation[]] :monitor_associations The monitor associations that will be used to evaluate the specified pool members.
|
206
259
|
def set_monitor_association(opts)
|
@@ -210,9 +263,10 @@ module IControl::LocalLB
|
|
210
263
|
|
211
264
|
##
|
212
265
|
# Sets the monitor/availability states for this pool members.
|
213
|
-
# @
|
214
|
-
# @raise [IControl::Common::
|
215
|
-
# @raise [IControl::Common::
|
266
|
+
# @rspec_example
|
267
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
268
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
269
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
216
270
|
# @param [Hash] opts
|
217
271
|
# @option opts [IControl::LocalLB::PoolMember::MemberMonitorState[]] :monitor_states The members and the monitor/availability states to be set.
|
218
272
|
def set_monitor_state(opts)
|
@@ -222,9 +276,10 @@ module IControl::LocalLB
|
|
222
276
|
|
223
277
|
##
|
224
278
|
# Sets the priorities for this pool members.
|
225
|
-
# @
|
226
|
-
# @raise [IControl::Common::
|
227
|
-
# @raise [IControl::Common::
|
279
|
+
# @rspec_example
|
280
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
281
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
282
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
228
283
|
# @param [Hash] opts
|
229
284
|
# @option opts [IControl::LocalLB::PoolMember::MemberPriority[]] :priorities The members and the priorities to be set.
|
230
285
|
def set_priority(opts)
|
@@ -234,9 +289,10 @@ module IControl::LocalLB
|
|
234
289
|
|
235
290
|
##
|
236
291
|
# Sets the ratios for this pool members.
|
237
|
-
# @
|
238
|
-
# @raise [IControl::Common::
|
239
|
-
# @raise [IControl::Common::
|
292
|
+
# @rspec_example
|
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.
|
240
296
|
# @param [Hash] opts
|
241
297
|
# @option opts [IControl::LocalLB::PoolMember::MemberRatio[]] :ratios The members and the ratios to be set.
|
242
298
|
def set_ratio(opts)
|
@@ -245,10 +301,12 @@ module IControl::LocalLB
|
|
245
301
|
end
|
246
302
|
|
247
303
|
##
|
248
|
-
# Sets the session states for this pool members. If session state is enabled or true,
|
249
|
-
#
|
250
|
-
# @
|
251
|
-
# @raise [IControl::Common::
|
304
|
+
# Sets the session states for this pool members. If session state is enabled or true,
|
305
|
+
# this means that new sessions will be allowed to be established with the pool members.
|
306
|
+
# @rspec_example
|
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.
|
252
310
|
# @param [Hash] opts
|
253
311
|
# @option opts [IControl::LocalLB::PoolMember::MemberSessionState[]] :session_states The members and the session states to be set.
|
254
312
|
def set_session_enabled_state(opts)
|
@@ -295,10 +353,10 @@ module IControl::LocalLB
|
|
295
353
|
##
|
296
354
|
# A struct that describes a member's monitor instances.
|
297
355
|
# @attr [IControl::Common::IPPortDefinition] member The IP address and port for the pool member.
|
298
|
-
# @attr [IControl::LocalLB::
|
356
|
+
# @attr [IControl::LocalLB::MonitorInstanceStateSequence] monitor_instances The monitor instances of the specified pool member.
|
299
357
|
class MemberMonitorInstanceState < IControl::Base::Struct
|
300
358
|
icontrol_attribute :member, IControl::Common::IPPortDefinition
|
301
|
-
icontrol_attribute :monitor_instances, IControl::LocalLB::
|
359
|
+
icontrol_attribute :monitor_instances, IControl::LocalLB::MonitorInstanceStateSequence
|
302
360
|
end
|
303
361
|
|
304
362
|
##
|
@@ -367,18 +425,18 @@ module IControl::LocalLB
|
|
367
425
|
##
|
368
426
|
# A struct that describes statistics for a particular pool member.
|
369
427
|
# @attr [IControl::Common::IPPortDefinition] member The pool member definition.
|
370
|
-
# @attr [IControl::Common::
|
428
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the pool member.
|
371
429
|
class MemberStatisticEntry < IControl::Base::Struct
|
372
430
|
icontrol_attribute :member, IControl::Common::IPPortDefinition
|
373
|
-
icontrol_attribute :statistics, IControl::Common::
|
431
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
374
432
|
end
|
375
433
|
|
376
434
|
##
|
377
435
|
# A struct that describes pool member statistics and timestamp.
|
378
|
-
# @attr [IControl::LocalLB::PoolMember::
|
436
|
+
# @attr [IControl::LocalLB::PoolMember::MemberStatisticEntrySequence] statistics The statistics for a sequence of pool members.
|
379
437
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
380
438
|
class MemberStatistics < IControl::Base::Struct
|
381
|
-
icontrol_attribute :statistics, IControl::LocalLB::PoolMember::
|
439
|
+
icontrol_attribute :statistics, IControl::LocalLB::PoolMember::MemberStatisticEntrySequence
|
382
440
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
383
441
|
end
|
384
442
|
|
@@ -1,16 +1,19 @@
|
|
1
1
|
module IControl::LocalLB
|
2
2
|
##
|
3
|
-
# The ProfileAuth interface enables you to manipulate a local load balancer's authentication
|
3
|
+
# The ProfileAuth interface enables you to manipulate a local load balancer's authentication
|
4
|
+
# profile.
|
4
5
|
class ProfileAuth < IControl::Base
|
5
6
|
|
6
7
|
set_id_name "profile_names"
|
7
8
|
|
8
9
|
class ProfileAuthStatisticEntry < IControl::Base::Struct; end
|
9
|
-
class ProfileAuthStatistics < IControl::Base::Struct; end
|
10
|
+
class ProfileAuthStatistics < IControl::Base::Struct; end
|
11
|
+
class ProfileAuthStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
10
12
|
# Creates this auth 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] :config_names The configuration used by the profile.
|
16
19
|
# @option opts [IControl::LocalLB::ProfileAuthenticationMethod] :auth_methods The authentication method used by the profile.
|
@@ -21,153 +24,171 @@ module IControl::LocalLB
|
|
21
24
|
|
22
25
|
##
|
23
26
|
# Deletes all auth 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 auth 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
46
|
# Gets the statistics for all the Auth profile.
|
47
|
+
# @rspec_example
|
42
48
|
# @return [ProfileAuthStatistics]
|
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.
|
49
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
50
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
51
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
46
52
|
def all_statistics
|
47
53
|
super
|
48
54
|
end
|
49
55
|
|
50
56
|
##
|
51
57
|
# Gets the authentication methods that this profile will be using.
|
58
|
+
# @rspec_example
|
52
59
|
# @return [ProfileAuthenticationMethod]
|
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.
|
60
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
61
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
62
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
56
63
|
def authentication_method
|
57
64
|
super
|
58
65
|
end
|
59
66
|
|
60
67
|
##
|
61
68
|
# Gets the names of the authentication configurations that this profile will be using.
|
69
|
+
# @rspec_example
|
62
70
|
# @return [ProfileString]
|
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.
|
71
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
72
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
73
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
66
74
|
def configuration_name
|
67
75
|
super
|
68
76
|
end
|
69
77
|
|
70
78
|
##
|
71
79
|
# Gets the sources of the credentials that this profile will be using.
|
80
|
+
# @rspec_example
|
72
81
|
# @return [ProfileCredentialSource]
|
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.
|
82
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
83
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
84
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
76
85
|
def credential_source
|
77
86
|
super
|
78
87
|
end
|
79
88
|
|
80
89
|
##
|
81
|
-
# Gets the names of the default profile from which this profile will derive default
|
90
|
+
# Gets the names of the default profile from which this profile will derive default
|
91
|
+
# values for its attributes.
|
92
|
+
# @rspec_example
|
82
93
|
# @return [String]
|
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.
|
94
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
95
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
96
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
86
97
|
def default_profile
|
87
98
|
super
|
88
99
|
end
|
89
100
|
|
90
101
|
##
|
91
102
|
# Gets the idle timeout for this auth profile.
|
103
|
+
# @rspec_example
|
92
104
|
# @return [ProfileULong]
|
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.
|
105
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
106
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
107
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
96
108
|
def idle_timeout
|
97
109
|
super
|
98
110
|
end
|
99
111
|
|
100
112
|
##
|
101
113
|
# Gets a list of all auth profile.
|
114
|
+
# @rspec_example
|
102
115
|
# @return [String]
|
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.
|
116
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
117
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
118
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
106
119
|
def list
|
107
120
|
super
|
108
121
|
end
|
109
122
|
|
110
123
|
##
|
111
124
|
# Gets the modes for this auth profile.
|
125
|
+
# @rspec_example
|
112
126
|
# @return [ProfileProfileMode]
|
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.
|
127
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
128
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
129
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
116
130
|
def profile_mode
|
117
131
|
super
|
118
132
|
end
|
119
133
|
|
120
134
|
##
|
121
135
|
# Gets the names of rules that this profile will be using.
|
136
|
+
# @rspec_example
|
122
137
|
# @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.
|
138
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
139
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
140
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
126
141
|
def rule_name
|
127
142
|
super
|
128
143
|
end
|
129
144
|
|
130
145
|
##
|
131
146
|
# Gets the statistics for this Auth profile.
|
147
|
+
# @rspec_example
|
132
148
|
# @return [ProfileAuthStatistics]
|
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.
|
149
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
150
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
151
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
136
152
|
def statistics
|
137
153
|
super
|
138
154
|
end
|
139
155
|
|
140
156
|
##
|
141
157
|
# Gets the version information for this interface.
|
158
|
+
# @rspec_example
|
142
159
|
# @return [String]
|
143
160
|
def version
|
144
161
|
super
|
145
162
|
end
|
146
163
|
|
147
164
|
##
|
148
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
165
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
166
|
+
# profile.
|
167
|
+
# @rspec_example
|
149
168
|
# @return [boolean]
|
150
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
151
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
152
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
169
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
170
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
171
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
153
172
|
def is_base_profile
|
154
173
|
super
|
155
174
|
end
|
156
175
|
|
157
176
|
##
|
158
177
|
# Resets the statistics for this Auth profile.
|
159
|
-
# @
|
160
|
-
# @raise [IControl::Common::
|
161
|
-
# @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.
|
162
182
|
def reset_statistics
|
163
183
|
super
|
164
184
|
end
|
165
185
|
|
166
186
|
##
|
167
187
|
# Sets the authentication methods that this profile will be using.
|
168
|
-
# @
|
169
|
-
# @raise [IControl::Common::
|
170
|
-
# @raise [IControl::Common::
|
188
|
+
# @rspec_example
|
189
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
190
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
191
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
171
192
|
# @param [Hash] opts
|
172
193
|
# @option opts [IControl::LocalLB::ProfileAuthenticationMethod] :auth_methods The authentication methods.
|
173
194
|
def set_authentication_method(opts)
|
@@ -177,9 +198,10 @@ module IControl::LocalLB
|
|
177
198
|
|
178
199
|
##
|
179
200
|
# Sets the names of the authentication configurations that this profile will be using.
|
180
|
-
# @
|
181
|
-
# @raise [IControl::Common::
|
182
|
-
# @raise [IControl::Common::
|
201
|
+
# @rspec_example
|
202
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
203
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
204
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
183
205
|
# @param [Hash] opts
|
184
206
|
# @option opts [IControl::LocalLB::ProfileString] :config_names The authentication configuration names.
|
185
207
|
def set_configuration_name(opts)
|
@@ -189,9 +211,10 @@ module IControl::LocalLB
|
|
189
211
|
|
190
212
|
##
|
191
213
|
# Sets the sources of the credentials that this profile will be using.
|
192
|
-
# @
|
193
|
-
# @raise [IControl::Common::
|
194
|
-
# @raise [IControl::Common::
|
214
|
+
# @rspec_example
|
215
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
216
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
217
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
195
218
|
# @param [Hash] opts
|
196
219
|
# @option opts [IControl::LocalLB::ProfileCredentialSource] :sources The sources of the credentials.
|
197
220
|
def set_credential_source(opts)
|
@@ -200,10 +223,12 @@ module IControl::LocalLB
|
|
200
223
|
end
|
201
224
|
|
202
225
|
##
|
203
|
-
# Sets the names of the default profile from which this profile will derive default
|
204
|
-
#
|
205
|
-
# @
|
206
|
-
# @raise [IControl::Common::
|
226
|
+
# Sets the names of the default profile from which this profile will derive default
|
227
|
+
# values for its attributes.
|
228
|
+
# @rspec_example
|
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.
|
207
232
|
# @param [Hash] opts
|
208
233
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
209
234
|
def set_default_profile(opts)
|
@@ -213,9 +238,10 @@ module IControl::LocalLB
|
|
213
238
|
|
214
239
|
##
|
215
240
|
# Sets the idle timeout for this auth profile.
|
216
|
-
# @
|
217
|
-
# @raise [IControl::Common::
|
218
|
-
# @raise [IControl::Common::
|
241
|
+
# @rspec_example
|
242
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
243
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
244
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
219
245
|
# @param [Hash] opts
|
220
246
|
# @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeout for the specified auth profiles.
|
221
247
|
def set_idle_timeout(opts)
|
@@ -225,9 +251,10 @@ module IControl::LocalLB
|
|
225
251
|
|
226
252
|
##
|
227
253
|
# Sets the modes for this auth profile.
|
228
|
-
# @
|
229
|
-
# @raise [IControl::Common::
|
230
|
-
# @raise [IControl::Common::
|
254
|
+
# @rspec_example
|
255
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
256
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
257
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
231
258
|
# @param [Hash] opts
|
232
259
|
# @option opts [IControl::LocalLB::ProfileProfileMode] :modes The modes of the specified auth profiles.
|
233
260
|
def set_profile_mode(opts)
|
@@ -237,9 +264,10 @@ module IControl::LocalLB
|
|
237
264
|
|
238
265
|
##
|
239
266
|
# Sets the names of rules that this profile will be using.
|
240
|
-
# @
|
241
|
-
# @raise [IControl::Common::
|
242
|
-
# @raise [IControl::Common::
|
267
|
+
# @rspec_example
|
268
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
269
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
270
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
243
271
|
# @param [Hash] opts
|
244
272
|
# @option opts [IControl::LocalLB::ProfileString] :rule_names The rule names.
|
245
273
|
def set_rule_name(opts)
|
@@ -250,18 +278,18 @@ module IControl::LocalLB
|
|
250
278
|
##
|
251
279
|
# A struct that describes statistics for a particular Auth profile.
|
252
280
|
# @attr [String] profile_name The profile name.
|
253
|
-
# @attr [IControl::Common::
|
281
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
254
282
|
class ProfileAuthStatisticEntry < IControl::Base::Struct
|
255
283
|
icontrol_attribute :profile_name, String
|
256
|
-
icontrol_attribute :statistics, IControl::Common::
|
284
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
257
285
|
end
|
258
286
|
|
259
287
|
##
|
260
288
|
# A struct that describes profile statistics and timestamp.
|
261
|
-
# @attr [IControl::LocalLB::ProfileAuth::
|
289
|
+
# @attr [IControl::LocalLB::ProfileAuth::ProfileAuthStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
262
290
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
263
291
|
class ProfileAuthStatistics < IControl::Base::Struct
|
264
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileAuth::
|
292
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileAuth::ProfileAuthStatisticEntrySequence
|
265
293
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
266
294
|
end
|
267
295
|
|