Class: IControl::LocalLB::PoolMember

Inherits:

Base

• Object
• Base
• IControl::LocalLB::PoolMember

Defined in:

lib/icontrol/local_lb/pool_member.rb,
lib/icontrol/local_lb.rb

Overview

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

Defined Under Namespace

Classes: MemberConnectionLimit, MemberConnectionLimitSequence, MemberConnectionLimitSequenceSequence, MemberDynamicRatio, MemberDynamicRatioSequence, MemberDynamicRatioSequenceSequence, MemberMonitorAssociation, MemberMonitorAssociationRemoval, MemberMonitorAssociationRemovalSequence, MemberMonitorAssociationRemovalSequenceSequence, MemberMonitorAssociationSequence, MemberMonitorAssociationSequenceSequence, MemberMonitorInstanceState, MemberMonitorInstanceStateSequence, MemberMonitorInstanceStateSequenceSequence, MemberMonitorState, MemberMonitorStateSequence, MemberMonitorStateSequenceSequence, MemberMonitorStatus, MemberMonitorStatusSequence, MemberMonitorStatusSequenceSequence, MemberObjectStatus, MemberObjectStatusSequence, MemberObjectStatusSequenceSequence, MemberPriority, MemberPrioritySequence, MemberPrioritySequenceSequence, MemberRatio, MemberRatioSequence, MemberRatioSequenceSequence, MemberSessionState, MemberSessionStateSequence, MemberSessionStateSequenceSequence, MemberSessionStatus, MemberSessionStatusSequence, MemberSessionStatusSequenceSequence, MemberStatisticEntry, MemberStatisticEntrySequence, MemberStatistics, MemberStatisticsSequence

Instance Method Summary

• #all_statistics ⇒ MemberStatistics

  Gets the statistics for all pool members of this pool.

• #connection_limit ⇒ MemberConnectionLimit[]

  Gets the connection limits for all members in this pool.

• #dynamic_ratio ⇒ MemberDynamicRatio[]

  Gets the dynamic ratios for all members of this pool.

• #monitor_association ⇒ MemberMonitorAssociation[]

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

• #monitor_instance ⇒ MemberMonitorInstanceState[]

  Gets the monitor instance information for the pool members in this pool.

• #monitor_status ⇒ MemberMonitorStatus[]

  Gets the monitor/availability status for all members of this pool.

• #object_status ⇒ MemberObjectStatus[]

  Gets the object statuses for all members of this pool.

• #priority ⇒ MemberPriority[]

  Gets the priorities for all members in this pool.

• #ratio ⇒ MemberRatio[]

  Gets the ratios for all members in this pool.

• #remove_monitor_association(opts) ⇒ Object

  Removes the monitor associations for this pool members.

• #reset_statistics(opts) ⇒ Object

  Resets the statistics for this set of pool members.

• #session_enabled_state ⇒ MemberSessionState[]

  Note: This function has been deprecated.

• #session_status ⇒ MemberSessionStatus[]

  Gets the session status for all members of this pool.

• #set_connection_limit(opts) ⇒ Object

  Sets the connection limits for this pool members.

• #set_dynamic_ratio(opts) ⇒ Object

  Sets the dynamic ratios for this pool members.

• #set_monitor_association(opts) ⇒ Object

  Sets/creates the monitor associations for this pool members.

• #set_monitor_state(opts) ⇒ Object

  Sets the monitor/availability states for this pool members.

• #set_priority(opts) ⇒ Object

  Sets the priorities for this pool members.

• #set_ratio(opts) ⇒ Object

  Sets the ratios for this pool members.

• #set_session_enabled_state(opts) ⇒ Object

  Sets the session states for this pool members.

• #statistics(opts) ⇒ MemberStatistics

  Gets the statistics for this set of pool members.

• #version ⇒ String

  Gets the version information for this interface.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#all_statistics ⇒ MemberStatistics

Gets the statistics for all pool members of this pool.

Returns:

• (MemberStatistics)

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 55

def all_statistics
  super
end

#connection_limit ⇒ MemberConnectionLimit[]

Gets the connection limits for all members in this pool.

Returns:

• (MemberConnectionLimit[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 66

def connection_limit
  super
end

#dynamic_ratio ⇒ MemberDynamicRatio[]

Gets the dynamic ratios for all members of this pool.

Returns:

• (MemberDynamicRatio[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 77

def dynamic_ratio
  super
end

#monitor_association ⇒ MemberMonitorAssociation[]

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

Returns:

• (MemberMonitorAssociation[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 89

def monitor_association
  super
end

#monitor_instance ⇒ MemberMonitorInstanceState[]

Gets the monitor instance information for the pool members in this pool.

Returns:

• (MemberMonitorInstanceState[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 100

def monitor_instance
  super
end

#monitor_status ⇒ MemberMonitorStatus[]

Gets the monitor/availability status for all members of this pool.

Returns:

• (MemberMonitorStatus[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 111

def monitor_status
  super
end

#object_status ⇒ MemberObjectStatus[]

Gets the object statuses for all members of this pool.

Returns:

• (MemberObjectStatus[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 122

def object_status
  super
end

#priority ⇒ MemberPriority[]

Gets the priorities for all members in this pool.

Returns:

• (MemberPriority[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 133

def priority
  super
end

#ratio ⇒ MemberRatio[]

Gets the ratios for all members in this pool.

Returns:

• (MemberRatio[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 144

def ratio
  super
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):

• :monitor_associations (IControl::LocalLB::PoolMember::MemberMonitorAssociationRemoval[]) —

  The monitor association removal rules that will be used to remove the monitor associations for the specified pool 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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 206

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):

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

  The members to get statistics from.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 219

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

#session_enabled_state ⇒ MemberSessionState[]

Note: This function has been deprecated. Please use get_session_status. Gets the session states for all members of this pool.

Returns:

• (MemberSessionState[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 156

def session_enabled_state
  super
end

#session_status ⇒ MemberSessionStatus[]

Gets the session status for all members of this pool.

Returns:

• (MemberSessionStatus[])

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 167

def session_status
  super
end

#set_connection_limit(opts) ⇒ Object

Sets the connection limits for this pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :limits (IControl::LocalLB::PoolMember::MemberConnectionLimit[]) —

  The members and the connection limits to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 232

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

#set_dynamic_ratio(opts) ⇒ Object

Sets the dynamic ratios for this pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :dynamic_ratios (IControl::LocalLB::PoolMember::MemberDynamicRatio[]) —

  The members and the dynamic ratios to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 245

def set_dynamic_ratio(opts)
  opts = check_params(opts,[:dynamic_ratios])
  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):

• :monitor_associations (IControl::LocalLB::PoolMember::MemberMonitorAssociation[]) —

  The monitor associations that will be used to evaluate the specified pool 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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 259

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

#set_monitor_state(opts) ⇒ Object

Sets the monitor/availability states for this pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :monitor_states (IControl::LocalLB::PoolMember::MemberMonitorState[]) —

  The members and the monitor/availability states to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 272

def set_monitor_state(opts)
  opts = check_params(opts,[:monitor_states])
  super(opts)
end

#set_priority(opts) ⇒ Object

Sets the priorities for this pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :priorities (IControl::LocalLB::PoolMember::MemberPriority[]) —

  The members and the priorities to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 285

def set_priority(opts)
  opts = check_params(opts,[:priorities])
  super(opts)
end

#set_ratio(opts) ⇒ Object

Sets the ratios for this pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :ratios (IControl::LocalLB::PoolMember::MemberRatio[]) —

  The members and the ratios to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 298

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

#set_session_enabled_state(opts) ⇒ Object

Sets the session states for this pool members. If session state is enabled or true, this means that new sessions will be allowed to be established with the pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

• :session_states (IControl::LocalLB::PoolMember::MemberSessionState[]) —

  The members and the session states to be set.

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 312

def set_session_enabled_state(opts)
  opts = check_params(opts,[:session_states])
  super(opts)
end

#statistics(opts) ⇒ MemberStatistics

Gets the statistics for this set of pool members.

Parameters:

• opts (Hash)

Options Hash (opts):

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

  The members to get statistics from.

Returns:

• (MemberStatistics)

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.

# File 'lib/icontrol/local_lb/pool_member.rb', line 180

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

#version ⇒ String

Gets the version information for this interface.

Returns:

• (String)

# File 'lib/icontrol/local_lb/pool_member.rb', line 189

def version
  super
end