Class: IControl::Management::TMOSModule

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/tmos_module.rb,
lib/icontrol/management.rb

Overview

The Module interface enables you to manage the system’s TMOS modules (e.g. LTM, GTM, ASM). The methods and types here focus on the modules themselves; some of the specific questions you might ask about modules are broken out in other places, such as the Provision or LicenseAdministration interface.

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

#descriptive_name ⇒ String

Gets a list of descriptive names for the module given

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.



18
19
20
 
# File 'lib/icontrol/management/tmos_module.rb', line 18

def descriptive_name
  super
end

#known_module_list ⇒ TMOSModule

Gets a list of all known module Caution! The list returned gives all module known, even if they are not licensed or provisionable on this system. You could use this to get a general picture of what module are possible, but this list is not specific to the system you have. To determine the licensing status of the module on your system, see the LicenseAdministration interface. To determine which module are supported (i.e., provisionable) under your system or currently provisioned to run on your system, see the Provision interface.

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.



35
36
37
 
# File 'lib/icontrol/management/tmos_module.rb', line 35

def known_module_list
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


43
44
45
 
# File 'lib/icontrol/management/tmos_module.rb', line 43

def version
  super
end