Class: IControl::ASM::WebApplication

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

Overview

The WebApplication interface enables you to manipulate 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

#active_policyString

Get the active policy for this web applications.

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.


46
47
48
# File 'lib/icontrol/asm/web_application.rb', line 46

def active_policy
  super
end

#apply_learningApplyLearning

Get the “apply learning” for this web applications.

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.


57
58
59
# File 'lib/icontrol/asm/web_application.rb', line 57

def apply_learning
  super
end

#delete_all_disabled_webappsObject

Deletes all disabled web 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.


14
15
16
# File 'lib/icontrol/asm/web_application.rb', line 14

def delete_all_disabled_webapps
  super
end

#delete_all_non_active_policiesObject

Deletes all non-actice policies for web applications. The active policy will not be deleted.

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.


25
26
27
# File 'lib/icontrol/asm/web_application.rb', line 25

def delete_all_non_active_policies
  super
end

#delete_webappObject

Deletes this web applications. Only disabled web applications can be deleted.

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/asm/web_application.rb', line 35

def delete_webapp
  super
end

#enabled_stateboolean

Returns the enabled flag of specified web application.

Returns:

  • (boolean)

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.


68
69
70
# File 'lib/icontrol/asm/web_application.rb', line 68

def enabled_state
  super
end

#languageWebApplicationLanguage

Gets the language for this web applications.

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.


79
80
81
# File 'lib/icontrol/asm/web_application.rb', line 79

def language
  super
end

#listString

Gets a list of all web applications.

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.


90
91
92
# File 'lib/icontrol/asm/web_application.rb', line 90

def list
  super
end

#logging_profileString

Get the logging profile for this web applications.

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/asm/web_application.rb', line 101

def logging_profile
  super
end

#policy_listString[]

Returns a list of the policies associated with this web 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.


112
113
114
# File 'lib/icontrol/asm/web_application.rb', line 112

def policy_list
  super
end

#reconfigureObject

Reconfigures this web applications. This resets all of the web application properties.

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.


130
131
132
# File 'lib/icontrol/asm/web_application.rb', line 130

def reconfigure
  super
end

#set_active_policy(opts) ⇒ Object

Set the active policy for this web applications. This applies this policy to the enforcer.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :policy_names (String)

    The names of the policies to set active for the specified web 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.


143
144
145
146
# File 'lib/icontrol/asm/web_application.rb', line 143

def set_active_policy(opts)
  opts = check_params(opts,[:policy_names])
  super(opts)
end

#set_apply_learning(opts) ⇒ Object

Set the “apply learning” for this web applications.

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.


156
157
158
159
# File 'lib/icontrol/asm/web_application.rb', line 156

def set_apply_learning(opts)
  opts = check_params(opts,[:settings])
  super(opts)
end

#set_language(opts) ⇒ Object

Set the language for this web applications. Note that the language can only be set once for a web 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.


170
171
172
173
# File 'lib/icontrol/asm/web_application.rb', line 170

def set_language(opts)
  opts = check_params(opts,[:languages])
  super(opts)
end

#set_language_extended(opts) ⇒ Object

Confugures this web applications in one-step. For each web application: sets the language adds a policy created from this template sets the policy active removes the original default policy

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :languages (IControl::ASM::WebApplicationLanguage)

    The language of the web application.

  • :policy_names (String)

    The policy names.

  • :policy_template_names (IControl::ASM::PolicyTemplate)

    The policy template names.

  • :timeout (long)

    The timeout period in which the ASM web-applications should be created prior to set its language

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.


188
189
190
191
# File 'lib/icontrol/asm/web_application.rb', line 188

def set_language_extended(opts)
  opts = check_params(opts,[:languages,:policy_names,:policy_template_names,:timeout])
  super(opts)
end

#set_logging_profile(opts) ⇒ Object

Set the logging profile for this web applications.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :logprof_names (String)

    The names of the logging profiles for the specified web 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.


201
202
203
204
# File 'lib/icontrol/asm/web_application.rb', line 201

def set_logging_profile(opts)
  opts = check_params(opts,[:logprof_names])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

120
121
122
# File 'lib/icontrol/asm/web_application.rb', line 120

def version
  super
end