OSM Public Wiki - User contributions [en]

Openstack configuration (Release ONE)

2017-03-06T14:47:26Z

Berpec:

__TOC__

=Configure openstack for OSM (basic)=

'''1. Guarantee that Openstack API endpoints are reachable from OSM (particularly from RO container)'''

'''2. Create a management network, with DHCP enabled, reachable from OSM (particularly from VCA container)'''

You need to create a management network, with DHCP enabled, and guarantee that this management network is reachable from OSM. The network is used by the VCA (Juju) for configuring the VNFs once they are running. It is recommended to create a provider network, isolated from Openstack. For instance, in order to create a provider network using physical interface em1 and VLAN 500 and with CIDR 10.208.0.0/24, you should run the following commands:
neutron net-create mgmt --provider:network_type=vlan --provider:physical_network=physnet_em1 --provider:segmentation_id=500 --shared
neutron subnet-create --name subnet-mgmt mgmt 10.208.0.0/24 --allocation-pool start=10.208.0.2,end=10.208.0.254

'''3. Create a valid tenant/user'''

You need to create a tenant/user with rights to create/delete flavors. The easiest way is to create a user and assign it the role "admin". Another option is to change the general flavor management policies at file ''/etc/nova/policy.json'' to allow flavor creation per user.

'''4. Upload images'''

OSM will create the needed images into openstack at deployment time, but the process takes a long time and the provided path at VNFD must be accesible by OSM. For this reason, it is recommended to upload the images of the VNFs manually at openstack, using the following command:

openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 --public --property location="/mnt/powervault/virtualization/osm/CirrOS/cirros-0.3.4-x86_64-disk.img" cirros034

'''5. Modify default security group or create a new one'''

By default openstack apply the "default" security group that blocks any incoming traffic to the VM. However ssh access is needed by VCA. You must modify the default security group to allow TCP port 22 or; create a new security group and configure RO to use this security group when datacenter is addeed (see [[Openstack_configuration_(Release_ONE)#Add openstack at OSM]] )

=Configure openstack for OSM (EPA)=

Besides the instructions above for any Openstack, you should do extra configuration to configure openstack for running VNFs which use SRIOV interfaces.

'''1. Provide a mechanism to connect the SR-IOV interfaces'''. As they are physical ports connected to an external switch, Neutron will not be able to connect them. You can use a physical switch programmed to interconnect the vlan tags among them (not recommened for security reasons). Another solution is to use a ML2 plugin that programs the external switch.

'''2. Configure the Neutron controller for using SR-IOV ports'''
<p>Edit /etc/neutron/plugins/ml2/ml2_conf.ini with the tag and vlan ranges used by the dataplane network</p>

[ml2_type_vlan]
network_vlan_ranges = physnet_sriov:3000:3100

'''3. Configure the compute nodes for using SR-IOV'''

On each compute node you have to associate the VFs available to each physical network. That is performed by configuring pci_passthrough_whitelist in /etc/nova/nova.conf. So, for example:

pci_passthrough_whitelist = {"vendor_id":"8086", "product_id":"10ed","physical_network":"physnet_sriov"}

=Add openstack at OSM=

'''The v2.0 of the OpenStack API is deprecated since [https://review.openstack.org/#/c/251530/ Nov 30, 2015]'''

There is a parameter called '''--config''' used to suply general guidelines both at datacenter creation and datacenter association to openmano tenant (this later precedes)
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site" --config='{security_groups: default, keypair: mykey}'
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin --config='{availability_zone: one}'

The following configuration can be added:

* '''security_groups''': To be used for the deployment
* '''availability_zone''': To be used for the deployment
* '''region_name''': The region where the VM must be deployed.
* '''insecure''': (By default false). When true it allows authorization over a non trusted certificate over https
* '''APIversion''': (By default v2.0). Set to "v3.3" to use this openstack API version (code on BETA)

ADVANCED configuration:

* '''keypair''': To be added in addition to the keypair allocated on the VNF descriptor. Provide the name of a openstack keypair
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for SRIOV networks, e.g. 'physnet_sriov' in the above configuration
* '''use_floating_ip''': (By default false). When true a management interface of a VNFD is automatically asigned a floating_ip -if possible-. The prefered method is to use a provider network

The content of config is a yaml format text. The recomendation is to use a comma separated list between curly brackets {} and quotes, e.g.:
--config='{use_floating_ip: True, availability_zone: controller}'

OSM Release ONE

2017-03-06T14:46:16Z

Berpec:

Open Source MANO (OSM) is the open source community that aims to deliver a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.

{{#evu:https://www.youtube.com/watch?v=yBWSKwms47E
|alignment=right
}}

__TOC__

=Interaction with VIMs and VNFs=
The following figure shows OSM interaction with VIM and VNFs.

[[File:OSMconnectivity1.png|400px|OSM Release 1 connectivity 1]]

In simpler setups, OSM only requires a single interface as long as both VIM and VNF IP addresses are reachable

[[File:OSMconnectivity2.png|400px|OSM Release 1 connectivity 2]]

=Install OSM=

==Install from source==

All you need to run OSM Release One is a single server or VM with the following requirements:
* 8 CPUs, 16 GB RAM, 100GB disk and a single interface with Internet access
* Ubuntu16.04 as base image (http://releases.ubuntu.com/16.04/), configured to run LXD containers. If you don't have LXD configured, you can follow the instructions here ([[LXD configuration for OSM release 1|LXD configuration]]).

Note: If you wish to install OSM Release One from inside a LXD container, you will need to enable nested containers following instructions here ([[LXD within LXD|Nested containers]]).

Once you have prepared the host with the previous requirements, all you need to do is:
wget https://osm-download.etsi.org/ftp/osm-1.0-one/install_from_source.sh
chmod +x install_from_source.sh
./install_from_source.sh
If you need to install from latest master (recommended for advanced users only), please use,
./install_from_source.sh --develop

After some time, you will get a fresh OSM Release One installation. You can access to the UI in the following URL (user:admin, password: admin):

You can connect to the service via a web browser (Google Chrome version 50 or later is recommended). Open a browser and connect to https://1.2.3.4:8443 , replacing 1.2.3.4 with the IP address of your host. Note that it uses https, not http. Google Chrome is recommended. If you are using Firefox and plan to use the self-signed certificate provided in the installation, please follow instructions at [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using2 Using untrusted, self-signed certificates]
Alternatively, you can run Launchpad with trusted CA signed SSL certs as per [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using Using a certificate signed by a trusted CA]
or, run Launchpad with SSL disabled as per [http://open.riftio.com/documentation/riftware/4.3/a/user-guide/run-launchpad-with-ssl-disabled.htm?Highlight=disable Run Launchpad with SSL Disabled]

[[File:OSMloginWindow.png|400px|OSM login window]]

Make sure that port 8443 is accessible, as well as the following required ports: 8000, 4567, 8008, 80, 9090.

As a result of the installation, three LXD containers are created in the host: RO, VCA, and SO-ub (running the SO and the UI), as shown in the figure below.

[[File:OSMcontainers.png|400px|OSM Release ONE installation result]]

=Adding a VIM account=
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Three different kinds of VIMs are currently supported by OSM:
*OpenVIM. Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation (Release One)]]
*OpenStack. Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack configuration (Release ONE)]]
*VMware vCloud Director. Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring VMware vCloud Director for OSM Release One]]

==OpenVIM site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")
export OPENMANO_TENANT=osm
openmano datacenter-create openvim-site http://10.10.10.10:9080/openvim --type openvim --description "Openvim site"
openmano datacenter-attach openvim-site --vim-tenant-name=osm
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==Openstack site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")
'''This API of OpenStack is deprecated since [https://review.openstack.org/#/c/251530/ Nov 30, 2015]'''

export OPENMANO_TENANT=osm
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site"
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==VMware site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")
openmano datacenter-create vmware-site https://10.10.10.12 --type vmware --description "VMware site" --config '{admin_password: adminpwd, admin_username: admin, orgname: orgVDC}'
openmano datacenter-attach vmware-site --user=osm --password=osm4u --vim-tenant-name=vmware-tenant
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

=Deploying your first Network Service=
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.

[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]

Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/examples/cirros_2vnf_ns/

==Uploading VNF image to the VIM==
Get the cirros 0.3.4 image from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img

Then, onboard the image into the VIM. The instruction differs from one VIM to another:
*In Openstack:
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034
*In openvim:
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img

==Onboarding a VNF==
*From the UI:
**Go to Catalog
**Click on the import button, then VNFD
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.
[[File:onboardingVNF.png|300px|Onboarding a VNF]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_vnf.tar.gz

==Onboarding a NS==
*From the UI:
**Go to Catalog
**Click on the import button, then NSD
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_2vnf_ns.tar.gz

==Instantiating the NS==
*From the UI:
**Go to Launchpad > Instantiate
**Select the NS descriptor to be instantiated, and click on Next
**Add a name to the NS instance, and click on Launch.
[[File:instantiatingNS.png|300px|Instantiating a NS (step 1)]] [[File:instantiatingNS-step2.png|400px|Instantiating a NS (step 2)]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:

/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -i <ns-instance-name> -d <nsd-id> -D <data-center-id>

Note: The nsd-id and data-center-id need to be replaced with the values from your setup.
Issue the following commands from the SO CLI(See the next section "Accessing CLI for viewing instantiated NS details" on how to access SO CLI) to determine the nsd-id and data-center-id,

* <code>show nsd-catalog nsd </code> - Displays the nsds in the catalog. Find the id of the cirros_2vnf_nsd NSD
* <code>show datacenters</code> - Displays the list of data centers configured in the RO. Choose the data center where the network service need to be instantiated.

Wait for the message that the NS has been successfully deployed, and that's all!

== Accessing CLI for viewing instantiated NS details ==

From the SO-ub container ("lxc exec SO-ub bash"), execute the following command to bring up SO CLI (username:admin password:admin)

/usr/rift/rift-shell -r -i /usr/rift -a /usr/rift/.artifacts -- rwcli --rift_var_root /usr/rift/var/rift

The CLI can be used to both configure the system and show operational-data from the system. For instance:
rift# show nsd-catalog # show the nsd catalog
rift# show vnfd-catalog # show vnfd catalog
rift# show ns-instance-config nsr # Lists instantiated network service
rift# show ns-instance-opdata nsr # Lists of instantiated network service op-data

=Interacting with the System via the SO REST APIs=
The following document describes how to interact with the systme using the SO REST APis.

[[Media:Osm-r1-so-rest-api-guide.pdf]]

=Additional information=

*Check other VNF packages and NS packages in the links below:
**VNF packages: https://osm-download.etsi.org/ftp/osm-1.0-one/vnf-packages
**NS packages: https://osm-download.etsi.org/ftp/osm-1.0-one/ns-packages
*[[Deploying advanced Network Services (Release ONE)|Deploy advanced Network Services]]
*[[Creating your own VNF package (Release ONE)|Create your own VNF package]]
*[[Reference VNF and NS Descriptors (Release ONE)|Reference VNF and NS Descriptors]]
*[[Creating your own VNF charm (Release_ONE)|Creating your own VNF charm]]
*[[How to report issues (Release ONE)|Have you detected any bug? Check this guide to see how to report issues]]
*[[Logs and troubleshooting (Release ONE)|Logs and troubleshooting]]
*[[Life Cycle Management of VNFs from the RO (Release ONE)|Life Cycle Management of VNFs from the RO]]
*[[Release ONE Data Model details|Data Model Details]]
*[https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf OSM White Paper - Release ONE Technical Overview]
*[[Release ONE Technical FAQ|Technical FAQ]]

{{Feedback}}

Openstack configuration (Release ONE)

2017-03-06T14:37:05Z

Berpec:

__TOC__

=Configure openstack for OSM (basic)=

'''1. Guarantee that Openstack API endpoints are reachable from OSM (particularly from RO container)'''

'''2. Create a management network, with DHCP enabled, reachable from OSM (particularly from VCA container)'''

You need to create a management network, with DHCP enabled, and guarantee that this management network is reachable from OSM. The network is used by the VCA (Juju) for configuring the VNFs once they are running. It is recommended to create a provider network, isolated from Openstack. For instance, in order to create a provider network using physical interface em1 and VLAN 500 and with CIDR 10.208.0.0/24, you should run the following commands:
neutron net-create mgmt --provider:network_type=vlan --provider:physical_network=physnet_em1 --provider:segmentation_id=500 --shared
neutron subnet-create --name subnet-mgmt mgmt 10.208.0.0/24 --allocation-pool start=10.208.0.2,end=10.208.0.254

'''3. Create a valid tenant/user'''

You need to create a tenant/user with rights to create/delete flavors. The easiest way is to create a user and assign it the role "admin". Another option is to change the general flavor management policies at file ''/etc/nova/policy.json'' to allow flavor creation per user.

'''4. Upload images'''

OSM will create the needed images into openstack at deployment time, but the process takes a long time and the provided path at VNFD must be accesible by OSM. For this reason, it is recommended to upload the images of the VNFs manually at openstack, using the following command:

openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 --public --property location="/mnt/powervault/virtualization/osm/CirrOS/cirros-0.3.4-x86_64-disk.img" cirros034

'''5. Modify default security group or create a new one'''

By default openstack apply the "default" security group that blocks any incoming traffic to the VM. However ssh access is needed by VCA. You must modify the default security group to allow TCP port 22 or; create a new security group and configure RO to use this security group when datacenter is addeed (see [[Openstack_configuration_(Release_ONE)#Add openstack at OSM]] )

=Configure openstack for OSM (EPA)=

Besides the instructions above for any Openstack, you should do extra configuration to configure openstack for running VNFs which use SRIOV interfaces.

'''1. Provide a mechanism to connect the SR-IOV interfaces'''. As they are physical ports connected to an external switch, Neutron will not be able to connect them. You can use a physical switch programmed to interconnect the vlan tags among them (not recommened for security reasons). Another solution is to use a ML2 plugin that programs the external switch.

'''2. Configure the Neutron controller for using SR-IOV ports'''
<p>Edit /etc/neutron/plugins/ml2/ml2_conf.ini with the tag and vlan ranges used by the dataplane network</p>

[ml2_type_vlan]
network_vlan_ranges = physnet_sriov:3000:3100

'''3. Configure the compute nodes for using SR-IOV'''

On each compute node you have to associate the VFs available to each physical network. That is performed by configuring pci_passthrough_whitelist in /etc/nova/nova.conf. So, for example:

pci_passthrough_whitelist = {"vendor_id":"8086", "product_id":"10ed","physical_network":"physnet_sriov"}

=Add openstack at OSM=

'''The v2.0 of the OpenStack API is deprecated since [https://bugs.launchpad.net/openstack-manuals/+bug/1536422 2016-01-21]'''

There is a parameter called '''--config''' used to suply general guidelines both at datacenter creation and datacenter association to openmano tenant (this later precedes)
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site" --config='{security_groups: default, keypair: mykey}'
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin --config='{availability_zone: one}'

The following configuration can be added:

* '''security_groups''': To be used for the deployment
* '''availability_zone''': To be used for the deployment
* '''region_name''': The region where the VM must be deployed.
* '''insecure''': (By default false). When true it allows authorization over a non trusted certificate over https
* '''APIversion''': (By default v2.0). Set to "v3.3" to use this openstack API version (code on BETA)

ADVANCED configuration:

* '''keypair''': To be added in addition to the keypair allocated on the VNF descriptor. Provide the name of a openstack keypair
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for SRIOV networks, e.g. 'physnet_sriov' in the above configuration
* '''use_floating_ip''': (By default false). When true a management interface of a VNFD is automatically asigned a floating_ip -if possible-. The prefered method is to use a provider network

The content of config is a yaml format text. The recomendation is to use a comma separated list between curly brackets {} and quotes, e.g.:
--config='{use_floating_ip: True, availability_zone: controller}'

OSM Release ONE

2017-03-06T14:35:44Z

Berpec:

Open Source MANO (OSM) is the open source community that aims to deliver a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.

{{#evu:https://www.youtube.com/watch?v=yBWSKwms47E
|alignment=right
}}

__TOC__

=Interaction with VIMs and VNFs=
The following figure shows OSM interaction with VIM and VNFs.

[[File:OSMconnectivity1.png|400px|OSM Release 1 connectivity 1]]

In simpler setups, OSM only requires a single interface as long as both VIM and VNF IP addresses are reachable

[[File:OSMconnectivity2.png|400px|OSM Release 1 connectivity 2]]

=Install OSM=

==Install from source==

All you need to run OSM Release One is a single server or VM with the following requirements:
* 8 CPUs, 16 GB RAM, 100GB disk and a single interface with Internet access
* Ubuntu16.04 as base image (http://releases.ubuntu.com/16.04/), configured to run LXD containers. If you don't have LXD configured, you can follow the instructions here ([[LXD configuration for OSM release 1|LXD configuration]]).

Note: If you wish to install OSM Release One from inside a LXD container, you will need to enable nested containers following instructions here ([[LXD within LXD|Nested containers]]).

Once you have prepared the host with the previous requirements, all you need to do is:
wget https://osm-download.etsi.org/ftp/osm-1.0-one/install_from_source.sh
chmod +x install_from_source.sh
./install_from_source.sh
If you need to install from latest master (recommended for advanced users only), please use,
./install_from_source.sh --develop

After some time, you will get a fresh OSM Release One installation. You can access to the UI in the following URL (user:admin, password: admin):

You can connect to the service via a web browser (Google Chrome version 50 or later is recommended). Open a browser and connect to https://1.2.3.4:8443 , replacing 1.2.3.4 with the IP address of your host. Note that it uses https, not http. Google Chrome is recommended. If you are using Firefox and plan to use the self-signed certificate provided in the installation, please follow instructions at [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using2 Using untrusted, self-signed certificates]
Alternatively, you can run Launchpad with trusted CA signed SSL certs as per [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using Using a certificate signed by a trusted CA]
or, run Launchpad with SSL disabled as per [http://open.riftio.com/documentation/riftware/4.3/a/user-guide/run-launchpad-with-ssl-disabled.htm?Highlight=disable Run Launchpad with SSL Disabled]

[[File:OSMloginWindow.png|400px|OSM login window]]

Make sure that port 8443 is accessible, as well as the following required ports: 8000, 4567, 8008, 80, 9090.

As a result of the installation, three LXD containers are created in the host: RO, VCA, and SO-ub (running the SO and the UI), as shown in the figure below.

[[File:OSMcontainers.png|400px|OSM Release ONE installation result]]

=Adding a VIM account=
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Three different kinds of VIMs are currently supported by OSM:
*OpenVIM. Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation (Release One)]]
*OpenStack. Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack configuration (Release ONE)]]
*VMware vCloud Director. Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring VMware vCloud Director for OSM Release One]]

==OpenVIM site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")
export OPENMANO_TENANT=osm
openmano datacenter-create openvim-site http://10.10.10.10:9080/openvim --type openvim --description "Openvim site"
openmano datacenter-attach openvim-site --vim-tenant-name=osm
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==Openstack site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")
'''This API of OpenStack is deprecated since [https://bugs.launchpad.net/openstack-manuals/+bug/1536422 2016-01-21]'''

export OPENMANO_TENANT=osm
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site"
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==VMware site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")
openmano datacenter-create vmware-site https://10.10.10.12 --type vmware --description "VMware site" --config '{admin_password: adminpwd, admin_username: admin, orgname: orgVDC}'
openmano datacenter-attach vmware-site --user=osm --password=osm4u --vim-tenant-name=vmware-tenant
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

=Deploying your first Network Service=
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.

[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]

Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/examples/cirros_2vnf_ns/

==Uploading VNF image to the VIM==
Get the cirros 0.3.4 image from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img

Then, onboard the image into the VIM. The instruction differs from one VIM to another:
*In Openstack:
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034
*In openvim:
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img

==Onboarding a VNF==
*From the UI:
**Go to Catalog
**Click on the import button, then VNFD
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.
[[File:onboardingVNF.png|300px|Onboarding a VNF]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_vnf.tar.gz

==Onboarding a NS==
*From the UI:
**Go to Catalog
**Click on the import button, then NSD
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_2vnf_ns.tar.gz

==Instantiating the NS==
*From the UI:
**Go to Launchpad > Instantiate
**Select the NS descriptor to be instantiated, and click on Next
**Add a name to the NS instance, and click on Launch.
[[File:instantiatingNS.png|300px|Instantiating a NS (step 1)]] [[File:instantiatingNS-step2.png|400px|Instantiating a NS (step 2)]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:

/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -i <ns-instance-name> -d <nsd-id> -D <data-center-id>

Note: The nsd-id and data-center-id need to be replaced with the values from your setup.
Issue the following commands from the SO CLI(See the next section "Accessing CLI for viewing instantiated NS details" on how to access SO CLI) to determine the nsd-id and data-center-id,

* <code>show nsd-catalog nsd </code> - Displays the nsds in the catalog. Find the id of the cirros_2vnf_nsd NSD
* <code>show datacenters</code> - Displays the list of data centers configured in the RO. Choose the data center where the network service need to be instantiated.

Wait for the message that the NS has been successfully deployed, and that's all!

== Accessing CLI for viewing instantiated NS details ==

From the SO-ub container ("lxc exec SO-ub bash"), execute the following command to bring up SO CLI (username:admin password:admin)

/usr/rift/rift-shell -r -i /usr/rift -a /usr/rift/.artifacts -- rwcli --rift_var_root /usr/rift/var/rift

The CLI can be used to both configure the system and show operational-data from the system. For instance:
rift# show nsd-catalog # show the nsd catalog
rift# show vnfd-catalog # show vnfd catalog
rift# show ns-instance-config nsr # Lists instantiated network service
rift# show ns-instance-opdata nsr # Lists of instantiated network service op-data

=Interacting with the System via the SO REST APIs=
The following document describes how to interact with the systme using the SO REST APis.

[[Media:Osm-r1-so-rest-api-guide.pdf]]

=Additional information=

*Check other VNF packages and NS packages in the links below:
**VNF packages: https://osm-download.etsi.org/ftp/osm-1.0-one/vnf-packages
**NS packages: https://osm-download.etsi.org/ftp/osm-1.0-one/ns-packages
*[[Deploying advanced Network Services (Release ONE)|Deploy advanced Network Services]]
*[[Creating your own VNF package (Release ONE)|Create your own VNF package]]
*[[Reference VNF and NS Descriptors (Release ONE)|Reference VNF and NS Descriptors]]
*[[Creating your own VNF charm (Release_ONE)|Creating your own VNF charm]]
*[[How to report issues (Release ONE)|Have you detected any bug? Check this guide to see how to report issues]]
*[[Logs and troubleshooting (Release ONE)|Logs and troubleshooting]]
*[[Life Cycle Management of VNFs from the RO (Release ONE)|Life Cycle Management of VNFs from the RO]]
*[[Release ONE Data Model details|Data Model Details]]
*[https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf OSM White Paper - Release ONE Technical Overview]
*[[Release ONE Technical FAQ|Technical FAQ]]

{{Feedback}}

OSM Release ONE

2017-03-03T14:08:02Z

Berpec: fix typo in a command

Open Source MANO (OSM) is the open source community that aims to deliver a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.

{{#evu:https://www.youtube.com/watch?v=yBWSKwms47E
|alignment=right
}}

__TOC__

=Interaction with VIMs and VNFs=
The following figure shows OSM interaction with VIM and VNFs.

[[File:OSMconnectivity1.png|400px|OSM Release 1 connectivity 1]]

In simpler setups, OSM only requires a single interface as long as both VIM and VNF IP addresses are reachable

[[File:OSMconnectivity2.png|400px|OSM Release 1 connectivity 2]]

=Install OSM=

==Install from source==

All you need to run OSM Release One is a single server or VM with the following requirements:
* 8 CPUs, 16 GB RAM, 100GB disk and a single interface with Internet access
* Ubuntu16.04 as base image (http://releases.ubuntu.com/16.04/), configured to run LXD containers. If you don't have LXD configured, you can follow the instructions here ([[LXD configuration for OSM release 1|LXD configuration]]).

Note: If you wish to install OSM Release One from inside a LXD container, you will need to enable nested containers following instructions here ([[LXD within LXD|Nested containers]]).

Once you have prepared the host with the previous requirements, all you need to do is:
wget https://osm-download.etsi.org/ftp/osm-1.0-one/install_from_source.sh
chmod +x install_from_source.sh
./install_from_source.sh
If you need to install from latest master (recommended for advanced users only), please use,
./install_from_source.sh --develop

After some time, you will get a fresh OSM Release One installation. You can access to the UI in the following URL (user:admin, password: admin):

You can connect to the service via a web browser (Google Chrome version 50 or later is recommended). Open a browser and connect to https://1.2.3.4:8443 , replacing 1.2.3.4 with the IP address of your host. Note that it uses https, not http. Google Chrome is recommended. If you are using Firefox and plan to use the self-signed certificate provided in the installation, please follow instructions at [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using2 Using untrusted, self-signed certificates]
Alternatively, you can run Launchpad with trusted CA signed SSL certs as per [http://open.riftio.com/documentation/riftware/4.3/a/monitor/avoiding-selfsigned-certificate-warnings.htm#Using Using a certificate signed by a trusted CA]
or, run Launchpad with SSL disabled as per [http://open.riftio.com/documentation/riftware/4.3/a/user-guide/run-launchpad-with-ssl-disabled.htm?Highlight=disable Run Launchpad with SSL Disabled]

[[File:OSMloginWindow.png|400px|OSM login window]]

Make sure that port 8443 is accessible, as well as the following required ports: 8000, 4567, 8008, 80, 9090.

As a result of the installation, three LXD containers are created in the host: RO, VCA, and SO-ub (running the SO and the UI), as shown in the figure below.

[[File:OSMcontainers.png|400px|OSM Release ONE installation result]]

=Adding a VIM account=
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Three different kinds of VIMs are currently supported by OSM:
*OpenVIM. Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation (Release One)]]
*OpenStack. Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack configuration (Release ONE)]]
*VMware vCloud Director. Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring VMware vCloud Director for OSM Release One]]

==OpenVIM site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")
export OPENMANO_TENANT=osm
openmano datacenter-create openvim-site http://10.10.10.10:9080/openvim --type openvim --description "Openvim site"
openmano datacenter-attach openvim-site --vim-tenant-name=osm
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==Openstack site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")
export OPENMANO_TENANT=osm
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site"
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

==VMware site==
*Go into the RO container:
lxc exec RO -- bash
*Execute the following commands, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")
openmano datacenter-create vmware-site https://10.10.10.12 --type vmware --description "VMware site" --config '{admin_password: adminpwd, admin_username: admin, orgname: orgVDC}'
openmano datacenter-attach vmware-site --user=osm --password=osm4u --vim-tenant-name=vmware-tenant
openmano datacenter-list
exit #or Ctrl+D to get out of the RO container

=Deploying your first Network Service=
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.

[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]

Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/examples/cirros_2vnf_ns/

==Uploading VNF image to the VIM==
Get the cirros 0.3.4 image from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img

Then, onboard the image into the VIM. The instruction differs from one VIM to another:
*In Openstack:
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034
*In openvim:
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img

==Onboarding a VNF==
*From the UI:
**Go to Catalog
**Click on the import button, then VNFD
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.
[[File:onboardingVNF.png|300px|Onboarding a VNF]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_vnf.tar.gz

==Onboarding a NS==
*From the UI:
**Go to Catalog
**Click on the import button, then NSD
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:
/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -s 127.0.0.1 -u cirros_2vnf_ns.tar.gz

==Instantiating the NS==
*From the UI:
**Go to Launchpad > Instantiate
**Select the NS descriptor to be instantiated, and click on Next
**Add a name to the NS instance, and click on Launch.
[[File:instantiatingNS.png|300px|Instantiating a NS (step 1)]] [[File:instantiatingNS-step2.png|400px|Instantiating a NS (step 2)]]
*From the SO CLI:
**From the SO-ub container ("lxc exec SO-ub bash"), execute the following command:

/root/SO/rwlaunchpad/plugins/rwlaunchpadtasklet/scripts/onboard_pkg -i <ns-instance-name> -d <nsd-id> -D <data-center-id>

Note: The nsd-id and data-center-id need to be replaced with the values from your setup.
Issue the following commands from the SO CLI(See the next section "Accessing CLI for viewing instantiated NS details" on how to access SO CLI) to determine the nsd-id and data-center-id,

** <code>show nsd-catalog nsd </code> - Displays the nsds in the catalog. Find the id of the cirros_2vnf_nsd NSD
** <code>show datacenters</code> - Displays the list of data centers configured in the RO. Choose the data center where the network service need to be instantiated.

Wait for the message that the NS has been successfully deployed, and that's all!

== Accessing CLI for viewing instantiated NS details ==

From the SO-ub container ("lxc exec SO-ub bash"), execute the following command to bring up SO CLI (username:admin password:admin)

/usr/rift/rift-shell -r -i /usr/rift -a /usr/rift/.artifacts -- rwcli --rift_var_root /usr/rift/var/rift

The CLI can be used to both configure the system and show operational-data from the system. For instance:
rift# show nsd-catalog # show the nsd catalog
rift# show vnfd-catalog # show vnfd catalog
rift# show ns-instance-config nsr # Lists instantiated network service
rift# show ns-instance-opdata nsr # Lists of instantiated network service op-data

=Interacting with the System via the SO REST APIs=
The following document describes how to interact with the systme using the SO REST APis.

[[Media:Osm-r1-so-rest-api-guide.pdf]]

=Additional information=

*Check other VNF packages and NS packages in the links below:
**VNF packages: https://osm-download.etsi.org/ftp/osm-1.0-one/vnf-packages
**NS packages: https://osm-download.etsi.org/ftp/osm-1.0-one/ns-packages
*[[Deploying advanced Network Services (Release ONE)|Deploy advanced Network Services]]
*[[Creating your own VNF package (Release ONE)|Create your own VNF package]]
*[[Reference VNF and NS Descriptors (Release ONE)|Reference VNF and NS Descriptors]]
*[[Creating your own VNF charm (Release_ONE)|Creating your own VNF charm]]
*[[How to report issues (Release ONE)|Have you detected any bug? Check this guide to see how to report issues]]
*[[Logs and troubleshooting (Release ONE)|Logs and troubleshooting]]
*[[Life Cycle Management of VNFs from the RO (Release ONE)|Life Cycle Management of VNFs from the RO]]
*[[Release ONE Data Model details|Data Model Details]]
*[https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf OSM White Paper - Release ONE Technical Overview]
*[[Release ONE Technical FAQ|Technical FAQ]]

{{Feedback}}

Talk:Logs and troubleshooting (Release ONE)

2017-02-28T16:47:35Z

Berpec: /* Update with install script ? */ new section

== Update with install script ? ==

About the section [[Logs_and_troubleshooting_(Release_ONE)#Software_upgrade]]

The script linked in [[OSM_Release_ONE#Install_from_source]] is supposed to handle updates, is it stable enough to be included in the wiki ?

Talk:RO Northbound Interface

2017-01-31T09:28:31Z

Berpec:

== Is RO supporting json or yaml or both ? ==

Several entries on this page are not correct according to what we find in the code.

For example :

'''On the wiki'''
POST /openmano/{tenant_id}/instances/{instance_id}/action
take an action over a scenario instance. Actions can be {start,pause,resume,shutoff,shutdown,forceOff,rebuild,reboot,console}
Params: Content-type: application/yaml

'''In the code we cand read''' [https://osm.etsi.org/gitweb/?p=osm/RO.git;a=blob;f=httpserver.py;h=789e0224c7c6354a49a04d1c56d59e524ee193d1;hb=aceb46455ba16b5cfddd8cde528251a57e8a3b56#l1224 httpserver.py]
@bottle.route(url_base + '/<tenant_id>/instances/<instance_id>/action', method='POST')
def http_post_instance_scenario_action(tenant_id, instance_id):
[...]
#parse input data
http_content,_ = format_in( ''instance_scenario_action_schema'' )

'''And then''' [https://osm.etsi.org/gitweb/?p=osm/RO.git;a=blob;f=openmano_schemas.py;h=ffbacd3adb68428bf143d227f9e6f295b8bbbea2;hb=aceb46455ba16b5cfddd8cde528251a57e8a3b56#l1036 openmano_schemas.py]
''instance_scenario_action_schema'' = {
"title":"instance scenario action information schema",
"$schema": "http://json-schema.org/draft-04/schema#",

The documentation states that yaml is expected but the code seem to expect a json.

Same problem for ''openmano/{tenant_id}/instances''

=== REPLY: ===

Code admits both yaml and json based on HTTP header "Content-type:" application/yaml or application/json

"json-schema" is a python library to validate input and, in spite of its name, has no connection at all with json or yaml.

As a side note, for further comments in "talk" sections, please use the "Add topic" option (between "Edit" and "View history"), so that more than one topic can be included.

== Version of the RO ? ==

There is several versions of the RO :https://osm.etsi.org/gitweb/?p=osm/RO.git;a=tags

Should a table explicit the compatibility of this page with each tag ?

Talk:RO Northbound Interface

2017-01-31T09:14:27Z

Berpec:

Several entries on this page are not correct according to what we find in the code.

For example :

'''On the wiki'''
POST /openmano/{tenant_id}/instances/{instance_id}/action
take an action over a scenario instance. Actions can be {start,pause,resume,shutoff,shutdown,forceOff,rebuild,reboot,console}
Params: Content-type: application/yaml

'''In the code we cand read''' [https://osm.etsi.org/gitweb/?p=osm/RO.git;a=blob;f=httpserver.py;h=789e0224c7c6354a49a04d1c56d59e524ee193d1;hb=aceb46455ba16b5cfddd8cde528251a57e8a3b56#l1224 httpserver.py]
@bottle.route(url_base + '/<tenant_id>/instances/<instance_id>/action', method='POST')
def http_post_instance_scenario_action(tenant_id, instance_id):
[...]
#parse input data
http_content,_ = format_in( ''instance_scenario_action_schema'' )

'''And then''' [https://osm.etsi.org/gitweb/?p=osm/RO.git;a=blob;f=openmano_schemas.py;h=ffbacd3adb68428bf143d227f9e6f295b8bbbea2;hb=aceb46455ba16b5cfddd8cde528251a57e8a3b56#l1036 openmano_schemas.py]
''instance_scenario_action_schema'' = {
"title":"instance scenario action information schema",
"$schema": "http://json-schema.org/draft-04/schema#",

The documentation states that yaml is expected but the code seem to expect a json.

Same problem for ''openmano/{tenant_id}/instances''

=== REPLY: ===

Code admits both yaml and json based on HTTP header "Content-type:" application/yaml or application/json

"json-schema" is a python library to validate input and, in spite of its name, has no connection at all with json or yaml.

As a side note, for further comments in "talk" sections, please use the "Add topic" option (between "Edit" and "View history"), so that more than one topic can be included.

== Version of the RO ? ==

There is several versions of the RO :https://osm.etsi.org/gitweb/?p=osm/RO.git;a=tags

Should a table explicit the compatibility of this page with each tag ?

Talk:RO Northbound Interface

2017-01-31T09:11:51Z

Berpec: /* Version of the RO ? */ new section

Several entries on this page are not correct according to what we find in the code.

For example :

'''On the wiki'''
POST /openmano/{tenant_id}/instances/{instance_id}/action
take an action over a scenario instance. Actions can be {start,pause,resume,shutoff,shutdown,forceOff,rebuild,reboot,console}
Params: Content-type: application/yaml

'''In the code we cand read''' [https://github.com/nfvlabs/openmano/blob/master/openmano/httpserver.py#L1066 httpserver.py]
@bottle.route(url_base + '/<tenant_id>/instances/<instance_id>/action', method='POST')
def http_post_instance_scenario_action(tenant_id, instance_id):
[...]
#parse input data
http_content,_ = format_in( ''instance_scenario_action_schema'' )

'''And then''' [https://github.com/nfvlabs/openmano/blob/master/openmano/openmano_schemas.py#L732 openmano_schemas.py]
''instance_scenario_action_schema'' = {
"title":"instance scenario action information schema",
"$schema": "http://json-schema.org/draft-04/schema#",

The documentation states that yaml is expected but the code seem to expect a json.

Same problem for ''openmano/{tenant_id}/instances''

=== REPLY: ===

Code admits both yaml and json based on HTTP header "Content-type:" application/yaml or application/json

"json-schema" is a python library to validate input and, in spite of its name, has no connection at all with json or yaml.

On the other hand, the references to github above are outdated. RO code is available at OSM's RO repo at: https://osm.etsi.org/gerrit/#/admin/projects/osm/RO

As a side note, for further comments in "talk" sections, please use the "Add topic" option (between "Edit" and "View history"), so that more than one topic can be included.

== Version of the RO ? ==

There is several versions of the RO :https://osm.etsi.org/gitweb/?p=osm/RO.git;a=tags

Should a table explicit the compatibility of this page with each tag ?

RO Northbound Interface

2017-01-30T16:33:34Z

Berpec:

==Introduction ==

This document describes the northbound interface of RO (openmano) Release 1.

The Northbound interface is based on REST and it allows performing actions over the
following entities:

* Tenant: Intended to create groups of resources. In this version no security mechanisms are implemented.
* Datacenters: Represents the VIM information stored by openmano.
* VIMs: used to perform an action over a datacenter (specific pool of resources)
* VNFs: SW-based network function, composed of one or several VM that can be deployed on an NFV datacenter.
* Scenarios: topologies of VNFs and their interconnections.
* Instances: Each one of the Scenarios deployed in a datacenter.

===Details===

===HTTP protocol details===
* The HTTP HEADER "X-Auth-Token" is ignored in this version, though it will be available in future. Current version does not support security and authentication
* Server supports JSON (by default), and YAML. Use HTTP HEADER "Content-Type:
application/FORMAT" for specifying the input format and HTTP HEADER "Accept:
application/FORMAT" for the wanted output format. In this version it does not support
the URL suffix .yaml or .json as for example openstack neutron does.
* Server supports URL Query String filters. For example:
HTTP GET /whatever?name1=value1&name2=value2"
Will filter by "name1=value1 AND name2=value2"

* In a near future version it will support pagination using limit, market, page_reverse and field filtering in the same way as openstack neutron.
* Possible responses of HTTP Commands are:
200 Ok
400 Bad Request
404 Not Found
405 Method Not Allowed
409 Conflict
503 Service Unavailable
500 Internal Server Error

==Openmano Server primitives==

===Tenants===
====GET /openmano/tenants====
Gets a list of all tenants

'''Params''': None

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

{
"tenants": [
{
"created_at": "2015-08-06T10:38:07",
"description": "tenant_de_prueba",
"uuid": "76094a2a-3c16-11e5-9fb6-5254004aea96",
"name": "tenanttest"
},
{
"created_at": "2015-12-04T13:06:54",
"description": "A description...",
"uuid": "8293285c-9a7f-11e5-bc4f-5254004aea96",
"name": "John Doe"
}
]
}

====GET /openmano/tenants/{tenant_id}====
Get the full description of the tenant identified by tenant_id (tenant´s name or uuid)

'''Params''': None

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

{
"tenant": {
"created_at": "2015-12-04T13:06:54",
"description": "A description...",
"modified_at": null,
"uuid": "8293285c-9a7f-11e5-bc4f-5254004aea96",
"name": "John Doe"
}
}
====POST/openmano/tenants====
Create new tenant

'''Params''': (Extra parameters are ignored) Content-type: application/json

* name: tenant name provided by the client
* description: (optional) tenant description provided by the client

{
"tenant":
{
"name": "John Doe",
"description": "A description..."
}
}

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

{
"tenant": {
"created_at": "2015-12-04T13:06:54",
"description": "A description...",
"modified_at": null,
"uuid": "8293285c-9a7f-11e5-bc4f-5254004aea96",
"name": "John Doe"
}
}

====PUT /openmano/tenants/{tenant_id}====
Update tenant identified by tenant_id (tenant´s name or uuid)

'''Params''': (Extra parameters are ignored) Content-type: application/json

* name: tenant name provided by the client
* description: (optional) tenant description provided by the client

{
"tenant":
{
"name": "John Doe",
"description": " Unknown person..."
}
}

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

{
"tenant": {
"created_at": "2015-12-04T13:06:54",
"description": " Unknown person...",
"modified_at": null,
"uuid": "8293285c-9a7f-11e5-bc4f-5254004aea96",
"name": "John Doe"
}
}

====DELETE /openmano/tenants/{tenant_id}====
Delete a tenant identified by tenant_id (tenant´s name or uuid)

'''Params''': none

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

{
"result": "tenant 9767ac6e-9a82-11e5-bc4f-5254004aea96 deleted"
}

===Datacenters===

These commands does not affect a concrete VIM, but the openmano information of a VIM

====GET /openmano/{tenant_id}/datacenters====
Get a list of datacenters attached to the tenant identified by tenant_id (tenant´s name or uuid). The parameter 'tenant_id' can be replaced by 'any' to get a list of all datacenters of all tenants.

'''Params''': none.

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

{
"datacenters": [
{
"vim_url": "http://localhost:9080/openvim",
"created_at": "2015-12-09T10:10:00",
"type": "openvim",
"uuid": "a01a4b34-9e54-11e5-bc4f-5254004aea96",
"name": "John_Doe_data_center"
}
]
}

====GET /openmano/{tenant\_id}/datacenters/{datacenter_id}====
Get a the parameters of a datacenter attached to a tenant identified by tenant_id. The parameter 'tenant_id' can be replaced by 'any' to look for the datacenter_id in all tenants.

'''Params''':none

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

{
"datacenter": {
"vim_url": "http://localhost:9080/openvim",
"vim_url_admin": null,
"created_at": "2015-12-09T10:10:00",
"uuid": "a01a4b34-9e54-11e5-bc4f-5254004aea96",
"name": "John_Doe_data_center",
"type": "openvim",
"description": null,
"config": null,
}
}

====POST /openmano/datacenters====
Create a new datacenter

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

* name: name of the datacenter to create
* vim_url: url of the machine where is hold VIM (Openvim) (TBC)
* type: can be openvim, openstack, ...
* config: extra configuration needed by the specific VIM connectors
* description: descriptive text

{
"datacenter":{
"name": "John_Doe_data_center",
"vim_url": "http://localhost:9080/openvim"
}
}

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

{
"datacenter": {
"vim_url": "http://localhost:9080/openvim",
"vim_url_admin": null,
"created_at": "2015-12-09T10:10:00",
"uuid": "a01a4b34-9e54-11e5-bc4f-5254004aea96",
"name": "John_Doe_data_center",
"type": "openvim",
"description": null,
"config": null,
}
}

====PUT /openmano/datacenters/{datacenter\_id_name}====
Modify a datacenter.

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

Params that can be changed are:

* name: datacenter name
* vim_url: vim url

{
"datacenter":{
"name": "new_datacenter_name",
"vim_url": "http://localhost:9080/openvim"
}
}

'''Response''':

If no error, same as "Post /openmano/datacenters"

====GET /openmano/datacenters/{datacenter_id}/networks====

'''Deprecated''': see [[RO_Northbound_Interface#VIMs]]

====POST /openmano/{tenant\_id}/datacenters/{datacenter_id}/action====

'''Deprecated''': see [[RO_Northbound_Interface#VIMs]]

====DELETE /openmano/datacenters/{datacenter_id}====

Delete a datacenter

'''Params''':none

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

{
"result": "datacenter e3042842-9e78-11e5-bc4f-5254004aea96 deleted"
}

====POST /openmano/<tenant\_id>/datacenters/{datacenter_id}====

Attach the datacenter identifiedby datacenter_id and openvim tenant to the openmano tenant

'''Params''': none

'''Response'''

If no error, same as GET /openmano/{tenant\_id}/datacenters/{datacenter_id}

====DELETE /openmano/<tenant\_id>/datacenters/{datacenter_id}====
Detach a datacenter and this tenant

'''Params''': none

'''Response'''

If no error, same as GET /openmano/{tenant\_id}/datacenters/{datacenter_id}

===VIMs===

These commands make actions over a VIM (datacenter)

====GET /openmano/{tenant_id}/vim/{datacenter_id}/networks====
Get a list of VIM networks.

'''Params''': none

'''Response''': Content-type: application/json
{
"networks": [
{
"status": "ACTIVE",
"provider:physical": "macvtap:em1",
"name": "macvtap:em1",
"admin_state_up": true,
"shared": true,
"type": "bridge_man",
"id": "7a6c5bae-65d5-11e6-b9c7-0800273e724c"
},
{
"status": "ACTIVE",
"name": "complex-instance.dataconn1",
"admin_state_up": true,
"tenant_id": "8850b260-65d5-11e6-b9c7-0800273e724c",
"provider:vlan": 3000,
"shared": false,
"type": "ptp",
"id": "8c0e199c-65d5-11e6-b9c7-0800273e724c"
},
{
"status": "ACTIVE",
"name": "complex2-instance.datanet",
"admin_state_up": true,
"tenant_id": "8850b260-65d5-11e6-b9c7-0800273e724c",
"provider:vlan": 3008,
"shared": false,
"type": "data",
"id": "8d764b7e-65d5-11e6-b9c7-0800273e724c"
}
]
}

====GET /openmano/{tenant_id}/vim/{datacenter_id}/{vim_network_id}====
Get details over a VIM network.

'''Params''': none

'''Response''': Content-type: application/json
{
"network": {
"status": "ACTIVE",
"provider:physical": "openflow:port1/8:vlan",
"name": "data_net",
"admin_state_up": true,
"provider:vlan": 3001,
"shared": true,
"type": "data",
"id": "7ab198cc-65d5-11e6-b9c7-0800273e724c"
}
}

====POST /openmano/{tenant_id}/vim/{datacenter_id}/networks====

Add a network at VIM

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

* name: name of the network
* type: type of network (data, ptp, bridge), To be changed to ETSI notation E-LAN, E-LINE
* shared: available for all tenants or private

{
"network":{
"name": "mynet",
"type": "data"
}
}

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

{
"network": {
"status": "ACTIVE",
"name": "mynet",
"admin_state_up": true,
"tenant_id": "8850b260-65d5-11e6-b9c7-0800273e724c",
"provider:vlan": 3009,
"shared": false,
"type": "data",
"id": "a8ac819e-65d8-11e6-b9c7-0800273e724c"
}
}

====DELETE /openmano/{tenant_id}/vim/{datacenter_id}/networks/{vim_network_id}====
Delete a VIM network

'''Params''': none

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

{
"result": "network e97b7158-65d8-11e6-b9c7-0800273e724c mynet deleted"
}

===VNFs===

====GET /openmano/{tenant_id}/vnfs====
Get a list of vnfs. The parameter 'tenant_id' can be replaced by 'any' to obtain also from all tenants.

'''Params''': none

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

{
"vnfs": [
{
"description": "VNF1 description",
"created_at": "2015-08-24T13:41:20",
"uuid": "09c7209c-4a55-11e5-9f62-5254004aea96",
"name": "VNF1",
"path": "/path/to/VNF1.vnfd",
"public": true,
"physical": false
},
{
"description": "VNF1 description"",
"created_at": "2015-09-15T13:22:24",
"uuid": "09d14bf0-5b9c-11e5-a873-5254004aea96",
"name": "VNF2",
"path": "/path/to/VNF2.vnfd",
"public": true,
"physical": false
}
]
}

====GET /openmano/{tenant_id}/vnfs/{vnf_id}====
Get vnf details. The parameter 'tenant_id' can be replaced by 'any' to obtain also from all tenants.

'''Params''': none

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

* VNFC: Array of virtual machines which compose the vnf
* 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

{
"vnf": {
"VNFC": [
{
"description": "VM 1 in the MultiVM template",
"uuid": "09c73a00-4a55-11e5-9f62-5254004aea96",
"name": "VM1"
}
],
"description": "VNF1 description",
"created_at": "2015-08-24T13:41:20",
"uuid": "09c7209c-4a55-11e5-9f62-5254004aea96",
"external-connections": [
{
"vm_name": "VM1",
"external_name": "bridge",
"uuid": "09c75562-4a55-11e5-9f62-5254004aea96",
"type": "bridge",
"vpci": null,
"bw": null,
"internal_name": "eth0",
"vm_id": "09c73a00-4a55-11e5-9f62-5254004aea96"
}
],
"path": "/home/psa/openmano/openmano/vnfrepo/VNF1.vnfd",
"physical": false,
"nets": [],
"public": true,
"name": "VNF1"
}
}

====POST /openmano/{tenant\_id}/vnfs====
Insert a vnf into the catalogue. Try to create the needed flavors and images at all attached VIM, and creates the VNF and its internal structure in the OPENMANO DB

'''Params''':

See at code /vnfs/vnf-template-2vm.yaml and /vnfs/vnf-template.yaml

* '''vnf''':
* '''name''' (required): vnf name
* '''description''' (optional): vnf description
* '''class''' (optional): Used to organize VNFs
* '''public''' (optional): boolean
* '''physical''' (optional): boolean
* '''external-connections''' (required): array of objects. Each one describe a connection that the vnf expose to the outside.
* '''name''' (required): connection name
* '''type''' (required): type of connection. Types availables are: "mgmt","bridge","data"
* '''VNFC''' (required): Name of the internal VM to which this connection is connected. Must match with one of the VM name of the VNF section
* '''local\_iface_name''' (required): interface name of the VM. Must match with one of the interfaces described in the VM description.
* '''description''' (optional): Connection description.
* '''internal-connections''' (optional): Array of objects which describes inner connections between VMs that the vnf contains
* '''name''' (required): inner connection name
* '''description''' (optional): inner connection description
* '''type''' (required): type of connection. Types availables are: "bridge","data","ptp"
* '''elements''' (required): Array of objects. Describes end points of the inner connection
* '''VNFC''': Name of the internal VM to which this connection is connected. Must match with one of the VM name of the VNF section
* '''local\_iface_name''': interface name of the VM. Must match with one of the interfaces described in the VM description.
* '''VNFC''': Array of objects that describes each of the inner VMs. Must contain at least one.
* '''name''' (required): Name of the VM
* '''description''' (optional): Description of the VM
* '''VNFC image''' (required): Path of the image location
* '''image metadata''' (optional)
* '''architecture'''
* '''use_incremental''': "yes" or "no"
* '''vpci''':
* '''os_distro''':
* '''os_type''':
* '''os_version''':
* '''bus''':
* '''processor''' (optional)
* '''model''' (required)
* '''features'''
* '''hypervisor'''
* '''type'''
* '''version'''
* '''ram''': RAM memory of the VM. Only for traditional cloud VMs. Memory in MBytes (not from hugepages, oversubscription is allowed)
* '''vcpus''': Only for traditional cloud VMs. Number of virtual CPUs (oversubscription is allowed).
* '''disk''': disk size in GiB, by default 1
* '''numas''': Array of numa nodes description
* '''memory''': memory in GBytes
* '''cores''' | '''paired-threads''' | '''threads''' (only use one)
* '''cores-id''' (optional): array of integer to specify each core
* '''paired-threads-id''' (optional): Array of paired threads. (i.e:[ [0,1], [2,3], [4,5], [6,7], [8,9] ]) By default follows incremental order
* '''threads-id''' (optional): array of integer to specify each thread
* '''interfaces'''
* '''name''' (required): interface name
* '''dedicated''' (required): available options are "yes"(passthrough), "no"(sriov with vlan tags), "yes:sriov"(sriovi, but exclusive and without vlan tag)
* '''bandwidth''' (required): bandwidth in Mbps or Gbps.
* '''vpci''' (optional): Virtual PCI address
* '''mac_address''' (optional): avoid this option if possible
* '''bridge-ifaces'''
* '''name''' (required): bridge interface name
* '''bandwidth''' (Optional): Informative only
* '''vpci''' (optional): Virtual PCI address
* '''mac_address''' (optional): avoid this option if possible
* '''model''' (optional): ("virtio","e1000","ne2k_pci","pcnet","rtl8139") By default, it is automatically filled by libvirt
* '''devices''': extra devices asigned to the VM. The order determines device letter asignation (hda, hdb, ...)
* '''type''': ("disk","cdrom","xml")
* '''image''': path to image
* '''image''' metadata: device image metadata.
* '''architecture'''
* '''use_incremental'''
* '''vpci'''
* '''os_distro'''
* '''os_type'''
* '''os_version'''
* '''bus'''
* '''vpci''' (optional): depending on the device type (not needed for disk or cdrom)
* '''xml''': xml text for XML described devices

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

====DELETE /openmano/{tenant_id}/vnfs/{vnf_id}====
Deletes a vnf from database, and images and flavors in VIM when appropriate. The parameter 'tenant_id' can be replaced by 'any' when vnf belong to other tenant.

'''Params''': none

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

{
"result": "VNF 1ec2cdac-6779-11e5-bc4f-5254004aea96 deleted"
}

====POST /openmano/{tenant_id}/topology/verify====

Deprecated

Scenarios===
====POST /openmano/{tenant_id}/scenarios ====

'''(TBC)'''

Add a scenario into the catalogue. Creates the scenario and its internal structure in the OPENMANO DB

'''Params''':

see at code /scenarios/scenario-template.yaml

====POST /openmano/{tenant_id}/scenarios/{scenario_id}/action====

'''Deprecated''': use ''POST /openmano/{tenant_id}/instances'' instead
Take an action over a scenario

'''Params''':

* Deploy a scenario: deploy all VNFs of the scenario. Creates a new instance scenario
* '''instance_name''' (required): name of the scenario to deploy
* '''description''' (optional): a description
* '''datacenter''' (optional): name of the datacenter where the scenario will be deployed.

Content-type: application/json:

{
"deploy": {
"instance_name": "scenario1",
"description" : "a description...",
"datacenter" : "mydc"
}
}

* 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:

{
"start": {
"instance_name": "scenario1",
"description" : "a description...",
"datacenter" : "mydc"
}
}

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

* '''instance_name''' (required): name of the scenario to launch
* '''description''' (optional): a description
* '''datacenter''' (optional): name of the datacenter where the scenario will be launched.

Content-type: application/json:

{
"reserve": {
"instance_name": "scenario1",
"description" : "a description...",
"datacenter" : "mydc"
}
}

* 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
* '''description''' (optional): a description
* '''datacenter''' (optional): name of the datacenter where the scenario will be verified.

Content-type: application/json:

{
"verify": {
"instance_name": "scenario1",
"description" : "a description...",
"datacenter" : "mydc"
}
}

====GET /openmano/{tenant_id}/scenarios====
Get a list of existing scenarios for a tenant identified by tenant_id. The parameter 'tenant_id' can be replaced by 'any' to obtain also from all tenants.

'''Params''': none

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

{
"scenarios": [
{
"created_at": "2015-09-15T13:02:07",
"description": "Scenario1 test",
"public": false,
"uuid": "34c4db72-5b99-11e5-a873-5254004aea96",
"name": "Scenario1"
},
{
"created_at": "2015-09-15T09:49:47",
"description": "Scenario2 test",
"public": false,
"uuid": "5638c64e-5b7e-11e5-a873-5254004aea96",
"name": "Scenario2"
}
]
}

====GET /openmano/{tenant_id}/scenarios/{scenario_id}====
Get details about a scenario. The parameter 'tenant_id' can be replaced by 'any' to obtain also from all tenants.

'''Params''': none

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

{
"scenario": {
"description": "Pconcepto-x",
"created_at": "2015-09-15T13:02:07",
"modified_at": null,
"name": "Pconcepto-x",
"vnfs": [
{
"vnf_id": "1f3d9aca-5b7e-11e5-a873-5254004aea96",
"description": "VNF prueba concepto1",
"interfaces": [
{
"sce_net_id": "34c4f26a-5b99-11e5-a873-5254004aea96",
"uuid": "34c5147a-5b99-11e5-a873-5254004aea96",
"interface_id": "1f3dce50-5b7e-11e5-a873-5254004aea96"
}
],
"name": "VNF-pconcepto1",
"nets": [],
"vms": [
{
"description": "prueba para demo",
"interfaces": [
{
"external_name": "bridge",
"uuid": "1f3dce50-5b7e-11e5-a873-5254004aea96",
"vpci": null,
"bw": null,
"internal_name": "eth0",
"model": null,
"type": "bridge",
"net_id": null
},
{
"external_name": "eth1",
"uuid": "1f3de232-5b7e-11e5-a873-5254004aea96",
"vpci": null,
"bw": null,
"internal_name": "eth1",
"model": null,
"type": "bridge",
"net_id": null
}
],
"name": "VMF-pconcepto1",
"image_id": "bbecf86a-5b7a-11e5-a873-5254004aea96",
"flavor_id": "09c350f2-4a55-11e5-9f62-5254004aea96",
"uuid": "1f3db2e4-5b7e-11e5-a873-5254004aea96"
}
],
"uuid": "34c4fefe-5b99-11e5-a873-5254004aea96"
}
],
"nfvo_tenant_id": "76094a2a-3c16-11e5-9fb6-5254004aea96",
"nets": [
{
"description": null,
"vim_id": null,
"name": "default",
"external": true,
"type": "bridge",
"uuid": "34c4f26a-5b99-11e5-a873-5254004aea96"
}
],
"public": false,
"uuid": "34c4db72-5b99-11e5-a873-5254004aea96"
}
}

====DELETE /openmano/{tenant_id}/scenarios/{scenario_id}====
Delete a scenario from database. The parameter 'tenant_id' can be replaced by 'any' if this scenario does not belong to this tenant.

'''Params''': none

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

{
"result": "Scenario 5638c64e-5b7e-11e5-a873-5254004aea96 Scenario2 deleted"
}

====PUT /openmano/{tenant_id}/scenarios/{scenario_id}====
Edit an existing scenario. Only can be edited the scenario name, scenario description, graphical topology of the VNFs and VNF name and description.

'''Params''':

'''(TBC)'''

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

===Instances===
====GET /openmano/{tenant_id}/instances====
Get instance list

'''Params''': none

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

{
"instances": [
{
"description": null,
"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
"created_at": "2016-08-19T13:58:16",
"scenario_id": "34752430-6604-11e6-950f-0800273e724c",
"name": "simple-instance",
"uuid": "369ac0d0-6604-11e6-950f-0800273e724c"
},
{
"description": null,
"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
"created_at": "2016-08-19T13:58:26",
"scenario_id": "349ce93e-6604-11e6-950f-0800273e724c",
"name": "complex2-instance",
"uuid": "3cf18d42-6604-11e6-950f-0800273e724c"
}
]
}

====GET /openmano/{tenant_id}/instances/{instance_id}====
Get instances details. The parameter 'tenant_id' can be replaced by 'any' to obtain also from all tenants.

'''Params''': none

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

{
"uuid": "06e9f0ea-a23c-11e5-bc4f-5254004aea96",
"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",
"datacenter_id": "487c6844-40df-11e5-aaa7-5254004aea96",
"vnfs": [
{
"vnf_name": "VNF1",
"vnf_id": "bbf04ac4-5b7a-11e5-a873-5254004aea96",
"uuid": "06ea139a-a23c-11e5-bc4f-5254004aea96",
"sce_vnf_id": "34753eca-6604-11e6-950f-0800273e724c",
"vms": [
{
"status": "VIM_ERROR",
"uuid": "06ea4aae-a23c-11e5-bc4f-5254004aea96",
"vim_vm_id": "06e7ca2c-a23c-11e5-92d5-5254004aea96",
"created_at": "2015-12-14T09:24:00",
"interfaces": [
{
"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>"
}
]
}
],
"scenario_name": "Scenario x",
"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",
"name": "Instance x"
}

====POST/openmano/{tenant_id}/instances====
Creates a new instance scenario

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

---
instance:
datacenter: 2dd83432-6604-11e6-950f-0800273e724c
name: myinstance
scenario: 34752430-6604-11e6-950f-0800273e724c
schema_version: '0.1'

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

{
"uuid": "6791882a-6610-11e6-b370-0800273e724c",
"tenant_id": "2db5634e-6604-11e6-950f-0800273e724c",
"datacenter_tenant_id": "2e06029a-6604-11e6-950f-0800273e724c",
"description": null,
"scenario_id": "34752430-6604-11e6-950f-0800273e724c",
"datacenter_id": "2dd83432-6604-11e6-950f-0800273e724c",
"vnfs": [
{
"vnf_id": "2fdd9a42-6604-11e6-950f-0800273e724c",
"uuid": "6792d28e-6610-11e6-b370-0800273e724c",
"sce_vnf_id": "34753eca-6604-11e6-950f-0800273e724c",
"vms": [
{
"status": "BUILD",
"uuid": "67937d92-6610-11e6-b370-0800273e724c",
"vim_vm_id": "b52342df-26e3-4456-871e-207138970757",
"created_at": 1471613132.416698,
"interfaces": [
{
"external_name": "eth0",
"instance_net_id": "679233ce-6610-11e6-b370-0800273e724c",
"vim_interface_id": null,
"internal_name": "eth0",
"mac_address": null,
"vim_info": null,
"ip_address": null
}
],
"vim_info": null,
"error_msg": null,
"name": "linux-VM"
}
],
"datacenter_id": "2dd83432-6604-11e6-950f-0800273e724c",
"vnf_name": "linux1",
"datacenter_tenant_id": "2e06029a-6604-11e6-950f-0800273e724c"
}
],
"scenario_name": "simple",
"nets": [
{
"status": "BUILD",
"datacenter_id": "2dd83432-6604-11e6-950f-0800273e724c",
"sce_net_id": "3475351a-6604-11e6-950f-0800273e724c",
"uuid": "679233ce-6610-11e6-b370-0800273e724c",
"datacenter_tenant_id": "2e06029a-6604-11e6-950f-0800273e724c",
"vnf_net_id": null,
"external": false,
"vim_net_id": "bc4e1ac4-831b-4098-ae0a-568d40caefd3",
"vim_info": null,
"error_msg": null
}
],
"created_at": 1471613132.416668,
"name": "myinstance"
}

====DELETE /openmano/{tenant_id}/instances/{instance_id}====
Delete instance from VIM and from database.

'''Params''': none

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

{
"result": "instance c8d1fca2-677c-11e5-bc4f-5254004aea96 deleted"
}

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

'''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" ]

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

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

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:

---
"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)"

Example for a "console" action response with success:

---
"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"
"name": "VNF_2VMs-VM2" #same as 'vnfs':'vms':'name'
"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"
"3cf26f78-6604-11e6-950f-0800273e724c":
"vim_result": 200
"description": "https://alf-vdevelop2:9096/vnc_auto.html?token=31f392f0-fee8-4d91-80a0-437b1149cbf8"
"name": "dataplaneVNF3-VM"

==Miscellaneous ==

===Physicalview===
====GET /openmano/{tenant_id}/physicalview/{datacenter}====

'''Deprecated'''

===Topology===
====POST /openmano/{tenant_id}/topology/deploy====
'''Deprecated'''

Talk:RO Northbound Interface

2017-01-30T16:31:07Z

Berpec: Created page with "Several entries on this page are not correct according to what we find in the code. For example : '''On the wiki''' POST /openmano/{tenant_id}/instances/{instance_id}/ac..."