Retrieves information about the routing configured for the specified edge gateway.

Prerequisites
1

Log in to vCloud Air as an administrator. See Log in to vCloud Air for information.

2

Create a login session with vCloud Director. See Create a Session for a Virtual Data Center in a Service for information.

3

Using the vCloud API, query vCloud Director for the ID of the edge gateway you require routing configuration details about. See Querying the vCloud API for information.

Procedure
♦

To get the details for the routing configuration, issue the following request:

GET https://vchs.vmware.com/hybridity/api/gateways/gatewayId/routing/config

In the request header, include the OATH token and the Accept header that you obtained when creating a login session: 

Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "vcloud-auth-token"

If the request is successful, the server returns HTTP response code 200 and the details of the router configuration.

Example: Retrieve Routing Configurations

See the following examples for an edge gateway where OSPF routing is configured and an edge gateway where BGP dynamic routing is configured.

Request and Response to Get OSPF Configuration

Request Header – List the Routing Configuration: OSPF Configured 

GET https://vchs.vmware.com/hybridity/api/gateways/gw-5/routing/config
Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "d6eFLOqQYfuEn2MJTp7BQ2ISEO+ZYaEgTcqBy8wZQ6js="

Request body not required.

Response Body – List the Routing Configuration: OSPF Configured 

{
  "featureType" : "routing_4.0"
  "version" : 32,
  "enabled" : true,
  "routingGlobalConfig" : {
    "routerId" : 192.168.4.49,
    "ecmp" : false,
    "logging" : {
      "enable" : false,
      "logLevel" : "info"
    },
    "ipPrefixes" : [ {
      "name" : "a",
      "ipAddress" : "10.112.196.160/24",
  },
  "staticRouting" : {
    "defaultRoute" : {
      "vnic" : "0",
      "mtu" : 1500,
      "description" : "defaultRoute",
      "gatewayAddress" : "192.168.0.1"
    },
    "staticRoutes" : {
      "staticRoutes" : [ {
        "mtu" : 1500,
        "description" : "route1",
        "type" : "user",
        "vnic" : "0",
        "network" : "172.16.1.2/32",
        "nextHop" : "192.168.32.201"
        }
      } ]
  },
  "ospf" : {
    "enabled" : true,
    "protocolAddress" : null,
    "forwardingAddress" : null,
    "ospfAreas" : {
      "ospfAreas" : [ {
        "areaId" : 51,
        "type" : "nssa",
        "authentication" : {
          "type" : "none",
          "value" : null
        }
      }, 
    "ospfInterfaces" : {
      "ospfInterfaces" : [ 
          "vnic" : 0,
          "areaId" : 51,
          "helloInterval" : 10,
          "deadInterval" : 40,
          "priority" : 128,
          "cost" : 10,
          "mtuIgnore" : false,
        }
      } ]
    },
    "redistribution" : {
      "enabled" : true,
      "rules" : {
        "rules" : [ ]
      }
    },
    "gracefulRestart" : true,
    "defaultOriginate" : false
  },
  "bgp" : null
}

Request and Response to Get BGP Configuration

Request Header – List the Routing Configuration: BGP Configured 

GET https://vchs.vmware.com/hybridity/api/gateways/gw-5/routing/config
Accept: application/json
Content-Type: application/json
X-Vcloud-Authorization: "d6eFLOqQYfuEn2MJTp7BQ2ISEO+ZYaEgTcqBy8wZQ6js="

Request body not required.

Response Body – List the Routing Configuration: BGP Configured 

{
  "featureType" : "routing_4.0"
  "version" : 33,
  "enabled" : true,
  "routingGlobalConfig" : {
    "routerId" : 192.168.4.49,
    "ecmp" : false,
    "logging" : {
      "enable" : false,
      "logLevel" : "info"
    },
    "ipPrefixes" : [ {
      "name" : "a",
      "ipAddress" : "10.112.196.160/24",
  },
  "staticRouting" : {
    "defaultRoute" : {
      "vnic" : "0",
      "mtu" : 1500,
      "description" : "defaultRoute",
      "gatewayAddress" : "192.168.0.1"
    },
    "staticRoutes" : {
      "staticRoutes" : [ {
        "mtu" : 1500,
        "description" : "route1",
        "type" : "user",
        "vnic" : "0",
        "network" : "172.16.1.2/32",
        "nextHop" : "192.168.32.201"
        }
      } ]
  },
  "ospf" : null
  "bgp" : {
    "enabled" : true,
    "localAS" : 1001,
    "bgpNeighbours" : {
      "ipAddress" : "10.145.202.179",
      "protocolAddress" : null,
      "forwardingAddress" : null,
      "remoteAS" : 2001,
      "weight" : 60,
      "holdDownTimer" : 180,
      "keepAliveTimer" : 60,
      "password" : "********"
      "bgpFilters" : [ 
          "direction" : "in",
          "action" : "permit",
          "network" : "10.0.0.0/8",
          "ipPrefixGe" : 17,
          "ipPrefixLe" : 32,
        }
      } ]
    },
    "redistribution" : {
      "enabled" : false,
      "rules" : {
        "rules" : [ {
           "id" : 0,
           "from" : {
             "isis" : false,
             "ospf" : true,
             "bgp" : false,
             "fromStatic" : false,
             "connected" : true
           },
           "action" : "permit"
         } ]
    "gracefulRestart" : true,
    "defaultOriginate" : false
  },
}