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,16 +1,20 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The ProfileRADIUS interface enables you to manipulate a local load balancer's RADIUS
|
|
3
|
+
# The ProfileRADIUS interface enables you to manipulate a local load balancer's RADIUS
|
|
4
|
+
# profile.
|
|
4
5
|
class ProfileRADIUS < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "profile_names"
|
|
7
8
|
|
|
8
9
|
class ProfileRADIUSStatisticEntry < IControl::Base::Struct; end
|
|
9
|
-
class ProfileRADIUSStatistics < IControl::Base::Struct; end
|
|
10
|
-
|
|
11
|
-
#
|
|
12
|
-
#
|
|
13
|
-
# @
|
|
10
|
+
class ProfileRADIUSStatistics < IControl::Base::Struct; end
|
|
11
|
+
class ProfileRADIUSStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
12
|
+
# Adds to the lists of host and network addresses from which clients can connect. See
|
|
13
|
+
# get_client for more information on the client specification.
|
|
14
|
+
# @rspec_example
|
|
15
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
16
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
17
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
18
|
# @param [Hash] opts
|
|
15
19
|
# @option opts [String[]] :clients The lists of clients.
|
|
16
20
|
def add_client(opts)
|
|
@@ -20,113 +24,131 @@ module IControl::LocalLB
|
|
|
20
24
|
|
|
21
25
|
##
|
|
22
26
|
# Creates this RADIUS profile.
|
|
23
|
-
# @
|
|
24
|
-
# @raise [IControl::Common::
|
|
25
|
-
# @raise [IControl::Common::
|
|
27
|
+
# @rspec_example
|
|
28
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
29
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
30
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
26
31
|
def create
|
|
27
32
|
super
|
|
28
33
|
end
|
|
29
34
|
|
|
30
35
|
##
|
|
31
36
|
# Deletes all RADIUS profile.
|
|
32
|
-
# @
|
|
33
|
-
# @raise [IControl::Common::
|
|
34
|
-
# @raise [IControl::Common::
|
|
37
|
+
# @rspec_example
|
|
38
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
39
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
40
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
35
41
|
def delete_all_profiles
|
|
36
42
|
super
|
|
37
43
|
end
|
|
38
44
|
|
|
39
45
|
##
|
|
40
46
|
# Deletes this RADIUS profile.
|
|
41
|
-
# @
|
|
42
|
-
# @raise [IControl::Common::
|
|
43
|
-
# @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.
|
|
44
51
|
def delete_profile
|
|
45
52
|
super
|
|
46
53
|
end
|
|
47
54
|
|
|
48
55
|
##
|
|
49
56
|
# Gets the statistics for all the RADIUS profile.
|
|
57
|
+
# @rspec_example
|
|
50
58
|
# @return [ProfileRADIUSStatistics]
|
|
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.
|
|
59
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
60
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
61
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
54
62
|
def all_statistics
|
|
55
63
|
super
|
|
56
64
|
end
|
|
57
65
|
|
|
58
66
|
##
|
|
59
|
-
# Gets the list of host and network addresses from which clients can connect. An entry
|
|
67
|
+
# Gets the list of host and network addresses from which clients can connect. An entry
|
|
68
|
+
# in the list can be a host or network address, for example: 10.10.10.0/24 or 10.10.10.10.
|
|
69
|
+
# An empty value indicates that any client can connect.
|
|
70
|
+
# @rspec_example
|
|
60
71
|
# @return [ProfileStringArray]
|
|
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.
|
|
72
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
73
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
74
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
64
75
|
def client
|
|
65
76
|
super
|
|
66
77
|
end
|
|
67
78
|
|
|
68
79
|
##
|
|
69
|
-
# Gets the names of the default profile from which this profile will derive default
|
|
80
|
+
# Gets the names of the default profile from which this profile will derive default
|
|
81
|
+
# values for its attributes.
|
|
82
|
+
# @rspec_example
|
|
70
83
|
# @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.
|
|
84
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
85
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
86
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
74
87
|
def default_profile
|
|
75
88
|
super
|
|
76
89
|
end
|
|
77
90
|
|
|
78
91
|
##
|
|
79
92
|
# Gets a list of all RADIUS profile.
|
|
93
|
+
# @rspec_example
|
|
80
94
|
# @return [String]
|
|
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.
|
|
95
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
96
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
97
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
84
98
|
def list
|
|
85
99
|
super
|
|
86
100
|
end
|
|
87
101
|
|
|
88
102
|
##
|
|
89
|
-
# Gets the the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the
|
|
103
|
+
# Gets the the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the
|
|
104
|
+
# profile given. See set_persist_avp for more information on the AVP specification.
|
|
105
|
+
# @rspec_example
|
|
90
106
|
# @return [ProfileString]
|
|
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.
|
|
107
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
108
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
109
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
94
110
|
def persist_avp
|
|
95
111
|
super
|
|
96
112
|
end
|
|
97
113
|
|
|
98
114
|
##
|
|
99
115
|
# Gets the statistics for this RADIUS profile.
|
|
116
|
+
# @rspec_example
|
|
100
117
|
# @return [ProfileRADIUSStatistics]
|
|
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.
|
|
118
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
119
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
120
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
104
121
|
def statistics
|
|
105
122
|
super
|
|
106
123
|
end
|
|
107
124
|
|
|
108
125
|
##
|
|
109
126
|
# Gets the version information for this interface.
|
|
127
|
+
# @rspec_example
|
|
110
128
|
# @return [String]
|
|
111
129
|
def version
|
|
112
130
|
super
|
|
113
131
|
end
|
|
114
132
|
|
|
115
133
|
##
|
|
116
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
134
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
135
|
+
# profile.
|
|
136
|
+
# @rspec_example
|
|
117
137
|
# @return [boolean]
|
|
118
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
119
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
120
|
-
# @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.
|
|
121
141
|
def is_base_profile
|
|
122
142
|
super
|
|
123
143
|
end
|
|
124
144
|
|
|
125
145
|
##
|
|
126
|
-
# Removes entries from the lists of host and network addresses from which clients can
|
|
127
|
-
#
|
|
128
|
-
# @
|
|
129
|
-
# @raise [IControl::Common::
|
|
146
|
+
# Removes entries from the lists of host and network addresses from which clients can
|
|
147
|
+
# connect. See get_client for more information on the client specification.
|
|
148
|
+
# @rspec_example
|
|
149
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
150
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
151
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
130
152
|
# @param [Hash] opts
|
|
131
153
|
# @option opts [String[]] :clients The lists of clients.
|
|
132
154
|
def remove_client(opts)
|
|
@@ -136,27 +158,31 @@ module IControl::LocalLB
|
|
|
136
158
|
|
|
137
159
|
##
|
|
138
160
|
# Resets the statistics for this RADIUS profile.
|
|
139
|
-
# @
|
|
140
|
-
# @raise [IControl::Common::
|
|
141
|
-
# @raise [IControl::Common::
|
|
161
|
+
# @rspec_example
|
|
162
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
163
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
164
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
142
165
|
def reset_statistics
|
|
143
166
|
super
|
|
144
167
|
end
|
|
145
168
|
|
|
146
169
|
##
|
|
147
170
|
# Resets the client list to the parent defaults.
|
|
148
|
-
# @
|
|
149
|
-
# @raise [IControl::Common::
|
|
150
|
-
# @raise [IControl::Common::
|
|
171
|
+
# @rspec_example
|
|
172
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
173
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
174
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
151
175
|
def set_default_client
|
|
152
176
|
super
|
|
153
177
|
end
|
|
154
178
|
|
|
155
179
|
##
|
|
156
|
-
# Sets the names of the default profile from which this profile will derive default
|
|
157
|
-
#
|
|
158
|
-
# @
|
|
159
|
-
# @raise [IControl::Common::
|
|
180
|
+
# Sets the names of the default profile from which this profile will derive default
|
|
181
|
+
# values for its attributes.
|
|
182
|
+
# @rspec_example
|
|
183
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
184
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
185
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
160
186
|
# @param [Hash] opts
|
|
161
187
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
|
162
188
|
def set_default_profile(opts)
|
|
@@ -165,10 +191,16 @@ module IControl::LocalLB
|
|
|
165
191
|
end
|
|
166
192
|
|
|
167
193
|
##
|
|
168
|
-
# Sets the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the profile
|
|
169
|
-
#
|
|
170
|
-
#
|
|
171
|
-
#
|
|
194
|
+
# Sets the RADIUS Attribute (Value Pair; AVP) on which to persist for each of the profile
|
|
195
|
+
# given. The attribute specification can be a string or a numeric code (1-255), encoded
|
|
196
|
+
# as string. If the string is empty, or the code does not exist in the traffic coming
|
|
197
|
+
# to the system, then persist is disabled (if the name is not recognized, this method
|
|
198
|
+
# will produce an error). See RFC 2865, section 5, for valid base numeric codes. Valid
|
|
199
|
+
# names are as listed in section 5, in any mix of upper and lower case.
|
|
200
|
+
# @rspec_example
|
|
201
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
202
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
203
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
172
204
|
# @param [Hash] opts
|
|
173
205
|
# @option opts [IControl::LocalLB::ProfileString] :avps The attribute value pair on which to persist for the specified profiles.
|
|
174
206
|
def set_persist_avp(opts)
|
|
@@ -179,18 +211,18 @@ module IControl::LocalLB
|
|
|
179
211
|
##
|
|
180
212
|
# A struct that describes statistics for a particular RADIUS profile.
|
|
181
213
|
# @attr [String] profile_name The profile name.
|
|
182
|
-
# @attr [IControl::Common::
|
|
214
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
|
183
215
|
class ProfileRADIUSStatisticEntry < IControl::Base::Struct
|
|
184
216
|
icontrol_attribute :profile_name, String
|
|
185
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
217
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
186
218
|
end
|
|
187
219
|
|
|
188
220
|
##
|
|
189
221
|
# A struct that describes profile statistics and timestamp.
|
|
190
|
-
# @attr [IControl::LocalLB::ProfileRADIUS::
|
|
222
|
+
# @attr [IControl::LocalLB::ProfileRADIUS::ProfileRADIUSStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
|
191
223
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
192
224
|
class ProfileRADIUSStatistics < IControl::Base::Struct
|
|
193
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileRADIUS::
|
|
225
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileRADIUS::ProfileRADIUSStatisticEntrySequence
|
|
194
226
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
195
227
|
end
|
|
196
228
|
|
|
@@ -1,229 +1,279 @@
|
|
|
1
1
|
module IControl::LocalLB
|
|
2
2
|
##
|
|
3
|
-
# The ProfileRTSP interface enables you to manipulate a local load balancer's RTSP
|
|
3
|
+
# The ProfileRTSP interface enables you to manipulate a local load balancer's RTSP
|
|
4
|
+
# profile.
|
|
4
5
|
class ProfileRTSP < IControl::Base
|
|
5
6
|
|
|
6
7
|
set_id_name "profile_names"
|
|
7
8
|
|
|
8
9
|
class ProfileRTSPStatisticEntry < IControl::Base::Struct; end
|
|
9
|
-
class ProfileRTSPStatistics < IControl::Base::Struct; end
|
|
10
|
+
class ProfileRTSPStatistics < IControl::Base::Struct; end
|
|
11
|
+
class ProfileRTSPStatisticEntrySequence < IControl::Base::Sequence ; end ##
|
|
10
12
|
# Creates this RTSP profile.
|
|
11
|
-
# @
|
|
12
|
-
# @raise [IControl::Common::
|
|
13
|
-
# @raise [IControl::Common::
|
|
13
|
+
# @rspec_example
|
|
14
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
15
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
16
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
14
17
|
def create
|
|
15
18
|
super
|
|
16
19
|
end
|
|
17
20
|
|
|
18
21
|
##
|
|
19
22
|
# Deletes all RTSP profile.
|
|
20
|
-
# @
|
|
21
|
-
# @raise [IControl::Common::
|
|
22
|
-
# @raise [IControl::Common::
|
|
23
|
+
# @rspec_example
|
|
24
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
25
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
26
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
23
27
|
def delete_all_profiles
|
|
24
28
|
super
|
|
25
29
|
end
|
|
26
30
|
|
|
27
31
|
##
|
|
28
32
|
# Deletes this RTSP profile.
|
|
29
|
-
# @
|
|
30
|
-
# @raise [IControl::Common::
|
|
31
|
-
# @raise [IControl::Common::
|
|
33
|
+
# @rspec_example
|
|
34
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
35
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
36
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
32
37
|
def delete_profile
|
|
33
38
|
super
|
|
34
39
|
end
|
|
35
40
|
|
|
36
41
|
##
|
|
37
42
|
# Gets the statistics for all the RTSP profile.
|
|
43
|
+
# @rspec_example
|
|
38
44
|
# @return [ProfileRTSPStatistics]
|
|
39
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
40
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
41
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
45
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
46
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
47
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
42
48
|
def all_statistics
|
|
43
49
|
super
|
|
44
50
|
end
|
|
45
51
|
|
|
46
52
|
##
|
|
47
|
-
# Gets the states to indicate how the RTSP filter handles the source attribute in the
|
|
53
|
+
# Gets the states to indicate how the RTSP filter handles the source attribute in the
|
|
54
|
+
# transport header. If true, the system will use the source attribute in the transport
|
|
55
|
+
# header to establish the target address of the RTP stream, and will update the value
|
|
56
|
+
# of the source attribute to be the virtual address (VIP) before the response is forwarded
|
|
57
|
+
# to the client. If false, the system leaves the source attribute alone.
|
|
58
|
+
# @rspec_example
|
|
48
59
|
# @return [ProfileEnabledState]
|
|
49
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
50
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
51
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
60
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
61
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
62
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
52
63
|
def check_source_state
|
|
53
64
|
super
|
|
54
65
|
end
|
|
55
66
|
|
|
56
67
|
##
|
|
57
|
-
# Gets the names of the default profile from which this profile will derive default
|
|
68
|
+
# Gets the names of the default profile from which this profile will derive default
|
|
69
|
+
# values for its attributes.
|
|
70
|
+
# @rspec_example
|
|
58
71
|
# @return [String]
|
|
59
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
60
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
61
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
72
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
73
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
74
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
62
75
|
def default_profile
|
|
63
76
|
super
|
|
64
77
|
end
|
|
65
78
|
|
|
66
79
|
##
|
|
67
|
-
# Gets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds
|
|
80
|
+
# Gets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds
|
|
81
|
+
# that the UDP data connections are allowed to idle before they are closed.
|
|
82
|
+
# @rspec_example
|
|
68
83
|
# @return [ProfileULong]
|
|
69
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
70
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
71
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
84
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
85
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
86
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
72
87
|
def idle_timeout
|
|
73
88
|
super
|
|
74
89
|
end
|
|
75
90
|
|
|
76
91
|
##
|
|
77
92
|
# Gets a list of all RTSP profile.
|
|
93
|
+
# @rspec_example
|
|
78
94
|
# @return [String]
|
|
79
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
80
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
81
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
95
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
96
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
97
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
82
98
|
def list
|
|
83
99
|
super
|
|
84
100
|
end
|
|
85
101
|
|
|
86
102
|
##
|
|
87
|
-
# Gets the maximum header sizes for this RTSP profile. This is the largest RTSP request
|
|
103
|
+
# Gets the maximum header sizes for this RTSP profile. This is the largest RTSP request
|
|
104
|
+
# or response header that the RTSP filter (control channel) will allow before aborting
|
|
105
|
+
# the connection.
|
|
106
|
+
# @rspec_example
|
|
88
107
|
# @return [ProfileULong]
|
|
89
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
90
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
91
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
108
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
109
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
110
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
92
111
|
def maximum_header_size
|
|
93
112
|
super
|
|
94
113
|
end
|
|
95
114
|
|
|
96
115
|
##
|
|
97
|
-
# Gets the maximum queued data sizes for this RTSP profile. This is the maximum amount
|
|
116
|
+
# Gets the maximum queued data sizes for this RTSP profile. This is the maximum amount
|
|
117
|
+
# of data that the RTSP filter (control channel) will buffer before assuming the connection
|
|
118
|
+
# is dead and subsequently aborting the connection.
|
|
119
|
+
# @rspec_example
|
|
98
120
|
# @return [ProfileULong]
|
|
99
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
100
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
101
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
121
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
122
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
123
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
102
124
|
def maximum_queued_data_size
|
|
103
125
|
super
|
|
104
126
|
end
|
|
105
127
|
|
|
106
128
|
##
|
|
107
|
-
# Gets the states to indicate whether to allow redirection of multicasts for this RTSP
|
|
129
|
+
# Gets the states to indicate whether to allow redirection of multicasts for this RTSP
|
|
130
|
+
# profile. If enabled, the client is allowed to select the destination where data will
|
|
131
|
+
# be streamed.
|
|
132
|
+
# @rspec_example
|
|
108
133
|
# @return [ProfileEnabledState]
|
|
109
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
110
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
111
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
134
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
135
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
136
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
112
137
|
def multicast_redirect_state
|
|
113
138
|
super
|
|
114
139
|
end
|
|
115
140
|
|
|
116
141
|
##
|
|
117
|
-
# Gets the names of the headers that are passed from the client side VIP to the server
|
|
142
|
+
# Gets the names of the headers that are passed from the client side VIP to the server
|
|
143
|
+
# side VIP in an RTSP proxy configuration. The name of the header should begin with
|
|
144
|
+
# &quot;X-".
|
|
145
|
+
# @rspec_example
|
|
118
146
|
# @return [ProfileString]
|
|
119
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
120
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
121
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
147
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
148
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
149
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
122
150
|
def proxy_header
|
|
123
151
|
super
|
|
124
152
|
end
|
|
125
153
|
|
|
126
154
|
##
|
|
127
155
|
# Gets the proxy types that this RTSP filters are associated with.
|
|
156
|
+
# @rspec_example
|
|
128
157
|
# @return [ProfileRtspProxyType]
|
|
129
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
130
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
131
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
158
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
159
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
160
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
132
161
|
def proxy_type
|
|
133
162
|
super
|
|
134
163
|
end
|
|
135
164
|
|
|
136
165
|
##
|
|
137
166
|
# Gets the RTCP port for this RTSP profile.
|
|
167
|
+
# @rspec_example
|
|
138
168
|
# @return [ProfilePortNumber]
|
|
139
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
140
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
141
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
169
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
170
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
171
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
142
172
|
def rtcp_port
|
|
143
173
|
super
|
|
144
174
|
end
|
|
145
175
|
|
|
146
176
|
##
|
|
147
177
|
# Gets the RTP port for this RTSP profile.
|
|
178
|
+
# @rspec_example
|
|
148
179
|
# @return [ProfilePortNumber]
|
|
149
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
150
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
151
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
180
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
181
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
182
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
152
183
|
def rtp_port
|
|
153
184
|
super
|
|
154
185
|
end
|
|
155
186
|
|
|
156
187
|
##
|
|
157
|
-
# Gets the states to indicate whether the RTSP filter will automatically handle persisting
|
|
188
|
+
# Gets the states to indicate whether the RTSP filter will automatically handle persisting
|
|
189
|
+
# Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled.
|
|
190
|
+
# Disabling this value allows the user to override the default behavior with a rule.
|
|
191
|
+
# @rspec_example
|
|
158
192
|
# @return [ProfileEnabledState]
|
|
159
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
160
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
161
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
193
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
194
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
195
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
162
196
|
def rtsp_over_http_persistence_state
|
|
163
197
|
super
|
|
164
198
|
end
|
|
165
199
|
|
|
166
200
|
##
|
|
167
|
-
# The RTSP specification allows a control connection to be resumed after it has become
|
|
201
|
+
# The RTSP specification allows a control connection to be resumed after it has become
|
|
202
|
+
# disconnected. Gets the states to indicate whether the RTSP filter will persist the
|
|
203
|
+
# control connection that is being resumed to the correct server.
|
|
204
|
+
# @rspec_example
|
|
168
205
|
# @return [ProfileEnabledState]
|
|
169
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
170
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
171
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
206
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
207
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
208
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
172
209
|
def session_reconnect_state
|
|
173
210
|
super
|
|
174
211
|
end
|
|
175
212
|
|
|
176
213
|
##
|
|
177
214
|
# Gets the statistics for this RTSP profile.
|
|
215
|
+
# @rspec_example
|
|
178
216
|
# @return [ProfileRTSPStatistics]
|
|
179
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
180
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
181
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
217
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
218
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
219
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
182
220
|
def statistics
|
|
183
221
|
super
|
|
184
222
|
end
|
|
185
223
|
|
|
186
224
|
##
|
|
187
|
-
# Gets the states to indicate whether to allow redirection of unicasts for this RTSP
|
|
225
|
+
# Gets the states to indicate whether to allow redirection of unicasts for this RTSP
|
|
226
|
+
# profile. If enabled, the client is allowed to select the destination where data will
|
|
227
|
+
# be streamed.
|
|
228
|
+
# @rspec_example
|
|
188
229
|
# @return [ProfileEnabledState]
|
|
189
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
190
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
191
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
230
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
231
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
232
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
192
233
|
def unicast_redirect_state
|
|
193
234
|
super
|
|
194
235
|
end
|
|
195
236
|
|
|
196
237
|
##
|
|
197
238
|
# Gets the version information for this interface.
|
|
239
|
+
# @rspec_example
|
|
198
240
|
# @return [String]
|
|
199
241
|
def version
|
|
200
242
|
super
|
|
201
243
|
end
|
|
202
244
|
|
|
203
245
|
##
|
|
204
|
-
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
246
|
+
# Determines whether this profile are base/pre-configured profile, or user-defined
|
|
247
|
+
# profile.
|
|
248
|
+
# @rspec_example
|
|
205
249
|
# @return [boolean]
|
|
206
|
-
# @raise [IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
207
|
-
# @raise [IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
208
|
-
# @raise [IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
250
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
251
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
252
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
209
253
|
def is_base_profile
|
|
210
254
|
super
|
|
211
255
|
end
|
|
212
256
|
|
|
213
257
|
##
|
|
214
258
|
# Resets the statistics for this RTSP profile.
|
|
215
|
-
# @
|
|
216
|
-
# @raise [IControl::Common::
|
|
217
|
-
# @raise [IControl::Common::
|
|
259
|
+
# @rspec_example
|
|
260
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
261
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
262
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
218
263
|
def reset_statistics
|
|
219
264
|
super
|
|
220
265
|
end
|
|
221
266
|
|
|
222
267
|
##
|
|
223
|
-
# Sets the states to indicate how the RTSP filter handles the source attribute in the
|
|
224
|
-
#
|
|
225
|
-
#
|
|
226
|
-
#
|
|
268
|
+
# Sets the states to indicate how the RTSP filter handles the source attribute in the
|
|
269
|
+
# transport header. If true, the system will use the source attribute in the transport
|
|
270
|
+
# header to establish the target address of the RTP stream, and will update the value
|
|
271
|
+
# of the source attribute to be the virtual address (VIP) before the response is forwarded
|
|
272
|
+
# to the client. If false, the system leaves the source attribute alone.
|
|
273
|
+
# @rspec_example
|
|
274
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
275
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
276
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
227
277
|
# @param [Hash] opts
|
|
228
278
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
|
229
279
|
def set_check_source_state(opts)
|
|
@@ -232,10 +282,12 @@ module IControl::LocalLB
|
|
|
232
282
|
end
|
|
233
283
|
|
|
234
284
|
##
|
|
235
|
-
# Sets the names of the default profile from which this profile will derive default
|
|
236
|
-
#
|
|
237
|
-
# @
|
|
238
|
-
# @raise [IControl::Common::
|
|
285
|
+
# Sets the names of the default profile from which this profile will derive default
|
|
286
|
+
# values for its attributes.
|
|
287
|
+
# @rspec_example
|
|
288
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
289
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
290
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
239
291
|
# @param [Hash] opts
|
|
240
292
|
# @option opts [String] :defaults The default profiles from which the specified profiles will get default values.
|
|
241
293
|
def set_default_profile(opts)
|
|
@@ -244,10 +296,12 @@ module IControl::LocalLB
|
|
|
244
296
|
end
|
|
245
297
|
|
|
246
298
|
##
|
|
247
|
-
# Sets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds
|
|
248
|
-
#
|
|
249
|
-
# @
|
|
250
|
-
# @raise [IControl::Common::
|
|
299
|
+
# Sets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds
|
|
300
|
+
# that the UDP data connections are allowed to idle before they are closed.
|
|
301
|
+
# @rspec_example
|
|
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.
|
|
251
305
|
# @param [Hash] opts
|
|
252
306
|
# @option opts [IControl::LocalLB::ProfileULong] :timeouts The idle timeouts.
|
|
253
307
|
def set_idle_timeout(opts)
|
|
@@ -256,10 +310,13 @@ module IControl::LocalLB
|
|
|
256
310
|
end
|
|
257
311
|
|
|
258
312
|
##
|
|
259
|
-
# Sets the maximum header sizes for this RTSP profile. This is the largest RTSP request
|
|
260
|
-
#
|
|
261
|
-
#
|
|
262
|
-
# @
|
|
313
|
+
# Sets the maximum header sizes for this RTSP profile. This is the largest RTSP request
|
|
314
|
+
# or response header that the RTSP filter (control channel) will allow before aborting
|
|
315
|
+
# the connection.
|
|
316
|
+
# @rspec_example
|
|
317
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
318
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
319
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
263
320
|
# @param [Hash] opts
|
|
264
321
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum header sizes.
|
|
265
322
|
def set_maximum_header_size(opts)
|
|
@@ -268,10 +325,13 @@ module IControl::LocalLB
|
|
|
268
325
|
end
|
|
269
326
|
|
|
270
327
|
##
|
|
271
|
-
# Sets the maximum queued data sizes for this RTSP profile. This is the maximum amount
|
|
272
|
-
#
|
|
273
|
-
#
|
|
274
|
-
# @
|
|
328
|
+
# Sets the maximum queued data sizes for this RTSP profile. This is the maximum amount
|
|
329
|
+
# of data that the RTSP filter (control channel) will buffer before assuming the connection
|
|
330
|
+
# is dead and subsequently aborting the connection.
|
|
331
|
+
# @rspec_example
|
|
332
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
333
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
334
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
275
335
|
# @param [Hash] opts
|
|
276
336
|
# @option opts [IControl::LocalLB::ProfileULong] :sizes The maximum queued data sizes.
|
|
277
337
|
def set_maximum_queued_data_size(opts)
|
|
@@ -280,10 +340,13 @@ module IControl::LocalLB
|
|
|
280
340
|
end
|
|
281
341
|
|
|
282
342
|
##
|
|
283
|
-
# Sets the states to indicate whether to allow redirection of multicasts for this RTSP
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
# @
|
|
343
|
+
# Sets the states to indicate whether to allow redirection of multicasts for this RTSP
|
|
344
|
+
# profile. If enabled, the client is allowed to select the destination where data will
|
|
345
|
+
# be streamed.
|
|
346
|
+
# @rspec_example
|
|
347
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
348
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
349
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
287
350
|
# @param [Hash] opts
|
|
288
351
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
|
289
352
|
def set_multicast_redirect_state(opts)
|
|
@@ -292,10 +355,13 @@ module IControl::LocalLB
|
|
|
292
355
|
end
|
|
293
356
|
|
|
294
357
|
##
|
|
295
|
-
# Sets the names of the headers that are passed from the client side VIP to the server
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
# @
|
|
358
|
+
# Sets the names of the headers that are passed from the client side VIP to the server
|
|
359
|
+
# side VIP in an RTSP proxy configuration. The name of the header should begin with
|
|
360
|
+
# &quot;X-".
|
|
361
|
+
# @rspec_example
|
|
362
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
363
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
364
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
299
365
|
# @param [Hash] opts
|
|
300
366
|
# @option opts [IControl::LocalLB::ProfileString] :headers The proxy header names for the specified profiles.
|
|
301
367
|
def set_proxy_header(opts)
|
|
@@ -305,9 +371,10 @@ module IControl::LocalLB
|
|
|
305
371
|
|
|
306
372
|
##
|
|
307
373
|
# Sets the proxy types that this RTSP filters are associated with.
|
|
308
|
-
# @
|
|
309
|
-
# @raise [IControl::Common::
|
|
310
|
-
# @raise [IControl::Common::
|
|
374
|
+
# @rspec_example
|
|
375
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
376
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
377
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
311
378
|
# @param [Hash] opts
|
|
312
379
|
# @option opts [IControl::LocalLB::ProfileRtspProxyType] :types The proxy types to set.
|
|
313
380
|
def set_proxy_type(opts)
|
|
@@ -317,9 +384,10 @@ module IControl::LocalLB
|
|
|
317
384
|
|
|
318
385
|
##
|
|
319
386
|
# Sets the RTCP port for this RTSP profile.
|
|
320
|
-
# @
|
|
321
|
-
# @raise [IControl::Common::
|
|
322
|
-
# @raise [IControl::Common::
|
|
387
|
+
# @rspec_example
|
|
388
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
389
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
390
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
323
391
|
# @param [Hash] opts
|
|
324
392
|
# @option opts [IControl::LocalLB::ProfilePortNumber] :ports The RTCP ports for the specified RTSP profiles.
|
|
325
393
|
def set_rtcp_port(opts)
|
|
@@ -329,9 +397,10 @@ module IControl::LocalLB
|
|
|
329
397
|
|
|
330
398
|
##
|
|
331
399
|
# Sets the RTP port for this RTSP profile.
|
|
332
|
-
# @
|
|
333
|
-
# @raise [IControl::Common::
|
|
334
|
-
# @raise [IControl::Common::
|
|
400
|
+
# @rspec_example
|
|
401
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
402
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
403
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
335
404
|
# @param [Hash] opts
|
|
336
405
|
# @option opts [IControl::LocalLB::ProfilePortNumber] :ports The RTP ports for the specified RTSP profiles.
|
|
337
406
|
def set_rtp_port(opts)
|
|
@@ -340,10 +409,13 @@ module IControl::LocalLB
|
|
|
340
409
|
end
|
|
341
410
|
|
|
342
411
|
##
|
|
343
|
-
# Sets the states to indicate whether the RTSP filter will automatically handle persisting
|
|
344
|
-
#
|
|
345
|
-
#
|
|
346
|
-
# @
|
|
412
|
+
# Sets the states to indicate whether the RTSP filter will automatically handle persisting
|
|
413
|
+
# Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled.
|
|
414
|
+
# Disabling this value allows the user to override the default behavior with a rule.
|
|
415
|
+
# @rspec_example
|
|
416
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
417
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
418
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
347
419
|
# @param [Hash] opts
|
|
348
420
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
|
349
421
|
def set_rtsp_over_http_persistence_state(opts)
|
|
@@ -352,10 +424,13 @@ module IControl::LocalLB
|
|
|
352
424
|
end
|
|
353
425
|
|
|
354
426
|
##
|
|
355
|
-
# The RTSP specification allows a control connection to be resumed after it has become
|
|
356
|
-
#
|
|
357
|
-
#
|
|
358
|
-
# @
|
|
427
|
+
# The RTSP specification allows a control connection to be resumed after it has become
|
|
428
|
+
# disconnected. This sets the states to indicate whether the RTSP filter will persist
|
|
429
|
+
# the control connection that is being resumed to the correct server.
|
|
430
|
+
# @rspec_example
|
|
431
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
432
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
433
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
359
434
|
# @param [Hash] opts
|
|
360
435
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
|
361
436
|
def set_session_reconnect_state(opts)
|
|
@@ -364,10 +439,13 @@ module IControl::LocalLB
|
|
|
364
439
|
end
|
|
365
440
|
|
|
366
441
|
##
|
|
367
|
-
# Sets the states to indicate whether to allow redirection of unicasts for this RTSP
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
# @
|
|
442
|
+
# Sets the states to indicate whether to allow redirection of unicasts for this RTSP
|
|
443
|
+
# profile. If enabled, the client is allowed to select the destination where data will
|
|
444
|
+
# be streamed.
|
|
445
|
+
# @rspec_example
|
|
446
|
+
# @raise [IControl::IControl::Common::AccessDenied] raised if the client credentials are not valid.
|
|
447
|
+
# @raise [IControl::IControl::Common::InvalidArgument] raised if one of the arguments is invalid.
|
|
448
|
+
# @raise [IControl::IControl::Common::OperationFailed] raised if an operation error occurs.
|
|
371
449
|
# @param [Hash] opts
|
|
372
450
|
# @option opts [IControl::LocalLB::ProfileEnabledState] :states The states to set.
|
|
373
451
|
def set_unicast_redirect_state(opts)
|
|
@@ -378,18 +456,18 @@ module IControl::LocalLB
|
|
|
378
456
|
##
|
|
379
457
|
# A struct that describes statistics for a particular RTSP profile.
|
|
380
458
|
# @attr [String] profile_name The profile name.
|
|
381
|
-
# @attr [IControl::Common::
|
|
459
|
+
# @attr [IControl::Common::StatisticSequence] statistics The statistics for the profile.
|
|
382
460
|
class ProfileRTSPStatisticEntry < IControl::Base::Struct
|
|
383
461
|
icontrol_attribute :profile_name, String
|
|
384
|
-
icontrol_attribute :statistics, IControl::Common::
|
|
462
|
+
icontrol_attribute :statistics, IControl::Common::StatisticSequence
|
|
385
463
|
end
|
|
386
464
|
|
|
387
465
|
##
|
|
388
466
|
# A struct that describes profile statistics and timestamp.
|
|
389
|
-
# @attr [IControl::LocalLB::ProfileRTSP::
|
|
467
|
+
# @attr [IControl::LocalLB::ProfileRTSP::ProfileRTSPStatisticEntrySequence] statistics The statistics for a sequence of profiles.
|
|
390
468
|
# @attr [IControl::Common::TimeStamp] time_stamp The time stamp at the time the statistics are gathered.
|
|
391
469
|
class ProfileRTSPStatistics < IControl::Base::Struct
|
|
392
|
-
icontrol_attribute :statistics, IControl::LocalLB::ProfileRTSP::
|
|
470
|
+
icontrol_attribute :statistics, IControl::LocalLB::ProfileRTSP::ProfileRTSPStatisticEntrySequence
|
|
393
471
|
icontrol_attribute :time_stamp, IControl::Common::TimeStamp
|
|
394
472
|
end
|
|
395
473
|
|