Class: IControl::Networking::ProfileGRE

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

Overview

The ProfileGRE interface allows you to manipulate a GRE tunnel profile to configure the General Routing Encapsulation tunneling protocol. The General Routing Encapsulation supports RFC2784, allowing the packets of any L3 protocol to be carried inside encapsulating IP packets.

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 GRE 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.


17
18
19
# File 'lib/icontrol/networking/profile_gre.rb', line 17

def create
  super
end

#default_profileString

Gets the existing GRE tunnel profile from which this set of GRE 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.


49
50
51
# File 'lib/icontrol/networking/profile_gre.rb', line 49

def default_profile
  super
end

#delete_all_profilesObject

Deletes all non-system GRE 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.


27
28
29
# File 'lib/icontrol/networking/profile_gre.rb', line 27

def delete_all_profiles
  super
end

#delete_profileObject

Deletes a set of GRE 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.


37
38
39
# File 'lib/icontrol/networking/profile_gre.rb', line 37

def delete_profile
  super
end

#include_checksum_stateProfileEnabledState

Gets whether the checksum should be included in the transmitted packets for a set of GRE tunnel profile.

Returns:

  • (ProfileEnabledState)

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/networking/profile_gre.rb', line 61

def include_checksum_state
  super
end

#is_base_profileboolean

Determines whether a set of GRE 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.


104
105
106
# File 'lib/icontrol/networking/profile_gre.rb', line 104

def is_base_profile
  super
end

#listString

Gets the names for all GRE 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.


72
73
74
# File 'lib/icontrol/networking/profile_gre.rb', line 72

def list
  super
end

#set_default_profile(opts) ⇒ Object

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

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String)

    GRE tunnel profile from which each specified GRE tunnel profile inherits its unspecified attribute values (default: gre)

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.


117
118
119
120
# File 'lib/icontrol/networking/profile_gre.rb', line 117

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

#set_include_checksum_state(opts) ⇒ Object

Sets whether the checksum should be included in the transmitted packets for a set of GRE tunnel profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :states (IControl::Common::ProfileEnabledState)

    Enabled state for including the checksum in the transmitted packets for each specified GRE tunnel profile (default: disabled)

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
134
# File 'lib/icontrol/networking/profile_gre.rb', line 131

def set_include_checksum_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#set_validate_checksum_state(opts) ⇒ Object

Sets whether the checksum should be validated on the received packets for a set of GRE tunnel profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :states (IControl::Common::ProfileEnabledState)

    Enabled state for validating the checksum on the received packets for each specified GRE 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.


145
146
147
148
# File 'lib/icontrol/networking/profile_gre.rb', line 145

def set_validate_checksum_state(opts)
  opts = check_params(opts,[:states])
  super(opts)
end

#validate_checksum_stateProfileEnabledState

Gets whether the checksum should be validated on the received packets for a set of GRE tunnel profile.

Returns:

  • (ProfileEnabledState)

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.


84
85
86
# File 'lib/icontrol/networking/profile_gre.rb', line 84

def validate_checksum_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

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

def version
  super
end