Class: IControl::LocalLB::SNAT

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

Overview

The SNAT interface enables you to work with the definitions contained in a local load balancer's top-level secure network address translations (SNAT) object. The top-level SNAT configuration object is a named object in the definition of a standard or a selective SNAT. Standard SNATs translate to a single address, while selective SNATs translate to a pool of translation addresses, i.e. SNAT pool.

Defined Under Namespace

Classes: SNATDefinition, SNATDefinitionSequence, SNATOriginalAddress, SNATOriginalAddressSequence, SNATOriginalAddressSequenceSequence, SNATStatisticEntry, SNATStatisticEntrySequence, SNATStatistics, Translation, TranslationSequence

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

Adds original client addresses to the filters used to match incoming traffic.

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.



29
30
31
32
# File 'lib/icontrol/local_lb/snat.rb', line 29

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

#all_statisticsSNATStatistics

Gets the statistics for all top-level SNATs.

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.



75
76
77
# File 'lib/icontrol/local_lb/snat.rb', line 75

def all_statistics
  super
end

#connection_mirror_stateEnabledState

Gets the connection mirror states for a specified SNATs.

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.



86
87
88
# File 'lib/icontrol/local_lb/snat.rb', line 86

def connection_mirror_state
  super
end

#create(opts) ⇒ Object

Creates this top-level SNAT objects.

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.



43
44
45
46
# File 'lib/icontrol/local_lb/snat.rb', line 43

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

#delete_all_snatsObject

Deletes all SNATs.

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

def delete_all_snats
  super
end

#delete_snatObject

Deletes a specified list of SNATs.

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.



64
65
66
# File 'lib/icontrol/local_lb/snat.rb', line 64

def delete_snat
  super
end

#listString

Gets a list of all top-level SNAT configuration objects.

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.



97
98
99
# File 'lib/icontrol/local_lb/snat.rb', line 97

def list
  super
end

#original_addressSNATOriginalAddress[]

Gets the list of original client addresses used to filter the traffic to the SNATs.

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.



108
109
110
# File 'lib/icontrol/local_lb/snat.rb', line 108

def original_address
  super
end

#remove_all_original_addressesObject

Removes all original client addresses in the filters.

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.



171
172
173
# File 'lib/icontrol/local_lb/snat.rb', line 171

def remove_all_original_addresses
  super
end

#remove_original_address(opts) ⇒ Object

Removes original client addresses from the filters used to match incoming traffic.

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.



183
184
185
186
# File 'lib/icontrol/local_lb/snat.rb', line 183

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

#reset_statisticsObject

Resets the statistics for a list of top-level SNATs.

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
# File 'lib/icontrol/local_lb/snat.rb', line 194

def reset_statistics
  super
end

#set_connection_mirror_state(opts) ⇒ Object

Sets the connection mirror state for this SNATs.

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.



206
207
208
209
# File 'lib/icontrol/local_lb/snat.rb', line 206

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

#set_source_port_behavior(opts) ⇒ Object

Sets the source port behavior for this SNATs.

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.



219
220
221
222
# File 'lib/icontrol/local_lb/snat.rb', line 219

def set_source_port_behavior(opts)
  opts = check_params(opts,[:source_port_behaviors])
  super(opts)
end

#set_translation_target(opts) ⇒ Object

Sets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty.

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.



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

def set_translation_target(opts)
  opts = check_params(opts,[:targets])
  super(opts)
end

#set_vlan(opts) ⇒ Object

Sets the VLANSs on which access to this SNATs is disabled/enabled.

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.



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

def set_vlan(opts)
  opts = check_params(opts,[:vlans])
  super(opts)
end

#source_port_behaviorSourcePortBehavior

Gets the source port behavior for this SNATs.

Returns:

  • (SourcePortBehavior)

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.



119
120
121
# File 'lib/icontrol/local_lb/snat.rb', line 119

def source_port_behavior
  super
end

#statisticsSNATStatistics

Gets the statistics for a list of top-level SNATs.

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.



130
131
132
# File 'lib/icontrol/local_lb/snat.rb', line 130

def statistics
  super
end

#translation_targetTranslation

Gets the translation targets for this SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty.

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.



142
143
144
# File 'lib/icontrol/local_lb/snat.rb', line 142

def translation_target
  super
end

#versionString

Get the version information for this interface.

Returns:

  • (String)


150
151
152
# File 'lib/icontrol/local_lb/snat.rb', line 150

def version
  super
end

#vlanVLANFilterList

Gets the list of VLANs on which access to this SNATs is disabled/enabled.

Returns:

  • (VLANFilterList)

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.



161
162
163
# File 'lib/icontrol/local_lb/snat.rb', line 161

def vlan
  super
end