This document provides information on how to use NVIDIA® NEO® software development kit (SDK) and lists several examples and use cases.
Intended Audience
This manual is intended for the use of NEO customers: integrators, DevOps and developers.
Abbreviations
|
Abbreviation |
Description |
|
NEO |
NEO – Cloud Orchestration and Management Software |
|
NEO – REST API |
Presents API usage examples which are exposed to NEO users |
|
REST |
Representational State Transfer |
|
API |
Application Programming Interface |
|
OS |
Operating system (In this context, referring to the OS installed or currently active on a switch) |
|
NVIDIA Onyx |
NVIDIA Operating system running on NVIDIA switches |
|
SDK |
Software Development Kit |
|
CLI |
Command Line Interface |
Resource Definitions
|
Abbreviation |
Description |
|
Access Credentials |
Access Credential objects (Username and Password) for all available protocols (SSH, HTTP, SNMP, and SNMPv3). |
|
Groups |
Used to logically group managed elements and assign credentials to groups of devices. Users can set specific Access Credentials for groups. They can also add systems as members of these groups. |
|
Systems |
The devices discovered by NEO. For supported systems, NEO provides details such as inventory, operating system, ports etc. |
|
Ports |
Discovered ports (of the systems). For supported systems, NEO provides details such as speed, technology, etc. |
|
Inventories |
Reported inventory items (FRUs) of all the supported systems. |
|
Links |
Discovered links (between interconnected ports). |
|
Events |
System and application events generated by NEO. |
|
Jobs |
Represents running/created/pending/completed jobs in NEO. A job is created when a system’s/ user’s flow/ action is submitted for processing. |
|
Reports |
Stored statistical reports. |
|
Tasks |
Created tasks. Tasks allow to run an operation on devices or groups on demand or schedule it to run at any desired time/interval. |
|
Templates |
Switch’s configuration templates that are supported by NEO. |
|
Capabilities |
A class that describes abilities and/or potential for use. |
|
Logs |
NEO system logs that can be used for debugging purposes. |
|
Users |
NEO users and their attributes. |
|
Providers |
Connected NEO service modules, their details and status. |
|
Services |
Used to provision complex configurations on multiple devices, and upon completion, constantly monitors these configurations. |