Class: IControl::Networking::RouteTable

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

Overview

The RouteTable interface enables you to work with the Route table and entries.

Defined Under Namespace

Classes: DynamicRoute, DynamicRouteSequence, DynamicRouteStatistics, DynamicRouteStatisticsSequence, RouteAttribute, RouteAttributeSequence, RouteDefinition, RouteDefinitionSequence, RouteTableMetricEntry, RouteTableMetricEntrySequence, RouteTableMetricStatistics, RouteTableMetricStatisticsSequence

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

- (Object) add_management_route(opts)

Adds this management route entries to the route table.

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.



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

def add_management_route(opts)
  check_params(opts,[:attributes])
  super
end

- (Object) add_static_route(opts)

Adds this static route entries to the route table.

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.



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

def add_static_route(opts)
  check_params(opts,[:attributes])
  super
end

- (Object) delete_all_management_routes

Deletes all management route entries from the route table.

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.



51
52
53
# File 'lib/icontrol/networking/route_table.rb', line 51

def delete_all_management_routes
  super
end

- (Object) delete_all_static_routes

Deletes all static route entries from the route table.

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

def delete_all_static_routes
  super
end

- (Object) delete_management_route

Deletes this management route entries from the route table.

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.



71
72
73
# File 'lib/icontrol/networking/route_table.rb', line 71

def delete_management_route
  super
end

- (Object) delete_static_route

Deletes this static route entries from the route table.

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.



81
82
83
# File 'lib/icontrol/networking/route_table.rb', line 81

def delete_static_route
  super
end

- (DynamicRouteStatistics) dynamic_route(opts)

Gets the dynamic route for this destination IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :destinations (String)

    The destination IP addresses.

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.



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

def dynamic_route(opts)
  check_params(opts,[:destinations])
  super
end

- (RouteDefinition) management_route

Gets a list of all management route entries.

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.



106
107
108
# File 'lib/icontrol/networking/route_table.rb', line 106

def management_route
  super
end

- (String) management_route_gateway

Gets the gateways for this management route.

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.



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

def management_route_gateway
  super
end

- (long) management_route_mtu

Gets the MTUs for this management route.

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.



128
129
130
# File 'lib/icontrol/networking/route_table.rb', line 128

def management_route_mtu
  super
end

- (RouteEntryType) management_route_type

Gets the route type for this management route.

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.



139
140
141
# File 'lib/icontrol/networking/route_table.rb', line 139

def management_route_type
  super
end

- (Object) reset_all_route_table_metric_statistics

Resets or flushes all route metric statistics.

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.



252
253
254
# File 'lib/icontrol/networking/route_table.rb', line 252

def reset_all_route_table_metric_statistics
  super
end

- (RouteTableMetricStatistics) route_table_metric_statistics_for_destination(opts)

Gets the route metric statistics for this destination IP addresses.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :destinations (String)

    The destination IP addresses.

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.



152
153
154
155
# File 'lib/icontrol/networking/route_table.rb', line 152

def route_table_metric_statistics_for_destination(opts)
  check_params(opts,[:destinations])
  super
end

- (RouteTableMetricStatistics) route_table_metric_statistics_for_mac(opts)

Gets the route metric statistics for this MAC addresses of the gateways.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :mac_addresses (String)

    The MAC addresses.

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.



166
167
168
169
# File 'lib/icontrol/networking/route_table.rb', line 166

def route_table_metric_statistics_for_mac(opts)
  check_params(opts,[:mac_addresses])
  super
end

- (Object) set_management_route_gateway(opts)

Sets the gateways for this management route.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :gateways (String)

    The gateways for the specified management routes.

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.



264
265
266
267
# File 'lib/icontrol/networking/route_table.rb', line 264

def set_management_route_gateway(opts)
  check_params(opts,[:gateways])
  super
end

- (Object) set_management_route_mtu(opts)

Sets the MTUs for this management route.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :mtus (long)

    The MTUs for the specified management routes.

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.



277
278
279
280
# File 'lib/icontrol/networking/route_table.rb', line 277

def set_management_route_mtu(opts)
  check_params(opts,[:mtus])
  super
end

- (Object) set_management_route_reject

Sets the state that rejects all requests for this management route.

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.



288
289
290
# File 'lib/icontrol/networking/route_table.rb', line 288

def set_management_route_reject
  super
end

- (Object) set_static_route_gateway(opts)

Sets the gateways for this static route.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :gateways (String)

    The gateways for the specified static routes.

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.



300
301
302
303
# File 'lib/icontrol/networking/route_table.rb', line 300

def set_static_route_gateway(opts)
  check_params(opts,[:gateways])
  super
end

- (Object) set_static_route_mtu(opts)

Sets the MTUs for this static route.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :mtus (long)

    The MTUs to destinations.

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.



313
314
315
316
# File 'lib/icontrol/networking/route_table.rb', line 313

def set_static_route_mtu(opts)
  check_params(opts,[:mtus])
  super
end

- (Object) set_static_route_pool(opts)

Sets the pool names for this static route. The pool name allow the destination to select the nexthop router from a pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :pools (String)

    The pool names.

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.



327
328
329
330
# File 'lib/icontrol/networking/route_table.rb', line 327

def set_static_route_pool(opts)
  check_params(opts,[:pools])
  super
end

- (Object) set_static_route_reject

Sets the state that rejects all requests for this static route.

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.



338
339
340
# File 'lib/icontrol/networking/route_table.rb', line 338

def set_static_route_reject
  super
end

- (Object) set_static_route_vlan(opts)

Sets the VLAN names for this static route.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :vlans (String)

    The VLAN names.

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.



350
351
352
353
# File 'lib/icontrol/networking/route_table.rb', line 350

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

- (RouteDefinition) static_route

Gets a list of all static route entries.

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.



178
179
180
# File 'lib/icontrol/networking/route_table.rb', line 178

def static_route
  super
end

- (String) static_route_gateway

Gets the gateways for this static route.

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.



189
190
191
# File 'lib/icontrol/networking/route_table.rb', line 189

def static_route_gateway
  super
end

- (long) static_route_mtu

Gets the MTUs for this static route.

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.



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

def static_route_mtu
  super
end

- (String) static_route_pool

Gets the pool names for this static route. The pool name allow the destination to select the nexthop router from a pool.

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.



212
213
214
# File 'lib/icontrol/networking/route_table.rb', line 212

def static_route_pool
  super
end

- (RouteEntryType) static_route_type

Gets the route type for this static route.

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.



223
224
225
# File 'lib/icontrol/networking/route_table.rb', line 223

def static_route_type
  super
end

- (String) static_route_vlan

Gets the VLAN names for this static route.

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.



234
235
236
# File 'lib/icontrol/networking/route_table.rb', line 234

def static_route_vlan
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


242
243
244
# File 'lib/icontrol/networking/route_table.rb', line 242

def version
  super
end