Class: IControl::ASM::ObjectParams

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

Overview

The ObjectParams interface enables you to manipulate Object Parameters

Defined Under Namespace

Classes: AttackSignatureDefinition, AttackSignatureDefinitionSequence, MetacharDefinition, MetacharDefinitionSequence, ObjectParamCategory, ObjectParamCategorySequence

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_or_update_object_param_with_characteristics(opts) ⇒ boolean

Adds (if doesn’t exists) or updates (if exists) URL parameter in a polic.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



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

def add_or_update_object_param_with_characteristics(opts)
  opts = check_params(opts,[:uri,:param_name,:setting_categories])
  super(opts)
end

#set_parameter_staging_flag(opts) ⇒ boolean

Set or unset staging for URL parameter in a polic.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :uri (String)
  • :param_name (String) —

    The name of the URL parameter.

  • :flg_is_staging (boolean) —

    Whether to move the parameter to staging, or pull it out from staging

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.



49
50
51
52
 
# File 'lib/icontrol/asm/object_params.rb', line 49

def set_parameter_staging_flag(opts)
  opts = check_params(opts,[:uri,:param_name,:flg_is_staging])
  super(opts)
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


34
35
36
 
# File 'lib/icontrol/asm/object_params.rb', line 34

def version
  super
end