Class: IControl::LocalLB::Klass

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

Overview

The Class interface enables you to manipulate a local load balancer's Class attributes. There are 3 different Class types: Address, String, and Value.

Defined Under Namespace

Classes: AddressClass, AddressClassSequence, AddressEntry, AddressEntrySequence, AddressEntrySequenceSequence, ClassType, ClassTypeSequence, FileFormatType, FileFormatTypeSequence, FileModeType, FileModeTypeSequence, MetaInformation, MetaInformationSequence, StringClass, StringClassSequence, ValueClass, ValueClassSequence

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

- (Object) add_address_class_member

Incrementally adds address class member.

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.



34
35
36
# File 'lib/icontrol/local_lb/klass.rb', line 34

def add_address_class_member
  super
end

- (Object) add_string_class_member

Incrementally adds string class member.

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.



44
45
46
# File 'lib/icontrol/local_lb/klass.rb', line 44

def add_string_class_member
  super
end

- (Object) add_value_class_member

Incrementally adds value class member.

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.



54
55
56
# File 'lib/icontrol/local_lb/klass.rb', line 54

def add_value_class_member
  super
end

- (AddressClass) address_class(opts)

Gets this address classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names.

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.



228
229
230
231
# File 'lib/icontrol/local_lb/klass.rb', line 228

def address_class(opts)
  check_params(opts,[:class_names])
  super
end

- (String) address_class_list

Gets the list of available address classes.

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.



240
241
242
# File 'lib/icontrol/local_lb/klass.rb', line 240

def address_class_list
  super
end

- (String[]) address_class_member_data_value

Gets the data values associated with a set of address class member. This method is effectively the lookup method for using the class as a value map.

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.



252
253
254
# File 'lib/icontrol/local_lb/klass.rb', line 252

def address_class_member_data_value
  super
end

- (MetaInformation) class_meta_information(opts)

Gets the meta data information for this classes. For external classes, the meta information will indicate the external file and other relevant information. For non-external classes, only applicable information such as class name/type will be of importance.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to retrieve class meta information from.

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.



267
268
269
270
# File 'lib/icontrol/local_lb/klass.rb', line 267

def class_meta_information(opts)
  check_params(opts,[:class_names])
  super
end

- (ClassType) class_type(opts)

Gets the class types for this classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to retrieve class types.

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.



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

def class_type(opts)
  check_params(opts,[:class_names])
  super
end

- (Object) create_address_class(opts)

Creates address classes. The specified classes must not already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::AddressClass)

    The class names and the class members.

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.



66
67
68
69
# File 'lib/icontrol/local_lb/klass.rb', line 66

def create_address_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) create_external_class(opts)

Creates external classes. Note: As of v9.6.0, the validation on the file_name field in external_classes was improved to ensure the class file exists on pain of Common::OperationFailed exception.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :external_classes (IControl::LocalLB::Class::MetaInformation)

    The sequence of external classes to create.

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.



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

def create_external_class(opts)
  check_params(opts,[:external_classes])
  super
end

- (Object) create_string_class(opts)

Creates string classes. The specified classes must not already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::StringClass)

    The class names and the class members.

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
97
# File 'lib/icontrol/local_lb/klass.rb', line 94

def create_string_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) create_value_class(opts)

Creates value classes. The specified classes must not already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::ValueClass)

    The class names and the class members.

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
110
# File 'lib/icontrol/local_lb/klass.rb', line 107

def create_value_class(opts)
  check_params(opts,[:classes])
  super
end

- (String) data_separator(opts)

Gets the strings used to separate a class member value from its optional associated data value for a set of classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    Names of the requested classes

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.



296
297
298
299
# File 'lib/icontrol/local_lb/klass.rb', line 296

def data_separator(opts)
  check_params(opts,[:class_names])
  super
end

- (Object) delete_address_class_member

Incrementally deletes address class member.

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/klass.rb', line 118

def delete_address_class_member
  super
end

- (Object) delete_all_address_classes

Deletes all address classes.

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.



128
129
130
# File 'lib/icontrol/local_lb/klass.rb', line 128

def delete_all_address_classes
  super
end

- (Object) delete_all_string_classes

Deletes all string classes.

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.



138
139
140
# File 'lib/icontrol/local_lb/klass.rb', line 138

def delete_all_string_classes
  super
end

- (Object) delete_all_value_classes

Deletes all value classes.

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.



148
149
150
# File 'lib/icontrol/local_lb/klass.rb', line 148

def delete_all_value_classes
  super
end

- (Object) delete_class(opts)

Deletes this classes. The specified classes can be of any class type, even external classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (String)

    The classes to delete.

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
164
# File 'lib/icontrol/local_lb/klass.rb', line 161

def delete_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) delete_string_class_member

Incrementally deletes string class member.

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/klass.rb', line 172

def delete_string_class_member
  super
end

- (Object) delete_value_class_member

Incrementally deletes value class member.

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/klass.rb', line 182

def delete_value_class_member
  super
end

- (FileFormatType) external_class_file_format(opts)

Gets the file format for this classes. This should only be called for external classes, since it does not make sense for non-external classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to retrieve file formats.

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.



311
312
313
314
# File 'lib/icontrol/local_lb/klass.rb', line 311

def external_class_file_format(opts)
  check_params(opts,[:class_names])
  super
end

- (FileModeType) external_class_file_mode(opts)

Gets the file modes for this classes. This should only be called for external classes, since it does not make sense for non-external classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to retrieve file modes.

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.



326
327
328
329
# File 'lib/icontrol/local_lb/klass.rb', line 326

def external_class_file_mode(opts)
  check_params(opts,[:class_names])
  super
end

- (String) external_class_file_name(opts)

Gets the file names for this classes. This should only be called for external classes, since it does not make sense for non-external classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to retrieve file names.

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.



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

def external_class_file_name(opts)
  check_params(opts,[:class_names])
  super
end

- (MetaInformation) external_class_list

Gets the list of all available external 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.



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

def external_class_list
  super
end

- (boolean[]) find_address_class_member

Checks to see if this class member are in this class names.

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.



193
194
195
# File 'lib/icontrol/local_lb/klass.rb', line 193

def find_address_class_member
  super
end

- (boolean[]) find_string_class_member

Checks to see if this class member are in this class names.

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.



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

def find_string_class_member
  super
end

- (boolean[]) find_value_class_member

Checks to see if this class member are in this class names.

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.



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

def find_value_class_member
  super
end

- (Object) modify_address_class(opts)

Modifies address classes. The specified classes must already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::AddressClass)

    The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.

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.



447
448
449
450
# File 'lib/icontrol/local_lb/klass.rb', line 447

def modify_address_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) modify_string_class(opts)

Modifies string classes. The specified classes must already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::StringClass)

    The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.

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.



460
461
462
463
# File 'lib/icontrol/local_lb/klass.rb', line 460

def modify_string_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) modify_value_class(opts)

Modifies value classes. The specified classes must already exist.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :classes (IControl::LocalLB::Class::ValueClass)

    The class names and the class members. The result is that the class now has the members specified in the class_members, regardless of what the class has before.

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.



473
474
475
476
# File 'lib/icontrol/local_lb/klass.rb', line 473

def modify_value_class(opts)
  check_params(opts,[:classes])
  super
end

- (Object) set_address_class_member_data_value(opts)

Sets the data values associated with a set of address class member. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (String[])

    Data values to associate with each class member, organized in the same manner as the class member IP addresses (default: "" (i.e., no value))

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.



488
489
490
491
# File 'lib/icontrol/local_lb/klass.rb', line 488

def set_address_class_member_data_value(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_data_separator(opts)

Sets the strings used to separate a class member value from its optional associated data value for a set of classes. This is used for listing and storing both external and internal classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    Names of the requested classes

  • :separators (String)

    String separator for each class (default: ":=")

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.



504
505
506
507
# File 'lib/icontrol/local_lb/klass.rb', line 504

def set_data_separator(opts)
  check_params(opts,[:class_names,:separators])
  super
end

- (Object) set_external_class_file_format(opts)

Sets the file format for this classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to set the file formats.

  • :file_formats (IControl::LocalLB::Class::FileFormatType)

    A list of file formats to set for the specified classes.

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.



520
521
522
523
# File 'lib/icontrol/local_lb/klass.rb', line 520

def set_external_class_file_format(opts)
  check_params(opts,[:class_names,:file_formats])
  super
end

- (Object) set_external_class_file_mode(opts)

Sets the file mode for this classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to set the file modes.

  • :file_modes (IControl::LocalLB::Class::FileModeType)

    A list of file modes to set for the specified classes.

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.



536
537
538
539
# File 'lib/icontrol/local_lb/klass.rb', line 536

def set_external_class_file_mode(opts)
  check_params(opts,[:class_names,:file_modes])
  super
end

- (Object) set_external_class_file_name(opts)

Sets the file names for this external classes. This should only be called for external classes, since it does not make sense for non-external classes. If called for non-external classes, it will silently accept it, but nothing will be done.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names to set the file names.

  • :file_names (String)

    A list of file names to set for the specified classes.

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.



552
553
554
555
# File 'lib/icontrol/local_lb/klass.rb', line 552

def set_external_class_file_name(opts)
  check_params(opts,[:class_names,:file_names])
  super
end

- (Object) set_string_class_member_data_value(opts)

Sets the data values associated with a set of string class member. This data value is an optional arbitrary string, which can be retrieved given the class member information, allowing the class to be used as a value map.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (String[])

    Data values to associate with each class member, organized in the same manner as the class member string values (default: "" (i.e., no value))

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.



567
568
569
570
# File 'lib/icontrol/local_lb/klass.rb', line 567

def set_string_class_member_data_value(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_value_class_member_data_value(opts)

Sets the data values associated with a set of value class member. This data value is an arbitrary optional string, which can be retrieved given the class member information, allowing the class to be used as a value map.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (String[])

    Data values to associate with each class member, organized in the same manner as the class member integer values (default: "" (i.e., no value))

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.



582
583
584
585
# File 'lib/icontrol/local_lb/klass.rb', line 582

def set_value_class_member_data_value(opts)
  check_params(opts,[:values])
  super
end

- (StringClass) string_class(opts)

Gets this string classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names.

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.



366
367
368
369
# File 'lib/icontrol/local_lb/klass.rb', line 366

def string_class(opts)
  check_params(opts,[:class_names])
  super
end

- (String) string_class_list

Gets the list of available string classes.

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.



378
379
380
# File 'lib/icontrol/local_lb/klass.rb', line 378

def string_class_list
  super
end

- (String[]) string_class_member_data_value

Gets the data values associated with a set of string class member. This method is effectively the lookup method for using the class as a value map.

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.



390
391
392
# File 'lib/icontrol/local_lb/klass.rb', line 390

def string_class_member_data_value
  super
end

- (ValueClass) value_class(opts)

Gets this value classes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_names (String)

    The class names.

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.



403
404
405
406
# File 'lib/icontrol/local_lb/klass.rb', line 403

def value_class(opts)
  check_params(opts,[:class_names])
  super
end

- (String) value_class_list

Gets the list of available value classes.

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.



415
416
417
# File 'lib/icontrol/local_lb/klass.rb', line 415

def value_class_list
  super
end

- (String[]) value_class_member_data_value

Gets the data values associated with a set of value class member. This method is effectively the lookup method for using the class as a value map.

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.



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

def value_class_member_data_value
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


435
436
437
# File 'lib/icontrol/local_lb/klass.rb', line 435

def version
  super
end