diff --git a/doc/supported_nbis.md b/doc/supported_nbis.md index ce4a11a215f08327243d377df8be4a8e0fcc50a9..4a79c258e3037f2356dd377d0e617cd9e23a3853 100644 --- a/doc/supported_nbis.md +++ b/doc/supported_nbis.md @@ -1,11 +1,11 @@ This section summarizes the NBI connectors supported by the TeraFlowSDN controller to interoperate with OSS/BSS/NFVO on top of it. - - [6.1. TFS API](#61-tfs-apie) - - [6.2. ETSI Bandwidth Management (BWM)](#62-etsi-bandwidth-management-bwm) - - [6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]](#63-ietf-l2vpn-service-delivery-l2sm-rfc8466) - - [6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]](#64-ietf-l3vpn-service-delivery-l3sm-rfc8299) - - [6.5. IETF Network Topology [RFC8345]](#65-ietf-network-topology-rfc8345) - - [6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]](#66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang) +- [6.1. TFS API](#61-tfs-apie) +- [6.2. ETSI Bandwidth Management (BWM)](#62-etsi-bandwidth-management-bwm) +- [6.3. IETF L2VPN Service Delivery (L2SM) [RFC8466]](#63-ietf-l2vpn-service-delivery-l2sm-rfc8466) +- [6.4. IETF L3VPN Service Delivery (L3SM) [RFC8299]](#64-ietf-l3vpn-service-delivery-l3sm-rfc8299) +- [6.5. IETF Network Topology [RFC8345]](#65-ietf-network-topology-rfc8345) +- [6.6. IETF Network Slice Service [draft-ietf-teas-ietf-network-slice-nbi-yang]](#66-ietf-network-slice-service-draft-ietf-teas-ietf-network-slice-nbi-yang) ## **6.1. TFS APIe** @@ -14,39 +14,48 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to <h3><u>Exposed endpoints:</h3></u> **Endpoint `/tfs-api/context_ids`** + - Method: `GET` - Used to list the context identifiers **Endpoint `/tfs-api/contexts`** + - Method: `GET` - Used to list the details of all contexts **Endpoint `/tfs-api/dummy_contexts`** + - Method: `GET` - Used to dump contexts (including related topologies, devices, links, services, slices, and connections) in a snapshot format that can be imported directly in TeraFlowSDN WebUI. - IMPORTANT: the resulting document is processed by WebUI in dummy mode, i.e., just to populate Context database, but not interacting with Device, Service, and Slice components. **Endpoint `/tfs-api/context/<path:context_uuid>`** + - Method: `GET` - Used to retrieve a specific context **Endpoint `/tfs-api/context/<path:context_uuid>/topology_ids`** + - Method: `GET` - Used to list the topology identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/topologies`** + - Method: `GET` - Used to list all the topology details in a context **Endpoint `/tfs-api/context/<path:context_uuid>/topology/<path:topology_uuid>`** + - Method: `GET` - Used to retrieve a specific topology in a context **Endpoint `/tfs-api/context/<path:context_uuid>/service_ids`** + - Method: `GET` - Used to list the service identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/services`** + - Method: `GET` - Used to list all the service details in a context @@ -60,66 +69,82 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to - Used to delete a service **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>`** + - Method: `GET` - Used to retrieve a specific service in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slice_ids`** + - Method: `GET` - Used to list the slice identifiers in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slices`** + - Method: `GET` - Used to list all the slice details in a context **Endpoint `/tfs-api/context/<path:context_uuid>/slice/<path:slice_uuid>`** + - Method: `GET` - Used to retrieve a specific slice in a context **Endpoint `/tfs-api/device_ids`** + - Method: `GET` - Used to list the device identifiers **Endpoint `/tfs-api/devices`** + - Method: `GET` - Used to list the device details **Endpoint `/tfs-api/device/<path:device_uuid>`** + - Method: `GET` - Used to retrieve a specific device **Endpoint `/tfs-api/link_ids`** + - Method: `GET` - Used to list the link identifiers **Endpoint `/tfs-api/links`** + - Method: `GET` - Used to list the link details **Endpoint `/tfs-api/link/<path:link_uuid>`** + - Method: `GET` - Used to retrieve a specific link **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connection_ids`** + - Method: `GET` - Used to list the connection identifiers related to a service **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connections`** + - Method: `GET` - Used to list all the connection details related to a service **Endpoint `/tfs-api/connection/<path:connection_uuid>`** + - Method: `GET` - Used to retrieve a specific connection **Endpoint `/tfs-api/policyrule_ids`** + - Method: `GET` - Used to list all the policy rule identifiers **Endpoint `/tfs-api/policyrules`** + - Method: `GET` - Used to list all the policy rule details **Endpoint `/tfs-api/policyrule/<path:policyrule_uuid>`** + - Method: `GET` - Used to retrieve a specific policy rule