VNF Manager¶
Overview¶
API to create sessions, configurations and running tasks of your VNFs
Version information¶
Version : v1
Contact information¶
Contact Email : sofiane.imadali@orange.com
License information¶
License : MIT
License URL : https://github.com/sofianinho/training/blob/master/LICENSE
Terms of service : http://swagger.io/terms/
URI scheme¶
Host : localhost:8000
BasePath : /api/v1
Schemes : HTTP
Tags¶
- Session : A set of VNFs and configs
- Configuration : Operations for configs in a session
- Instance : Operations for instances of VNFs in a session
- Status : An overview of the system status
Paths¶
Create a new session on your VNF manager¶
1 | POST /session/
|
Description¶
Session creation in your VNF manager
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Successfully created a new session | typesSession |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Session
Returns a session on your VNF manager¶
1 | GET /session/{session_id}
|
Description¶
Session search in your VNF manager
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id to search | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully found a session | typesSession |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Session
Delete a session¶
1 | DELETE /session/{session_id}
|
Description¶
Delete a session with configuration and instances
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id to delete | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully deleted a session | handlersapiReply |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Session
Create a new VNF configuration in your session¶
1 | POST /session/{session_id}/config
|
Description¶
Configuration creation in your session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id for this config | string | |
| Body | body required |
Configuration needs to be created in the session | handlersconfJson |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Successfully created a configuration | typesConfig |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Configuration
Returns a configuration from your VNF manager session¶
1 | GET /session/{session_id}/config/{config_id}
|
Description¶
Config search in your VNF manager session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | config_id required |
config id to search | string | |
| Path | session_id required |
session id to search | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully found a config | typesConfig |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Configuration
Delete a VNF configuration in your session¶
1 | DELETE /session/{session_id}/config/{config_id}
|
Description¶
Configuration delete in your session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | config_id required |
config id to delete | string | |
| Path | session_id required |
session id for this config | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Successfully deleted a configuration | handlersapiReply |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Configuration
Returns all configs in your VNF manager session¶
1 | GET /session/{session_id}/configs
|
Description¶
Configs listing in your VNF manager session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id to search | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully returned configs | < typesConfig > array |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Configuration
Create a new VNF instance in your session¶
1 | POST /session/{session_id}/instance
|
Description¶
Instance creation in your session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id for this instance | string | |
| Query | vnf_name optional |
the VNF name for this session | string | |
| Body | body required |
Instance to be created in the session | handlersinstanceJson |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Successfully created an instance | typesInstance |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Instance
Returns an instance from your VNF manager session¶
1 | GET /session/{session_id}/instance/{instance_id}
|
Description¶
Instance search in your VNF manager session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | instance_id required |
instance id to search | string | |
| Path | session_id required |
session id to search | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully found an instance | typesInstance |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Instance
Delete a VNF instance in your session¶
1 | DELETE /session/{session_id}/instance/{instance_id}
|
Description¶
Instance delete in your session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | instance_id required |
instance id to delete | string | |
| Path | session_id required |
session id for this config | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully deleted an instance | handlersapiReply |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Instance
Returns all instances in your VNF manager session¶
1 | GET /session/{session_id}/instances
|
Description¶
Instances listing in your VNF manager session
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | session_id required |
session id to search | string |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully returned instances | < typesInstance > array |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Instance
Returns all sessions on your VNF manager¶
1 | GET /sessions/
|
Description¶
Sessions listing in your VNF manager
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully returned sessions | < typesSession > array |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Session
Returns a status for the scheduler¶
1 | GET /status
|
Description¶
Scheduler status in your VNF manager
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successfully returned a system status | typesStatus |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- Status
Definitions¶
handlersapiReply¶
| Name | Description | Schema |
|---|---|---|
| hostname optional |
string | |
| session_id optional |
string | |
| status optional |
string |
handlersconfJson¶
| Name | Description | Schema |
|---|---|---|
| Params optional |
typesVNFParams | |
| alias optional |
string | |
| tags optional |
< string > array | |
| template_version optional |
string |
handlersinstanceJson¶
| Name | Description | Schema |
|---|---|---|
| Tags optional |
< string > array | |
| alias optional |
string | |
| config_id optional |
string |
timeTime¶
Type : object
typesConfig¶
| Name | Description | Schema |
|---|---|---|
| alias optional |
string | |
| created_at optional |
timeTime | |
| id optional |
string | |
| params optional |
typesVNFParams | |
| session_id optional |
string | |
| tags optional |
< string > array | |
| template_version optional |
string |
typesCpu¶
| Name | Description | Schema |
|---|---|---|
| idle_per optional |
number(double) | |
| sys_per optional |
number(double) | |
| user_per optional |
number(double) |
typesInstance¶
| Name | Description | Schema |
|---|---|---|
| Artefact optional |
string | |
| alias optional |
string | |
| configuration optional |
typesConfig | |
| created_at optional |
timeTime | |
| id optional |
string | |
| session_id optional |
string | |
| tags optional |
< string > array |
typesLoad¶
| Name | Description | Schema |
|---|---|---|
| load_avg_1 optional |
number(double) | |
| load_avg_15 optional |
number(double) | |
| load_avg_5 optional |
number(double) |
typesMMEConf¶
| Name | Description | Schema |
|---|---|---|
| ipv4 optional |
string | |
| ipv6 optional |
string | |
| preference optional |
string |
typesMem¶
| Name | Description | Schema |
|---|---|---|
| free optional |
string | |
| total optional |
string | |
| user optional |
string |
typesNet¶
| Name | Description | Schema |
|---|---|---|
| bytes_recv optional |
string | |
| bytes_sent optional |
string | |
| packets_recv optional |
string | |
| packets_sent optional |
string |
typesOAIEnb¶
| Name | Description | Schema |
|---|---|---|
| cell_type optional |
string | |
| enb_dl optional |
integer(int32) | |
| enb_id optional |
string | |
| enb_mcc optional |
integer(int32) | |
| enb_mnc optional |
integer(int32) | |
| enb_name optional |
string | |
| enb_tra optional |
integer(int32) | |
| enb_ul optional |
integer(int32) | |
| mme optional |
typesMMEConf | |
| nb_rx optional |
integer(int32) | |
| nb_tx optional |
integer(int32) |
typesSession¶
| Name | Description | Schema |
|---|---|---|
| created_at optional |
timeTime | |
| id optional |
string |
typesStatus¶
| Name | Description | Schema |
|---|---|---|
| cpu_stats optional |
typesCpu | |
| load_avg optional |
typesLoad | |
| memory optional |
typesMem | |
| network optional |
typesNet |
typesVNFParams¶
| Name | Description | Schema |
|---|---|---|
| enb optional |
typesOAIEnb |