Class: IControl::Networking::ProfileIPIP

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/networking/profile_ipip.rb,
lib/icontrol/networking.rb

Overview

The ProfileIPIP interface enables you to manipulate an IP-IP tunnel profile to configure the IP-within-IP tunneling protocol. The IP-within-IP protocol (RFC2003) specifies how to encapsulate an IP packet within another IP packet.

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

#createObject

Creates a set of IP-IP tunnel profile.

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.


16
17
18
# File 'lib/icontrol/networking/profile_ipip.rb', line 16

def create
  super
end

#default_profileString

Gets the existing IP-IP tunnel profile from which this set of IP-IP profile inherits its unspecified attribute values.

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.


48
49
50
# File 'lib/icontrol/networking/profile_ipip.rb', line 48

def default_profile
  super
end

#delete_all_profilesObject

Deletes all non-system IP-IP tunnel profile.

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
# File 'lib/icontrol/networking/profile_ipip.rb', line 26

def delete_all_profiles
  super
end

#delete_profileObject

Deletes a set of IP-IP tunnel profile.

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.


36
37
38
# File 'lib/icontrol/networking/profile_ipip.rb', line 36

def delete_profile
  super
end

#is_base_profileboolean

Determines whether a set of IP-IP tunnel profile are base/pre-configured (vs user-defined) profile.

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.


79
80
81
# File 'lib/icontrol/networking/profile_ipip.rb', line 79

def is_base_profile
  super
end

#listString

Gets the names for all IP-IP tunnel profile.

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.


59
60
61
# File 'lib/icontrol/networking/profile_ipip.rb', line 59

def list
  super
end

#set_default_profile(opts) ⇒ Object

Sets the existing IP-IP tunnel profile from which this set of IP-IP tunnel profile inherits their unspecified attribute values.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String)

    IP-IP tunnel profile from which each specified IP-IP tunnel profile inherits its unspecified attribute values (default: ipip)

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.


92
93
94
95
# File 'lib/icontrol/networking/profile_ipip.rb', line 92

def set_default_profile(opts)
  opts = check_params(opts,[:defaults])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

67
68
69
# File 'lib/icontrol/networking/profile_ipip.rb', line 67

def version
  super
end