Class: IControl::LocalLB::NodeAddress

Inherits:

Base

• Object
• Base
• IControl::LocalLB::NodeAddress

Defined in:

lib/icontrol/local_lb/node_address.rb,
lib/icontrol/local_lb.rb

Overview

The NodeAddress interface enables you to work with the states, statistics, limits, availability, ratios, application response deltas, and monitors of a local load balancer’s node address.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationRemoval, MonitorAssociationRemovalSequence, MonitorAssociationSequence, NodeAddressStatisticEntry, NodeAddressStatisticEntrySequence, NodeAddressStatistics

Instance Method Summary

• #all_statistics ⇒ NodeAddressStatistics

  Gets the statistics for all the node addresse.

• #connection_limit ⇒ ULong64

  Gets the connection limits for this node addresse.

• #create(opts) ⇒ Object

  Creates this node addresse.

• #delete_all_node_addresses ⇒ Object

  Deletes all node addresse.

• #delete_node_address ⇒ Object

  Deletes this node addresse.

• #dynamic_ratio ⇒ short

  Gets the dynamic ratios of a node addresse.

• #list ⇒ String

  Gets a list of all node addresse.

• #monitor_association(opts) ⇒ MonitorAssociation

  Gets the monitor associations used by this node addresse, i.e.

• #monitor_instance(opts) ⇒ MonitorInstanceState[]

  Gets the monitor instance information for this node addresse.

• #monitor_status ⇒ MonitorStatus

  Gets the current availability status of this node addresse.

• #object_status ⇒ ObjectStatus

  Gets the statuses of this node addresse.

• #ratio ⇒ long

  Gets the ratios for this node addresse.

• #remove_monitor_association(opts) ⇒ Object

  Removes the monitor associations for this node addresse.

• #reset_statistics ⇒ Object

  Resets the statistics for this node addresse.

• #screen_name ⇒ String

  Gets the screen names for this node addresse.

• #session_enabled_state ⇒ EnabledState

  Note: This function has been deprecated.

• #session_status ⇒ SessionStatus

  Gets the current session statuses of this node addresse.

• #set_connection_limit(opts) ⇒ Object

  Sets the connection limits for a sequence of node addresse.

• #set_dynamic_ratio(opts) ⇒ Object

  Sets the dynamic ratios for this node addresse.

• #set_monitor_association(opts) ⇒ Object

  Sets/creates the monitor associations for this node addresse.

• #set_monitor_state(opts) ⇒ Object

  Sets the availability states for a sequence of node addresse, either enabled/disabled or up/down.

• #set_ratio(opts) ⇒ Object

  Sets the ratios for this node addresse.

• #set_screen_name(opts) ⇒ Object

  Sets the screen names for this node addresse.

• #set_session_enabled_state(opts) ⇒ Object

  Sets the states that allows new sessions to be established for this node addresse.

• #statistics ⇒ NodeAddressStatistics

  Gets the statistics for this node.

• #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 ⇒ NodeAddressStatistics

Gets the statistics for all the node addresse.

Returns:

• (NodeAddressStatistics)

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/node_address.rb', line 56

def all_statistics
  super
end

#connection_limit ⇒ ULong64

Gets the connection limits for this node addresse.

Returns:

• (ULong64)

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/node_address.rb', line 67

def connection_limit
  super
end

#create(opts) ⇒ Object

Creates this node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :limits (long) —

  The connection limits.

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/node_address.rb', line 24

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

#delete_all_node_addresses ⇒ Object

Deletes all node addresse.

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/node_address.rb', line 35

def delete_all_node_addresses
  super
end

#delete_node_address ⇒ Object

Deletes this node addresse.

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/node_address.rb', line 45

def delete_node_address
  super
end

#dynamic_ratio ⇒ short

Gets the dynamic ratios of a node addresse.

Returns:

• (short)

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/node_address.rb', line 78

def dynamic_ratio
  super
end

#list ⇒ String

Gets a list of all node addresse.

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.

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

def list
  super
end

#monitor_association(opts) ⇒ MonitorAssociation

Gets the monitor associations used by this node addresse, i.e. the monitor rules used by the node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :addresses (IControl::LocalLB::MonitorIP) —

  The node addresses.

Returns:

• (MonitorAssociation)

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/node_address.rb', line 103

def monitor_association(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#monitor_instance(opts) ⇒ MonitorInstanceState[]

Gets the monitor instance information for this node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :addresses (IControl::LocalLB::MonitorIP) —

  The node addresses.

Returns:

• (MonitorInstanceState[])

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/node_address.rb', line 117

def monitor_instance(opts)
  opts = check_params(opts,[:addresses])
  super(opts)
end

#monitor_status ⇒ MonitorStatus

Gets the current availability status of this node addresse.

Returns:

• (MonitorStatus)

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/node_address.rb', line 129

def monitor_status
  super
end

#object_status ⇒ ObjectStatus

Gets the statuses of this node addresse.

Returns:

• (ObjectStatus)

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/node_address.rb', line 140

def object_status
  super
end

#ratio ⇒ long

Gets the ratios for this node addresse.

Returns:

• (long)

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/node_address.rb', line 151

def ratio
  super
end

#remove_monitor_association(opts) ⇒ Object

Removes the monitor associations for this node addresse. This basically deletes the monitor associations between a node address and a monitor rule, i.e. this node address will no longer be monitored.

Parameters:

• opts (Hash)

Options Hash (opts):

• :monitor_associations (IControl::LocalLB::NodeAddress::MonitorAssociationRemoval) —

  The monitor association removal rules that will be used to remove the monitor associations for the specified node addresses.

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/node_address.rb', line 218

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

#reset_statistics ⇒ Object

Resets the statistics for this node addresse.

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/node_address.rb', line 229

def reset_statistics
  super
end

#screen_name ⇒ String

Gets the screen names for this node addresse.

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.

# File 'lib/icontrol/local_lb/node_address.rb', line 162

def screen_name
  super
end

#session_enabled_state ⇒ EnabledState

Note: This function has been deprecated. Please use get_session_status. Gets the states that allows new sessions to be established for this node addresse.

Returns:

• (EnabledState)

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/node_address.rb', line 174

def session_enabled_state
  super
end

#session_status ⇒ SessionStatus

Gets the current session statuses of this node addresse.

Returns:

• (SessionStatus)

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/node_address.rb', line 185

def session_status
  super
end

#set_connection_limit(opts) ⇒ Object

Sets the connection limits for a sequence of node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :limits (IControl::Common::ULong64) —

  The limits for the specified node addresses.

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/node_address.rb', line 241

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

#set_dynamic_ratio(opts) ⇒ Object

Sets the dynamic ratios for this node addresse

Parameters:

• opts (Hash)

Options Hash (opts):

• :dynamic_ratios (short) —

  The dynamic ratios for the specified node addresses.

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/node_address.rb', line 254

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 node addresse. This basically creates the monitor associations between a node address and a monitor rule.

Parameters:

• opts (Hash)

Options Hash (opts):

• :monitor_associations (IControl::LocalLB::NodeAddress::MonitorAssociation) —

  The monitor associations that will be used to evaluate the specified node addresses.

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/node_address.rb', line 268

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

#set_monitor_state(opts) ⇒ Object

Sets the availability states for a sequence of node addresse, either enabled/disabled or up/down.

Parameters:

• opts (Hash)

Options Hash (opts):

• :states (IControl::Common::EnabledState) —

  The availability states of the specified node addresses.

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/node_address.rb', line 282

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

#set_ratio(opts) ⇒ Object

Sets the ratios for this node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :ratios (long) —

  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/node_address.rb', line 295

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

#set_screen_name(opts) ⇒ Object

Sets the screen names for this node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :names (String) —

  The screen names 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/node_address.rb', line 308

def set_screen_name(opts)
  opts = check_params(opts,[:names])
  super(opts)
end

#set_session_enabled_state(opts) ⇒ Object

Sets the states that allows new sessions to be established for this node addresse.

Parameters:

• opts (Hash)

Options Hash (opts):

• :states (IControl::Common::EnabledState) —

  The new session enabled states of the specified node addresses.

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/node_address.rb', line 321

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

#statistics ⇒ NodeAddressStatistics

Gets the statistics for this node.

Returns:

• (NodeAddressStatistics)

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/node_address.rb', line 196

def statistics
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

• (String)

# File 'lib/icontrol/local_lb/node_address.rb', line 204

def version
  super
end