Class: IControl::Management::ChangeControl

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

Overview

The ChangeControl interface is a private interface to support Change Control capabilities.

Defined Under Namespace

Classes: ClassInfo, ClassInfoSequence, ClassTransactionInfo, ClassTransactionInfoSequence, DeprecatedClassInfo, DeprecatedClassInfoSequence, Instance, InstanceFormatType, InstanceInfo, InstanceInfoSequence, InstanceInfoSequenceSequence, InstanceSequence, InstanceSequenceSequence, InstanceVariable, InstanceVariableSequence, InstanceVariableSequenceSequence, InstanceVariableType, ModuleInfo, ModuleInfoSequence

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

- (ClassInfo) class_info(opts)

Gets the sequence of class information for the classes of objects available on the system

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :filter (String)

    The filter to apply to the class names

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.



48
49
50
51
# File 'lib/icontrol/management/change_control.rb', line 48

def class_info(opts)
  check_params(opts,[:filter])
  super
end

- (Object) delete_instance

Delete object 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.



34
35
36
# File 'lib/icontrol/management/change_control.rb', line 34

def delete_instance
  super
end

- (DeprecatedClassInfo) deprecated_class_info(opts)

Gets the sequence of deprecated class information for the classes of objects that have been deprecated

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :filter (String)

    The filter to apply to the class names

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.



63
64
65
66
# File 'lib/icontrol/management/change_control.rb', line 63

def deprecated_class_info(opts)
  check_params(opts,[:filter])
  super
end

- (Instance) instance(opts)

Gets the information and contents of each instance requested

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



77
78
79
80
# File 'lib/icontrol/management/change_control.rb', line 77

def instance(opts)
  check_params(opts,[:instance_format])
  super
end

- (String[]) instance_dependency(opts)

Gets the sequence of dependencies for each instance

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :depth (long)

    Limits the depth of search. Zero indicates no limit.

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.



91
92
93
94
# File 'lib/icontrol/management/change_control.rb', line 91

def instance_dependency(opts)
  check_params(opts,[:depth])
  super
end

- (InstanceInfo[]) instance_info(opts)

Gets the sequence of information for each instance of each class

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



105
106
107
108
# File 'lib/icontrol/management/change_control.rb', line 105

def instance_info(opts)
  check_params(opts,[:classes])
  super
end

- (InstanceVariable[]) instance_variable(opts)

Gets the sequence of variable items for each instance

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



119
120
121
122
# File 'lib/icontrol/management/change_control.rb', line 119

def instance_variable(opts)
  check_params(opts,[:instance_variable])
  super
end

- (TimeStamp) last_load_time

Gets the last time that the configuration was loaded.

Returns:

  • (TimeStamp)

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.



131
132
133
# File 'lib/icontrol/management/change_control.rb', line 131

def last_load_time
  super
end

- (ModuleInfo) module_info(opts)

Gets the sequence of module information for the modules available on the system

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :filter (String)

    The filter to apply to the module names

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.



144
145
146
147
# File 'lib/icontrol/management/change_control.rb', line 144

def module_info(opts)
  check_params(opts,[:filter])
  super
end

- (Object) put_config(opts)

Put object configuration (formatted contents)

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.



166
167
168
169
# File 'lib/icontrol/management/change_control.rb', line 166

def put_config(opts)
  check_params(opts,[:instance_format,:data])
  super
end

- (Object) put_instance(opts)

Put object instance (native format)

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.



179
180
181
182
# File 'lib/icontrol/management/change_control.rb', line 179

def put_instance(opts)
  check_params(opts,[:instances])
  super
end

- (Object) verify_config(opts)

Verify object configuration (formatted contents) can be put/saved

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.



193
194
195
196
# File 'lib/icontrol/management/change_control.rb', line 193

def verify_config(opts)
  check_params(opts,[:instance_format,:data])
  super
end

- (Object) verify_instance(opts)

Verify that object instance (native format) can be put

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.



206
207
208
209
# File 'lib/icontrol/management/change_control.rb', line 206

def verify_instance(opts)
  check_params(opts,[:instances])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


153
154
155
# File 'lib/icontrol/management/change_control.rb', line 153

def version
  super
end