Class: IControl::System::Connections

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/system/connections.rb,
lib/icontrol/system.rb

Overview

The Connections interface enables you to get information about a device's connections. For example, use Connection interface to get a list of all active connections or to get a list of all active connections for a specific client.

Defined Under Namespace

Classes: ActiveConnection, ActiveConnectionSequence, ConnectionID, ConnectionIDSequence

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

- (ActiveConnection) active_connection

Gets the active connection in details for this connection.

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.



40
41
42
 
# File 'lib/icontrol/system/connections.rb', line 40

def active_connection
  super
end

- (ActiveConnection) all_active_connections

Gets all active connection in details on the local load balancer.

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.



51
52
53
 
# File 'lib/icontrol/system/connections.rb', line 51

def all_active_connections
  super
end

- (Object) delete_active_connection

Deletes this connection from the connection table.

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.



19
20
21
 
# File 'lib/icontrol/system/connections.rb', line 19

def delete_active_connection
  super
end

- (Object) delete_all_active_connections

Deletes all active connection from the connection table.

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
 
# File 'lib/icontrol/system/connections.rb', line 29

def delete_all_active_connections
  super
end

- (ConnectionID) list

Gets the list of active connection.

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.



62
63
64
 
# File 'lib/icontrol/system/connections.rb', line 62

def list
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


70
71
72
 
# File 'lib/icontrol/system/connections.rb', line 70

def version
  super
end