Cisco Cisco Virtual Topology System 2.3 Developer's Guide

VTS 2.3 Developer Guide

2.2 Key Concepts

The VTC northbound API is a REST API over HTTPS. A VM managing entity is

assumed to create VMs and call the VTC APIs to provide the required information for

the creation of the virtual networks.

For security reasons the API implements certificate-based validation both on client

side (the Managing Entity) and server side (VTC). The user is responsible for creating

and uploading the server-side certificate in VTC, as well as creating and using the

certificate on the client side. Instructions for the upload of certificate are specified in

section 4.4.

3 Preparing to Use the VTS 2.3 API

The VTC NB API is used to provision the VTC with all hardware VTEPS that it

controls, as well the networks, subnets and VMs that will be deployed on the compute

servers.

3.1 Requirements

In order to exercise the API you should be able to issue https requests to VTC. This

can be done by a binary or script. This document provides client-side examples using

the curl command.

3.2 Installing the VTS 2.3 API

The VTS 2.3 API uses server-side certificate for security. The VTS 2.3 comes with

default server-side certificate. The user is responsible for creating and replacing such

certificates if needed.

3.2.1 Installing Certificates

 Key-file: Specifies which file that contains the private key for the certificate

Copy the key file to /etc/ncs/ssl/cert/host.key

 Cert-file: Specifies which file that contains the server certificate.

Copy the cert file to /etc/ncs/ssl/cert/host.cert

 restart the VTS server process:

sudo service ncs restart

3.2.2 REST Semantics

 Retrieving a Resource