Get Multicast Routes

Get Multicast Routes.
This API is only available when using VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/multicast/routes

Request Headers:

n/a

Query Parameters:

ListByOptionalTransportNodeParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Transport node	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://policy-mgr/policy/api/v1/infra/tier-0s/tier0/locale-services/tier0localeservices/multicast/routes

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyMulticastRoutes+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
gateway_path	Policy path to Tier0 gateway Policy path to Tier0 gateway.	string	Required
mcast_routes_per_edge		array of MulticastRoutesPerEdge
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "gateway_path": "/infra/tier-0s/tier0", "mcast_routes_per_edge": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a9b95292-51f7-11ea-ae0d-005056a3c9f4", "mcast_routes": [] }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/b051d3f9-3ad8-4831-9d67-8ae1cd3f5a1e/edge-nodes/a96e2790-51f7-11ea-aedf-005056a370d4", "mcast_routes": [ { "source_address": "1.1.5.10", "group": "239.102.102.102", "input_interface": "downlink-279", "output_interface": "uplink-278", "ttl": 1, "uptime": "00:07:55" }, { "source_address": "1.1.5.10", "group": "239.102.102.102", "input_interface": "downlink-279", "output_interface": "pimreg", "ttl": 1, "uptime": "00:07:55" }, { "source_address": "*", "group": "239.101.101.101", "input_interface": "uplink-278", "output_interface": "downlink-279", "ttl": 1, "uptime": "11:55:29" }, { "source_address": "*", "group": "239.101.101.101", "input_interface": "uplink-278", "output_interface": "pimreg", "ttl": 1, "uptime": "11:55:29" } ] } ] }

Get Multicast Routes

Request:

ListByOptionalTransportNodeParameters (schema)

Example Request:

Successful Response:

PolicyMulticastRoutes (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: