Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 110 of 223
route.enumerate
Queries the device for its IP routes. You can filter the response by the type of route -
automatic or
configured - but the response includes both types by default. The response contains an array of IPv4
routes and an array of IPv6 routes.
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
filter (route)
string
Filters the returned routes by the route type. One of
configuredautomatic, or both. Defaults to both.
Returned data
Always returned
Parameter name
Type
Short description
ipv4Routes
array
An array of structs, each of which represents an IPv4 route.
destination
string
IP address of the route's destination.
prefixLength
integer
The prefix length of the destination IP range for this route
(the number of fixed bits in the address).
gateway
string
The IP address of the gateway (or next hop) of this route.
port (Ethernet)
string
Identifies the Ethernet port. May be A or B.
type (route)
string
The type of route. One of automatic,
configuredByGateway or configuredByPort.
active (route)
boolean
true if the route is currently active. false if the route is
inactive (e.g. a route pointing to Port B when port B is
disabled). Applies to configured routes only.
routeId
integer
A number that identifies a route. The device assigns a
number to each manually configured route.
ipv6Routes
array
An array of structs, each of which represents an IPv6 route
(the structs are the same as described above for the IPv4
routes array).
route.preferences.modify
Changes the routing preferences for IPv4 and IPv6 traffic to the specified ethernet interfaces.