NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Revision History

Revision

Date

Description

2.6.2

October 22, 2020

First release of NVIDIA Mellanox Compact-NEO-on-a-Switch

Version

Date

Description

2.7.10

July 27, 2021

No changes

2.7.10

January 27, 2021

No changes

2.7

August 06, 2020

Added:

Updated:

2.6

April 12, 2020

Added:

Updated:

2.5.1

December 02, 2019

No changes were made to this version

2.5

September 26, 2019

Added:

Updated:

Removed section Network Bring-Up and its subsections

2.4

April 30, 2019

Added:

  • Section "Generate Dump”

  • Section “Create a New Generate Dump Task”

  • Section “Get a Service Configuration Status of a Specific Service Type”

  • Section “Get a Service Validation Status of a Spe­cific Service Type”

  • Section “Generate Dump” (and its subsections)

  • Section “Network Bring-up” (and its subsections)

Updated:

  • Section “Device/Group Actions REST API”

  • Section “Get Heatmap Grouped Systems”

  • Removed all “ecomode” references

  • Section “Dropped Packets Statistics”

  • Section “Dropped Packets Data”

2.3

January 30, 2019

No changes were made to this version

2.3

November 29, 2018

Added:

  • Section “Get Events Summary”

  • Section “RoCE Events REST API”

  • Section “Get RoCE Events”

  • Section “Get RoCE Events Summary”

  • Section “Get RoCE Monitoring Data”

  • Section “Get Last Snapshot”

  • Section “Get Service Settings”

  • Section “Discovery Settings REST API”

  • Section “Dropped Packets Statistics”

  • Section “Dropped Packets Data”

Updated:

  • Section “Events REST API”

2.2

August 5, 2018

No changes were made to this version

2.1

March 3, 2018

Added:

  • Section “Docker Actions” (and its subsections)

  • Section “Transceiver Diagnostics”

  • Section “Transceivers REST API” (and its subsections)

  • Section “NEO Telemetry Agent REST API” (and its subsections)

  • Section “Protocol Settings REST API”

  • Section “Configure RoCE Device Input Data”

  • Section “Backup and Restore” (and its subsections)

Updated:

  • Changed MLNX-OS to Mellanox Onyx throughout the document

  • Section “Get Members in Group”

  • Section “Get Systems with Properties in Group”

  • Section “Systems Links REST API”

  • Section “Transceivers REST API”

  • Section “Get Credentials (All Protocols for Specified Object)”

  • Section “Get Events”

  • Section “Get Monitoring Data”

  • Section “Get All Events Policies”

  • Section “Get Event Policy”

  • Section “Update Event Policy”

  • Section “Configure-MLAG Input Data”

  • Section “RoCE Input Data”

  • Section “Modify Service Parameters”

  • Section “Get Syslog”

2.0.5

November 30, 2017

No changes were made to this version

2.0

November 5, 2017

Added:

  • Section “Protocol Settings REST API”

  • Section “Network Snapshots”

  • Section “Create a New Apply Configuration Task”

Updated:

  • Section “Links REST API”

  • Section “Login REST API”

  • Section “Get Ports”

  • Section “Systems Ports”

  • Section “Syslog REST API”

  • Section “Apply Configuration Using Configuration Files with Parameters”

1.9

June 29, 2017

Added:

  • Section “NEO-Host Install/Uninstall”

  • Section “Apply Configuration”

  • Section “RoCE Input Data”

  • Section “Edit a Configuration File”

  • Section“Discovery REST API”

Updated:

  • Section “Get Systems”

  • Section “Add Systems”

  • Section “Get all Available Systems for all Groups”

  • Section “LAGs REST API”

  • Section “Systems LAGs”

  • Section “Get Specific LAGs”

  • Section “Configuration Tools REST API”

Removed:

  • “Delete all Configuration Files”

1.8

January 3, 2017

Added:

  • Section “Get Groups by Type”

  • Section “NIC Capabilities REST API”

  • Section “Profile REST API”

  • Section “Filter Ports by Adapters”

  • Section “Task Sequence REST API”

  • Section “Update Task”

Updated:

  • Section“Groups REST API”

  • Section “Tasks REST API”

  • Section “Modules REST API”

Removed:

  • Lossless Fabric Input Data

1.7

September 29, 2016

Added:

  • Section “Port Provisioning REST API”

  • Section “Transceivers REST API”

  • Section “Get all Available Systems for all Groups”

  • Section “High Availability REST API”

  • Section “Syslog REST API”

  • Section “Modify Service Parameters”

  • Section “L3 Network Provisioning Input Data”

  • Section “Performance REST API”

Updated:

  • Section “Device/Group Actions REST API”

1.6

April 30, 2016

Added:

  • Section “LAGs REST API”

  • Section “Mellanox Care REST API”

  • Section “Maintenance Mode REST API”

  • Section “Mellanox Care REST API”

  • Section “Heatmap REST API”

  • Section “Live Monitoring REST API”

  • Section “Services REST API”

  • Section “Download Logs REST API”

Updated:

  • Section “Get Event Policy”

  • Section “Update Event Policy”

  • Section “Network Notifications REST API”

  • Section “All Available Templates for Mellanox Switches”

Removed:

  • Systems Running Configuration REST API section

1.5

December 3, 2015

Updated:

  • Section “Get All Templates”

  • Section “General Templates”

  • Section “Ethernet Templates”

  • Section “Links REST API”

1.3

November 26, 2015

Updated section “Provisioning Examples”

November 2015

Added:

  • Section “Templates REST API”

  • Section “Provisioning REST API”

  • Section “Create a New Provisioning Task Using Template Name”

  • Section “Create a New Software Upgrade Task”

  • Section “Create a New Reboot Task”

Updated:

  • Section “Create New Task”

1.2

August 2015

Added:

  • Section “Templates REST API”

Updated:

  • Generic URLs

1.1

July 2015

Initial release

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.