Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Introduction

In recent years, REST (REpresentational State Transfer) has emerged as the standard architectural design for web services and web APIs.

This documentation describes how to integrate Paragon Active Assurance with a network service orchestrator via the Paragon Active Assurance REST API. This is a RESTful API that adheres to the standardized OpenAPI/Swagger 2.0 definition format, thereby enabling easy and efficient orchestration of Paragon Active Assurance tasks. 1

Hands-on examples are given of the principal tasks involved, including:

  • creating and deploying Virtual Test Agents
  • running tests and monitors
  • retrieving results from these activities.

Orchestration through the REST API (that is, using the "write" functions of the API) is available only with on-premise installations of Paragon Active Assurance where the REST API has been installed. Orchestration is not available to users of the Paragon Active Assurance SaaS solution. However, SaaS users do have access to the data retrieval (that is, "read") functions of the REST API.

Conventions

The following abbreviations are used in this document:

Abbreviation Meaning
EM Element Manager
ES Errored Second
MEP MEG (Maintenance Entity Group) End Point (ITU-T Y.1731 definition)
or Maintenance End Point (Cisco definition)
NFV Network Function Virtualization
NFVO Network Function Virtualization Orchestrator
NSD Network Service Descriptor
REST REpresentational State Transfer
SLA Service Level Agreement
S-VNFM Special VNF Manager
VNF Virtual Network Function
vTA Virtual Test Agent