Class: IControl::LocalLB::SNATPool

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

Overview

The SNATPool interface enables you to work with the definitions contained in a local load balancer's SNAT pool, which is a set of translation addresses. Either a virtual server, an iRule or a top-level SNAT object can reference a SNAT pool.

Defined Under Namespace

Classes: SNATPoolStatisticEntry, SNATPoolStatisticEntrySequence, SNATPoolStatistics

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_member(opts) ⇒ Object

Adds members to this SNAT pools.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :members (String[])

    The members to add to the specified SNAT pools.

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.



20
21
22
23
# File 'lib/icontrol/local_lb/snat_pool.rb', line 20

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

#all_statisticsSNATPoolStatistics

Gets the statistics for all SNAT pools.

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.



65
66
67
# File 'lib/icontrol/local_lb/snat_pool.rb', line 65

def all_statistics
  super
end

#create(opts) ⇒ Object

Creates this SNAT pools.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :translation_addresses (String[])

    The translation addresses associated with the SNAT pools. If the referenced SNAT translation addresses do not exist, they are created automatically using the global SNAT defaults.

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.



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

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

#delete_all_snat_poolsObject

Deletes all SNAT pools.

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/snat_pool.rb', line 44

def delete_all_snat_pools
  super
end

#delete_snat_poolObject

Deletes a specified list of SNAT pools.

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/snat_pool.rb', line 54

def delete_snat_pool
  super
end

#listString

Gets a list of all SNAT pools.

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.



76
77
78
# File 'lib/icontrol/local_lb/snat_pool.rb', line 76

def list
  super
end

#memberString[]

Gets the list of members belonging to this SNAT pools.

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.



87
88
89
# File 'lib/icontrol/local_lb/snat_pool.rb', line 87

def member
  super
end

#remove_all_membersObject

Removes all members from this SNAT pools.

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.



116
117
118
# File 'lib/icontrol/local_lb/snat_pool.rb', line 116

def remove_all_members
  super
end

#remove_member(opts) ⇒ Object

Removes members from this SNAT pools.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :members (String[])

    The members to remove from the specified SNAT pools.

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
131
# File 'lib/icontrol/local_lb/snat_pool.rb', line 128

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

#reset_statisticsObject

Resets the statistics for a list of SNAT pools.

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.



139
140
141
# File 'lib/icontrol/local_lb/snat_pool.rb', line 139

def reset_statistics
  super
end

#statisticsSNATPoolStatistics

Gets the statistics for a list of SNAT pools.

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.



98
99
100
# File 'lib/icontrol/local_lb/snat_pool.rb', line 98

def statistics
  super
end

#versionString

Get the version information for this interface.

Returns:

  • (String)


106
107
108
# File 'lib/icontrol/local_lb/snat_pool.rb', line 106

def version
  super
end