Setting Up the Network Director API
After you install the Network Director API, invoke the API for importing the physical network topology of the NaaS domain. Before you can use the full set of NaaS service resources with the API, you must initialize the NaaS domain and import static configurations to your managed devices.
After you initialize the NaaS service, you can enable features on the devices in the NaaS domain by importing (pushing) static configurations of each feature to the devices.
Initializing the NaaS Domain
As the network administrator, you initialize the NaaS domain by importing the physical topology. The Network Director API then performs a discovery of the devices in the NaaS domain. When the device discovery is complete, all devices in the topology are ready for configuration.
Before you begin, make sure that:
- The network and devices are running.
- Network Director API 1.5 is installed.
To initialize the Network Director API by importing the NaaS domain topology:
- Prepare an XML file containing the physical topology of
your network. This topology has the same components and devices as
the NaaS domain. Include the required information such as system name
(for each device), revenue port interface names, and linked interface
information.
For more information, see Network Director API Setup Sample Files.
- In your REST API client, send an HTTP POST request by
using the following input:
- Content-Type = application/vnd.juniper.nd.import-topology-xml-request+xml;version=1;charset=UTF-8
- URL=https://host-ip/api/juniper/nd/import-topology-xml
- Include the content of your topology file in the POST content.
Importing a topology results in one of three conditions:
- SUCCESS—All the details in topology are valid, and the corresponding components are added and updated successfully in the Network Director API repository. A NaaS domain is created and its ID returned. You may proceed to the next task of pushing configuration files to devices.
- PARTIAL_SUCCESS—The topology file contains errors
for one or more systems. Issues may include an invalid revenue port
name or number, or an unreachable device. A NaaS domain is created
and its ID returned.
Note: If the return condition is PARTIAL_SUCCESS, you may proceed to the next task of pushing configuration files to devices. However, if the topology contains an error for a device or port, you might not be able to configure that component in the future. We recommend that you correct or remove the error and reimport the topology file.
- FAILURE—The topology file contains severe errors, resulting in cancellation of the topology import. A NaaS domain is not created. You must correct the errors and reimport the topology file.
Pushing Static Configuration Files to Devices
After the physical topology is imported into the Network Director API repository and the NaaS domain is initialized, all managed devices specified in the topology must be configured. We recommend that you push the static configuration files of supported features to the devices at this time. Static configurations are typically stable configurations, but they could be updated in the future if necessary. For example, to enable BGP on a device, you must push the static configuration file for BGP to the device. Pushing static configuration files to your devices enables them to be managed and configured by using the Network Director API.
To push a static configuration file to your devices:
- Prepare a static configuration file for each feature,
for example, BGP.
For more information, see Network Director API Setup Sample Files.
- In your REST API client, send an HTTP POST request by
using the following input:
- Content-Type= application/vnd.juniper.nd.configuration-push+xml;version=1;charset=UTF-8
- URL=https://server-ip/api/juniper/nd/configuration-push/device host name
- Include the content of your static configuration file in the POST content.
- Repeat Step 2 for each device in your topology.
