Skip to content
Snippets Groups Projects
Commit 088e5dea authored by yangalicace1's avatar yangalicace1
Browse files

ADDS: adding supported nbis page

parent 7add4f9a
No related branches found
No related tags found
No related merge requests found
Pipeline #9355 passed
This section summarizes the NBI connectors supported by the TeraFlowSDN controller to interoperate with OSS/BSS/NFVO on top of it. 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.1. TFS API](#61-tfs-apie)
- [6.2. ETSI Bandwidth Management (BWM)](#62-etsi-bandwidth-management-bwm) - [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.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.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.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.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** ## **6.1. TFS APIe**
...@@ -14,39 +14,48 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to ...@@ -14,39 +14,48 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to
<h3><u>Exposed endpoints:</h3></u> <h3><u>Exposed endpoints:</h3></u>
**Endpoint `/tfs-api/context_ids`** **Endpoint `/tfs-api/context_ids`**
- Method: `GET` - Method: `GET`
- Used to list the context identifiers - Used to list the context identifiers
**Endpoint `/tfs-api/contexts`** **Endpoint `/tfs-api/contexts`**
- Method: `GET` - Method: `GET`
- Used to list the details of all contexts - Used to list the details of all contexts
**Endpoint `/tfs-api/dummy_contexts`** **Endpoint `/tfs-api/dummy_contexts`**
- Method: `GET` - 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. - 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. - 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>`** **Endpoint `/tfs-api/context/<path:context_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific context - Used to retrieve a specific context
**Endpoint `/tfs-api/context/<path:context_uuid>/topology_ids`** **Endpoint `/tfs-api/context/<path:context_uuid>/topology_ids`**
- Method: `GET` - Method: `GET`
- Used to list the topology identifiers in a context - Used to list the topology identifiers in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/topologies`** **Endpoint `/tfs-api/context/<path:context_uuid>/topologies`**
- Method: `GET` - Method: `GET`
- Used to list all the topology details in a context - Used to list all the topology details in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/topology/<path:topology_uuid>`** **Endpoint `/tfs-api/context/<path:context_uuid>/topology/<path:topology_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific topology in a context - Used to retrieve a specific topology in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/service_ids`** **Endpoint `/tfs-api/context/<path:context_uuid>/service_ids`**
- Method: `GET` - Method: `GET`
- Used to list the service identifiers in a context - Used to list the service identifiers in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/services`** **Endpoint `/tfs-api/context/<path:context_uuid>/services`**
- Method: `GET` - Method: `GET`
- Used to list all the service details in a context - 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 ...@@ -60,66 +69,82 @@ This NBI connector exposes the basic gRPC methods of TeraFlowSDN that enable to
- Used to delete a service - Used to delete a service
**Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>`** **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific service in a context - Used to retrieve a specific service in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/slice_ids`** **Endpoint `/tfs-api/context/<path:context_uuid>/slice_ids`**
- Method: `GET` - Method: `GET`
- Used to list the slice identifiers in a context - Used to list the slice identifiers in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/slices`** **Endpoint `/tfs-api/context/<path:context_uuid>/slices`**
- Method: `GET` - Method: `GET`
- Used to list all the slice details in a context - Used to list all the slice details in a context
**Endpoint `/tfs-api/context/<path:context_uuid>/slice/<path:slice_uuid>`** **Endpoint `/tfs-api/context/<path:context_uuid>/slice/<path:slice_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific slice in a context - Used to retrieve a specific slice in a context
**Endpoint `/tfs-api/device_ids`** **Endpoint `/tfs-api/device_ids`**
- Method: `GET` - Method: `GET`
- Used to list the device identifiers - Used to list the device identifiers
**Endpoint `/tfs-api/devices`** **Endpoint `/tfs-api/devices`**
- Method: `GET` - Method: `GET`
- Used to list the device details - Used to list the device details
**Endpoint `/tfs-api/device/<path:device_uuid>`** **Endpoint `/tfs-api/device/<path:device_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific device - Used to retrieve a specific device
**Endpoint `/tfs-api/link_ids`** **Endpoint `/tfs-api/link_ids`**
- Method: `GET` - Method: `GET`
- Used to list the link identifiers - Used to list the link identifiers
**Endpoint `/tfs-api/links`** **Endpoint `/tfs-api/links`**
- Method: `GET` - Method: `GET`
- Used to list the link details - Used to list the link details
**Endpoint `/tfs-api/link/<path:link_uuid>`** **Endpoint `/tfs-api/link/<path:link_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific link - Used to retrieve a specific link
**Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connection_ids`** **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connection_ids`**
- Method: `GET` - Method: `GET`
- Used to list the connection identifiers related to a service - Used to list the connection identifiers related to a service
**Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connections`** **Endpoint `/tfs-api/context/<path:context_uuid>/service/<path:service_uuid>/connections`**
- Method: `GET` - Method: `GET`
- Used to list all the connection details related to a service - Used to list all the connection details related to a service
**Endpoint `/tfs-api/connection/<path:connection_uuid>`** **Endpoint `/tfs-api/connection/<path:connection_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific connection - Used to retrieve a specific connection
**Endpoint `/tfs-api/policyrule_ids`** **Endpoint `/tfs-api/policyrule_ids`**
- Method: `GET` - Method: `GET`
- Used to list all the policy rule identifiers - Used to list all the policy rule identifiers
**Endpoint `/tfs-api/policyrules`** **Endpoint `/tfs-api/policyrules`**
- Method: `GET` - Method: `GET`
- Used to list all the policy rule details - Used to list all the policy rule details
**Endpoint `/tfs-api/policyrule/<path:policyrule_uuid>`** **Endpoint `/tfs-api/policyrule/<path:policyrule_uuid>`**
- Method: `GET` - Method: `GET`
- Used to retrieve a specific policy rule - Used to retrieve a specific policy rule
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment