Prior to the installation process, make sure that:
One of the following supported versions of Linux is installed on your machine:
RedHat/CentOS 7.4
RedHat/CentOS 7.5
RedHat/CentOS 7.6
Python 3 is installed on the machine or run all NEO SDK commands from NEO virtual environment by running "/opt/neo/venv/bin/python".
You have http/https access from your machine (on which NVIDIA ® NEO ® SDK is running) to the machine that you intend to run NEO on.
To download the NEO 2.4 software:
Log into MyMellanox.
Go to Software → Management Software → NEO.
Click the “Downloads” tab and select the required NEO SDK software package.
Click “Download".
The default NEO SDK installation directory is /opt/neo/sdk.
To install NEO SDK software, navigate to the RPM location and install it.
RH7.0:
rpm -ivh neo-sdk-2.3-5.el7.noarch.rpm
NEO SDK contains several Python scripts that communicate with NEO.
To use NEO SDK scripts, navigate to the script directory:
cd /opt/neo/sdk/bin/sdk/
To run NEO SDK scripts, set Python path:
export PYTHONPATH=/opt/neo/sdk/bin/
To view the list of available scripts, run:
ls -1 *.py
Each script contains several arguments that need to be supplied.
To view each script arguments, run:
/opt/neo/venv/bin/python <script>.py -h
To run SDK on a physical machine:
[root@neo_sdk]# cd /opt/neo/sdk/bin/sdk/ [root@neo_sdk]# export PYTHONPATH=/opt/neo/sdk/bin/ [root@neo_sdk]# /opt/neo/venv/bin/python /opt/neo/sdk/bin/sdk/neo_groups.py -s 10.209.24.112 -u admin -p 123456 -r https --port 443 -o getall ====================================================================== <<< NEO - Getting all groups data SDK >>> ---------------------------------------------------------------------- [*] Running Settings: -> NEO server IP address: 10.209.24.112:443 -> NEO user name: admin ====================================================================== [*] Getting all groups data stages: -1- Setting Up data... -2- Sending Getting all groups data request... ====================================================================== [*] Getting all groups data results: >> Getting all groups data request HTTP response status code: 200 >> Getting all groups data request HTTP response text: [{"groupType":"System","elementName":"ConnectX-4-Hosts","description":"NVIDIA ConnectX-4 Hosts Group","instanceID":"group.connectx-4-hontName": "Telemetry-Active","description":"NVIDIA Spectrum Switches With Telemetry Container Capability Group","instanceID":"group.telem","elementName": "Telemetry-Enabled","description":"NVIDIA Spectrum Switches With Telemetry Image Capability Group","instanceID":"group.System","elementName": "Other-Switches","description":"Third Party Switches Group","instanceID":"group.other-switches","hasSettings":falsescription":"ESXi Hosts Group", "instanceID":"group.esxi-hosts","hasSettings":false,"readOnly":true},{"groupType":"System","elementName":"NnstanceID":"group.neo-host-active", "hasSettings":false,"readOnly":true},{"groupType":"System","elementName":"ConnectX-5-Hosts","descriptiosts","hasSettings":false,"readOnly":true}, {"groupType":"System","elementName":"Windows-Hosts","description":"Windows Hosts Group","instaoupType":"System","elementName":"Mellanox-Switches", "description":"NVIDIA Switches Group","instanceID":"group.mellanox-switches","hasSellanox-Spectrum-Switches","description":"NVIDIA Spectrum Switches Group", "instanceID":"group.mellanox-spectrum-switches","hasSettings":sts","description":"Nutanix Hosts Group","instanceID":"group.nutanix-hosts","hasSettings":false, "readOnly":true},{"groupType":"System","etanceID":"group.linux-switches","hasSettings":false,"readOnly":true},{"groupType":"System","elementName": "NEO-Host-Supported","descriptiost-supported","hasSettings":false,"readOnly":true},{"groupType":"System","elementName":"Linux-Hosts","description": "Linux Hosts Group","igroupType":"System","elementName":"Cumulus-Switches","description":"Cumulus Linux Switches Group","instanceID": "group.cumulus-switches","":"Telemetry-Supported","description":"NVIDIA Spectrum Switches With Docker Capability Group","instanceID": "group.telemetry-supported", ======================================================================
To run SDK on a docker container:
[root@neo_sdk]# cd /opt/neo/sdk/bin/sdk/ [root@neo_sdk]# export PYTHONPATH=/opt/neo/sdk/bin/ [root@neo_sdk]# /opt/neo/venv/bin/python /opt/neo/sdk/bin/sdk/neo_groups.py -s 10.213.90.62 -u admin -p 123456 -r https --port 3443 -o getall ====================================================================== <<< NEO - Getting all groups data SDK >>> ---------------------------------------------------------------------- [*] Running Settings: -> NEO server IP address: 10.213.90.62:3443 -> NEO user name: admin ====================================================================== [*] Getting all groups data stages: -1- Setting Up data... -2- Sending Getting all groups data request... ====================================================================== [*] Getting all groups data results: >> Getting all groups data request HTTP response status code: 200 >> Getting all groups data request HTTP response text: [{"instanceID":"group.neo-host-supported","elementName":"NEO-Host-Supported","description":"Hosts Without NEO-Host Installed Group", "groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.mellanox-spectrum-switches","elementName": "Mellanox-Spectrum-Switches","description":"NVIDIA Spectrum Switches Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.linux-switches","elementName":"Linux-Switches","description":"Linux Switches Group","groupType":"System","readOnly":true, "hasSettings":false},{"instanceID":"group.connectx-5-hosts","elementName":"ConnectX-5-Hosts","description":"NVIDIA ConnectX-5 Hosts Group", "groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.nutanix-hosts","elementName":"Nutanix-Hosts","description": "Nutanix Hosts Group","groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.connectx-4-hosts","elementName": "ConnectX-4-Hosts","description":"NVIDIA ConnectX-4 Hosts Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.other-switches","elementName":"Other-Switches","description":"Third Party Switches Group","groupType":"System", "readOnly":true,"hasSettings":false},{"instanceID":"group.telemetry-active","elementName":"Telemetry-Active","description": "NVIDIA Spectrum Switches With Telemetry Container Capability Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.telemetry-enabled","elementName":"Telemetry-Enabled","description":"NVIDIA Spectrum Switches With Telemetry Image Capability Group","groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.esxi-hosts","elementName": "ESXi-Hosts","description":"ESXi Hosts Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.cumulus-switches","elementName":"Cumulus-Switches","description":"Cumulus Linux Switches Group", "groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.windows-hosts","elementName":"Windows-Hosts", "description":"Windows Hosts Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.mellanox-switches","elementName":"Mellanox-Switches","description":"NVIDIA Switches Group","groupType":"System", "readOnly":true,"hasSettings":false},{"instanceID":"group.linux-hosts","elementName":"Linux-Hosts","description":"Linux Hosts Group", "groupType":"System","readOnly":true,"hasSettings":false},{"instanceID":"group.telemetry-supported","elementName":"Telemetry-Supported", "description":"NVIDIA Spectrum Switches With Docker Capability Group","groupType":"System","readOnly":true,"hasSettings":false}, {"instanceID":"group.neo-host-active","elementName":"NEO-Host-Active","description":"Hosts With NEO-Host Installed Group", "groupType":"System","readOnly":true,"hasSettings":false}] ======================================================================
This document contains the usage of each script in detail.