Get Multicast Status (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/interfaces/:interface_id/multicaststatus

List all the multicast status information.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

ID of the site.

element_id stringrequired

ID of the element.

interface_id stringrequired

The multicast interface ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items MulticastStatusResponse[]
Array [
address stringrequired
The multicast status interface address.
element_id string
The element ID.
id string
The ID of the multicast config.
interface_id string
The interface ID on which multicast is configured.
name stringrequired
The name of the multicast status interface.
pim_neighbors MulticastNeighbor[]required
The PIM neighbor’s IP address.
Array [
address string
The address of the selected interface.
dr boolean
The neighbor is a designated router.
dr_prio string
The priority associated with the interface on the device for DR election.
expires string
The time remaining before a neighbor is timed out and the next PIM Hello message is received.
uptime string
The time for which the neighbor has been up.
]
site_id stringrequired
The site ID.
state stringrequired
The state of the selected interface—up or down.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "address": "string",
      "element_id": "string",
      "id": "string",
      "interface_id": "string",
      "name": "string",
      "pim_neighbors": [
        {
          "address": "string",
          "dr": true,
          "dr_prio": "string",
          "expires": "string",
          "uptime": "string"
        }
      ],
      "site_id": "string",
      "state": "string"
    }
  ]
}

Loading...