Profile

Description

Creates a new profile

Request URL

POST /neo/app/profiles/images/{profile_type}/{profile_name}

Request data:

Copy
Copied!
            

{ "parameters": {   description: "desc", protocol: "scp", server: "127.0.0.1", path: "/tmp", image: "a.tar.gz", username: "user", password: "pass" } }

Warning

Profile name should not contain spaces.

Description

Modifies the specified profile

Request URL

PUT /neo/app/profiles/images/{profile_type}/{profile_name}

Request data:

Copy
Copied!
            

{ "parameters": {   description: "desc", protocol: "scp", server: "127.0.0.1", path: "/tmp", image: "a.tar.gz", username: "user", password: "pass" }

Description

Deletes the specified profile

Request URL

DELETE /neo/app/profiles/images/{profile_type}/{profile_name}

Get All Profiles

Description

Get all the profiles

Request URL

GET /neo/app/profiles/images

Request Data

N/A

Response:

Copy
Copied!
            

[ { "type": "ofed_install", "name": "profile1", "parameters": { "username": "", "protocol": "shared_folder", "description": "test", "image": "img.tar.gz", "server": "", "path": "/tmp", "password": "" }, "dateModified": "2016-12-01 14:54:50" } ]


Get All Profiles of Specific Type

Description

Gets all the profiles of specific type

Request URL

GET /neo/app/profiles/images/{profile_type}

Request Data

N/A

Response

See code directly below

Status Codes

  • 200 OK

    Profile modified successfully

  • 404 NOT FOUND

    Invalid profile type

  • 500 INTERNAL SERVER ERROR

    Server failed for an internal reason

Response:

Copy
Copied!
            

[ { "type": "ofed_install", "name": "profile1", "parameters": { "username": "", "protocol": "shared_folder", "description": "test", "image": "img.tar.gz", "server": "", "path": "/tmp", "password": "" }, "dateModified": "2016-12-01 14:54:50" } ]


Get Specific Profile

Description

Gets the specified profile

Request URL

GET /neo/app/profiles/images/{profile_type}/{profile_name}

Request Data

N/A

Response:

Copy
Copied!
            

[ { "type": "ofed_install", "name": "profile1", "parameters": { "username": "", "protocol": "shared_folder", "description": "test", "image": "img.tar.gz", "server": "", "path": "/tmp", "password": "" }, "dateModified": "2016-12-01 14:54:50" } ]


Description

Manage folder and image file profiles for use in NEO UI.

Request URL

/neo/app/profiles/images/

Profile types

  • OFED image (ofed_install)

  • Onyx image (sw_upgrade)

  • Docker image (image_docker)

  • Remote folder (remote_folder)

  • Main Operations

  • Create profile

  • Modify Profile

  • Delete profile

  • Get profile

Response:

Copy
Copied!
            

[ { "type": "ofed_install", "name": "profile1", "parameters": { "username": "", "protocol": "shared_folder", "description": "test", "image": "img.tar.gz", "server": "", "path": "/tmp", "password": "" }, "dateModified": "2016-12-01 14:54:50" } ]

This allows the user to upload image file to NEO, and let NEO maintain it and use it to upgrade switches.

Upload Image

Description

Upload image file to NEO

Request URL

/app/profiles/images/< profile_type >/images /<image>

Profile types

Onyx image (sw_upgrade)


Get Image

Description

Get all SW image files saved internally on NEO

Request URL

/app/profiles/images/<profile_type>/images

Profile types

Onyx image (sw_upgrade)

Response:

Copy
Copied!
            

[{"id":"1","filename":"test1.img","LastDateModified":"2019-12-09 13:55:31"}]


Delete Image

Description

Remove image file from NEO

Request URL

/app/profiles/images/< profile_type >/images /< image>

Profile types

Onyx image (sw_upgrade)


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