Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Networking::Routes

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Techpreview::Networking::Routes
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb

## Overview

``Com::Vmware::Appliance::Techpreview::Networking::Routes`` class provides methods Performs networking routes operations.

## Defined Under Namespace

Classes: Message, MessageStatus, Route, RouteReadOnly, TestStatus, TestStatusInfo

## Instance Method Summary (collapse)

- - (Void) add(route)

  Set static routing rules.

- - (Void) delete(route)

  Delete static routing rules.

- - (Routes) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Appliance::Techpreview::Networking::Routes::RouteReadOnly>) list

  Get main routing table.

- - (Void) set(routes)

  Set static routing rules.

- - (Com::Vmware::Appliance::Techpreview::Networking::Routes::TestStatusInfo) test(gateways)

  Test connection to a list of gateways.

## Constructor Details

### - (`Routes`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    1497
    1498
    1499
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1497

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Void`) add(route)

Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of | and prefix 0 (for IPv6) refers to the default gateway.

Parameters:

- route (`Com::Vmware::Appliance::Techpreview::Networking::Routes::Route`) —

  Static routing rule.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    1524
    1525
    1526
    1527
    1528
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1524

    def add(route)
        invoke_with_info(@@add_info, {
            'route' => route,
        })
    end

### - (`Void`) delete(route)

Delete static routing rules.

Parameters:

- route (`Com::Vmware::Appliance::Techpreview::Networking::Routes::Route`) —

  Static routing rule.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    1563
    1564
    1565
    1566
    1567
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1563

    def delete(route)
        invoke_with_info(@@delete_info, {
            'route' => route,
        })
    end

### - (`Array<Com::Vmware::Appliance::Techpreview::Networking::Routes::RouteReadOnly>`) list

Get main routing table. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of | and prefix 0 (for IPv6) refers to the default gateway.

Returns:

- (`Array<Com::Vmware::Appliance::Techpreview::Networking::Routes::RouteReadOnly>`) —

  Routing table.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    1551
    1552
    1553
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1551

    def list()
        invoke_with_info(@@list_info)
    end

### - (`Void`) set(routes)

Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of | and prefix 0 (for IPv6) refers to the default gateway.

Parameters:

- routes (`Array<Com::Vmware::Appliance::Techpreview::Networking::Routes::Route>`) —

  Static routing rules.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    1538
    1539
    1540
    1541
    1542
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1538

    def set(routes)
        invoke_with_info(@@set_info, {
            'routes' => routes,
        })
    end

### - (`Com::Vmware::Appliance::Techpreview::Networking::Routes::TestStatusInfo`) test(gateways)

Test connection to a list of gateways

Parameters:

- gateways (`Array<String>`) —

  list of gateways.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Networking::Routes::TestStatusInfo`) —

  connection status

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    1510
    1511
    1512
    1513
    1514
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1510

    def test(gateways)
        invoke_with_info(@@test_info, {
            'gateways' => gateways,
        })
    end