Class: IControl::ASM::WebApplicationGroup

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/asm/web_application_group.rb,
lib/icontrol/asm.rb

Overview

The WebApplicationGroup interface enables you to manipulate a group of ASM Web 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

#add_webapp(opts) ⇒ Object

Adds web applications to this web application group.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :webapp_names (String[])

    The names of the web applications to add to the specified groups.

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.


16
17
18
19
# File 'lib/icontrol/asm/web_application_group.rb', line 16

def add_webapp(opts)
  opts = check_params(opts,[:webapp_names])
  super(opts)
end

#createObject

Creates a new web application group.

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.


27
28
29
# File 'lib/icontrol/asm/web_application_group.rb', line 27

def create
  super
end

#delete_all_groupsObject

Deletes all web application group.

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.


37
38
39
# File 'lib/icontrol/asm/web_application_group.rb', line 37

def delete_all_groups
  super
end

#delete_groupObject

Deletes this web application group.

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.


47
48
49
# File 'lib/icontrol/asm/web_application_group.rb', line 47

def delete_group
  super
end

#listWebApplicationGroupDefinition

Gets a list of all web application group.

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.


58
59
60
# File 'lib/icontrol/asm/web_application_group.rb', line 58

def list
  super
end

#remove_all_webappsObject

Removes all web applications from this web application group.

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.


87
88
89
# File 'lib/icontrol/asm/web_application_group.rb', line 87

def remove_all_webapps
  super
end

#remove_webapp(opts) ⇒ Object

Removes web applications from this web application group.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :webapp_names (String[])

    The names of the web applications to remove from the specified groups.

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.


99
100
101
102
# File 'lib/icontrol/asm/web_application_group.rb', line 99

def remove_webapp(opts)
  opts = check_params(opts,[:webapp_names])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

66
67
68
# File 'lib/icontrol/asm/web_application_group.rb', line 66

def version
  super
end

#webapp_listString[]

Returns a list of the web applications associated with this web application group.

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.


77
78
79
# File 'lib/icontrol/asm/web_application_group.rb', line 77

def webapp_list
  super
end