Class: IControl::GlobalLB::PoolMember

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/pool_member.rb,
lib/icontrol/global_lb.rb

Overview

The PoolMember interface enables you to work with the pool members and their settings, and statistics.

Defined Under Namespace

Classes: MemberDependency, MemberDependencySequence, MemberDependencySequenceSequence, MemberEnabledState, MemberEnabledStateSequence, MemberEnabledStateSequenceSequence, MemberMetricLimit, MemberMetricLimitSequence, MemberMetricLimitSequenceSequence, MemberMonitorAssociation, MemberMonitorAssociationRemoval, MemberMonitorAssociationRemovalSequence, MemberMonitorAssociationRemovalSequenceSequence, MemberMonitorAssociationSequence, MemberMonitorAssociationSequenceSequence, MemberObjectStatus, MemberObjectStatusSequence, MemberObjectStatusSequenceSequence, MemberOrder, MemberOrderSequence, MemberOrderSequenceSequence, MemberRatio, MemberRatioSequence, MemberRatioSequenceSequence, MemberStatisticEntry, MemberStatisticEntrySequence, MemberStatistics, MemberStatisticsSequence

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

#add_dependency(opts) ⇒ Object

Adds the virtual servers to the dependency list that this pool members depend on.

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.



44
45
46
47
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 44

def add_dependency(opts)
  opts = check_params(opts,[:dependencies])
  super(opts)
end

#all_statistics ⇒ MemberStatistics

Gets the statistics for all pool members of this pool.

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.



56
57
58
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 56

def all_statistics
  super
end

#dependency(opts) ⇒ MemberDependency[]

Gets the list of virtual servers that this pool members depend on.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



69
70
71
72
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 69

def dependency(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#enabled_state(opts) ⇒ MemberEnabledState[]

Gets the enabled states for this members in this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



83
84
85
86
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 83

def enabled_state(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#limit(opts) ⇒ MemberMetricLimit[]

Gets the metric limits for this members of this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



97
98
99
100
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 97

def limit(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#monitor_association ⇒ MemberMonitorAssociation[]

Gets the monitor associations used by this pool members, i.e. the monitor rules used by the pool members.

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.



110
111
112
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 110

def monitor_association
  super
end

#object_status(opts) ⇒ MemberObjectStatus[]

Gets the statuses for this members in this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

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
126
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 123

def object_status(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#order(opts) ⇒ MemberOrder[]

Gets the orders for this members in this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

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
140
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 137

def order(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#ratio(opts) ⇒ MemberRatio[]

Gets the ratios for this members in this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

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
154
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 151

def ratio(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#remove_all_dependencies(opts) ⇒ Object

Removes any and all dependencies of this pool members.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :members (IControl::Common::IPPortDefinition[]) —

    The pool members to remove the dependencies from. These pool members will no longer have any dependency on any other virtual servers.

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.



186
187
188
189
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 186

def remove_all_dependencies(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#remove_dependency(opts) ⇒ Object

Removes the virtual servers from the dependency list that this pool members depend on.

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.



200
201
202
203
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 200

def remove_dependency(opts)
  opts = check_params(opts,[:dependencies])
  super(opts)
end

#remove_monitor_association(opts) ⇒ Object

Removes the monitor associations for this pool members. Depending on the monitor association removal rule specified, this basically deletes any explicit monitor associations between a pool member and a monitor rule and thus causing the pool member to use the default monitor association of its parent pool, or this will delete any monitor association for the pool members altogether, i.e. this pool members will no longer be monitored.

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.



218
219
220
221
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 218

def remove_monitor_association(opts)
  opts = check_params(opts,[:monitor_associations])
  super(opts)
end

#reset_statistics(opts) ⇒ Object

Resets the statistics for this set of pool members.

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/global_lb/pool_member.rb', line 231

def reset_statistics(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#set_enabled_state(opts) ⇒ Object

Sets the enabled states for this pool members in this pool.

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.



244
245
246
247
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 244

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

#set_limit(opts) ⇒ Object

Sets the metric limits for this members of this pool.

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.



257
258
259
260
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 257

def set_limit(opts)
  opts = check_params(opts,[:limits])
  super(opts)
end

#set_monitor_association(opts) ⇒ Object

Sets/creates the monitor associations for this pool members. This basically creates the monitor associations between a pool member and a monitor 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.



271
272
273
274
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 271

def set_monitor_association(opts)
  opts = check_params(opts,[:monitor_associations])
  super(opts)
end

#set_order(opts) ⇒ Object

Sets the orders for this pool members.

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.



284
285
286
287
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 284

def set_order(opts)
  opts = check_params(opts,[:orders])
  super(opts)
end

#set_ratio(opts) ⇒ Object

Sets the ratios for this pool members.

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.



297
298
299
300
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 297

def set_ratio(opts)
  opts = check_params(opts,[:ratios])
  super(opts)
end

#statistics(opts) ⇒ MemberStatistics

Gets the statistics for this set of pool members.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



165
166
167
168
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 165

def statistics(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


174
175
176
 
# File 'lib/icontrol/global_lb/pool_member.rb', line 174

def version
  super
end