Merge branch 'tierno-master-patch-03254' into 'master' (87caef51) · Commits · osm-doc / OSM User Guide

16-ro-northbound-rest-api.md

+14 −13

Original line number	Original line	Diff line number	Diff line
	@@ -476,7 +476,7 @@ Get a list of vnfs. The parameter `tenant_id` can be replaced by `any` to obtain
	"physical": false		"physical": false
	},		},
	{		{
	"description": "VNF1 description"",		"description": "VNF1 description",
	"created_at": "2015-09-15T13:22:24",		"created_at": "2015-09-15T13:22:24",
	"uuid": "09d14bf0-5b9c-11e5-a873-5254004aea96",		"uuid": "09d14bf0-5b9c-11e5-a873-5254004aea96",
	"name": "VNF2",		"name": "VNF2",
	@@ -498,14 +498,14 @@ Get vnf details. The parameter `tenant_id` can be replaced by `any` to obtain al

	- VNFC: Array of virtual machines which compose the vnf		- VNFC: Array of virtual machines which compose the vnf
	- External-connections: array of vnf's connections		- External-connections: array of vnf's connections
			- `vm_name`: name of the internal virtual machine which this connections is connected
			- `external_name`: name of the conection to show in the interface
			- `type`: type of connection
			- `vpci`: Virtual PCI address
			- `bw`: bandwidth
			- `internal_name`: local iface name of the VM

	```json		```json
	* vm_name: name of the internal virtual machine which this connections is connected
	* external_name: name of the conection to show in the interface
	* type: type of connection
	* vpci: Virtual PCI address
	* bw: bandwidth
	* internal_name: local iface name of the VM
	{		{
	"vnf": {		"vnf": {
	"VNFC": [		"VNFC": [
	@@ -675,12 +675,13 @@ see at code `/scenarios/scenario-template.yaml`
	```		```

	- Start a scenario: Equivalent to deploy		- Start a scenario: Equivalent to deploy
			- instance_name (required): name of the scenario to start
			- description (optional): a description
			- datacenter (optional): name of the datacenter where the scenario will be started.

			`Content-type: application/json`:

	```json		```json
	* instance_name (required): name of the scenario to start
	* description (optional): a description
	* datacenter (optional): name of the datacenter where the scenario will be started.
	Content-type: application/json:
	{		{
	"start": {		"start": {
	"instance_name": "scenario1",		"instance_name": "scenario1",
	@@ -961,7 +962,7 @@ Creates a new instance scenario

	Params: `Content-type: application/yaml`		Params: `Content-type: application/yaml`

	```json		```yaml
	---		---
	instance:		instance:
	datacenter: 2dd83432-6604-11e6-950f-0800273e724c		datacenter: 2dd83432-6604-11e6-950f-0800273e724c
	@@ -1054,7 +1055,7 @@ take an action over a scenario instance. Actions can be `{start,pause,resume,shu

	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.		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.

	```json		```yaml
	---		---
	"start": null #To start an instance		"start": null #To start an instance
	"pause": null #To pause an instance		"pause": null #To pause an instance