Class: IControl::LocalLB::ProfileXML

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

Overview

The ProfileXML interface enables you to manipulate a local load balancer's XML profile.

Defined Under Namespace

Classes: NamespaceMapping, NamespaceMappingSequence, NamespaceMappingSequenceSequence, ProfileNamespaceMappingSequence, ProfileNamespaceMappingSequenceSequence, ProfileXMLStatisticEntry, ProfileXMLStatisticEntrySequence, ProfileXMLStatistics

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

- (ProfileEnabledState) abort_on_error_state

Gets the state that if true, abort the connection on errors.

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.



84
85
86
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 84

def abort_on_error_state
  super
end

- (Object) add_namespace_mappings(opts)

Adds sets of namespace mappings to a set of XML profile. Specifies a list of mappings between namespaces and prefixes to be used in the profile context. For example, to define a namespace mapping of XML schema namespace one would add the namespace mapping of the prefix "xsd" to the namespace "www.w3.org/2001/XMLSchema".

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.



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

def add_namespace_mappings(opts)
  check_params(opts,[:namespace_mappings])
  super
end

- (Object) add_xpath_queries(opts)

Adds sets of XPath query strings to a set of XML profile. A match of any of the queries will trigger an iRule event. For example, to trigger an iRule event on document having title of the first book node under the bookstore element it's needed to add the "/bookstore/book/title" XPath query to a xml profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :xpath_queries (String[]) —

    The lists of XPath queries to be added to the XPath queries list of each XML profile respectively.

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.



42
43
44
45
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 42

def add_xpath_queries(opts)
  check_params(opts,[:xpath_queries])
  super
end

- (ProfileXMLStatistics) all_statistics

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



95
96
97
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 95

def all_statistics
  super
end

- (Object) create

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



53
54
55
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 53

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.



107
108
109
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 107

def default_profile
  super
end

- (Object) delete_all_profiles

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



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

def delete_all_profiles
  super
end

- (Object) delete_profile

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



73
74
75
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 73

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



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

def is_base_profile
  super
end

- (String) list

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



118
119
120
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 118

def list
  super
end

- (ProfileULong) maximum_buffer_size

Gets the values that specify the maximum buffer size 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.



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

def maximum_buffer_size
  super
end

- (ProfileNamespaceMappingSequence) namespace_mappings

Gets sets of namespace mappings of a set of XML 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_xml.rb', line 140

def namespace_mappings
  super
end

- (Object) remove_all_namespace_mappings

Removes all the namespace mappings from a set of XML 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.



192
193
194
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 192

def remove_all_namespace_mappings
  super
end

- (Object) remove_all_xpath_queries

Removes all the XPath queries from a set of XML 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.



202
203
204
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 202

def remove_all_xpath_queries
  super
end

- (Object) remove_namespace_mappings(opts)

Removes sets of namespace mappings from a set of XML 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.



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

def remove_namespace_mappings(opts)
  check_params(opts,[:namespace_mappings])
  super
end

- (Object) remove_xpath_queries(opts)

Removes sets of XPath query strings from a set of XML profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :xpath_queries (String[]) —

    The lists of XPath queries to be removed from the XPath queries list of each XML profile respectively.

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.



227
228
229
230
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 227

def remove_xpath_queries(opts)
  check_params(opts,[:xpath_queries])
  super
end

- (Object) reset_statistics

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



238
239
240
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 238

def reset_statistics
  super
end

- (Object) set_abort_on_error_state(opts)

Sets the state that if true, abort the connection on errors.

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.



250
251
252
253
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 250

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



264
265
266
267
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 264

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

- (Object) set_maximum_buffer_size(opts)

Sets the values that specify the maximum buffer size for this 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.



277
278
279
280
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 277

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

- (ProfileXMLStatistics) statistics

Gets the statistics for this XML 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_xml.rb', line 151

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


159
160
161
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 159

def version
  super
end

- (ProfileStringArray) xpath_queries

Gets sets of XPath query strings of a set of XML 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.



170
171
172
 
# File 'lib/icontrol/local_lb/profile_xml.rb', line 170

def xpath_queries
  super
end