Juniper Contrail Configuration API server documentation

The Juniper Contrail configuration API server allows for manipulation of configuration elements exposed by the VNS. Interaction with this server is possible through either a REST interface or by a python library (which internally uses the same REST API).

This document provides

• Tutorials for using the REST and library interface,
• Generalizes the examples to work on different configuration elements
• Provides tips to use the system effectively
• Reference of the package, module and classes involved.

• REST API Tutorial
  • Create virtual-network and network-policy objects
  • Update virtual-networks to use the policy
  • Read the objects to verify
  • List the virtual-networks
  • Delete the objects
• Library API Tutorial
  • Initialize the library
  • Create virtual-network and network-policy objects
  • Update virtual-networks to use the policy
  • Reading the objects to verify
  • List the virtual-networks
  • Deleting the objects
• REST API Details
  • Discovering API server resources
  • Creating a resource
  • Reading a resource
  • Update a resource
  • Listing Resources
• Library API Details
  • Exceptions
  • Tips
• Rest API Reference
  • vnc_cfg_api_server Package
  • vnc_cfg_api_server Module
  • resource_common Module
  • resource_xsd Module
• Library API reference
  • vnc_api_client_gen Module
  • resource_common Module
  • resource_xsd Module

Indices and tables

• Index
• Module Index
• Search Page