Network Director API Release Notes, Release 1.5

Overview

The Network Director API provides users with a set of software orchestration services that exposes a set of Representational State Transfer (REST) APIs. The REST APIs enable network management functions, including:

Virtualization of cloud and datacenter operations
Provisioning of secure multitenant networks in a shared network infrastructure
Support for Layer 2, Layer 3, security, and Internet services
Support for a single point of integration with external cloud and datacenter orchestration tools

The software image for the Network Director API, Network Director API Reference documentation, and the release notes for Network Director API Release 1.5 are available at: Junos Space and Junos Space Network Director Download page. Before you install or test the Network Director API, see Junos Space Network Management Platform Requirements.

Junos Space Network Management Platform Requirements

The Network Director API Release 1.5 is supported only on Junos Space Network Management Platform Release 13.1P5.

The Network Director API is supported on a Junos Space JA1500 Appliance or a Junos Space Virtual Appliance that meets the hardware requirements specified in the Junos Space documentation. It is not supported on a Junos Space instance running on a Juniper Networks NSM3000 appliance.

Supported Platforms for Network Director API in Release 1.5

The Network Director API supports the following Juniper Networks devices running Junos OS Release 12.3 and later:

EX Series switches
MX Series routers
QFX3500 and QFX3600 switches
QFabric systems
SRX Series Services Gateways

Installation Instructions for Network Director API, Release 1.5

Before you begin to install Network Director API Release 1.5, ensure that the Network Management Platform is at the required release with the latest patch release installed. See Junos Space Network Management Platform Requirements for requirements information.

Note: If you have installed Network Director API Release 1.5 Beta on the same Junos Space appliance, then you must uninstall it before installing Network Director API Release 1.5.

To install Network Director API:

Install or upgrade to Network Management Platform, Release 13.1P5.
Install the Network Director, API Release 1.5.
Once the installation is complete, the system lists the Network Director API in the installed applications list.
Import the network topology and the static configurations.

For detailed instructions about installing Network Director API, see Network Director API Quick Start Guide.

Junos Space DMI Schema Requirements for Network Director API

In most installations, Junos Space automatically matches DMI schemas to device families. But there might be certain situations where your network uses a device for which Junos Space does not have the latest or supported schema available. In such instances, you must obtain and upload the requisite schema and set it as the default DMI schema for each device family. Set a default DMI schema for each device family to enable Junos Space to apply an appropriate schema to a device family.

Table 1 lists the latest DMI schema that you must obtain and upload in Junos Space before you start working on Network Director API Release 1.5:

Table 1: DMI Schemas

Device	Name of the DMI Schema	Device Family
EX4300 EX9200	JUNOS 13.2X50-D10.2	junos-ex
MX Series (applies to Network Director API only)	JUNOS 12.3R4.6	junos
QFabric devices	JUNOS 13.1X50-D15	junos-qf
QFX3500 QFX3600	JUNOS 12.3X50-D30.2	junos-qfx
SRX Series (applies to Network Director API only)	JUNOS 12.1R7.9	junos-es

For detailed steps on acquiring and uploading the schema files, see the Junos Space Documentation or Managing DMI Schemas Overview.

Operational Notes on Device Discovery and Management

For the Network Director API to be able to discover and manage devices, the following protocol ports must be open between the Junos Space Network Management Platform server and the devices:
- Port 22 for SSH connections. If you have changed the SSH port to a port other than port 22 on your Network Management Platform, you must change the SSH ports on your managed devices to the port that the Network Management Platform is using.
- Port 10162 for SNMP traps. the Network Director API receives traps from managed devices on this port. (After you install the Network Director API, use the Network Director API to configure SNMP on your devices to send traps to the Network Director API on this port.)
- Port 21 (TCP) and port 69 (UDP) for uploading the software image and configuration file to the FTP server.
You can verify that the ports are open to the devices by logging in to the Network Management Platform CLI and executing the nmap command. For example, to verify that port 22 is open to a device, enter:
```
root@space# nmap <device-ip-address> -p 22
```

Known Issues in the Network Director API Release 1.5

The following are known issues in the Network Director API Release 1.5.

PR Number	Problem Description
904780	If your network includes an MX Series router and has multiple tenants set up with Layer 3 and Internet access services, each tenant might be able to View the Layer 3 traffic of other tenants on the MX Series router. Workaround: None available at present.
905118	After you use the Network Director API to activate services such as Layer 2 or Layer 3 connectivity on a switch, the access port on the switch is configured with the trunk port mode by default. As a result, the access port cannot communicate with physical (non-virtualized) servers that are part of the services. This issue does not affect virtualized servers. Workaround: In a non-virtualized environment, configure the server port to send the Ethernet frames with VLAN tags: Find the VLAN ID from the NaasService-L2ConnectivityService Enter the following CLI command: sudo vconfig add interface-name VLAN-ID For example: sudo vconfig add eth1 22 This creates a virtual interface eth1.22. Configure this virtual interface with an IP address and add routes as needed (similar to configuring any other physical interface).
905360	After you install the Network Director API, activating NaaS services might fail. Workaround: Restart the JBoss process by issuing the CLI command, service jboss restart, and then activate NaaS services again.
918553	Reactivate with Layer 3 service in QFabric fails in certain scenarios. Workaround: None available at present.
929572	If you install Network Director and the Network Director API after upgrading Junos Space network management platform to Release 13.1P5, the topology import for the Network Director API might not work in some cases. Workaround: Login to the SQL server and execute the command: alter table ServiceAccessPointPeer modify column peerL int(11);
930768	The Network Director API does not support clustered deployment across multiple Junos Space servers in this release. Workaround: Deploy and use the Network Director API in a single Junos Space server environment only.

Known Limitations in the Network Director API Release 1.5

The Network Director API supports running Junos Space in Space as System-of-Record (SSOR) mode only.
Only user accounts with Admin privileges can use Network Director API.