Class: IControl::LocalLB::ProfileHttpClass

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

Overview

The ProfileHttpClass interface enables you to manipulate a local load balancer's ability to classify HTTP traffic.

Defined Under Namespace

Classes: ProfileHttpClassStatisticEntry, ProfileHttpClassStatisticEntrySequence, ProfileHttpClassStatistics

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

Adds to the lists of patterns used to match the cookies.

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.



19
20
21
22
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 19

def add_cookie_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) add_header_match_pattern(opts)

Adds to the lists of patterns used to match the headers.

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.



32
33
34
35
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 32

def add_header_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) add_host_match_pattern(opts)

Adds to the lists of patterns used to match the hosts.

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.



45
46
47
48
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 45

def add_host_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) add_path_match_pattern(opts)

Adds to the lists of patterns used to match the URI paths.

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.



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

def add_path_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (ProfileHttpClassStatistics) all_statistics

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



100
101
102
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 100

def all_statistics
  super
end

- (ProfileEnabledState) application_security_module_enabled_state

Gets the states that specify whether specified classes are Application Security Module classes.

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.



112
113
114
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 112

def application_security_module_enabled_state
  super
end

Gets the lists of patterns used to match the cookies.

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.



123
124
125
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 123

def cookie_match_pattern
  super
end

- (Object) create

Creates this HTTP class 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.



69
70
71
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 69

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.



135
136
137
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 135

def default_profile
  super
end

- (Object) delete_all_profiles

Deletes all HTTP class 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.



79
80
81
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 79

def delete_all_profiles
  super
end

- (Object) delete_profile

Deletes this HTTP class 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.



89
90
91
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 89

def delete_profile
  super
end

- (ProfileMatchPatternStringArray) header_match_pattern

Gets the lists of patterns used to match the headers.

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.



146
147
148
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 146

def header_match_pattern
  super
end

- (ProfileMatchPatternStringArray) host_match_pattern

Gets the lists of patterns used to match the hosts.

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.



157
158
159
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 157

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



256
257
258
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 256

def is_base_profile
  super
end

- (String) list

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



168
169
170
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 168

def list
  super
end

- (ProfileMatchPatternStringArray) path_match_pattern

Gets the lists of patterns used to match the URI paths.

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.



179
180
181
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 179

def path_match_pattern
  super
end

- (ProfileString) pool_name

Gets the pool names to use when this classes match.

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.



190
191
192
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 190

def pool_name
  super
end

- (ProfileString) redirect_location

Gets the string (which may include a TCL expression) to indicates where to redirect the original HTTP request once a match occurs. For example, to redirect requests to myserver.com to myotherserver.com.

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.



203
204
205
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 203

def redirect_location
  super
end

Removes from the lists of patterns used to match the cookies.

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.



268
269
270
271
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 268

def remove_cookie_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) remove_header_match_pattern(opts)

Removes from the lists of patterns used to match the headers.

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.



281
282
283
284
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 281

def remove_header_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) remove_host_match_pattern(opts)

Removes from the lists of patterns used to match the hosts.

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.



294
295
296
297
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 294

def remove_host_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) remove_path_match_pattern(opts)

Removes from the lists of patterns used to match the URI paths.

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_http_class.rb', line 307

def remove_path_match_pattern(opts)
  check_params(opts,[:patterns])
  super
end

- (Object) reset_statistics

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



318
319
320
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 318

def reset_statistics
  super
end

- (ProfileString) rewrite_url

Gets the strings (which may include a TCL expression) with which to rewrite the URLs.

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.



214
215
216
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 214

def rewrite_url
  super
end

- (Object) set_application_security_module_enabled_state(opts)

Sets the states that specify whether specified classes are Application Security Module classes.

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_http_class.rb', line 331

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

Resets the lists to parent defaults.

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.



342
343
344
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 342

def set_default_cookie_match_pattern
  super
end

- (Object) set_default_header_match_pattern

Resets the lists to parent defaults.

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
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 352

def set_default_header_match_pattern
  super
end

- (Object) set_default_host_match_pattern

Resets the lists to parent defaults.

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.



362
363
364
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 362

def set_default_host_match_pattern
  super
end

- (Object) set_default_path_match_pattern

Resets the lists to parent defaults.

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.



372
373
374
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 372

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



385
386
387
388
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 385

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

- (Object) set_pool_name(opts)

Sets the pool names to use when this classes match.

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.



398
399
400
401
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 398

def set_pool_name(opts)
  check_params(opts,[:pool_names])
  super
end

- (Object) set_redirect_location(opts)

Sets the string (which may include a TCL expression) to indicates where to redirect the original HTTP request once a match occurs. For example, to redirect requests to myserver.com to myotherserver.com.

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.



413
414
415
416
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 413

def set_redirect_location(opts)
  check_params(opts,[:redirect_locations])
  super
end

- (Object) set_rewrite_url(opts)

Sets the strings (which may include a TCL expression) with which to rewrite the URLs.

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.



426
427
428
429
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 426

def set_rewrite_url(opts)
  check_params(opts,[:urls])
  super
end

- (Object) set_web_accelerator_module_enabled_state(opts)

Sets the states that specify whether specified classes are Web Accelerator classes.

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.



439
440
441
442
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 439

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

- (ProfileHttpClassStatistics) statistics

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



225
226
227
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 225

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


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

def version
  super
end

- (ProfileEnabledState) web_accelerator_module_enabled_state

Gets the states that specify whether specified classes are Web Accelerator classes.

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.



244
245
246
# File 'lib/icontrol/local_lb/profile_http_class.rb', line 244

def web_accelerator_module_enabled_state
  super
end