icontrol 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/icontrol/arx.rb +38 -8
- data/lib/icontrol/arx/api.rb +1 -0
- data/lib/icontrol/arx/chassis.rb +11 -0
- data/lib/icontrol/arx/export.rb +4 -1
- data/lib/icontrol/arx/file_change_notification.rb +25 -4
- data/lib/icontrol/arx/file_server.rb +2 -0
- data/lib/icontrol/arx/namespace.rb +2 -0
- data/lib/icontrol/arx/network.rb +3 -0
- data/lib/icontrol/arx/policy.rb +3 -0
- data/lib/icontrol/arx/share.rb +2 -0
- data/lib/icontrol/arx/virtual_service.rb +3 -0
- data/lib/icontrol/arx/volume.rb +2 -0
- data/lib/icontrol/asm.rb +18 -3
- data/lib/icontrol/asm/object_params.rb +12 -6
- data/lib/icontrol/asm/policy.rb +118 -79
- data/lib/icontrol/asm/system_configuration.rb +27 -19
- data/lib/icontrol/asm/web_application.rb +74 -52
- data/lib/icontrol/asm/web_application_group.rb +33 -24
- data/lib/icontrol/base.rb +1 -0
- data/lib/icontrol/base/exception.rb +1 -0
- data/lib/icontrol/base/icontrol/local_lb/pool.rb +7 -0
- data/lib/icontrol/base/icontrol_overlay.rb +6 -0
- data/lib/icontrol/base/predeclarations.rb +5 -4
- data/lib/icontrol/base/struct.rb +6 -2
- data/lib/icontrol/common.rb +55 -4
- data/lib/icontrol/global_lb.rb +22 -3
- data/lib/icontrol/global_lb/application.rb +63 -44
- data/lib/icontrol/global_lb/data_center.rb +82 -58
- data/lib/icontrol/global_lb/dnssec_key.rb +152 -90
- data/lib/icontrol/global_lb/dnssec_zone.rb +55 -35
- data/lib/icontrol/global_lb/globals.rb +662 -430
- data/lib/icontrol/global_lb/link.rb +181 -131
- data/lib/icontrol/global_lb/monitor.rb +174 -104
- data/lib/icontrol/global_lb/pool.rb +290 -203
- data/lib/icontrol/global_lb/pool_member.rb +118 -71
- data/lib/icontrol/global_lb/region.rb +37 -25
- data/lib/icontrol/global_lb/rule.rb +53 -37
- data/lib/icontrol/global_lb/server.rb +176 -124
- data/lib/icontrol/global_lb/topology.rb +41 -27
- data/lib/icontrol/global_lb/virtual_server.rb +118 -84
- data/lib/icontrol/global_lb/wide_ip.rb +168 -117
- data/lib/icontrol/local_lb.rb +81 -10
- data/lib/icontrol/local_lb/klass.rb +233 -153
- data/lib/icontrol/local_lb/monitor.rb +158 -96
- data/lib/icontrol/local_lb/nat.rb +74 -52
- data/lib/icontrol/local_lb/node_address.rb +123 -86
- data/lib/icontrol/local_lb/pool.rb +229 -164
- data/lib/icontrol/local_lb/pool_member.rb +134 -76
- data/lib/icontrol/local_lb/profile_auth.rb +103 -75
- data/lib/icontrol/local_lb/profile_client_ssl.rb +284 -201
- data/lib/icontrol/local_lb/profile_diameter.rb +113 -71
- data/lib/icontrol/local_lb/profile_dns.rb +65 -46
- data/lib/icontrol/local_lb/profile_fast_http.rb +265 -178
- data/lib/icontrol/local_lb/profile_fast_l4.rb +283 -194
- data/lib/icontrol/local_lb/profile_ftp.rb +81 -58
- data/lib/icontrol/local_lb/profile_http.rb +701 -433
- data/lib/icontrol/local_lb/profile_http_class.rb +169 -121
- data/lib/icontrol/local_lb/profile_iiop.rb +87 -63
- data/lib/icontrol/local_lb/profile_one_connect.rb +99 -71
- data/lib/icontrol/local_lb/profile_persistence.rb +326 -203
- data/lib/icontrol/local_lb/profile_radius.rb +94 -62
- data/lib/icontrol/local_lb/profile_rtsp.rb +207 -129
- data/lib/icontrol/local_lb/profile_sctp.rb +231 -167
- data/lib/icontrol/local_lb/profile_server_ssl.rb +268 -189
- data/lib/icontrol/local_lb/profile_sip.rb +145 -99
- data/lib/icontrol/local_lb/profile_stream.rb +71 -51
- data/lib/icontrol/local_lb/profile_tcp.rb +455 -296
- data/lib/icontrol/local_lb/profile_udp.rb +109 -78
- data/lib/icontrol/local_lb/profile_user_statistic.rb +77 -46
- data/lib/icontrol/local_lb/profile_xml.rb +116 -79
- data/lib/icontrol/local_lb/ram_cache_information.rb +43 -20
- data/lib/icontrol/local_lb/rate_class.rb +523 -318
- data/lib/icontrol/local_lb/rule.rb +53 -37
- data/lib/icontrol/local_lb/snat.rb +96 -65
- data/lib/icontrol/local_lb/snat_pool.rb +54 -39
- data/lib/icontrol/local_lb/snat_pool_member.rb +22 -15
- data/lib/icontrol/local_lb/snat_translation_address.rb +94 -69
- data/lib/icontrol/local_lb/virtual_address.rb +99 -70
- data/lib/icontrol/local_lb/virtual_server.rb +358 -243
- data/lib/icontrol/lt_config.rb +8 -1
- data/lib/icontrol/lt_config/field.rb +87 -53
- data/lib/icontrol/lt_config/klass.rb +59 -43
- data/lib/icontrol/management.rb +80 -38
- data/lib/icontrol/management/ccldap_configuration.rb +218 -144
- data/lib/icontrol/management/change_control.rb +67 -41
- data/lib/icontrol/management/crldp_configuration.rb +73 -52
- data/lib/icontrol/management/crldp_server.rb +55 -39
- data/lib/icontrol/management/db_variable.rb +32 -21
- data/lib/icontrol/management/event_notification.rb +19 -8
- data/lib/icontrol/management/event_subscription.rb +121 -74
- data/lib/icontrol/management/key_certificate.rb +235 -138
- data/lib/icontrol/management/ldap_configuration.rb +249 -179
- data/lib/icontrol/management/license_administration.rb +97 -56
- data/lib/icontrol/management/named.rb +103 -67
- data/lib/icontrol/management/ocsp_configuration.rb +33 -24
- data/lib/icontrol/management/ocsp_responder.rb +294 -165
- data/lib/icontrol/management/partition.rb +42 -23
- data/lib/icontrol/management/provision.rb +73 -39
- data/lib/icontrol/management/radius_configuration.rb +85 -57
- data/lib/icontrol/management/radius_server.rb +51 -37
- data/lib/icontrol/management/resource_record.rb +163 -121
- data/lib/icontrol/management/snmp_configuration.rb +675 -390
- data/lib/icontrol/management/tacacs_configuration.rb +99 -67
- data/lib/icontrol/management/tmos_module.rb +20 -8
- data/lib/icontrol/management/user_management.rb +198 -124
- data/lib/icontrol/management/view.rb +33 -24
- data/lib/icontrol/management/zone.rb +49 -34
- data/lib/icontrol/management/zone_runner.rb +11 -7
- data/lib/icontrol/networking.rb +31 -4
- data/lib/icontrol/networking/admin_ip.rb +92 -71
- data/lib/icontrol/networking/arp.rb +41 -28
- data/lib/icontrol/networking/i_session_advertised_route.rb +47 -32
- data/lib/icontrol/networking/i_session_local_interface.rb +72 -52
- data/lib/icontrol/networking/i_session_peer_discovery.rb +105 -68
- data/lib/icontrol/networking/i_session_remote_interface.rb +105 -76
- data/lib/icontrol/networking/interfaces.rb +241 -142
- data/lib/icontrol/networking/packet_filter.rb +111 -69
- data/lib/icontrol/networking/packet_filter_globals.rb +39 -28
- data/lib/icontrol/networking/port_mirror.rb +39 -27
- data/lib/icontrol/networking/profile_gre.rb +63 -41
- data/lib/icontrol/networking/profile_ipip.rb +38 -25
- data/lib/icontrol/networking/profile_wccpgre.rb +85 -55
- data/lib/icontrol/networking/route_domain.rb +70 -44
- data/lib/icontrol/networking/route_table.rb +128 -91
- data/lib/icontrol/networking/self_ip.rb +57 -39
- data/lib/icontrol/networking/self_ip_port_lockdown.rb +34 -22
- data/lib/icontrol/networking/stp_globals.rb +115 -63
- data/lib/icontrol/networking/stp_instance.rb +166 -68
- data/lib/icontrol/networking/trunk.rb +165 -101
- data/lib/icontrol/networking/tunnel.rb +77 -52
- data/lib/icontrol/networking/vlan.rb +140 -98
- data/lib/icontrol/networking/vlan_group.rb +145 -101
- data/lib/icontrol/system.rb +70 -33
- data/lib/icontrol/system/cluster.rb +103 -81
- data/lib/icontrol/system/config_sync.rb +128 -72
- data/lib/icontrol/system/connections.rb +27 -17
- data/lib/icontrol/system/disk.rb +134 -67
- data/lib/icontrol/system/failover.rb +44 -27
- data/lib/icontrol/system/geo_ip.rb +16 -5
- data/lib/icontrol/system/inet.rb +47 -30
- data/lib/icontrol/system/internal.rb +13 -9
- data/lib/icontrol/system/services.rb +75 -42
- data/lib/icontrol/system/software_management.rb +132 -83
- data/lib/icontrol/system/statistics.rb +443 -298
- data/lib/icontrol/system/system_info.rb +137 -95
- data/lib/icontrol/web_accelerator/applications.rb +17 -10
- data/lib/icontrol/web_accelerator/policies.rb +13 -9
- data/lib/icontrol/web_accelerator/proxy_message.rb +11 -7
- data/spec/icontrol/local_lb/pool_member_spec.rb +495 -0
- data/spec/icontrol/local_lb/profile_http_class_spec.rb +514 -0
- metadata +10 -4
|
@@ -1,132 +1,150 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The VirtualAddress interface enables you to work with the states, statistics, limits,
|
|
3
|
+
# The VirtualAddress interface enables you to work with the states, statistics, limits,
|
|
4
|
+
# availability, and settings of a local load balancer's virtual address.
|
|
4
5
|
class VirtualAddress < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "virtual_addresses"
|
|
7
8
|
|
|
8
9
|
class VirtualAddressStatisticEntry < IControl::Base::Struct; end
|
|
9
|
-
class VirtualAddressStatistics < IControl::Base::Struct; end
|
|
10
|
+
class VirtualAddressStatistics < IControl::Base::Struct; end
|
|
11
|
+
class VirtualAddressStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
10
12
|
# Deletes this virtual addresse.
|
|
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
|
def delete_virtual_address
|
|
15
18
|
super
|
|
16
19
|
end
|
|
17
20
|
|
|
18
21
|
##
|
|
19
22
|
# Gets the statistics for all the virtual addresse.
|
|
23
|
+
# @rspec_example
|
|
20
24
|
# @return [VirtualAddressStatistics]
|
|
21
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
22
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
23
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
25
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
26
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
27
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
24
28
|
def all_statistics
|
|
25
29
|
super
|
|
26
30
|
end
|
|
27
31
|
|
|
28
32
|
##
|
|
29
33
|
# Gets the ARP states for this virtual addresse.
|
|
34
|
+
# @rspec_example
|
|
30
35
|
# @return [EnabledState]
|
|
31
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
32
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
33
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
36
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
37
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
38
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
34
39
|
def arp_state
|
|
35
40
|
super
|
|
36
41
|
end
|
|
37
42
|
|
|
38
43
|
##
|
|
39
44
|
# Gets the connection limits for this virtual addresse.
|
|
45
|
+
# @rspec_example
|
|
40
46
|
# @return [ULong64]
|
|
41
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
42
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
43
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
47
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
48
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
49
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
44
50
|
def connection_limit
|
|
45
51
|
super
|
|
46
52
|
end
|
|
47
53
|
|
|
48
54
|
##
|
|
49
55
|
# Gets the enabled states of this virtual addresse.
|
|
56
|
+
# @rspec_example
|
|
50
57
|
# @return [EnabledState]
|
|
51
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
52
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
53
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
58
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
59
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
60
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
54
61
|
def enabled_state
|
|
55
62
|
super
|
|
56
63
|
end
|
|
57
64
|
|
|
58
65
|
##
|
|
59
|
-
# Gets the the states that indicate whether these virtual addresse should be shared
|
|
66
|
+
# Gets the the states that indicate whether these virtual addresse should be shared
|
|
67
|
+
# between the redundant pair. This is typically used in one-armed Combo pair, where
|
|
68
|
+
# GTM is only licensed on one of the boxes. Default is TRUE.
|
|
69
|
+
# @rspec_example
|
|
60
70
|
# @return [EnabledState]
|
|
61
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
62
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
63
|
-
# @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.
|
|
64
74
|
def is_floating_state
|
|
65
75
|
super
|
|
66
76
|
end
|
|
67
77
|
|
|
68
78
|
##
|
|
69
79
|
# Gets a list of virtual addresse.
|
|
80
|
+
# @rspec_example
|
|
70
81
|
# @return [String]
|
|
71
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
72
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
73
|
-
# @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.
|
|
74
85
|
def list
|
|
75
86
|
super
|
|
76
87
|
end
|
|
77
88
|
|
|
78
89
|
##
|
|
79
90
|
# Gets the status of each of this virtual addresse.
|
|
91
|
+
# @rspec_example
|
|
80
92
|
# @return [ObjectStatus]
|
|
81
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
82
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
83
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
93
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
94
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
95
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
84
96
|
def object_status
|
|
85
97
|
super
|
|
86
98
|
end
|
|
87
99
|
|
|
88
100
|
##
|
|
89
101
|
# Gets the route advertisement states for this virtual addresse.
|
|
102
|
+
# @rspec_example
|
|
90
103
|
# @return [EnabledState]
|
|
91
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
92
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
93
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
105
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
106
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
94
107
|
def route_advertisement_state
|
|
95
108
|
super
|
|
96
109
|
end
|
|
97
110
|
|
|
98
111
|
##
|
|
99
112
|
# Gets the statistics for this virtual addresse.
|
|
113
|
+
# @rspec_example
|
|
100
114
|
# @return [VirtualAddressStatistics]
|
|
101
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
102
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
103
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
115
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
116
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
117
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
118
|
def statistics
|
|
105
119
|
super
|
|
106
120
|
end
|
|
107
121
|
|
|
108
122
|
##
|
|
109
|
-
# Gets the status dependency scopes that are used to calculate the virtual addresse'
|
|
123
|
+
# Gets the status dependency scopes that are used to calculate the virtual addresse'
|
|
124
|
+
# status based on the related virtual servers' status.
|
|
125
|
+
# @rspec_example
|
|
110
126
|
# @return [VirtualAddressStatusDependency]
|
|
111
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
112
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
113
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
127
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
128
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
129
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
114
130
|
def status_dependency_scope
|
|
115
131
|
super
|
|
116
132
|
end
|
|
117
133
|
|
|
118
134
|
##
|
|
119
135
|
# Gets the list of unit IDs used by this virtual addresse.
|
|
136
|
+
# @rspec_example
|
|
120
137
|
# @return [long]
|
|
121
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
122
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
123
|
-
# @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.
|
|
124
141
|
def unit_id
|
|
125
142
|
super
|
|
126
143
|
end
|
|
127
144
|
|
|
128
145
|
##
|
|
129
146
|
# Gets the version information for this interface.
|
|
147
|
+
# @rspec_example
|
|
130
148
|
# @return [String]
|
|
131
149
|
def version
|
|
132
150
|
super
|
|
@@ -134,18 +152,20 @@ module IControl::LocalLB
|
|
|
134
152
|
|
|
135
153
|
##
|
|
136
154
|
# Resets the statistics for this virtual addresse.
|
|
137
|
-
# @
|
|
138
|
-
# @raise [IControl::Common::
|
|
139
|
-
# @raise [IControl::Common::
|
|
155
|
+
# @rspec_example
|
|
156
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
157
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
158
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
140
159
|
def reset_statistics
|
|
141
160
|
super
|
|
142
161
|
end
|
|
143
162
|
|
|
144
163
|
##
|
|
145
164
|
# Sets the ARP states for this virtual addresse.
|
|
146
|
-
# @
|
|
147
|
-
# @raise [IControl::Common::
|
|
148
|
-
# @raise [IControl::Common::
|
|
165
|
+
# @rspec_example
|
|
166
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
167
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
168
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
149
169
|
# @param [Hash] opts
|
|
150
170
|
# @option opts [IControl::Common::EnabledState] :states The ARP states to set.
|
|
151
171
|
def set_arp_state(opts)
|
|
@@ -155,9 +175,10 @@ module IControl::LocalLB
|
|
|
155
175
|
|
|
156
176
|
##
|
|
157
177
|
# Sets the connection limits of this virtual addresse.
|
|
158
|
-
# @
|
|
159
|
-
# @raise [IControl::Common::
|
|
160
|
-
# @raise [IControl::Common::
|
|
178
|
+
# @rspec_example
|
|
179
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
180
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
181
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
161
182
|
# @param [Hash] opts
|
|
162
183
|
# @option opts [IControl::Common::ULong64] :limits The connection limits to set.
|
|
163
184
|
def set_connection_limit(opts)
|
|
@@ -167,9 +188,10 @@ module IControl::LocalLB
|
|
|
167
188
|
|
|
168
189
|
##
|
|
169
190
|
# Sets the enabled states of this virtual addresse.
|
|
170
|
-
# @
|
|
171
|
-
# @raise [IControl::Common::
|
|
172
|
-
# @raise [IControl::Common::
|
|
191
|
+
# @rspec_example
|
|
192
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
193
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
194
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
173
195
|
# @param [Hash] opts
|
|
174
196
|
# @option opts [IControl::Common::EnabledState] :states The enabled states to set.
|
|
175
197
|
def set_enabled_state(opts)
|
|
@@ -178,10 +200,13 @@ module IControl::LocalLB
|
|
|
178
200
|
end
|
|
179
201
|
|
|
180
202
|
##
|
|
181
|
-
# Sets the states that indicate whether these virtual addresse should be shared between
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
# @
|
|
203
|
+
# Sets the states that indicate whether these virtual addresse should be shared between
|
|
204
|
+
# the redundant pair. This is typically used in one-armed Combo pair, where GTM is
|
|
205
|
+
# only licensed on one of the boxes. Default is TRUE.
|
|
206
|
+
# @rspec_example
|
|
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.
|
|
185
210
|
# @param [Hash] opts
|
|
186
211
|
# @option opts [IControl::Common::EnabledState] :states The states to set.
|
|
187
212
|
def set_is_floating_state(opts)
|
|
@@ -191,9 +216,10 @@ module IControl::LocalLB
|
|
|
191
216
|
|
|
192
217
|
##
|
|
193
218
|
# Sets the route advertisement states for this virtual addresse.
|
|
194
|
-
# @
|
|
195
|
-
# @raise [IControl::Common::
|
|
196
|
-
# @raise [IControl::Common::
|
|
219
|
+
# @rspec_example
|
|
220
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
221
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
222
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
197
223
|
# @param [Hash] opts
|
|
198
224
|
# @option opts [IControl::Common::EnabledState] :states The route advertisement states to set.
|
|
199
225
|
def set_route_advertisement_state(opts)
|
|
@@ -202,10 +228,12 @@ module IControl::LocalLB
|
|
|
202
228
|
end
|
|
203
229
|
|
|
204
230
|
##
|
|
205
|
-
# Sets the status dependency scopes that are used to calculate the virtual addresse'
|
|
206
|
-
#
|
|
207
|
-
# @
|
|
208
|
-
# @raise [IControl::Common::
|
|
231
|
+
# Sets the status dependency scopes that are used to calculate the virtual addresse'
|
|
232
|
+
# status based on the related virtual servers' status.
|
|
233
|
+
# @rspec_example
|
|
234
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
235
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
236
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
209
237
|
# @param [Hash] opts
|
|
210
238
|
# @option opts [IControl::LocalLB::VirtualAddressStatusDependency] :scopes The status dependency scopes to set.
|
|
211
239
|
def set_status_dependency_scope(opts)
|
|
@@ -215,9 +243,10 @@ module IControl::LocalLB
|
|
|
215
243
|
|
|
216
244
|
##
|
|
217
245
|
# Sets the unit IDs for this virtual addresse.
|
|
218
|
-
# @
|
|
219
|
-
# @raise [IControl::Common::
|
|
220
|
-
# @raise [IControl::Common::
|
|
246
|
+
# @rspec_example
|
|
247
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
248
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
249
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
221
250
|
# @param [Hash] opts
|
|
222
251
|
# @option opts [long] :unit_ids The unit IDs to set.
|
|
223
252
|
def set_unit_id(opts)
|
|
@@ -228,18 +257,18 @@ module IControl::LocalLB
|
|
|
228
257
|
##
|
|
229
258
|
# A struct that describes a virtual address and its statistics.
|
|
230
259
|
# @attr [String] virtual_address The virtual address.
|
|
231
|
-
# @attr [IControl::Common::
|
|
260
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics of the virtual server.
|
|
232
261
|
class VirtualAddressStatisticEntry < IControl::Base::Struct
|
|
233
262
|
icontrol_attribute :virtual_address, String
|
|
234
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
263
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
235
264
|
end
|
|
236
265
|
|
|
237
266
|
##
|
|
238
267
|
# A struct that describes virtual address statistics and timestamp.
|
|
239
|
-
# @attr [IControl::LocalLB::VirtualAddress::
|
|
268
|
+
# @attr [IControl::LocalLB::VirtualAddress::VirtualAddressStatisticEntrySequence] statistics The statistics for a sequence of virtual addresses.
|
|
240
269
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
241
270
|
class VirtualAddressStatistics < IControl::Base::Struct
|
|
242
|
-
icontrol_attribute :statistics, IControl::LocalLB::VirtualAddress::
|
|
271
|
+
icontrol_attribute :statistics, IControl::LocalLB::VirtualAddress::VirtualAddressStatisticEntrySequence
|
|
243
272
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
244
273
|
end
|
|
245
274
|
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The VirtualServer interface enables you to work with the states, statistics, limits,
|
|
3
|
+
# The VirtualServer interface enables you to work with the states, statistics, limits,
|
|
4
|
+
# availability, and settings of a local load balancer's virtual servers. For example,
|
|
5
|
+
# you can use the Virtual Server interface to create a virtual server from a specified
|
|
6
|
+
# pool or rule or to delete a virtual server from a specified pool.
|
|
4
7
|
class VirtualServer < IControl::Base
|
|
5
8
|
|
|
6
9
|
set_id_name "virtual_servers"
|
|
@@ -16,14 +19,35 @@ module IControl::LocalLB
|
|
|
16
19
|
class VirtualServerRule < IControl::Base::Struct; end
|
|
17
20
|
class VirtualServerStatisticEntry < IControl::Base::Struct; end
|
|
18
21
|
class VirtualServerStatistics < IControl::Base::Struct; end
|
|
22
|
+
class VirtualServerAuthenticationSequence < IControl::Base::Sequence ; end
|
|
23
|
+
class VirtualServerAuthenticationSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
24
|
+
class VirtualServerCMPEnableModeSequence < IControl::Base::Sequence ; end
|
|
25
|
+
class VirtualServerClonePoolSequence < IControl::Base::Sequence ; end
|
|
26
|
+
class VirtualServerClonePoolSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
27
|
+
class VirtualServerHttpClassSequence < IControl::Base::Sequence ; end
|
|
28
|
+
class VirtualServerHttpClassSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
29
|
+
class VirtualServerModuleScoreSequence < IControl::Base::Sequence ; end
|
|
30
|
+
class VirtualServerModuleScoreSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
31
|
+
class VirtualServerPersistenceSequence < IControl::Base::Sequence ; end
|
|
32
|
+
class VirtualServerPersistenceSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
33
|
+
class VirtualServerProfileAttributeSequence < IControl::Base::Sequence ; end
|
|
34
|
+
class VirtualServerProfileAttributeSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
35
|
+
class VirtualServerProfileSequence < IControl::Base::Sequence ; end
|
|
36
|
+
class VirtualServerProfileSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
37
|
+
class VirtualServerResourceSequence < IControl::Base::Sequence ; end
|
|
38
|
+
class VirtualServerRuleSequence < IControl::Base::Sequence ; end
|
|
39
|
+
class VirtualServerRuleSequenceSequence < IControl::Base::SequenceSequence ; end
|
|
40
|
+
class VirtualServerStatisticEntrySequence < IControl::Base::Sequence ; end
|
|
41
|
+
class VirtualServerTypeSequence < IControl::Base::Sequence ; end
|
|
19
42
|
# A list of CMP enable modes.
|
|
20
43
|
class VirtualServerCMPEnableMode < IControl::Base::Enumeration; end
|
|
21
44
|
# A list of virtual server types.
|
|
22
45
|
class VirtualServerType < IControl::Base::Enumeration; end ##
|
|
23
46
|
# Adds/associates authentication profiles to this virtual server.
|
|
24
|
-
# @
|
|
25
|
-
# @raise [IControl::Common::
|
|
26
|
-
# @raise [IControl::Common::
|
|
47
|
+
# @rspec_example
|
|
48
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
49
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
50
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
27
51
|
# @param [Hash] opts
|
|
28
52
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerAuthentication[]] :profiles The authentication profiles to add to the virtual servers.
|
|
29
53
|
def add_authentication_profile(opts)
|
|
@@ -33,9 +57,10 @@ module IControl::LocalLB
|
|
|
33
57
|
|
|
34
58
|
##
|
|
35
59
|
# Adds/associates clone pools to this virtual server.
|
|
36
|
-
# @
|
|
37
|
-
# @raise [IControl::Common::
|
|
38
|
-
# @raise [IControl::Common::
|
|
60
|
+
# @rspec_example
|
|
61
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
62
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
63
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
39
64
|
# @param [Hash] opts
|
|
40
65
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerClonePool[]] :clone_pools The clone pools to add to the virtual servers.
|
|
41
66
|
def add_clone_pool(opts)
|
|
@@ -45,9 +70,10 @@ module IControl::LocalLB
|
|
|
45
70
|
|
|
46
71
|
##
|
|
47
72
|
# Adds/associates HTTP class profiles to this virtual server.
|
|
48
|
-
# @
|
|
49
|
-
# @raise [IControl::Common::
|
|
50
|
-
# @raise [IControl::Common::
|
|
73
|
+
# @rspec_example
|
|
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.
|
|
51
77
|
# @param [Hash] opts
|
|
52
78
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerHttpClass[]] :profiles The HTTP class profiles to add to the virtual servers.
|
|
53
79
|
def add_httpclass_profile(opts)
|
|
@@ -57,9 +83,10 @@ module IControl::LocalLB
|
|
|
57
83
|
|
|
58
84
|
##
|
|
59
85
|
# Adds/associates persistence profiles to this virtual server.
|
|
60
|
-
# @
|
|
61
|
-
# @raise [IControl::Common::
|
|
62
|
-
# @raise [IControl::Common::
|
|
86
|
+
# @rspec_example
|
|
87
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
88
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
89
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
63
90
|
# @param [Hash] opts
|
|
64
91
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerPersistence[]] :profiles The persistence profiles to add to the virtual servers.
|
|
65
92
|
def add_persistence_profile(opts)
|
|
@@ -69,9 +96,10 @@ module IControl::LocalLB
|
|
|
69
96
|
|
|
70
97
|
##
|
|
71
98
|
# Adds/associates profiles to this virtual server.
|
|
72
|
-
# @
|
|
73
|
-
# @raise [IControl::Common::
|
|
74
|
-
# @raise [IControl::Common::
|
|
99
|
+
# @rspec_example
|
|
100
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
101
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
102
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
75
103
|
# @param [Hash] opts
|
|
76
104
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerProfile[]] :profiles The profiles to add to the virtual servers.
|
|
77
105
|
def add_profile(opts)
|
|
@@ -81,9 +109,10 @@ module IControl::LocalLB
|
|
|
81
109
|
|
|
82
110
|
##
|
|
83
111
|
# Adds/associates rules to this virtual server.
|
|
84
|
-
# @
|
|
85
|
-
# @raise [IControl::Common::
|
|
86
|
-
# @raise [IControl::Common::
|
|
112
|
+
# @rspec_example
|
|
113
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
114
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
115
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
87
116
|
# @param [Hash] opts
|
|
88
117
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerRule[]] :rules The rules to add to the virtual servers.
|
|
89
118
|
def add_rule(opts)
|
|
@@ -92,10 +121,12 @@ module IControl::LocalLB
|
|
|
92
121
|
end
|
|
93
122
|
|
|
94
123
|
##
|
|
95
|
-
# Creates or updates virtual server from this resources. Takes additional, optional
|
|
96
|
-
#
|
|
97
|
-
# @
|
|
98
|
-
# @raise [IControl::Common::
|
|
124
|
+
# Creates or updates virtual server from this resources. Takes additional, optional
|
|
125
|
+
# parameters that enable you to override the default optional values.
|
|
126
|
+
# @rspec_example
|
|
127
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
128
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
129
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
99
130
|
# @param [Hash] opts
|
|
100
131
|
# @option opts [IControl::Common::VirtualServerDefinition] :definitions The virtual server definitions, address, port, and protocols the virtual servers will be using, for protocol, only IP (which includes both TCP and UDP), TCP or UDP are supported.
|
|
101
132
|
# @option opts [String] :wildmasks The network masks used to look up the specified virtual servers.
|
|
@@ -108,18 +139,20 @@ module IControl::LocalLB
|
|
|
108
139
|
|
|
109
140
|
##
|
|
110
141
|
# Deletes all virtual server.
|
|
111
|
-
# @
|
|
112
|
-
# @raise [IControl::Common::
|
|
113
|
-
# @raise [IControl::Common::
|
|
142
|
+
# @rspec_example
|
|
143
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
144
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
145
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
114
146
|
def delete_all_virtual_servers
|
|
115
147
|
super
|
|
116
148
|
end
|
|
117
149
|
|
|
118
150
|
##
|
|
119
151
|
# Deletes the persistence records based on this persistent modes for this virtual server.
|
|
120
|
-
# @
|
|
121
|
-
# @raise [IControl::Common::
|
|
122
|
-
# @raise [IControl::Common::
|
|
152
|
+
# @rspec_example
|
|
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.
|
|
123
156
|
# @param [Hash] opts
|
|
124
157
|
# @option opts [IControl::LocalLB::PersistenceMode] :persistence_modes The persistence modes from which we delete the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be deleted for that virtual server.
|
|
125
158
|
def delete_persistence_record(opts)
|
|
@@ -129,209 +162,236 @@ module IControl::LocalLB
|
|
|
129
162
|
|
|
130
163
|
##
|
|
131
164
|
# Deletes this virtual server.
|
|
132
|
-
# @
|
|
133
|
-
# @raise [IControl::Common::
|
|
134
|
-
# @raise [IControl::Common::
|
|
165
|
+
# @rspec_example
|
|
166
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
167
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
168
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
135
169
|
def delete_virtual_server
|
|
136
170
|
super
|
|
137
171
|
end
|
|
138
172
|
|
|
139
173
|
##
|
|
140
174
|
# Gets the actual hardware acceleration modes for this virtual server.
|
|
175
|
+
# @rspec_example
|
|
141
176
|
# @return [HardwareAccelerationMode]
|
|
142
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
143
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
144
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
177
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
178
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
179
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
145
180
|
def actual_hardware_acceleration
|
|
146
181
|
super
|
|
147
182
|
end
|
|
148
183
|
|
|
149
184
|
##
|
|
150
185
|
# Gets the statistics for all the virtual server.
|
|
186
|
+
# @rspec_example
|
|
151
187
|
# @return [VirtualServerStatistics]
|
|
152
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
153
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
154
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
188
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
189
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
190
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
155
191
|
def all_statistics
|
|
156
192
|
super
|
|
157
193
|
end
|
|
158
194
|
|
|
159
195
|
##
|
|
160
196
|
# Gets the lists of authentication profiles this virtual server are associated with.
|
|
197
|
+
# @rspec_example
|
|
161
198
|
# @return [VirtualServerAuthentication[]]
|
|
162
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
163
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
164
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
199
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
200
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
201
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
165
202
|
def authentication_profile
|
|
166
203
|
super
|
|
167
204
|
end
|
|
168
205
|
|
|
169
206
|
##
|
|
170
207
|
# Gets the lists of clone pools this virtual server are associated with.
|
|
208
|
+
# @rspec_example
|
|
171
209
|
# @return [VirtualServerClonePool[]]
|
|
172
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
173
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
174
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
210
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
211
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
212
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
175
213
|
def clone_pool
|
|
176
214
|
super
|
|
177
215
|
end
|
|
178
216
|
|
|
179
217
|
##
|
|
180
|
-
# Gets the CMP enable modes from this virtual server. This is read-only, as the modes
|
|
218
|
+
# Gets the CMP enable modes from this virtual server. This is read-only, as the modes
|
|
219
|
+
# are set according to the system and configuration, and influenced by the desired
|
|
220
|
+
# CMP enabled state.
|
|
221
|
+
# @rspec_example
|
|
181
222
|
# @return [VirtualServerCMPEnableMode]
|
|
182
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
183
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
184
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
223
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
224
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
225
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
185
226
|
def cmp_enable_mode
|
|
186
227
|
super
|
|
187
228
|
end
|
|
188
229
|
|
|
189
230
|
##
|
|
190
|
-
# Gets the CMP enabled states for this virtual server. Enables or disables CMP. Note
|
|
231
|
+
# Gets the CMP enabled states for this virtual server. Enables or disables CMP. Note
|
|
232
|
+
# that this setting can influence the CMP enable mode set automatically by the system
|
|
233
|
+
# and configuration. You can not always enable CMP, but you can always disable it.
|
|
234
|
+
# @rspec_example
|
|
191
235
|
# @return [EnabledState]
|
|
192
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
193
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
194
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
236
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
237
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
238
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
195
239
|
def cmp_enabled_state
|
|
196
240
|
super
|
|
197
241
|
end
|
|
198
242
|
|
|
199
243
|
##
|
|
200
244
|
# Gets the connection limits for this virtual server.
|
|
245
|
+
# @rspec_example
|
|
201
246
|
# @return [ULong64]
|
|
202
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
203
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
204
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
247
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
248
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
249
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
205
250
|
def connection_limit
|
|
206
251
|
super
|
|
207
252
|
end
|
|
208
253
|
|
|
209
254
|
##
|
|
210
255
|
# Gets the mirror connection states for this virtual server.
|
|
256
|
+
# @rspec_example
|
|
211
257
|
# @return [EnabledState]
|
|
212
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
213
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
214
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
258
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
259
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
260
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
215
261
|
def connection_mirror_state
|
|
216
262
|
super
|
|
217
263
|
end
|
|
218
264
|
|
|
219
265
|
##
|
|
220
266
|
# Gets the default pool names for this virtual server.
|
|
267
|
+
# @rspec_example
|
|
221
268
|
# @return [String]
|
|
222
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
223
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
224
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
269
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
270
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
271
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
225
272
|
def default_pool_name
|
|
226
273
|
super
|
|
227
274
|
end
|
|
228
275
|
|
|
229
276
|
##
|
|
230
277
|
# Gets the destination IP and port of this virtual server.
|
|
278
|
+
# @rspec_example
|
|
231
279
|
# @return [IPPortDefinition]
|
|
232
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
233
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
234
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
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.
|
|
235
283
|
def destination
|
|
236
284
|
super
|
|
237
285
|
end
|
|
238
286
|
|
|
239
287
|
##
|
|
240
288
|
# Gets the enabled state of this virtual server.
|
|
289
|
+
# @rspec_example
|
|
241
290
|
# @return [EnabledState]
|
|
242
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
243
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
244
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
291
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
292
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
293
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
245
294
|
def enabled_state
|
|
246
295
|
super
|
|
247
296
|
end
|
|
248
297
|
|
|
249
298
|
##
|
|
250
299
|
# Gets the persistence profiles to use for fallback persistence for this virtual server.
|
|
300
|
+
# @rspec_example
|
|
251
301
|
# @return [String]
|
|
252
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
253
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
254
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
302
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
303
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
304
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
255
305
|
def fallback_persistence_profile
|
|
256
306
|
super
|
|
257
307
|
end
|
|
258
308
|
|
|
259
309
|
##
|
|
260
310
|
# Returns the gtm scores for this virtual server.
|
|
311
|
+
# @rspec_example
|
|
261
312
|
# @return [ULong64]
|
|
262
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
263
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
264
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
313
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
314
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
315
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
265
316
|
def gtm_score
|
|
266
317
|
super
|
|
267
318
|
end
|
|
268
319
|
|
|
269
320
|
##
|
|
270
|
-
# Gets the lists of HTTP class profiles this virtual server are associated with. If
|
|
321
|
+
# Gets the lists of HTTP class profiles this virtual server are associated with. If
|
|
322
|
+
# a specified virtual server is not associated with any HTTP class profile, then the
|
|
323
|
+
# list of HTTP class profiles for that virtual server will be empty.
|
|
324
|
+
# @rspec_example
|
|
271
325
|
# @return [VirtualServerHttpClass[]]
|
|
272
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
273
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
274
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
326
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
327
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
328
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
275
329
|
def httpclass_profile
|
|
276
330
|
super
|
|
277
331
|
end
|
|
278
332
|
|
|
279
333
|
##
|
|
280
334
|
# Gets the last hop pools for this virtual server.
|
|
335
|
+
# @rspec_example
|
|
281
336
|
# @return [String]
|
|
282
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
283
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
284
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
337
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
338
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
339
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
285
340
|
def last_hop_pool
|
|
286
341
|
super
|
|
287
342
|
end
|
|
288
343
|
|
|
289
344
|
##
|
|
290
345
|
# Gets a list of virtual server.
|
|
346
|
+
# @rspec_example
|
|
291
347
|
# @return [String]
|
|
292
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
293
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
294
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
348
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
349
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
350
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
295
351
|
def list
|
|
296
352
|
super
|
|
297
353
|
end
|
|
298
354
|
|
|
299
355
|
##
|
|
300
356
|
# Returns the module scores for this virtual server.
|
|
357
|
+
# @rspec_example
|
|
301
358
|
# @return [VirtualServerModuleScore[]]
|
|
302
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
303
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
304
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
359
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
360
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
361
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
305
362
|
def module_score
|
|
306
363
|
super
|
|
307
364
|
end
|
|
308
365
|
|
|
309
366
|
##
|
|
310
367
|
# Gets the status of each of this virtual server.
|
|
368
|
+
# @rspec_example
|
|
311
369
|
# @return [ObjectStatus]
|
|
312
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
313
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
314
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
370
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
371
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
372
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
315
373
|
def object_status
|
|
316
374
|
super
|
|
317
375
|
end
|
|
318
376
|
|
|
319
377
|
##
|
|
320
378
|
# Gets the lists of persistence profiles this virtual server are associated with.
|
|
379
|
+
# @rspec_example
|
|
321
380
|
# @return [VirtualServerPersistence[]]
|
|
322
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
323
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
324
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
381
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
382
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
383
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
325
384
|
def persistence_profile
|
|
326
385
|
super
|
|
327
386
|
end
|
|
328
387
|
|
|
329
388
|
##
|
|
330
389
|
# Gets the persistence records based on this persistent modes for this virtual server.
|
|
390
|
+
# @rspec_example
|
|
331
391
|
# @return [PersistenceRecord[]]
|
|
332
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
333
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
334
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
392
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
393
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
394
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
335
395
|
# @param [Hash] opts
|
|
336
396
|
# @option opts [IControl::LocalLB::PersistenceMode] :persistence_modes The persistence modes from which we retrieve the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be returned for that virtual server.
|
|
337
397
|
def persistence_record(opts)
|
|
@@ -341,116 +401,132 @@ module IControl::LocalLB
|
|
|
341
401
|
|
|
342
402
|
##
|
|
343
403
|
# Gets the lists of profiles this virtual server are associated with.
|
|
404
|
+
# @rspec_example
|
|
344
405
|
# @return [VirtualServerProfileAttribute[]]
|
|
345
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
346
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
347
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
406
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
407
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
408
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
348
409
|
def profile
|
|
349
410
|
super
|
|
350
411
|
end
|
|
351
412
|
|
|
352
413
|
##
|
|
353
414
|
# Gets the protocols supported by this virtual server.
|
|
415
|
+
# @rspec_example
|
|
354
416
|
# @return [ProtocolType]
|
|
355
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
356
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
357
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
417
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
418
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
419
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
358
420
|
def protocol
|
|
359
421
|
super
|
|
360
422
|
end
|
|
361
423
|
|
|
362
424
|
##
|
|
363
425
|
# Gets the rate classes that will be used to rate limit the traffic.
|
|
426
|
+
# @rspec_example
|
|
364
427
|
# @return [String]
|
|
365
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
366
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
367
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
428
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
429
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
430
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
368
431
|
def rate_class
|
|
369
432
|
super
|
|
370
433
|
end
|
|
371
434
|
|
|
372
435
|
##
|
|
373
|
-
# Gets the lists of rules this virtual server are associated with. If a specified virtual
|
|
436
|
+
# Gets the lists of rules this virtual server are associated with. If a specified virtual
|
|
437
|
+
# server is not associated with any rule, then the list of rules for that virtual server
|
|
438
|
+
# will be empty.
|
|
439
|
+
# @rspec_example
|
|
374
440
|
# @return [VirtualServerRule[]]
|
|
375
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
376
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
377
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
441
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
442
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
443
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
378
444
|
def rule
|
|
379
445
|
super
|
|
380
446
|
end
|
|
381
447
|
|
|
382
448
|
##
|
|
383
449
|
# Gets the SNAT pools to be used in iSNAT configurations for this virtual server.
|
|
450
|
+
# @rspec_example
|
|
384
451
|
# @return [String]
|
|
385
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
386
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
387
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
452
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
453
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
454
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
388
455
|
def snat_pool
|
|
389
456
|
super
|
|
390
457
|
end
|
|
391
458
|
|
|
392
459
|
##
|
|
393
460
|
# Gets the SNAT type for this virtual server.
|
|
461
|
+
# @rspec_example
|
|
394
462
|
# @return [SnatType]
|
|
395
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
396
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
397
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
463
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
464
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
465
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
398
466
|
def snat_type
|
|
399
467
|
super
|
|
400
468
|
end
|
|
401
469
|
|
|
402
470
|
##
|
|
403
471
|
# Gets the source port behavior for this virtual server.
|
|
472
|
+
# @rspec_example
|
|
404
473
|
# @return [SourcePortBehavior]
|
|
405
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
406
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
407
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
474
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
475
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
476
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
408
477
|
def source_port_behavior
|
|
409
478
|
super
|
|
410
479
|
end
|
|
411
480
|
|
|
412
481
|
##
|
|
413
482
|
# Gets the statistics for this virtual server.
|
|
483
|
+
# @rspec_example
|
|
414
484
|
# @return [VirtualServerStatistics]
|
|
415
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
416
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
417
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
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.
|
|
418
488
|
def statistics
|
|
419
489
|
super
|
|
420
490
|
end
|
|
421
491
|
|
|
422
492
|
##
|
|
423
|
-
# Gets the address translation states for this virtual server. Enables or disables
|
|
493
|
+
# Gets the address translation states for this virtual server. Enables or disables
|
|
494
|
+
# address translation.
|
|
495
|
+
# @rspec_example
|
|
424
496
|
# @return [EnabledState]
|
|
425
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
426
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
427
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
497
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
498
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
499
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
428
500
|
def translate_address_state
|
|
429
501
|
super
|
|
430
502
|
end
|
|
431
503
|
|
|
432
504
|
##
|
|
433
|
-
# Gets the port translation states for this virtual server. Enables or disables port
|
|
505
|
+
# Gets the port translation states for this virtual server. Enables or disables port
|
|
506
|
+
# translation.
|
|
507
|
+
# @rspec_example
|
|
434
508
|
# @return [EnabledState]
|
|
435
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
436
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
437
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
509
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
510
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
511
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
438
512
|
def translate_port_state
|
|
439
513
|
super
|
|
440
514
|
end
|
|
441
515
|
|
|
442
516
|
##
|
|
443
517
|
# Gets the types of this virtual server.
|
|
518
|
+
# @rspec_example
|
|
444
519
|
# @return [VirtualServerType]
|
|
445
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
446
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
447
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
520
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
521
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
522
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
448
523
|
def type
|
|
449
524
|
super
|
|
450
525
|
end
|
|
451
526
|
|
|
452
527
|
##
|
|
453
528
|
# Gets the version information for this interface.
|
|
529
|
+
# @rspec_example
|
|
454
530
|
# @return [String]
|
|
455
531
|
def version
|
|
456
532
|
super
|
|
@@ -458,83 +534,92 @@ module IControl::LocalLB
|
|
|
458
534
|
|
|
459
535
|
##
|
|
460
536
|
# Gets the lists of VLANs on which access to this Virtual Servers are enabled/disabled.
|
|
537
|
+
# @rspec_example
|
|
461
538
|
# @return [VLANFilterList]
|
|
462
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
463
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
464
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
539
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
540
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
541
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
465
542
|
def vlan
|
|
466
543
|
super
|
|
467
544
|
end
|
|
468
545
|
|
|
469
546
|
##
|
|
470
547
|
# Gets the wildmasks for this virtual server.
|
|
548
|
+
# @rspec_example
|
|
471
549
|
# @return [String]
|
|
472
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
473
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
474
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
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.
|
|
475
553
|
def wildmask
|
|
476
554
|
super
|
|
477
555
|
end
|
|
478
556
|
|
|
479
557
|
##
|
|
480
558
|
# Removes all authentication profiles from this virtual server.
|
|
481
|
-
# @
|
|
482
|
-
# @raise [IControl::Common::
|
|
483
|
-
# @raise [IControl::Common::
|
|
559
|
+
# @rspec_example
|
|
560
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
561
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
562
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
484
563
|
def remove_all_authentication_profiles
|
|
485
564
|
super
|
|
486
565
|
end
|
|
487
566
|
|
|
488
567
|
##
|
|
489
568
|
# Removes all clone pools from this virtual server.
|
|
490
|
-
# @
|
|
491
|
-
# @raise [IControl::Common::
|
|
492
|
-
# @raise [IControl::Common::
|
|
569
|
+
# @rspec_example
|
|
570
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
571
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
572
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
493
573
|
def remove_all_clone_pools
|
|
494
574
|
super
|
|
495
575
|
end
|
|
496
576
|
|
|
497
577
|
##
|
|
498
578
|
# Removes all HTTP class profiles from this virtual server.
|
|
499
|
-
# @
|
|
500
|
-
# @raise [IControl::Common::
|
|
501
|
-
# @raise [IControl::Common::
|
|
579
|
+
# @rspec_example
|
|
580
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
581
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
582
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
502
583
|
def remove_all_httpclass_profiles
|
|
503
584
|
super
|
|
504
585
|
end
|
|
505
586
|
|
|
506
587
|
##
|
|
507
588
|
# Removes all persistence profiles from this virtual server.
|
|
508
|
-
# @
|
|
509
|
-
# @raise [IControl::Common::
|
|
510
|
-
# @raise [IControl::Common::
|
|
589
|
+
# @rspec_example
|
|
590
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
591
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
592
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
511
593
|
def remove_all_persistence_profiles
|
|
512
594
|
super
|
|
513
595
|
end
|
|
514
596
|
|
|
515
597
|
##
|
|
516
598
|
# Removes all profiles from this virtual server.
|
|
517
|
-
# @
|
|
518
|
-
# @raise [IControl::Common::
|
|
519
|
-
# @raise [IControl::Common::
|
|
599
|
+
# @rspec_example
|
|
600
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
601
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
602
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
520
603
|
def remove_all_profiles
|
|
521
604
|
super
|
|
522
605
|
end
|
|
523
606
|
|
|
524
607
|
##
|
|
525
608
|
# Removes all rules from this virtual server.
|
|
526
|
-
# @
|
|
527
|
-
# @raise [IControl::Common::
|
|
528
|
-
# @raise [IControl::Common::
|
|
609
|
+
# @rspec_example
|
|
610
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
611
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
612
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
529
613
|
def remove_all_rules
|
|
530
614
|
super
|
|
531
615
|
end
|
|
532
616
|
|
|
533
617
|
##
|
|
534
618
|
# Removes authentication profiles from this virtual server.
|
|
535
|
-
# @
|
|
536
|
-
# @raise [IControl::Common::
|
|
537
|
-
# @raise [IControl::Common::
|
|
619
|
+
# @rspec_example
|
|
620
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
621
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
622
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
538
623
|
# @param [Hash] opts
|
|
539
624
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerAuthentication[]] :profiles The authentication profiles to remove from the virtual servers.
|
|
540
625
|
def remove_authentication_profile(opts)
|
|
@@ -544,9 +629,10 @@ module IControl::LocalLB
|
|
|
544
629
|
|
|
545
630
|
##
|
|
546
631
|
# Removes clone pools from this virtual server.
|
|
547
|
-
# @
|
|
548
|
-
# @raise [IControl::Common::
|
|
549
|
-
# @raise [IControl::Common::
|
|
632
|
+
# @rspec_example
|
|
633
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
634
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
635
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
550
636
|
# @param [Hash] opts
|
|
551
637
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerClonePool[]] :clone_pools The clone pools to remove from the virtual servers.
|
|
552
638
|
def remove_clone_pool(opts)
|
|
@@ -556,9 +642,10 @@ module IControl::LocalLB
|
|
|
556
642
|
|
|
557
643
|
##
|
|
558
644
|
# Removes HTTP class profiles from this virtual server.
|
|
559
|
-
# @
|
|
560
|
-
# @raise [IControl::Common::
|
|
561
|
-
# @raise [IControl::Common::
|
|
645
|
+
# @rspec_example
|
|
646
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
647
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
648
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
562
649
|
# @param [Hash] opts
|
|
563
650
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerHttpClass[]] :profiles The HTTP class profiles to remove from the virtual servers.
|
|
564
651
|
def remove_httpclass_profile(opts)
|
|
@@ -568,9 +655,10 @@ module IControl::LocalLB
|
|
|
568
655
|
|
|
569
656
|
##
|
|
570
657
|
# Removes persistence profiles from this virtual server.
|
|
571
|
-
# @
|
|
572
|
-
# @raise [IControl::Common::
|
|
573
|
-
# @raise [IControl::Common::
|
|
658
|
+
# @rspec_example
|
|
659
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
660
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
661
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
574
662
|
# @param [Hash] opts
|
|
575
663
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerPersistence[]] :profiles The persistence profiles to remove from the virtual servers.
|
|
576
664
|
def remove_persistence_profile(opts)
|
|
@@ -580,9 +668,10 @@ module IControl::LocalLB
|
|
|
580
668
|
|
|
581
669
|
##
|
|
582
670
|
# Removes profiles from this virtual server.
|
|
583
|
-
# @
|
|
584
|
-
# @raise [IControl::Common::
|
|
585
|
-
# @raise [IControl::Common::
|
|
671
|
+
# @rspec_example
|
|
672
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
673
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
674
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
586
675
|
# @param [Hash] opts
|
|
587
676
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerProfile[]] :profiles The profiles to remove from the virtual servers.
|
|
588
677
|
def remove_profile(opts)
|
|
@@ -592,9 +681,10 @@ module IControl::LocalLB
|
|
|
592
681
|
|
|
593
682
|
##
|
|
594
683
|
# Removes rules from this virtual server.
|
|
595
|
-
# @
|
|
596
|
-
# @raise [IControl::Common::
|
|
597
|
-
# @raise [IControl::Common::
|
|
684
|
+
# @rspec_example
|
|
685
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
686
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
687
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
598
688
|
# @param [Hash] opts
|
|
599
689
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerRule[]] :rules The rules to remove from the virtual servers.
|
|
600
690
|
def remove_rule(opts)
|
|
@@ -604,18 +694,22 @@ module IControl::LocalLB
|
|
|
604
694
|
|
|
605
695
|
##
|
|
606
696
|
# Resets the statistics for this virtual server.
|
|
607
|
-
# @
|
|
608
|
-
# @raise [IControl::Common::
|
|
609
|
-
# @raise [IControl::Common::
|
|
697
|
+
# @rspec_example
|
|
698
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
699
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
700
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
610
701
|
def reset_statistics
|
|
611
702
|
super
|
|
612
703
|
end
|
|
613
704
|
|
|
614
705
|
##
|
|
615
|
-
# Sets the CMP enabled states for this virtual server. Enables or disables CMP. Note
|
|
616
|
-
#
|
|
617
|
-
#
|
|
618
|
-
# @
|
|
706
|
+
# Sets the CMP enabled states for this virtual server. Enables or disables CMP. Note
|
|
707
|
+
# that this setting can influence the CMP enable mode set automatically by the system
|
|
708
|
+
# and configuration. You can not always enable CMP, but you can always disable it.
|
|
709
|
+
# @rspec_example
|
|
710
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
711
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
712
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
619
713
|
# @param [Hash] opts
|
|
620
714
|
# @option opts [IControl::Common::EnabledState] :states The CMP enabled states to apply.
|
|
621
715
|
def set_cmp_enabled_state(opts)
|
|
@@ -625,9 +719,10 @@ module IControl::LocalLB
|
|
|
625
719
|
|
|
626
720
|
##
|
|
627
721
|
# Sets the connection limits of this virtual server.
|
|
628
|
-
# @
|
|
629
|
-
# @raise [IControl::Common::
|
|
630
|
-
# @raise [IControl::Common::
|
|
722
|
+
# @rspec_example
|
|
723
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
724
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
725
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
631
726
|
# @param [Hash] opts
|
|
632
727
|
# @option opts [IControl::Common::ULong64] :limits The connection limits to set.
|
|
633
728
|
def set_connection_limit(opts)
|
|
@@ -637,9 +732,10 @@ module IControl::LocalLB
|
|
|
637
732
|
|
|
638
733
|
##
|
|
639
734
|
# Sets the mirror connection states for this virtual server.
|
|
640
|
-
# @
|
|
641
|
-
# @raise [IControl::Common::
|
|
642
|
-
# @raise [IControl::Common::
|
|
735
|
+
# @rspec_example
|
|
736
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
737
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
738
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
643
739
|
# @param [Hash] opts
|
|
644
740
|
# @option opts [IControl::Common::EnabledState] :states The mirror connection states for the specified virtual servers.
|
|
645
741
|
def set_connection_mirror_state(opts)
|
|
@@ -649,9 +745,10 @@ module IControl::LocalLB
|
|
|
649
745
|
|
|
650
746
|
##
|
|
651
747
|
# Sets the default pool names for this virtual server.
|
|
652
|
-
# @
|
|
653
|
-
# @raise [IControl::Common::
|
|
654
|
-
# @raise [IControl::Common::
|
|
748
|
+
# @rspec_example
|
|
749
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
750
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
751
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
655
752
|
# @param [Hash] opts
|
|
656
753
|
# @option opts [String] :default_pools The default pool names for the specified virtual servers.
|
|
657
754
|
def set_default_pool_name(opts)
|
|
@@ -661,9 +758,10 @@ module IControl::LocalLB
|
|
|
661
758
|
|
|
662
759
|
##
|
|
663
760
|
# Sets the destination IP and port for this virtual server.
|
|
664
|
-
# @
|
|
665
|
-
# @raise [IControl::Common::
|
|
666
|
-
# @raise [IControl::Common::
|
|
761
|
+
# @rspec_example
|
|
762
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
763
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
764
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
667
765
|
# @param [Hash] opts
|
|
668
766
|
# @option opts [IControl::Common::IPPortDefinition] :destinations The destinations to set.
|
|
669
767
|
def set_destination(opts)
|
|
@@ -673,9 +771,10 @@ module IControl::LocalLB
|
|
|
673
771
|
|
|
674
772
|
##
|
|
675
773
|
# Sets the enabled state of this virtual server.
|
|
676
|
-
# @
|
|
677
|
-
# @raise [IControl::Common::
|
|
678
|
-
# @raise [IControl::Common::
|
|
774
|
+
# @rspec_example
|
|
775
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
776
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
777
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
679
778
|
# @param [Hash] opts
|
|
680
779
|
# @option opts [IControl::Common::EnabledState] :states The enabled states to set.
|
|
681
780
|
def set_enabled_state(opts)
|
|
@@ -685,9 +784,10 @@ module IControl::LocalLB
|
|
|
685
784
|
|
|
686
785
|
##
|
|
687
786
|
# Sets the persistence profiles to use for fallback persistence for this virtual server.
|
|
688
|
-
# @
|
|
689
|
-
# @raise [IControl::Common::
|
|
690
|
-
# @raise [IControl::Common::
|
|
787
|
+
# @rspec_example
|
|
788
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
789
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
790
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
691
791
|
# @param [Hash] opts
|
|
692
792
|
# @option opts [String] :profile_names The persistence profiles to use for fallback persistence for the specified virtual servers.
|
|
693
793
|
def set_fallback_persistence_profile(opts)
|
|
@@ -697,9 +797,10 @@ module IControl::LocalLB
|
|
|
697
797
|
|
|
698
798
|
##
|
|
699
799
|
# Sets the gtm score for this virtual server.
|
|
700
|
-
# @
|
|
701
|
-
# @raise [IControl::Common::
|
|
702
|
-
# @raise [IControl::Common::
|
|
800
|
+
# @rspec_example
|
|
801
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
802
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
803
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
703
804
|
# @param [Hash] opts
|
|
704
805
|
# @option opts [IControl::Common::ULong64] :scores The GTM score value to set
|
|
705
806
|
def set_gtm_score(opts)
|
|
@@ -709,9 +810,10 @@ module IControl::LocalLB
|
|
|
709
810
|
|
|
710
811
|
##
|
|
711
812
|
# Sets the last hop pools for this virtual server.
|
|
712
|
-
# @
|
|
713
|
-
# @raise [IControl::Common::
|
|
714
|
-
# @raise [IControl::Common::
|
|
813
|
+
# @rspec_example
|
|
814
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
815
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
816
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
715
817
|
# @param [Hash] opts
|
|
716
818
|
# @option opts [String] :last_hop_pools The last hop pools of the specified virtual servers. Empty strings remove the last hop pools from the specified virtual servers.
|
|
717
819
|
def set_last_hop_pool(opts)
|
|
@@ -721,9 +823,10 @@ module IControl::LocalLB
|
|
|
721
823
|
|
|
722
824
|
##
|
|
723
825
|
# Sets the protocols supported by this virtual server, one of IP, TCP or UDP.
|
|
724
|
-
# @
|
|
725
|
-
# @raise [IControl::Common::
|
|
726
|
-
# @raise [IControl::Common::
|
|
826
|
+
# @rspec_example
|
|
827
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
828
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
829
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
727
830
|
# @param [Hash] opts
|
|
728
831
|
# @option opts [IControl::Common::ProtocolType] :protocols The protocols to set.
|
|
729
832
|
def set_protocol(opts)
|
|
@@ -733,9 +836,10 @@ module IControl::LocalLB
|
|
|
733
836
|
|
|
734
837
|
##
|
|
735
838
|
# Sets the rate classes that will be used to rate limit the traffic.
|
|
736
|
-
# @
|
|
737
|
-
# @raise [IControl::Common::
|
|
738
|
-
# @raise [IControl::Common::
|
|
839
|
+
# @rspec_example
|
|
840
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
841
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
842
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
739
843
|
# @param [Hash] opts
|
|
740
844
|
# @option opts [String] :rate_classes The rate classes used to rate limit the traffic.
|
|
741
845
|
def set_rate_class(opts)
|
|
@@ -745,27 +849,30 @@ module IControl::LocalLB
|
|
|
745
849
|
|
|
746
850
|
##
|
|
747
851
|
# Sets the SNAT automap state for this virtual server.
|
|
748
|
-
# @
|
|
749
|
-
# @raise [IControl::Common::
|
|
750
|
-
# @raise [IControl::Common::
|
|
852
|
+
# @rspec_example
|
|
853
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
854
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
855
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
751
856
|
def set_snat_automap
|
|
752
857
|
super
|
|
753
858
|
end
|
|
754
859
|
|
|
755
860
|
##
|
|
756
861
|
# Sets the state to use no SNATs for this virtual server.
|
|
757
|
-
# @
|
|
758
|
-
# @raise [IControl::Common::
|
|
759
|
-
# @raise [IControl::Common::
|
|
862
|
+
# @rspec_example
|
|
863
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
864
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
865
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
760
866
|
def set_snat_none
|
|
761
867
|
super
|
|
762
868
|
end
|
|
763
869
|
|
|
764
870
|
##
|
|
765
871
|
# Sets the SNAT pools to be used in iSNAT configurations for this virtual server.
|
|
766
|
-
# @
|
|
767
|
-
# @raise [IControl::Common::
|
|
768
|
-
# @raise [IControl::Common::
|
|
872
|
+
# @rspec_example
|
|
873
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
874
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
875
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
769
876
|
# @param [Hash] opts
|
|
770
877
|
# @option opts [String] :snatpools The SNAT pools of the specified virtual servers.
|
|
771
878
|
def set_snat_pool(opts)
|
|
@@ -775,9 +882,10 @@ module IControl::LocalLB
|
|
|
775
882
|
|
|
776
883
|
##
|
|
777
884
|
# Sets the source port behavior for this virtual server.
|
|
778
|
-
# @
|
|
779
|
-
# @raise [IControl::Common::
|
|
780
|
-
# @raise [IControl::Common::
|
|
885
|
+
# @rspec_example
|
|
886
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
887
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
888
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
781
889
|
# @param [Hash] opts
|
|
782
890
|
# @option opts [IControl::Common::SourcePortBehavior] :source_port_behaviors The source port behaviors to set.
|
|
783
891
|
def set_source_port_behavior(opts)
|
|
@@ -786,10 +894,12 @@ module IControl::LocalLB
|
|
|
786
894
|
end
|
|
787
895
|
|
|
788
896
|
##
|
|
789
|
-
# Sets the address translation states for this virtual server. Enables or disables
|
|
790
|
-
#
|
|
791
|
-
# @
|
|
792
|
-
# @raise [IControl::Common::
|
|
897
|
+
# Sets the address translation states for this virtual server. Enables or disables
|
|
898
|
+
# address translation.
|
|
899
|
+
# @rspec_example
|
|
900
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
901
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
902
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
793
903
|
# @param [Hash] opts
|
|
794
904
|
# @option opts [IControl::Common::EnabledState] :states The address translation states to apply.
|
|
795
905
|
def set_translate_address_state(opts)
|
|
@@ -798,10 +908,12 @@ module IControl::LocalLB
|
|
|
798
908
|
end
|
|
799
909
|
|
|
800
910
|
##
|
|
801
|
-
# Sets the port translation states for this virtual server. Enables or disables port
|
|
802
|
-
#
|
|
803
|
-
# @
|
|
804
|
-
# @raise [IControl::Common::
|
|
911
|
+
# Sets the port translation states for this virtual server. Enables or disables port
|
|
912
|
+
# translation.
|
|
913
|
+
# @rspec_example
|
|
914
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
915
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
916
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
805
917
|
# @param [Hash] opts
|
|
806
918
|
# @option opts [IControl::Common::EnabledState] :states The port translation states to apply.
|
|
807
919
|
def set_translate_port_state(opts)
|
|
@@ -811,9 +923,10 @@ module IControl::LocalLB
|
|
|
811
923
|
|
|
812
924
|
##
|
|
813
925
|
# Sets the types for this virtual server.
|
|
814
|
-
# @
|
|
815
|
-
# @raise [IControl::Common::
|
|
816
|
-
# @raise [IControl::Common::
|
|
926
|
+
# @rspec_example
|
|
927
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
928
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
929
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
817
930
|
# @param [Hash] opts
|
|
818
931
|
# @option opts [IControl::LocalLB::VirtualServer::VirtualServerType] :types The types to set.
|
|
819
932
|
def set_type(opts)
|
|
@@ -823,9 +936,10 @@ module IControl::LocalLB
|
|
|
823
936
|
|
|
824
937
|
##
|
|
825
938
|
# Sets VLANs to the list of VLANs on which access to this Virtual Servers are enabled/disabled.
|
|
826
|
-
# @
|
|
827
|
-
# @raise [IControl::Common::
|
|
828
|
-
# @raise [IControl::Common::
|
|
939
|
+
# @rspec_example
|
|
940
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
941
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
942
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
829
943
|
# @param [Hash] opts
|
|
830
944
|
# @option opts [IControl::Common::VLANFilterList] :vlans The VLAN names to add to the list of enabled/disabled VLANs .
|
|
831
945
|
def set_vlan(opts)
|
|
@@ -835,9 +949,10 @@ module IControl::LocalLB
|
|
|
835
949
|
|
|
836
950
|
##
|
|
837
951
|
# Sets the wildmasks for this virtual server.
|
|
838
|
-
# @
|
|
839
|
-
# @raise [IControl::Common::
|
|
840
|
-
# @raise [IControl::Common::
|
|
952
|
+
# @rspec_example
|
|
953
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
954
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
955
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
841
956
|
# @param [Hash] opts
|
|
842
957
|
# @option opts [String] :wildmasks The wildmasks for the specified virtual servers.
|
|
843
958
|
def set_wildmask(opts)
|
|
@@ -931,18 +1046,18 @@ module IControl::LocalLB
|
|
|
931
1046
|
##
|
|
932
1047
|
# A struct that describes a virtual server and its statistics.
|
|
933
1048
|
# @attr [IControl::Common::VirtualServerDefinition] virtual_server The virtual server definition.
|
|
934
|
-
# @attr [IControl::Common::
|
|
1049
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics of the virtual server.
|
|
935
1050
|
class VirtualServerStatisticEntry < IControl::Base::Struct
|
|
936
1051
|
icontrol_attribute :virtual_server, IControl::Common::VirtualServerDefinition
|
|
937
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
1052
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
938
1053
|
end
|
|
939
1054
|
|
|
940
1055
|
##
|
|
941
1056
|
# A struct that describes virtual server statistics and timestamp.
|
|
942
|
-
# @attr [IControl::LocalLB::VirtualServer::
|
|
1057
|
+
# @attr [IControl::LocalLB::VirtualServer::VirtualServerStatisticEntrySequence] statistics The statistics for a sequence of virtual servers.
|
|
943
1058
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
944
1059
|
class VirtualServerStatistics < IControl::Base::Struct
|
|
945
|
-
icontrol_attribute :statistics, IControl::LocalLB::VirtualServer::
|
|
1060
|
+
icontrol_attribute :statistics, IControl::LocalLB::VirtualServer::VirtualServerStatisticEntrySequence
|
|
946
1061
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
947
1062
|
end
|
|
948
1063
|
|