Class: IControl::LocalLB::ProfileRTSP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/profile_rtsp.rb,
lib/icontrol/local_lb.rb

Overview

The ProfileRTSP interface enables you to manipulate a local load balancer's RTSP profile.

Defined Under Namespace

Classes: ProfileRTSPStatisticEntry, ProfileRTSPStatisticEntrySequence, ProfileRTSPStatistics

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (ProfileRTSPStatistics) all_statistics

Gets the statistics for all the RTSP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



48
49
50
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 48

def all_statistics
  super
end

- (ProfileEnabledState) check_source_state

Gets the states to indicate how the RTSP filter handles the source attribute in the transport header. If true, the system will use the source attribute in the transport header to establish the target address of the RTP stream, and will update the value of the source attribute to be the virtual address (VIP) before the response is forwarded to the client. If false, the system leaves the source attribute alone.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



63
64
65
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 63

def check_source_state
  super
end

- (Object) create

Creates this RTSP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



17
18
19
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 17

def create
  super
end

- (String) default_profile

Gets the names of the default profile from which this profile will derive default values for its attributes.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



75
76
77
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 75

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all RTSP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



27
28
29
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 27

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this RTSP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



37
38
39
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 37

def delete_profile
  super
end

- (ProfileULong) idle_timeout

Gets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds that the UDP data connections are allowed to idle before they are closed.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



87
88
89
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 87

def idle_timeout
  super
end

- (boolean) is_base_profile

Determines whether this profile are base/pre-configured profile, or user-defined profile.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



253
254
255
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 253

def is_base_profile
  super
end

- (String) list

Gets a list of all RTSP profile.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



98
99
100
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 98

def list
  super
end

- (ProfileULong) maximum_header_size

Gets the maximum header sizes for this RTSP profile. This is the largest RTSP request or response header that the RTSP filter (control channel) will allow before aborting the connection.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



111
112
113
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 111

def maximum_header_size
  super
end

- (ProfileULong) maximum_queued_data_size

Gets the maximum queued data sizes for this RTSP profile. This is the maximum amount of data that the RTSP filter (control channel) will buffer before assuming the connection is dead and subsequently aborting the connection.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



124
125
126
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 124

def maximum_queued_data_size
  super
end

- (ProfileEnabledState) multicast_redirect_state

Gets the states to indicate whether to allow redirection of multicasts for this RTSP profile. If enabled, the client is allowed to select the destination where data will be streamed.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



137
138
139
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 137

def multicast_redirect_state
  super
end

- (ProfileString) proxy_header

Gets the names of the headers that are passed from the client side VIP to the server side VIP in an RTSP proxy configuration. The name of the header should begin with "X-".

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



150
151
152
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 150

def proxy_header
  super
end

- (ProfileRtspProxyType) proxy_type

Gets the proxy types that this RTSP filters are associated with.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



161
162
163
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 161

def proxy_type
  super
end

- (Object) reset_statistics

Resets the statistics for this RTSP profile.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



263
264
265
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 263

def reset_statistics
  super
end

- (ProfilePortNumber) rtcp_port

Gets the RTCP port for this RTSP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



172
173
174
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 172

def rtcp_port
  super
end

- (ProfilePortNumber) rtp_port

Gets the RTP port for this RTSP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



183
184
185
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 183

def rtp_port
  super
end

- (ProfileEnabledState) rtsp_over_http_persistence_state

Gets the states to indicate whether the RTSP filter will automatically handle persisting Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled. Disabling this value allows the user to override the default behavior with a rule.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



196
197
198
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 196

def rtsp_over_http_persistence_state
  super
end

- (ProfileEnabledState) session_reconnect_state

The RTSP specification allows a control connection to be resumed after it has become disconnected. Gets the states to indicate whether the RTSP filter will persist the control connection that is being resumed to the correct server.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



209
210
211
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 209

def session_reconnect_state
  super
end

- (Object) set_check_source_state(opts)

Sets the states to indicate how the RTSP filter handles the source attribute in the transport header. If true, the system will use the source attribute in the transport header to establish the target address of the RTP stream, and will update the value of the source attribute to be the virtual address (VIP) before the response is forwarded to the client. If false, the system leaves the source attribute alone.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



279
280
281
282
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 279

def set_check_source_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_default_profile(opts)

Sets the names of the default profile from which this profile will derive default values for its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String) —

    The default profiles from which the specified profiles will get default values.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



293
294
295
296
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 293

def set_default_profile(opts)
  check_params(opts,[:defaults])
  super
end

- (Object) set_idle_timeout(opts)

Sets the idle timeouts (seconds) for this RTSP profile. This is the number of seconds that the UDP data connections are allowed to idle before they are closed.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



307
308
309
310
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 307

def set_idle_timeout(opts)
  check_params(opts,[:timeouts])
  super
end

- (Object) set_maximum_header_size(opts)

Sets the maximum header sizes for this RTSP profile. This is the largest RTSP request or response header that the RTSP filter (control channel) will allow before aborting the connection.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



322
323
324
325
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 322

def set_maximum_header_size(opts)
  check_params(opts,[:sizes])
  super
end

- (Object) set_maximum_queued_data_size(opts)

Sets the maximum queued data sizes for this RTSP profile. This is the maximum amount of data that the RTSP filter (control channel) will buffer before assuming the connection is dead and subsequently aborting the connection.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



337
338
339
340
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 337

def set_maximum_queued_data_size(opts)
  check_params(opts,[:sizes])
  super
end

- (Object) set_multicast_redirect_state(opts)

Sets the states to indicate whether to allow redirection of multicasts for this RTSP profile. If enabled, the client is allowed to select the destination where data will be streamed.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



352
353
354
355
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 352

def set_multicast_redirect_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_proxy_header(opts)

Sets the names of the headers that are passed from the client side VIP to the server side VIP in an RTSP proxy configuration. The name of the header should begin with "X-".

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



367
368
369
370
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 367

def set_proxy_header(opts)
  check_params(opts,[:headers])
  super
end

- (Object) set_proxy_type(opts)

Sets the proxy types that this RTSP filters are associated with.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



380
381
382
383
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 380

def set_proxy_type(opts)
  check_params(opts,[:types])
  super
end

- (Object) set_rtcp_port(opts)

Sets the RTCP port for this RTSP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



393
394
395
396
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 393

def set_rtcp_port(opts)
  check_params(opts,[:ports])
  super
end

- (Object) set_rtp_port(opts)

Sets the RTP port for this RTSP profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



406
407
408
409
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 406

def set_rtp_port(opts)
  check_params(opts,[:ports])
  super
end

- (Object) set_rtsp_over_http_persistence_state(opts)

Sets the states to indicate whether the RTSP filter will automatically handle persisting Real Networks tunneled RTSP over HTTP, over the RTSP port. The default value is enabled. Disabling this value allows the user to override the default behavior with a rule.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



421
422
423
424
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 421

def set_rtsp_over_http_persistence_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_session_reconnect_state(opts)

The RTSP specification allows a control connection to be resumed after it has become disconnected. This sets the states to indicate whether the RTSP filter will persist the control connection that is being resumed to the correct server.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



436
437
438
439
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 436

def set_session_reconnect_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_unicast_redirect_state(opts)

Sets the states to indicate whether to allow redirection of unicasts for this RTSP profile. If enabled, the client is allowed to select the destination where data will be streamed.

Parameters:

  • opts (Hash)

Options Hash (opts):

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



451
452
453
454
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 451

def set_unicast_redirect_state(opts)
  check_params(opts,[:states])
  super
end

- (ProfileRTSPStatistics) statistics

Gets the statistics for this RTSP profile.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



220
221
222
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 220

def statistics
  super
end

- (ProfileEnabledState) unicast_redirect_state

Gets the states to indicate whether to allow redirection of unicasts for this RTSP profile. If enabled, the client is allowed to select the destination where data will be streamed.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



233
234
235
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 233

def unicast_redirect_state
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


241
242
243
 
# File 'lib/icontrol/local_lb/profile_rtsp.rb', line 241

def version
  super
end