RO Northbound Interface - Revision history

Berpec at 16:33, 30 January 2017

2017-01-30T16:33:34Z

← Older revision		Revision as of 16:33, 30 January 2017
Line 600:		Line 600:
	'''Params''':		'''Params''':

	* Deploy an scenario: deploy all VNFs of the scenario. Creates a new instance scenario		* Deploy a scenario: deploy all VNFs of the scenario. Creates a new instance scenario
	* '''instance_name''' (required): name of the scenario to deploy		* '''instance_name''' (required): name of the scenario to deploy
	* '''description''' (optional): a description		* '''description''' (optional): a description
Line 615:		Line 615:
	}		}

	* Start an scenario: Equivalent to deploy		* Start a scenario: Equivalent to deploy

	* '''instance_name''' (required): name of the scenario to start		* '''instance_name''' (required): name of the scenario to start
Line 631:		Line 631:
	}		}

	* Reserve an scenario: Launch a new instance of the scenario without starting virtual machines.		* Reserve a scenario: Launch a new instance of the scenario without starting virtual machines.

	* '''instance_name''' (required): name of the scenario to launch		* '''instance_name''' (required): name of the scenario to launch
Line 647:		Line 647:
	}		}

	* Verify an scenario: deploy and destroy an scenario to check that there is room for it.		* Verify a scenario: deploy and destroy a scenario to check that there is room for it.

	* '''instance_name''' (required): name of the scenario to verify		* '''instance_name''' (required): name of the scenario to verify

Tierno: /* POST /openmano/{tenant\_id}/instances/{instance_id}/action */

2016-08-22T11:07:37Z

POST /openmano/{tenant\_id}/instances/{instance_id}/action

Tierno: /* Instances */

2016-08-19T14:50:28Z

Instances

@@ Line 877: / Line 877: @@
        "name": "Instance x"
+     }
 ====DELETE /openmano/{tenant_id}/instances/{instance_id}====
@@ Line 883: / Line 958: @@
 '''Params''': none
-'''Response''' Content-type: application/json
+'''Response''': Content-type: application/json
+     {
@@ Line 909: / Line 984: @@
          "vms": [ "369b02a2-6604-11e6-950f-0800273e724c" ]
- * console type can be "novnc", "xvpvnc", "rdp-html5", "spice-html5"
+* console type can be "novnc", "xvpvnc", "rdp-html5", "spice-html5"
-Openmano response: Content-type: application/yaml
+'''Response''': Content-type: application/yaml
-The response is a dictionary where the key is the affected VM uuid, and teh values are the http code returned by the VIM, the VM name, and the result of the description.
+The response is a dictionary where the key is the affected VM uuid, and the values are the http code returned by the VIM, the VM name, and the result of the description.
 Example for a "rebuild" action response with error:

Tierno: /* POST /openmano/{tenant\_id}/instances/{instance_id}/action */

2016-08-19T14:41:39Z

POST /openmano/{tenant\_id}/instances/{instance_id}/action

← Older revision		Revision as of 14:41, 19 August 2016
Line 890:		Line 890:

	====POST /openmano/{tenant\_id}/instances/{instance_id}/action====		====POST /openmano/{tenant\_id}/instances/{instance_id}/action====
	take an action over a scenario instance		take an action over a scenario instance. Actions can be {start,pause,resume,shutoff,shutdown,forceOff,rebuild,reboot,console}

	'''Params''': Content-type: application/~~json~~		'''Params''': Content-type: application/yaml

			Must contain ONLY ONE action (from the bellow list), and optionally a VNF list and/or a VM list. If a VNF list is provided the action is applied only to all VMs of this VNF. If a VM list is provided the actions is applied also to these VMs. If neither VNF, nor VM list are provided the action is applied to all the VMs of the instance scenario. These lists conatin the identifier obtained in creating the scenario response(and also GET instance scenario details); concretely the at the "vnfs":"uuid" field for the VNFs, and at"vnfs":"vms":"uuid" field for the VMs.

			---
			"start": null #To start an instance
			"pause": null #To pause an instance
			"resume": null #To resume an instance
			"shutoff": null #To shutoff an instance
			"shutdown": null #To shutdown an instance
			"forceOff": null #To forceOff an instance
			"rebuild": null #To rebuild an instance
			"reboot": {"type": "SOFT"} #To reboot an instance
			"console": "novnc" # To obtain a console
			"vnfs": [ "06ea139a-a23c-11e5-bc4f-5254004aea96" ],
			"vms": [ "369b02a2-6604-11e6-950f-0800273e724c" ]

	~~No extra parameters are allowed. For reboot~~, ~~the~~ "~~type~~" ~~is ignored~~		* console type can be "novnc", "xvpvnc", "rdp-html5", "spice-html5"

	~~To start an instance~~:		Openmano response: Content-type: application/yaml

	{		The response is a dictionary where the key is the affected VM uuid, and teh values are the http code returned by the VIM, the VM name, and the result of the description.
	~~"start": null~~
	}

	~~To pause an instance~~:		Example for a "rebuild" action response with error:

	{		---
	"~~pause~~": ~~null~~		"369b02a2-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'
	}		"vim_result": 503
			"name": "linux-VM" #same as 'vnfs':'vms':'name'
			"description": "Conflict: Instance 0a29c298-21d0-4dac-9eda-95a3953ae211 is in an invalid state for 'rebuild' (HTTP 409) (Request-ID: req-2a8096d1-1270-402d-bb3f-0b4d6789b233)"

	~~To resume an instance~~:		Example for a "console" action response with success:

	{		---
	~~"resume": null~~		"3cf35eba-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'
	}		"vim_result": 200
			"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=548f5442-32ce-4ffa-b95c-f1d483520cc9"
	~~To shutoff an instance:~~		"name": "VNF_2VMs-VM2" #same as 'vnfs':'vms':'name'
			"3cf40ee6-6604-11e6-950f-0800273e724c":
	{		"vim_result": 200
	~~"shutoff": null~~		"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=67451dd3-c039-44f6-9860-1a69aad5338c"
	}

	~~To shutdown an instance:~~

	{
	~~"shutdown": null~~
	}

	~~To forceOff an instance:~~

	{
	~~"forceOff": null~~
	}

	~~To rebuild an instance:~~

	{
	~~"rebuild": null~~
	}

	~~To reboot an instance:~~

	{
	~~"reboot": {~~
	~~"type": "SOFT"~~
	}

	~~To obtain a console:~~
	{
	~~"console": "novnc"~~
	}

	~~Openmano response: Content~~-~~type: application/json~~

	{
	"3cf35eba-6604-11e6-950f-0800273e724c": {
	"vim_result": 200,
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=548f5442-32ce-4ffa-b95c-f1d483520cc9",
	"name": "VNF_2VMs-VM2"
	},
	"3cf40ee6-6604-11e6-950f-0800273e724c": {
	"vim_result": 200,
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=67451dd3-c039-44f6-9860-1a69aad5338c",
	"name": "VNF_2VMs-VM1"		"name": "VNF_2VMs-VM1"
	},		"3cf26f78-6604-11e6-950f-0800273e724c":
	"3cf26f78-6604-11e6-950f-0800273e724c": {		"vim_result": 200
	"vim_result": 200,		"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=31f392f0-fee8-4d91-80a0-437b1149cbf8"
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=31f392f0-fee8-4d91-80a0-437b1149cbf8",
	"name": "dataplaneVNF3-VM"		"name": "dataplaneVNF3-VM"
	}
	}


	==Miscellaneous ==		==Miscellaneous ==

Tierno: /* GET /openmano/{tenant_id}/instances/{instance_id} */

2016-08-19T14:10:51Z

GET /openmano/{tenant_id}/instances/{instance_id}

← Older revision		Revision as of 14:10, 19 August 2016
Line 855:		Line 855:
	"error_msg": "ClientException: Not enough parameters to connect to openstack",		"error_msg": "ClientException: Not enough parameters to connect to openstack",
	"vim_info": "<VIM information text formatted>"		"vim_info": "<VIM information text formatted>"

	}		}
	]		]

Tierno: /* GET /openmano/{tenant_id}/instances/{instance_id} */

2016-08-19T14:10:25Z

GET /openmano/{tenant_id}/instances/{instance_id}

← Older revision		Revision as of 14:10, 19 August 2016
Line 821:		Line 821:

	'''Response''': Content-type: application/json		'''Response''': Content-type: application/json


	{		{
	"uuid": "06e9f0ea-a23c-11e5-bc4f-5254004aea96",		"uuid": "06e9f0ea-a23c-11e5-bc4f-5254004aea96",
	"description": "Instance x description",		"description": "Instance x description",
			"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
			"datacenter_tenant_id": "2e06029a-6604-11e6-950f-0800273e724c",
	"scenario_id": "cd4cf84e-5b7a-11e5-a873-5254004aea96",		"scenario_id": "cd4cf84e-5b7a-11e5-a873-5254004aea96",
	"datacenter_id": "487c6844-40df-11e5-aaa7-5254004aea96",		"datacenter_id": "487c6844-40df-11e5-aaa7-5254004aea96",
Line 833:		Line 834:
	"vnf_id": "bbf04ac4-5b7a-11e5-a873-5254004aea96",		"vnf_id": "bbf04ac4-5b7a-11e5-a873-5254004aea96",
	"uuid": "06ea139a-a23c-11e5-bc4f-5254004aea96",		"uuid": "06ea139a-a23c-11e5-bc4f-5254004aea96",
			"sce_vnf_id": "34753eca-6604-11e6-950f-0800273e724c",
	"vms": [		"vms": [
	{		{
	"status": "~~INACTIVE~~",		"status": "VIM_ERROR",
	"uuid": "06ea4aae-a23c-11e5-bc4f-5254004aea96",		"uuid": "06ea4aae-a23c-11e5-bc4f-5254004aea96",
	"vim_vm_id": "06e7ca2c-a23c-11e5-92d5-5254004aea96",		"vim_vm_id": "06e7ca2c-a23c-11e5-92d5-5254004aea96",
	"created_at": "2015-12-14T09:24:00",		"created_at": "2015-12-14T09:24:00",
	"interfaces": [],		"interfaces": [
	"name": "VMF1"		{
			"external_name": "eth0",
			"instance_net_id": "369ad048-6604-11e6-950f-0800273e724c",
			"vim_interface_id": "b00549c8-e22f-4e07-bc00-ea8f65eaed9c",
			"internal_name": "eth0",
			"mac_address": "fa:16:3e:71:2f:af",
			"vim_info": "<VIM information text formatted>",
			"ip_address": "192.168.111.3"
			}
			],
			"name": "VMF1",
			"error_msg": "ClientException: Not enough parameters to connect to openstack",
			"vim_info": "<VIM information text formatted>"

	}		}
	]		]
Line 846:		Line 861:
	],		],
	"scenario_name": "Scenario x",		"scenario_name": "Scenario x",
	"~~nfvo_tenant_id~~": "~~76094a2a~~-~~3c16~~-~~11e5~~-~~9fb6~~-~~5254004aea96~~",		"nets": [
	"~~nets~~": [],		{
			"status": "VIM_ERROR",
			"datacenter_id": "2dd83432-6604-11e6-950f-0800273e724c",
			"sce_net_id": "3475351a-6604-11e6-950f-0800273e724c",
			"uuid": "369ad048-6604-11e6-950f-0800273e724c",
			"datacenter_tenant_id": "2e06029a-6604-11e6-950f-0800273e724c",
			"vnf_net_id": null,
			"external": false,
			"vim_net_id": "0e22e974-650f-4d09-a4ed-0473277acd85",
			"vim_info": "<VIM information text formatted>",
			"error_msg": "ClientException: Not enough parameters to connect to openstack"
			}
			],
	"created_at": "2015-12-14T09:24:00",		"created_at": "2015-12-14T09:24:00",
	"name": "Instance x"		"name": "Instance x"
	}		}



	====DELETE /openmano/{tenant_id}/instances/{instance_id}====		====DELETE /openmano/{tenant_id}/instances/{instance_id}====

Tierno: /* GET /openmano/{tenant_id}/instances */

2016-08-19T13:48:35Z

GET /openmano/{tenant_id}/instances

← Older revision		Revision as of 13:48, 19 August 2016
Line 797:		Line 797:
	"instances": [		"instances": [
	{		{
	"created_at": "~~2015~~-12-~~14T09~~:24:00",		"description": null,
	"scenario_id": "~~cd4cf84e~~-~~5b7a~~-~~11e5~~-~~a873~~-~~5254004aea96~~",		"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
	"~~description~~": "~~Instance description~~",		"created_at": "2016-08-19T13:58:16",
	"uuid": "~~06e9f0ea~~-~~a23c~~-~~11e5~~-~~bc4f~~-~~5254004aea96",~~		"scenario_id": "34752430-6604-11e6-950f-0800273e724c",
	~~"name": "Instance 1~~"		"name": "simple-instance",
			"uuid": "369ac0d0-6604-11e6-950f-0800273e724c"
	},		},
	{		{
	"created_at": "~~2015~~-12-~~01T12~~:20:08",		"description": null,
	"scenario_id": "~~fbcab89a~~-~~5dd8~~-~~11e5~~-~~8018~~-~~5254004aea96~~",		"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
	"~~description~~": "~~Instance description~~",		"created_at": "2016-08-19T13:58:26",
	"uuid": "~~7abd7196~~-~~981d~~-~~11e5~~-~~bc4f~~-~~5254004aea96",~~		"scenario_id": "349ce93e-6604-11e6-950f-0800273e724c",
	~~"name": "Instance 2~~"		"name": "complex2-instance",
			"uuid": "3cf18d42-6604-11e6-950f-0800273e724c"
	}		}
	]		]
	}		}


	====GET /openmano/{tenant_id}/instances/{instance_id}====		====GET /openmano/{tenant_id}/instances/{instance_id}====

Tierno: /* DELETE /openmano/{tenant\_id}/instances/{instance_id} */

2016-08-19T13:47:24Z

DELETE /openmano/{tenant\_id}/instances/{instance_id}

← Older revision		Revision as of 13:47, 19 August 2016
Line 853:		Line 853:


	====DELETE /openmano/{~~tenant\_id~~}/instances/{instance_id}====		====DELETE /openmano/{tenant_id}/instances/{instance_id}====
	~~delete~~ instance from VIM and from database.		Delete instance from VIM and from database.

	'''Params''': none		'''Params''': none

Tierno at 13:46, 19 August 2016

2016-08-19T13:46:52Z

Show changes

Tierno at 10:58, 19 August 2016

2016-08-19T10:58:22Z

Show changes

← Older revision		Revision as of 11:07, 22 August 2016
Line 972:		Line 972:

	---		---
	"start": null #To start an instance		"start": null #To start an instance
	"pause": null #To pause an instance		"pause": null #To pause an instance
	"resume": null #To resume an instance		"resume": null #To resume an instance
	"shutoff": null #To shutoff an instance		"shutoff": null #To shutoff an instance
	"shutdown": null #To shutdown an instance		"shutdown": null #To shutdown an instance
	"forceOff": null #To forceOff an instance		"forceOff": null #To forceOff an instance
	"rebuild": null #To rebuild an instance		"rebuild": null #To rebuild an instance
	"reboot": {"type": "SOFT"} #To reboot an instance		"reboot": {"type": "SOFT"} #To reboot an instance
	"console": "novnc" # To obtain a console		"console": "novnc" # To obtain a console
	"vnfs": [ "06ea139a-a23c-11e5-bc4f-5254004aea96" ],		"vnfs": [ "06ea139a-a23c-11e5-bc4f-5254004aea96" ],
	"vms": [ "369b02a2-6604-11e6-950f-0800273e724c" ]		"vms": [ "369b02a2-6604-11e6-950f-0800273e724c" ]

	* console type can be "novnc", "xvpvnc", "rdp-html5", "spice-html5"		* console type can be "novnc", "xvpvnc", "rdp-html5", "spice-html5"
Line 993:		Line 993:

	---		---
	"369b02a2-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'		"369b02a2-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'
	"vim_result": 503		"vim_result": 503
	"name": "linux-VM" #same as 'vnfs':'vms':'name'		"name": "linux-VM" #same as 'vnfs':'vms':'name'
	"description": "Conflict: Instance 0a29c298-21d0-4dac-9eda-95a3953ae211 is in an invalid state for 'rebuild' (HTTP 409) (Request-ID: req-2a8096d1-1270-402d-bb3f-0b4d6789b233)"		"description": "Conflict: Instance 0a29c298-21d0-4dac-9eda-95a3953ae211 is in an invalid state for 'rebuild' (HTTP 409) (Request-ID: req-2a8096d1-1270-402d-bb3f-0b4d6789b233)"

	Example for a "console" action response with success:		Example for a "console" action response with success:

	---		---
	"3cf35eba-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'		"3cf35eba-6604-11e6-950f-0800273e724c": #VM uuid 'vnfs':'vms':'uuid'
	"vim_result": 200		"vim_result": 200
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=548f5442-32ce-4ffa-b95c-f1d483520cc9"		"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=548f5442-32ce-4ffa-b95c-f1d483520cc9"
	"name": "VNF_2VMs-VM2" #same as 'vnfs':'vms':'name'		"name": "VNF_2VMs-VM2" #same as 'vnfs':'vms':'name'
	"3cf40ee6-6604-11e6-950f-0800273e724c":		"3cf40ee6-6604-11e6-950f-0800273e724c":
	"vim_result": 200		"vim_result": 200
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=67451dd3-c039-44f6-9860-1a69aad5338c"		"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=67451dd3-c039-44f6-9860-1a69aad5338c"
	"name": "VNF_2VMs-VM1"		"name": "VNF_2VMs-VM1"
	"3cf26f78-6604-11e6-950f-0800273e724c":		"3cf26f78-6604-11e6-950f-0800273e724c":
	"vim_result": 200		"vim_result": 200
	"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=31f392f0-fee8-4d91-80a0-437b1149cbf8"		"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=31f392f0-fee8-4d91-80a0-437b1149cbf8"
	"name": "dataplaneVNF3-VM"		"name": "dataplaneVNF3-VM"

	==Miscellaneous ==		==Miscellaneous ==