Class: IControl::LocalLB::NAT

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

Overview

The NAT interface enables you to work with the statistics and definitions contained in a local load balancer's network address translations (NAT). For example, use the NAT interface to both get and set the NAT statistics and attributes of a local load balancer.

Defined Under Namespace

Classes: NATDefinition, NATDefinitionSequence, NATStatisticEntry, NATStatisticEntrySequence, NATStatistics

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

- (NATStatistics) all_statistics

Gets statistics for all NATs.

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.



56
57
58
# File 'lib/icontrol/local_lb/nat.rb', line 56

def all_statistics
  super
end

- (EnabledState) arp_state

Gets the ARP states for this NATs.

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.



67
68
69
# File 'lib/icontrol/local_lb/nat.rb', line 67

def arp_state
  super
end

- (Object) create(opts)

Creates this NATs.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :unit_ids (long)

    The controller for the NATs in an active-active, redundant load balancer configuration.

  • :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.



24
25
26
27
# File 'lib/icontrol/local_lb/nat.rb', line 24

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

- (Object) delete_all_nats

Deletes all NATs.

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.



35
36
37
# File 'lib/icontrol/local_lb/nat.rb', line 35

def delete_all_nats
  super
end

- (Object) delete_nat

Deletes this NATs.

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.



45
46
47
# File 'lib/icontrol/local_lb/nat.rb', line 45

def delete_nat
  super
end

- (EnabledState) enabled_state

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



78
79
80
# File 'lib/icontrol/local_lb/nat.rb', line 78

def enabled_state
  super
end

- (NATDefinition) list

Gets a sequence of all NAT definitions.

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.



89
90
91
# File 'lib/icontrol/local_lb/nat.rb', line 89

def list
  super
end

- (Object) reset_statistics

Resets statistics for a NAT.

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.



141
142
143
# File 'lib/icontrol/local_lb/nat.rb', line 141

def reset_statistics
  super
end

- (Object) set_arp_state(opts)

Sets the ARP states for this NATs.

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.



153
154
155
156
# File 'lib/icontrol/local_lb/nat.rb', line 153

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

- (Object) set_enabled_state(opts)

Sets the state for a list of NAT 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.



166
167
168
169
# File 'lib/icontrol/local_lb/nat.rb', line 166

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

- (Object) set_unit_id(opts)

Sets the Unit IDs for this NATs.

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.



179
180
181
182
# File 'lib/icontrol/local_lb/nat.rb', line 179

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

- (Object) set_vlan(opts)

Adds VLANSs to the list of VLANs on which access to this NATs is disabled.

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.



192
193
194
195
# File 'lib/icontrol/local_lb/nat.rb', line 192

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

- (NATStatistics) statistics

Gets statistics for a sequence of NATs.

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.



100
101
102
# File 'lib/icontrol/local_lb/nat.rb', line 100

def statistics
  super
end

- (long) unit_id

Gets the controller to which this NATs apply in an active-active, redundant load balancer configuration.

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.



112
113
114
# File 'lib/icontrol/local_lb/nat.rb', line 112

def unit_id
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


120
121
122
# File 'lib/icontrol/local_lb/nat.rb', line 120

def version
  super
end

- (VLANFilterList) vlan

Gets the lists of VLANs on which access to this NATs is disabled.

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.



131
132
133
# File 'lib/icontrol/local_lb/nat.rb', line 131

def vlan
  super
end