Update Nsx Configuration

Update Nsx Configuration
Modify NSX Configuration

Updates an existing NSX Manager configuration identified by UUID. Validates the new configuration before applying changes.

Request
URI
PUT
https://{server}:9443/api/admin/global/config/nsx/{uuid}
COPY
Path Parameters
string
uuid
Required

The UUID of the NSX Manager configuration to update

uuid example
b2c3d4e5-f6a7-8901-bcde-f12345678901
Request Body
NsxPutRequestBody of type(s) application/json
Required 
{
    "data": {
        "items": [
            {
                "config": {
                    "UUID": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
                    "url": "https://nsx-manager.example.com",
                    "userName": "admin",
                    "password": "TlNYUGFzc3dvcmQxMjMh"
                }
            }
        ]
    }
}
object
data
Optional

data

Authentication
This operation uses the following authentication methods.
Responses
200

NSX configuration updated successfully

Returns NsxGetResponse200 of type(s) application/json 
{
    "data": {
        "items": [
            {
                "section": "nsx",
                "config": {
                    "userName": "admin",
                    "url": "https://nsx-manager.example.com",
                    "nsxuuid": "77130142-9600-c190-c074-3b2959321085",
                    "vcuuid": "52a3f5d7-8b9c-4e1d-a2f3-6b8c9d0e1f2a",
                    "vcuuids": [
                        {
                            "build": "25042376",
                            "server": "10.192.18.130",
                            "version": "9.1.0",
                            "fullName": "VMware vCenter Server 9.1.0.0.25042376",
                            "apiVersion": "9.1.0.0.0000",
                            "instanceUuid": "f1e7b2a1-51fa-401a-a3b6-8f0642bfaa57"
                        }
                    ],
                    "UUID": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
                    "version": "4.1.2",
                    "auth": {
                        "authType": "BASIC"
                    },
                    "type": "NSX-T"
                }
            }
        ]
    }
}
object
data
Required

data


400

Bad request - validation failed or SSL certificate error

{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}

404

Configuration not found

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Failed modify item: b2c3d4e5-f6a7-8901-bcde-f12345678901, section: nsx. Config does not exists.",
    "httpStatusCode": 404
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error - update failed

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Unable to update NSX configuration",
    "httpStatusCode": 500
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/nsx/{uuid}
On This Page
Nsx Configuration Operations
GET
Get Nsx Configuration
POST
Add Nsx Configuration
PUT
Update Nsx Configuration