Help

Support

🛠️ Support Made Simple! Users can easily connect with Aviz Support for any issues or assistance they need. 💬🤝

Documentation

📚 Documentation Anytime, Anywhere! Users now have the privilege to access GitBook directly from the application — no active internet connection required on the local machine. 🚀✨

API-Explorer

ONES Apps API Aviz Networks is redefining open-source networking with cloud-native, AI-powered applications for multi-vendor fabrics. 🚀 With ONES Apps APIs, users can seamlessly integrate telemetry into their in-house applications, enabling real-time observability, orchestration, and assurance across data center and edge networks.

Built to be platform and ASIC agnostic, these APIs ensure SONiC becomes ubiquitous, intelligent, and accessible for every stakeholder. Aviz stands as your trusted partner for Open, Cloud, AI-first networking, making every step of your SONiC journey a success.

Telemetry APIs

354KB

ONESAPI.pdf

PDF

Open

Sample APIs for Fabric Management

Simplified Day 1 Orchestration

API	uploadDay1Config
Description	Intent Driven orchestration -Performs Day 1 fabric orchestration for various Data Center topologies.This method will initiate the Day-1 orchestration depending on the topology and intent supplied via template file. This REST API allows network operators to upload an entire intent file (yaml-based) and orchestrate the entire fabric in a desired intent based underlay and overlay. For example, if customers want to provision BGP as an underlay and VXLAN as an overlay ,they can operate the template form and provide minimum parameter inputs , with the rest of the derivation and parameters handled by the ONES application.
Parameters	<Intent YAML file- Path to Template file > Output:< Intent ID> Input Parameter for the REST API call - Template file for the intent configuration for the whole fabric switches enrolled with ONES
Response	Returns the intent ID which is an unique tag mapped to the specific intended input configuration desired by the network operator while defining the intended configuration with only specific desired network entities
Example	POST /uploadDay1Config HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: 10.x.x.6:8787 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 Input configure_az_1.yaml Response: configure_az_1.yaml_20230223115541

Get Day 1 Operational Status

API	getDay1ConfigStatus
Description	getDay1ConfigStatus- Retrieve Generic Intent Status for provisioning over SONiC enabled fabric switches . This REST API allows network operators to get the status of orchestration progress on a specific switch in a SONiC fabric enrolled with ONES application
Parameters	Input: <Intent ID> Output: JSON (status) Input Parameter for the Rest API call - Intent ID for the intent configuration for the complete fabric switches enrolled with ONES
Response	Return the Intent Status for the Day 1 orchestration.
Example	GET/getDay1ConfigStatus?intentID=configure_az_1.yaml_20230223115541 HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: 10.x.x.6:8787 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 Response[ { "intentName": "SNMPServer", "ip": "10.x.x.69", "verification_status": "1", "config_status": "1", "logs": "" },]</pre></td>

ZTP Upgrade SONiC NOS Image

API	enableZTPUpgrade
Description	ZTP upgrade - Perform SONiC upgrade using ZTP mechanism for a specific image and configuration file. Use Case is to support image management for network operators running SONiC fabric Both ZTP image upgrade enables network operators to change the version of the operating Sonic NOS during maintenance window
Parameters	REST API Input parameter : `<`Input Device IPs`>` ZTP enable image upgrade by network operators use case is to change the version of the Sonic NOS during the maintenance window . Following are the REST API call signatures for the same. REST API: enableZTPUpgrade Type: POST
Response	Response: true/False Returns status true, if ZTP enabled upgrade to SONiC enrolled devices is successful Returns status false, if ZTP enabled upgrade to SONiC enrolled devices is unsuccessful
Example	POST /enableZTPUpgrade HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: localhost:8080 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 ["10.x.x.10", "10.x.x.11"]

Custom Upgrade SONiC NOS Image

API	upgradeNOSImage
Description	Custom Image Upgrade for Sonic devices . Performs custom image upgrades for specific enrolled sonic devices only. Custom image management via ONES application. ONES application needs the following #information as the input - - List of devices (IP address or host name) for the upgrade image operation. - Image path and user credentials to scp server
Parameters	REST API Input Parameter : Input Parameters: one or more device ip address
Response	Response: True/False- Returns True status , if image upgrade to SONiC devices is successful Returns False Status , if Image upgrade to SONiC devices is unsuccessful
Example	POST /upgradeNOSImage HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: localhost:8080 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 [{"ip":"10.x.x.67","pathToImage":"http://10.x.x.10:8191/mnt/ws/ images/SONiC-mellanox-e8daeacd.bin"}]

Show Difference between golden and running config

API	getConfigDiff
Description	Leveraging this REST API call, Operators get a view on difference between running configuration and applied configuration on enrolled devices
Parameters	REST API Input Parameter : < List of device IPs for which Configuration difference is required >
Response	API Response is the difference of running configuration vs Applied configuration through ONES fabric manager
Example	POST /getConfigDiff HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: localhost:8080 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 Input { "ip": "10.x.x.66", “diff_only”: “false”} Response: current config on device vs config done via FM { "orchestrated_config": "Last login: Fri Sep 30 11:44:05 2022 from 10.x.x.150\r\r\nsave\nsave\r\n\rSN2100-Leaf1# save\r\n\r Saving Configuration\r\n\rSN2100-Leaf1# show run\show run\r\n\r configure terminal\r\nrouter-id 3.0.0.2\r\nntp add 128.138.141.172<br /> r\nclock timezone Asia/Kolkata\r\nsyslog add 10.x.11\r\snmp-server trap modify }

Backup Current running Config

API	backupConfig
Description	After Sonic enabled DC fabric switches are orchestrated completely using Aviz’s ONES REST API , Network operators can take the backup of running configuration on SONiC switches at any time instance ONES network operators can leverage REST API calls to validate the available configuration snapshot of specific devices at any time instance . This REST API will list the existing backups already taken for specific devices. Operators have the option to Timestamp the label while restoring the configuration
Parameters	Input Parameters: List of Device IP , User label defined by operator for each backup configure saved by ONES application
Response	Response : True/false Return True status , If backup of current running configuration goes successful by ONES Return false status , If backup of current running configuration goes unsuccessful by ONES
Example	POST /backupConfig HTTP/1.1 Content-Type: application/json; charset=utf-8 Host: localhost:8080 Connection: close User-Agent: Paw/3.4.0 (Macintosh; OS X/12.3.0) GCDHTTPRequest Content-Length: 61 [{"ip":"10.x.x.10","label":"test label"}]