Class: IControl::WebAccelerator::Applications

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/web_accelerator/applications.rb,
lib/icontrol/web_accelerator.rb

Overview

Allows manipulation of Applications.

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

- (long) create(opts)

Create a new Application. The strings that describe requested hosts should be one-line and are of the form: requested_host(domain=>www.example.com, destination_pool=>INTERNAL) or requested_host(domain=>www.example.com, destination_pool=>INTERNAL, http_subdomain_count=>5, https_subdomain_count=>5, subdomain_prefix=>wa)

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :description (String) —

    The description of the new application.

  • :local_policy (String) —

    The name of the local policy to use.

  • :remote_policy (String) —

    The name of the remote policy to use; optional, may be blank.

  • :requested_hosts (String) —

    A list of strings describing the one or more requested hosts to use with this application. The format of the strings is given above.

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.



23
24
25
26
 
# File 'lib/icontrol/web_accelerator/applications.rb', line 23

def create(opts)
  check_params(opts,[:description,:local_policy,:remote_policy,:requested_hosts])
  super
end

- (Object) delete_application(opts)

Delete a list of namd Applications.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :applications (String) —

    A list of application names.

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.



36
37
38
39
 
# File 'lib/icontrol/web_accelerator/applications.rb', line 36

def delete_application(opts)
  check_params(opts,[:applications])
  super
end

- (String) list

Get a list of Applications present on this WebAccelerator.

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.



48
49
50
 
# File 'lib/icontrol/web_accelerator/applications.rb', line 48

def list
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


56
57
58
 
# File 'lib/icontrol/web_accelerator/applications.rb', line 56

def version
  super
end