Class: IControl::Networking::ProfileWCCPGRE

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

Overview

The ProfileWCCPGRE interface allows you to manipulate a WCCP-GRE tunnel profile to configure the General Routing Encapsulation (GRE - RFC2784) tunnel protocol in conjunction with the Web-Cache Communication Protocol (WCCP). See the Networking/ProfileGRE interface for additional information.

Defined Under Namespace

Classes: ProfileWCCPGREForwarding, ProfileWCCPGREForwardingSequence, WCCPGREForwarding, WCCPGREForwardingSequence

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


21
22
23
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 21

def create
  super
end

#default_profileString

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


53
54
55
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 53

def default_profile
  super
end

#delete_all_profilesObject

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


31
32
33
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 31

def delete_all_profiles
  super
end

#delete_profileObject

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


41
42
43
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 41

def delete_profile
  super
end

#egress_forwardingProfileWCCPGREForwarding

Gets the forwarding specification for packets leaving a WCCP-GRE tunnel for a set of WCCP-GRE tunnel profile.

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.


65
66
67
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 65

def egress_forwarding
  super
end

#include_checksum_stateProfileEnabledState

Gets whether the checksum should be included in the transmitted packets for a set of WCCP-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.


77
78
79
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 77

def include_checksum_state
  super
end

#is_base_profileboolean

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


131
132
133
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 131

def is_base_profile
  super
end

#listString

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


88
89
90
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 88

def list
  super
end

#set_default_profile(opts) ⇒ Object

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

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :defaults (String)

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

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/networking/profile_wccpgre.rb', line 144

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

#set_egress_forwarding(opts) ⇒ Object

Sets the forwarding specification for packets leaving a WCCP-GRE tunnel for a set of WCCP-GRE tunnel profile.

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.


158
159
160
161
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 158

def set_egress_forwarding(opts)
  opts = check_params(opts,[:modes])
  super(opts)
end

#set_include_checksum_state(opts) ⇒ Object

Sets whether the checksum should be included in the transmitted packets for a set of WCCP-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 WCCP-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.


172
173
174
175
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 172

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


186
187
188
189
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 186

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

#set_wccp_version(opts) ⇒ Object

Sets the WCCP version currently in use for a set of WCCP-GRE tunnel profile.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :versions (IControl::Common::ProfileULong)

    WCCP version currently in use for each specified WCCP-GRE tunnel profiles

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.


199
200
201
202
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 199

def set_wccp_version(opts)
  opts = check_params(opts,[:versions])
  super(opts)
end

#validate_checksum_stateProfileEnabledState

Gets whether the checksum should be validated on the received packets for a set of WCCP-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.


100
101
102
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 100

def validate_checksum_state
  super
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

108
109
110
# File 'lib/icontrol/networking/profile_wccpgre.rb', line 108

def version
  super
end

#wccp_versionProfileULong

Gets the WCCP version currently in use for a set of WCCP-GRE tunnel profile.

Returns:

  • (ProfileULong)

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/networking/profile_wccpgre.rb', line 119

def wccp_version
  super
end