Class: IControl::Networking::ISessionAdvertisedRoute

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

Overview

The iSession AdvertisedRoute interface enables you to work with the definitions and attributes contained in a device’s optimized endpoint subnets.

Defined Under Namespace

Classes: ISessionAdvertisedRouteStruct, ISessionAdvertisedRouteStructSequence, SubnetOptKey, SubnetOptKeySequence, SubnetOptKeySequenceSequence

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

#create(opts) ⇒ Object

Creates a specified subnet object with all its attributes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :subnet (IControl::Networking::iSessionAdvertisedRoute::iSessionAdvertisedRouteStruct) —

    The subnet struct to create.

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
24
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 21

def create(opts)
  opts = check_params(opts,[:subnet])
  super(opts)
end

#delete_all_subnets ⇒ Object

Deletes all exisiting subnet objects.

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.



32
33
34
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 32

def delete_all_subnets
  super
end

#delete_subnets ⇒ Object

Deletes this subnet via its IP address and netmask.

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.



42
43
44
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 42

def delete_subnets
  super
end

#enabled_state ⇒ EnabledState

Gets the enabled flag on the target subnet.

Returns:

  • (EnabledState)

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/i_session_advertised_route.rb', line 53

def enabled_state
  super
end

#label ⇒ String

Gets the label string on the target subnet.

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.



64
65
66
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 64

def label
  super
end

#list ⇒ SubnetOptKey

Get a list of all subnet interfaces and their netmasks.

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.



75
76
77
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 75

def list
  super
end

#metric ⇒ long

Gets the metric with which this subnet IPs are associated.

Returns:

  • (long)

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.



86
87
88
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 86

def metric
  super
end

#set_enabled_state(opts) ⇒ Object

Sets/Resets the enabled flag on the target subnet.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ip (IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey) —

    The subnet IP.

  • :included (IControl::Common::EnabledState) —

    The new included setting.

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.



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

def set_enabled_state(opts)
  opts = check_params(opts,[:ip,:included])
  super(opts)
end

#set_label(opts) ⇒ Object

Sets/Resets the label string on the target subnet.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ip (IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey) —

    The subnet IP.

  • :labels (String) —

    The new subnet labels

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.



121
122
123
124
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 121

def set_label(opts)
  opts = check_params(opts,[:ip,:labels])
  super(opts)
end

#set_metric(opts) ⇒ Object

Sets the metric with which this subnet IPs are associated.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :subnet (IControl::Networking::iSessionAdvertisedRoute::SubnetOptKey) —

    The subnet IPs .

  • :metric (long) —

    value.

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.



135
136
137
138
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 135

def set_metric(opts)
  opts = check_params(opts,[:subnet,:metric])
  super(opts)
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


94
95
96
 
# File 'lib/icontrol/networking/i_session_advertised_route.rb', line 94

def version
  super
end