Class: IControl::Networking::RouteDomain

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

Overview

The RouteDomain interface enables you to work with the definitions and attributes contained in a device’s route domains. Route domains allow you to specify overlapping IP addresses for different objects in the system. This allows a service provider, for example, to have two different pool members at 10.10.10.1 that represent completely different real servers. The addresses for the two pool members might be 10.10.10.1%1 and 10.10.10.1%2 where the numbers after the percent signs are numeric ids of route domains.

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_vlan(opts) ⇒ Object

Adds this VLANs to this route domain.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlans (String[]) —

    The lists of child VLANs .

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.



22
23
24
25
 
# File 'lib/icontrol/networking/route_domain.rb', line 22

def add_vlan(opts)
  opts = check_params(opts,[:vlans])
  super(opts)
end

#create(opts) ⇒ Object

Creates a route domain.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlans (String[]) —

    The lists of VLANs .

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.



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

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

#delete_all_route_domains ⇒ Object

Deletes all route domain.

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.



46
47
48
 
# File 'lib/icontrol/networking/route_domain.rb', line 46

def delete_all_route_domains
  super
end

#delete_route_domain ⇒ Object

Deletes this route domain.

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.



56
57
58
 
# File 'lib/icontrol/networking/route_domain.rb', line 56

def delete_route_domain
  super
end

#description ⇒ String

Gets the descriptions for the this route domain.

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.



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

def description
  super
end

#list ⇒ long

Gets a list of all route domain on this device.

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.



78
79
80
 
# File 'lib/icontrol/networking/route_domain.rb', line 78

def list
  super
end

#parent_id ⇒ long

Gets the parent ids for this route domain.

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.



89
90
91
 
# File 'lib/icontrol/networking/route_domain.rb', line 89

def parent_id
  super
end

#remove_all_vlans ⇒ Object

Removes all VLANs from this route domain.

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.



129
130
131
 
# File 'lib/icontrol/networking/route_domain.rb', line 129

def remove_all_vlans
  super
end

#remove_vlan(opts) ⇒ Object

Removes this VLANs from this route domain.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlans (String[]) —

    The lists of child VLANs .

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.



141
142
143
144
 
# File 'lib/icontrol/networking/route_domain.rb', line 141

def remove_vlan(opts)
  opts = check_params(opts,[:vlans])
  super(opts)
end

#set_description(opts) ⇒ Object

Sets the descriptions for the this route domain.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :descriptions (String) —

    The descriptions to set for the specified route domains.

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.



154
155
156
157
 
# File 'lib/icontrol/networking/route_domain.rb', line 154

def set_description(opts)
  opts = check_params(opts,[:descriptions])
  super(opts)
end

#set_parent_id(opts) ⇒ Object

Sets the parent ids for this route domain.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :parent_ids (long) —

    The route domain parent ids.

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.



167
168
169
170
 
# File 'lib/icontrol/networking/route_domain.rb', line 167

def set_parent_id(opts)
  opts = check_params(opts,[:parent_ids])
  super(opts)
end

#set_strict_state(opts) ⇒ Object

Sets the state to enforce cross-domain routing restrictions for a set of route domain. NOTES = If set, packets cannot cross route domain boundaries, i.e., they are strictly isolated to the current route domain. = For example, if not set, you can add a route to the routing table where the destination is 10.0.0.0%20 (route domain 20) and the gateway is 172.27.84.29%32 (route domain 32). = If set, the system may find invalid iRules that passed validation.

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.



185
186
187
188
 
# File 'lib/icontrol/networking/route_domain.rb', line 185

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

#strict_state ⇒ EnabledState

Gets the state to enforce cross-domain routing restrictions for a set of route domain.

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.



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

def strict_state
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


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

def version
  super
end

#vlan ⇒ String[]

Gets the lists of VLANs for this route domain.

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.



119
120
121
 
# File 'lib/icontrol/networking/route_domain.rb', line 119

def vlan
  super
end