Class: IControl::GlobalLB::Application

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/application.rb,
lib/icontrol/global_lb.rb

Overview

The Application interface enables you to work with applications running within Wide IPs.

Defined Under Namespace

Classes: ApplicationContextObject, ApplicationContextObjectSequence, ApplicationObjectType, ApplicationObjectTypeSequence

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

- (ObjectStatus) application_context_status(opts)

Gets the statuses of this application context objects.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

  • (ObjectStatus)

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
81
# File 'lib/icontrol/global_lb/application.rb', line 78

def application_context_status(opts)
  check_params(opts,[:application_objects])
  super
end

- (AvailabilityDependency) availability_dependency

Gets the availability dependency for this application.

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.



90
91
92
# File 'lib/icontrol/global_lb/application.rb', line 90

def availability_dependency
  super
end

- (Object) create

Creates this application.

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/global_lb/application.rb', line 19

def create
  super
end

- (Object) delete_all_applications

Deletes all application.

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/global_lb/application.rb', line 29

def delete_all_applications
  super
end

- (Object) delete_application

Deletes this application.

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.



39
40
41
# File 'lib/icontrol/global_lb/application.rb', line 39

def delete_application
  super
end

- (Object) disable_application_context_object(opts)

Disables this objects within the application' context.

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.



51
52
53
54
# File 'lib/icontrol/global_lb/application.rb', line 51

def disable_application_context_object(opts)
  check_params(opts,[:application_objects])
  super
end

- (Object) enable_application_context_object(opts)

Enables this objects within the application' context.

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.



64
65
66
67
# File 'lib/icontrol/global_lb/application.rb', line 64

def enable_application_context_object(opts)
  check_params(opts,[:application_objects])
  super
end

- (String) list

Gets a list of application.

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.



101
102
103
# File 'lib/icontrol/global_lb/application.rb', line 101

def list
  super
end

- (ObjectStatus) object_status

Gets the statuses of this application.

Returns:

  • (ObjectStatus)

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/global_lb/application.rb', line 112

def object_status
  super
end

- (EnabledState) persistence_state

Gets the persistence states for this application.

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.



123
124
125
# File 'lib/icontrol/global_lb/application.rb', line 123

def persistence_state
  super
end

- (long) persistence_ttl

Gets the persistence TTL values of this application.

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.



134
135
136
# File 'lib/icontrol/global_lb/application.rb', line 134

def persistence_ttl
  super
end

- (Object) set_availability_dependency(opts)

Sets the availability dependency for this application.

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.



154
155
156
157
# File 'lib/icontrol/global_lb/application.rb', line 154

def set_availability_dependency(opts)
  check_params(opts,[:values])
  super
end

- (Object) set_persistence_state(opts)

Sets the persistence states for this application.

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.



167
168
169
170
# File 'lib/icontrol/global_lb/application.rb', line 167

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

- (Object) set_persistence_ttl(opts)

Sets the persistence TTL values of this application.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long)

    The persistence TTLs of the specified applications.

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.



180
181
182
183
# File 'lib/icontrol/global_lb/application.rb', line 180

def set_persistence_ttl(opts)
  check_params(opts,[:values])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


142
143
144
# File 'lib/icontrol/global_lb/application.rb', line 142

def version
  super
end