AMWA IS-06 NMOS Network Control API Specification: Endpoint
(c) AMWA 2017, CC Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
The endpoint, in this context, equals a single connection of the host devices to the network device. Therefore, if the host devices has multiple interfaces through which the flows are sent or received, then each of them will be classified as an “endpoint” as per this specification, IS-06. The broadcast controller can register as many “endpoints” as there are interfaces on the host devices that are connected to the network devices to send and receive flows.
The endpoint has to be registered with the Network Controller before it can send and/or receive any flows. The Broadcast Controller will provide a unique identifier in the PUT request to register the endpoint. The Broadcast Controller may create this identifier by itself or it may be generated elsewhere in the system such as the Register and Discovery Server (RDS: refer AMWA NMOS IS-04). This identifier uniquely identifies the endpoint within the network and is used on all subsequently endpoint related operations.
The required parameters for registering the endpoint are: • id: An unique identifier for this endpoint as explained above • chassis_id: The endpoint shall provide its MAC address or any information permitted by the IEEE Link Layer Discovery Protocol (LLDP) in for the Chassis ID parameter • port_id: The endpoint shall provide its MAC address as permitted by LLDP in this parameter • ip_address: The endpoint’s ip_ address that will be used to send and/or receive the flows. • Attached_network_device: the switch’s MAC address and its ethernet information which are provided by the switch in the LLDP’s mandatory Chassis ID and MAC ID parameters
The operations allowed on an endpoint is GET, PUT, PATCH and DELETE. GET is to retrieve an endpoint using the identifier. PUT is to create or register a new endpoint. PATCH is for modification of an endpoint. Only certain fields can be modified as explained in the API schema.