NEO Users

NVIDIA Docs Hub NVIDIA Networking Networking Software NVIDIA NEO SDK v2.7.20 NEO Users

Script Information

File Name	neo_users.py
Description	This SDK manipulates NEO user data using NEO's REST API. The script includes the following main operations: 'add' – Add a new user 'get' – Get an existing user 'getall' – Get all existing users 'update' – Update an existing user 'delete' – Delete an existing user
Usage	neo_users.py [-h] -s SERVER -u USERNAME -p PASSWORD [-r {http,https}] --port {80,443,3080,3443} -o {delete,add,getall,update,get} [-d PAYLOAD] [-t PARAMETERS]
Arguments	-h	Displays the help menu
	-s SERVER	NEO server IP
	-u USERNAME	NEO username
	-p PASSWORD	NEO password
	--port	The port used to communicate with NEO. If NEO is run on a physical machine: Port 80 is used for HTTP Port 443 is used for HTTPS If NEO run on a docker container: Port 3080 is used for HTTP Port 3443 is used for HTTPS
	-r {http,https}	Connection protocol to NEO
	-o {add,get,getall,update,delete}	Script operations
	-d PAYLOAD	Payload attributes. Valid format: attrib1=value1&attrib2=value2
	-t PARAMETERS	URL parameters. Valid formats: attrib1=value1&attrib2=value2 attrib=[value1,value2]

Script Options

'add'

Required Arguments
Payload	'username' - The username of the new user 'password' - The password of the new user 'role' - The role of the new user: user/administrator

Output example:

Copy
Copied!

            
            [root@ufm_sdk]# /opt/neo/venv/bin/python neo_users.py -s 10.209.37.77 -u admin -r https --port 443 -p 123456 -o add -d "username=shachar&password=12345&role=user"
======================================================================
<<< NEO - Adding user SDK >>>
----------------------------------------------------------------------
[*] Running Settings:
 -> NEO server IP address: 10.209.37.77
 -> NEO user name: admin
======================================================================
[*] Adding user stages:
 -1- Setting Up data...
 -2- Sending Adding user request...
======================================================================
[*] Adding user results:
>> Adding user request HTTP response status code: 201
======================================================================

'get'

Required Arguments
Parameters	'username' - The username of an existing user

Output example:

Copy
Copied!

            
            [root@ufm_sdk]# /opt/neo/venv/bin/python neo_users.py -s 10.209.37.77 -u admin -r https --port 443 -p 123456 -o get -t
"username=shachar"
======================================================================
<<< NEO - Getting user data SDK >>>
----------------------------------------------------------------------
[*] Running Settings:
 -> NEO server IP address: 10.209.37.77
 -> NEO user name: admin
======================================================================
[*] Getting user data stages:
 -1- Setting Up data...
 -2- Sending Getting user data request...
======================================================================
[*] Getting user data results:
>> Getting user data request HTTP response status code: 200
>> Getting user data request HTTP response text:
[
	{
		"username": "shachar",
		"role": "user"
	}
]
======================================================================

'getall'

Output example:

Copy
Copied!

            
            [root@ufm_sdk]# /opt/neo/venv/bin/python neo_users.py -s 10.209.37.77 -u admin -r https --port 443 -p 123456 -o getall
======================================================================
<<< NEO - Getting all users data SDK >>>
----------------------------------------------------------------------
[*] Running Settings:
 -> NEO server IP address: 10.209.37.77
 -> NEO user name: admin
======================================================================
[*] Getting all users data stages:
 -1- Setting Up data...
 -2- Sending Getting all users data request...
======================================================================
[*] Getting all users data results:
>> Getting all users data request HTTP response status code: 200
>> Getting all users data request HTTP response text:
[
	 {
		"username": "admin",
		"role": "administrator"
	},
	{
		"username": "shachar",
		"role": "user"
	}
]
======================================================================

'update'

Required Arguments
Parameters	'username' - A username of an existing user
Payload	'password' - The new password for the user 'old_password' - The old password for the user 'role' - The new role of the user: user/administrator

Output example:

Copy
Copied!

            
            [root@ufm_sdk]# /opt/neo/venv/bin/python neo_users.py -s 10.209.37.77 -u admin -r https --port 443 -p 123456 -o update - t "username=shachar" -d "password=12345&old_password=12345&role=user"
======================================================================
<<< NEO - Updating user SDK >>>
----------------------------------------------------------------------
[*] Running Settings:
 -> NEO server IP address: 10.209.37.77
 -> NEO user name: admin
======================================================================
[*] Updating user stages:
 -1- Setting Up data...
 -2- Sending Updating user request...
======================================================================
[*] Updating user results:
>> Updating user request HTTP response status code: 202
======================================================================

'delete'

Required Arguments
Parameters	'username' - A username of an existing user

Output example:

Copy
Copied!

            
            [root@ufm_sdk]# /opt/neo/venv/bin/python neo_users.py -s 10.209.37.77 -u admin -r https --port 443 -p 123456 -o delete -t username="shachar"
======================================================================
<<< NEO - Deleting user SDK >>>
----------------------------------------------------------------------
[*] Running Settings:
 -> NEO server IP address: 10.209.37.77
 -> NEO user name: admin
======================================================================
[*] Deleting user stages:
 -1- Setting Up data...
 -2- Sending Deleting user request...
======================================================================
[*] Deleting user results:
>> Deleting user request HTTP response status code: 204
======================================================================

On This Page

Script Information

Script Options

'add'

'get'

'getall'

'update'

'delete'