Class: IControl::LTConfig::Klass

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/lt_config/klass.rb,
lib/icontrol/lt_config.rb

Overview

The Class interface enables you to manage classes and class instances in the Loosely-Typed Configuration system.

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

#categoryString

Gets the category for this loosely-typed configuration classes.

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.


42
43
44
# File 'lib/icontrol/lt_config/klass.rb', line 42

def category
  super
end

#clustered_stateEnabledState

Gets the clustered state for this loosely-typed configuration classes.

Returns:

  • (EnabledState)

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.


53
54
55
# File 'lib/icontrol/lt_config/klass.rb', line 53

def clustered_state
  super
end

#configsyncd_stateEnabledState

Gets the configsyncd state for this loosely-typed configuration classes.

Returns:

  • (EnabledState)

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.


64
65
66
# File 'lib/icontrol/lt_config/klass.rb', line 64

def configsyncd_state
  super
end

#constraintsString[]

Gets the constraints for this loosely-typed configuration classes.

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.


75
76
77
# File 'lib/icontrol/lt_config/klass.rb', line 75

def constraints
  super
end

#create_instance(opts) ⇒ Object

Creates a loosely-typed configuration class instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_instance_keys (IControl::LTConfig::ClassInstanceKey)

    Class instance keys defining the keys for the new instances. Each of these specifies the name of the instance, the class name of the instance, and if appropriate, a container class for the instance.

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.


17
18
19
20
# File 'lib/icontrol/lt_config/klass.rb', line 17

def create_instance(opts)
  opts = check_params(opts,[:class_instance_keys])
  super(opts)
end

#delete_instance(opts) ⇒ Object

Deletes a loosely-typed configuration class instance.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :class_instance_keys (IControl::LTConfig::ClassInstanceKey)

    Class instance keys defining the keys for the instances to delete. Each of these specifies the name of the instance, the class name of the instance, and if appropriate, a container class for the instance.

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.


30
31
32
33
# File 'lib/icontrol/lt_config/klass.rb', line 30

def delete_instance(opts)
  opts = check_params(opts,[:class_instance_keys])
  super(opts)
end

#field_countlong

Gets the field count for this loosely-typed configuration classes.

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.


86
87
88
# File 'lib/icontrol/lt_config/klass.rb', line 86

def field_count
  super
end

#listString

Gets a list of loosely-typed configuration classes.

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.


97
98
99
# File 'lib/icontrol/lt_config/klass.rb', line 97

def list
  super
end

#list_of_instancesClassInstanceKey[]

Gets a list of loosely-typed configuration class instances.

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.


108
109
110
# File 'lib/icontrol/lt_config/klass.rb', line 108

def list_of_instances
  super
end

#nested_classesString[]

Gets the nested classes for this loosely-typed configuration classes.

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.


119
120
121
# File 'lib/icontrol/lt_config/klass.rb', line 119

def nested_classes
  super
end

#partitioned_stateEnabledState

Gets the partitioned state for this loosely-typed configuration classes.

Returns:

  • (EnabledState)

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/lt_config/klass.rb', line 130

def partitioned_state
  super
end

#singleton_stateEnabledState

Gets the singleton state for this loosely-typed configuration classes.

Returns:

  • (EnabledState)

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.


141
142
143
# File 'lib/icontrol/lt_config/klass.rb', line 141

def singleton_state
  super
end

#statisticsString[]

Gets the statistics for this loosely-typed configuration classes.

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.


152
153
154
# File 'lib/icontrol/lt_config/klass.rb', line 152

def statistics
  super
end

#toplevelcmd_stateEnabledState

Gets the toplevelcmd state for this loosely-typed configuration classes.

Returns:

  • (EnabledState)

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.


163
164
165
# File 'lib/icontrol/lt_config/klass.rb', line 163

def toplevelcmd_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

171
172
173
# File 'lib/icontrol/lt_config/klass.rb', line 171

def version
  super
end