Class: IControl::LocalLB::SNATTranslationAddress

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

Overview

The SNATTranslationAddress interface enables you to work with the definitions contained in a local load balancer's SNAT translation address. A translation address defines an address to which a client address may be translated on the server side.

Defined Under Namespace

Classes: SNATTranslationAddressStatisticEntry, SNATTranslationAddressStatisticEntrySequence, SNATTranslationAddressStatistics

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

#all_statisticsSNATTranslationAddressStatistics

Gets the statistics for all SNAT translation addresse..

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.



52
53
54
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 52

def all_statistics
  super
end

#arp_stateEnabledState

Gets the ARP states for this translation SNAT addresses.

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.



63
64
65
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 63

def arp_state
  super
end

#connection_limitULong64

Gets the connection limits of this original SNAT translation 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.



74
75
76
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 74

def connection_limit
  super
end

#create(opts) ⇒ Object

Creates this SNAT translation addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :unit_ids (long)

    The unit IDs associated with the translation addresses. If the unit ID of a translation address is not active on a BIG-IP, the BIG-IP does not respond to ARP requests or send gratuitous ARPs for that translation address.

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_translation_address.rb', line 20

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

#delete_all_translation_addressesObject

Deletes all SNAT translation 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.



31
32
33
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 31

def delete_all_translation_addresses
  super
end

#delete_translation_addressObject

Deletes a specified list of SNAT translation 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.



41
42
43
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 41

def delete_translation_address
  super
end

#enabled_stateEnabledState

Gets the states of this SNAT translation 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.



85
86
87
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 85

def enabled_state
  super
end

#ip_timeoutlong

Gets the IP idle timeouts of this SNAT translation 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.



96
97
98
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 96

def ip_timeout
  super
end

#listString

Gets a list of all SNAT translation 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.



107
108
109
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 107

def list
  super
end

#reset_statisticsObject

Resets the statistics for a list of SNAT translation 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.



169
170
171
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 169

def reset_statistics
  super
end

#set_arp_state(opts) ⇒ Object

Sets the ARP states for this tranlation SNAT addresses.

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.



181
182
183
184
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 181

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

#set_connection_limit(opts) ⇒ Object

Sets the connection limits of this original SNAT translation addresse.

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.



194
195
196
197
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 194

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

#set_enabled_state(opts) ⇒ Object

Sets the state for a list of SNAT translation addresse.

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.



207
208
209
210
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 207

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

#set_ip_timeout(opts) ⇒ Object

Sets the IP idle timeouts of this SNAT translation addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The IP timeouts to 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.



220
221
222
223
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 220

def set_ip_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_tcp_timeout(opts) ⇒ Object

Sets the TCP idle timeouts of this SNAT translation addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The TCP timeouts to 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.



233
234
235
236
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 233

def set_tcp_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_udp_timeout(opts) ⇒ Object

Sets the UDP idle timeouts of this SNAT translation addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :timeouts (long)

    The UDP timeouts to 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.



246
247
248
249
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 246

def set_udp_timeout(opts)
  opts = check_params(opts,[:timeouts])
  super(opts)
end

#set_unit_id(opts) ⇒ Object

Sets the unit IDs for this tranlation SNAT addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :unit_ids (long)

    The unit IDs to 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.



259
260
261
262
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 259

def set_unit_id(opts)
  opts = check_params(opts,[:unit_ids])
  super(opts)
end

#statisticsSNATTranslationAddressStatistics

Gets the statistics for a list of SNAT translation addresse.

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.



118
119
120
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 118

def statistics
  super
end

#tcp_timeoutlong

Gets the TCP idle timeouts of this SNAT translation 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.



129
130
131
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 129

def tcp_timeout
  super
end

#udp_timeoutlong

Gets the UDP idle timeouts of this SNAT translation 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.



140
141
142
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 140

def udp_timeout
  super
end

#unit_idlong

Gets the unit IDs for a specified SNAT translation 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.



151
152
153
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 151

def unit_id
  super
end

#versionString

Get the version information for this interface.

Returns:

  • (String)


159
160
161
# File 'lib/icontrol/local_lb/snat_translation_address.rb', line 159

def version
  super
end