Class: IControl::LocalLB::ProfileSIP

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

Overview

The ProfileSIP interface enables you to manipulate a local load balancer's SIP profile.

Defined Under Namespace

Classes: ProfileSIPStatisticEntry, ProfileSIPStatisticEntrySequence, ProfileSIPStatistics

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

- (ProfileSIPStatistics) all_statistics

Gets the statistics for all the SIP 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.



47
48
49
# File 'lib/icontrol/local_lb/profile_sip.rb', line 47

def all_statistics
  super
end

- (Object) create

Creates this SIP 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.



16
17
18
# File 'lib/icontrol/local_lb/profile_sip.rb', line 16

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.



59
60
61
# File 'lib/icontrol/local_lb/profile_sip.rb', line 59

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all SIP 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.



26
27
28
# File 'lib/icontrol/local_lb/profile_sip.rb', line 26

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this SIP 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.



36
37
38
# File 'lib/icontrol/local_lb/profile_sip.rb', line 36

def delete_profile
  super
end

- (ProfileEnabledState) dialog_aware_state

Gets whether this SIP profile are dialog aware.

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.



70
71
72
# File 'lib/icontrol/local_lb/profile_sip.rb', line 70

def dialog_aware_state
  super
end

- (ProfileEnabledState) insert_record_route_state

Gets the insert Record-Route states for this SIP profile. If true, insert a Record-Route header field value into the SIP message.

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.



82
83
84
# File 'lib/icontrol/local_lb/profile_sip.rb', line 82

def insert_record_route_state
  super
end

- (ProfileEnabledState) insert_via_state

Gets the insert Via header states for this SIP profile. If true, insert a Via header into the SIP message.

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.



94
95
96
# File 'lib/icontrol/local_lb/profile_sip.rb', line 94

def insert_via_state
  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.



194
195
196
# File 'lib/icontrol/local_lb/profile_sip.rb', line 194

def is_base_profile
  super
end

- (String) list

Gets a list of all SIP 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.



105
106
107
# File 'lib/icontrol/local_lb/profile_sip.rb', line 105

def list
  super
end

- (ProfileULong) max_message_size

Gets the maximum SIP message sizes for this SIP profile. This indicates the maximum SIP header size the BIG-IP will accept.

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.



117
118
119
# File 'lib/icontrol/local_lb/profile_sip.rb', line 117

def max_message_size
  super
end

- (Object) reset_statistics

Resets the statistics for this SIP 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.



204
205
206
# File 'lib/icontrol/local_lb/profile_sip.rb', line 204

def reset_statistics
  super
end

- (ProfileEnabledState) secure_via_state

Gets the secure Via states for this SIP profile. If true, use "TLS" in the sent-protocol portion of an inserted Via header.

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.



129
130
131
# File 'lib/icontrol/local_lb/profile_sip.rb', line 129

def secure_via_state
  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.



217
218
219
220
# File 'lib/icontrol/local_lb/profile_sip.rb', line 217

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

- (Object) set_dialog_aware_state(opts)

Sets whether this SIP profile should gather SIP dialog information and automatically forward SIP messages belonging to known SIP dialogs.

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.



231
232
233
234
# File 'lib/icontrol/local_lb/profile_sip.rb', line 231

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

- (Object) set_insert_record_route_state(opts)

Sets the insert Record-Route states for this SIP profile. If true, insert a Record-Route header field value into the SIP message.

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.



245
246
247
248
# File 'lib/icontrol/local_lb/profile_sip.rb', line 245

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

- (Object) set_insert_via_state(opts)

Sets the insert Via header states for this SIP profile. If true, insert a Via header into the SIP message.

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.



259
260
261
262
# File 'lib/icontrol/local_lb/profile_sip.rb', line 259

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

- (Object) set_max_message_size(opts)

Sets the maximum SIP message sizes for this SIP profile. This indicates the maximum SIP header size the BIG-IP will accept.

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.



273
274
275
276
# File 'lib/icontrol/local_lb/profile_sip.rb', line 273

def set_max_message_size(opts)
  check_params(opts,[:max_message_sizes])
  super
end

- (Object) set_secure_via_state(opts)

Sets the secure Via states for this SIP profile. If true, use "TLS" in the sent-protocol portion of an inserted Via header.

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.



287
288
289
290
# File 'lib/icontrol/local_lb/profile_sip.rb', line 287

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

- (Object) set_sip_community(opts)

Sets a community name for this SIP profile. For "dialog aware" SIP profile with multiple SIP virtual server/profile pairings, this name groups the SIP profile in the same SIP proxy functional group.

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.



302
303
304
305
# File 'lib/icontrol/local_lb/profile_sip.rb', line 302

def set_sip_community(opts)
  check_params(opts,[:community])
  super
end

- (Object) set_terminate_connection_after_bye_state(opts)

Sets the terminate connection after bye states for this SIP profile. If true, terminate a connection after a (200 BYE) message.

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.



316
317
318
319
# File 'lib/icontrol/local_lb/profile_sip.rb', line 316

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

- (Object) set_via_userdata(opts)

Sets the via userdata for this SIP profile. If insert via is enabled and this string is not empty, for a SIP request message the via header will be compiled using this string.

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.



331
332
333
334
# File 'lib/icontrol/local_lb/profile_sip.rb', line 331

def set_via_userdata(opts)
  check_params(opts,[:via_userdata])
  super
end

- (ProfileString) sip_community

Gets the community name for this SIP 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.



140
141
142
# File 'lib/icontrol/local_lb/profile_sip.rb', line 140

def sip_community
  super
end

- (ProfileSIPStatistics) statistics

Gets the statistics for this SIP 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.



151
152
153
# File 'lib/icontrol/local_lb/profile_sip.rb', line 151

def statistics
  super
end

- (ProfileEnabledState) terminate_connection_after_bye_state

Gets the terminate connection after bye states for this SIP profile. If true, terminate a connection after a (200 BYE) message.

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.



163
164
165
# File 'lib/icontrol/local_lb/profile_sip.rb', line 163

def terminate_connection_after_bye_state
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


171
172
173
# File 'lib/icontrol/local_lb/profile_sip.rb', line 171

def version
  super
end

- (ProfileString) via_userdata

Gets the via userdata for this SIP 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.



182
183
184
# File 'lib/icontrol/local_lb/profile_sip.rb', line 182

def via_userdata
  super
end