Class: IControl::Management::View

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

Overview

The View interface contains all calls necessary to manipulate views

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_viewObject

Adds this Views to the server.

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/management/view.rb', line 14

def add_view
  super
end

#add_view_option(opts) ⇒ Object

Adds new options to the view.

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.



26
27
28
29
# File 'lib/icontrol/management/view.rb', line 26

def add_view_option(opts)
  opts = check_params(opts,[:view_infos])
  super(opts)
end

#delete_viewObject

Delete this view (and all their zones) from a server.

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.



37
38
39
# File 'lib/icontrol/management/view.rb', line 37

def delete_view
  super
end

#delete_view_option(opts) ⇒ Object

Deletes the options from the view.

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.



49
50
51
52
# File 'lib/icontrol/management/view.rb', line 49

def delete_view_option(opts)
  opts = check_params(opts,[:view_infos])
  super(opts)
end

#listViewInfo

Get a sequence of ViewInfo structs from the server

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.



61
62
63
# File 'lib/icontrol/management/view.rb', line 61

def list
  super
end

#move_viewObject

Moves this Views to the spot indicated in the named.conf

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.



93
94
95
# File 'lib/icontrol/management/view.rb', line 93

def move_view
  super
end

#set_view_option(opts) ⇒ Object

Sets (changes) the values of existing options of the view specified.

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.



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

def set_view_option(opts)
  opts = check_params(opts,[:view_infos])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


69
70
71
# File 'lib/icontrol/management/view.rb', line 69

def version
  super
end

#view(opts) ⇒ ViewInfo

Get the ViewInfo structs from the server for this view.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :view_names (String)

    The names of the views to retrieve.

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.



82
83
84
85
# File 'lib/icontrol/management/view.rb', line 82

def view(opts)
  opts = check_params(opts,[:view_names])
  super(opts)
end