Class: IControl::LocalLB::SNAT

Inherits:

Base

Object
Base
IControl::LocalLB::SNAT

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)

- (Object) add_original_address(opts)

Adds original client addresses to the filters used to match incoming traffic.
- (SNATStatistics) all_statistics

Gets the statistics for all top-level SNATs.
- (EnabledState) connection_mirror_state

Gets the connection mirror states for a specified SNATs.
- (Object) create(opts)

Creates this top-level SNAT objects.
- (Object) delete_all_snats

Deletes all SNATs.
- (Object) delete_snat

Deletes a specified list of SNATs.
- (String) list

Gets a list of all top-level SNAT configuration objects.
- (SNATOriginalAddress[]) original_address

Gets the list of original client addresses used to filter the traffic to the SNATs.
- (Object) remove_all_original_addresses

Removes all original client addresses in the filters.
- (Object) remove_original_address(opts)

Removes original client addresses from the filters used to match incoming traffic.
- (Object) reset_statistics

Resets the statistics for a list of top-level SNATs.
- (Object) set_connection_mirror_state(opts)

Sets the connection mirror state for this SNATs.
- (Object) set_source_port_behavior(opts)

Sets the source port behavior for this SNATs.
- (Object) set_translation_target(opts)

Sets the translation targets for this SNATs.
- (Object) set_vlan(opts)

Sets the VLANSs on which access to this SNATs is disabled/enabled.
- (SourcePortBehavior) source_port_behavior

Gets the source port behavior for this SNATs.
- (SNATStatistics) statistics

Gets the statistics for a list of top-level SNATs.
- (Translation) translation_target

Gets the translation targets for this SNATs.
- (String) version

Get the version information for this interface.
- (VLANFilterList) vlan

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

Dynamic Method Handling

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

Instance Method Details

- (`Object`) add_original_address(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:addresses (IControl::LocalLB::SNAT::SNATOriginalAddress[]) —

The list of original addresses to add to 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.

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

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

- (`SNATStatistics`) all_statistics

Gets the statistics for all top-level SNATs.

Returns:

(SNATStatistics)

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

- (`EnabledState`) connection_mirror_state

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

- (`Object`) create(opts)

Creates this top-level SNAT objects.

Parameters:

opts (Hash)

Options Hash (opts):

:original_addresses (IControl::LocalLB::SNAT::SNATOriginalAddress[]) —

The list of original client addresses used to filter traffic to the SNATs .
:vlans (IControl::Common::VLANFilterList) —

The list of VLANs used to filter the client connections on ingress VLAN.

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/snat.rb', line 43

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

- (`Object`) delete_all_snats

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

- (`Object`) delete_snat

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

- (`String`) list

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

- (`SNATOriginalAddress[]`) original_address

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

Returns:

(SNATOriginalAddress[])

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

- (`Object`) remove_all_original_addresses

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

- (`Object`) remove_original_address(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:addresses (IControl::LocalLB::SNAT::SNATOriginalAddress[]) —

The list of original addresses to remove from 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.

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

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

- (`Object`) reset_statistics

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

- (`Object`) set_connection_mirror_state(opts)

Sets the connection mirror state for this SNATs.

Parameters:

opts (Hash)

Options Hash (opts):

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

The connection mirror states 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.

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

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

- (`Object`) set_source_port_behavior(opts)

Sets the source port behavior for this SNATs.

Parameters:

opts (Hash)

Options Hash (opts):

:source_port_behaviors (IControl::Common::SourcePortBehavior) —

The source port behaviors 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.

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

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

- (`Object`) set_translation_target(opts)

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

:targets (IControl::LocalLB::SNAT::Translation) —

The translation targets 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.

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

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

- (`Object`) set_vlan(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:vlans (IControl::Common::VLANFilterList) —

The list of VLANs used to filter the ingress VLAN.

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/snat.rb', line 246

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

- (`SourcePortBehavior`) source_port_behavior

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

- (`SNATStatistics`) statistics

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

Returns:

(SNATStatistics)

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`) translation_target

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

Returns:

(Translation)

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

- (`String`) version

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

- (`VLANFilterList`) vlan

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

Class: IControl::LocalLB::SNAT

Overview

Defined Under Namespace

Instance Method Summary (collapse)

Dynamic Method Handling

Instance Method Details

- (Object) add_original_address(opts)

- (SNATStatistics) all_statistics

- (EnabledState) connection_mirror_state

- (Object) create(opts)

- (Object) delete_all_snats

- (Object) delete_snat

- (String) list

- (SNATOriginalAddress[]) original_address

- (Object) remove_all_original_addresses

- (Object) remove_original_address(opts)

- (Object) reset_statistics

- (Object) set_connection_mirror_state(opts)

- (Object) set_source_port_behavior(opts)

- (Object) set_translation_target(opts)

- (Object) set_vlan(opts)

- (SourcePortBehavior) source_port_behavior

- (SNATStatistics) statistics

- (Translation) translation_target

- (String) version

- (VLANFilterList) vlan

- (`Object`) add_original_address(opts)

- (`SNATStatistics`) all_statistics

- (`EnabledState`) connection_mirror_state

- (`Object`) create(opts)

- (`Object`) delete_all_snats

- (`Object`) delete_snat

- (`String`) list

- (`SNATOriginalAddress[]`) original_address

- (`Object`) remove_all_original_addresses

- (`Object`) remove_original_address(opts)

- (`Object`) reset_statistics

- (`Object`) set_connection_mirror_state(opts)

- (`Object`) set_source_port_behavior(opts)

- (`Object`) set_translation_target(opts)

- (`Object`) set_vlan(opts)

- (`SourcePortBehavior`) source_port_behavior

- (`SNATStatistics`) statistics

- (`Translation`) translation_target

- (`String`) version

- (`VLANFilterList`) vlan