NSX-T Data Center REST API

Update service manager

Update service-manager which is registered with NSX with basic details like name, username, password.

Request:

Method:

PUT

URI Path(s):

/api/v1/serviceinsertion/service-managers/<service-manager-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ServiceManager+

ServiceManager (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_scheme	Scheme to authenticate requests sent to the server A CallbackAuthenticationScheme that describes how notification requests/callbacks from NSX, should authenticate to the server.	CallbackAuthenticationScheme	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
port	Integer port value to specify a HTTPS port Integer port value to specify a standard/non-standard HTTPS port.	integer	Required Minimum: 0 Maximum: 65535
resource_type	Must be set to the value ServiceManager	string
server	IP address or fully qualified domain name of server IP address or fully qualified domain name of the partner REST server.	string	Required
service_ids	Service IDs The IDs of services, provided by partner.	array of ResourceReference	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
thumbprint	Thumbprint of the certificate for partner console Thumbprint (SHA-256 hash represented in lower case hex) for the certificate on the partner console. This will be required to establish secure communication with the console and to avoid man-in-the-middle attacks.	string
uri	URI notification requests should be made on the server URI on which notification requests should be made on the specified server.	string	Required
vendor_id	Vendor ID Id which is unique to a vendor or partner for which the service is created.	string	Readonly

Example Request:

PUT https://<nsx-mgr>/api/v1/serviceinsertion/service-managers/34ab3b14-5b73-424b-b521-6d1cabd7c151 { "display_name":"SampleVendor Antivirus", "vendor_id":"SampleVendor1234", "service_ids": [{ "target_id": "ea9ae885-d3ec-4acc-8194-d5d96dc569cd", "target_type": "ServiceDefinition" }], "server": "10.0.0.1", "port": 12345, "uri": "/nsx-notifications", "authentication_scheme": { "scheme_name": CERTIFICATE, "certificate_id": "5e1a209d-5319-4342-9222-8809499c4927" }, "thumbprint":"0a8b3a7062e4c1405623a2365d56d63a83c890617234222c0b0dd8a6152ddf0d" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceManager+

ServiceManager (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_scheme	Scheme to authenticate requests sent to the server A CallbackAuthenticationScheme that describes how notification requests/callbacks from NSX, should authenticate to the server.	CallbackAuthenticationScheme	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
port	Integer port value to specify a HTTPS port Integer port value to specify a standard/non-standard HTTPS port.	integer	Required Minimum: 0 Maximum: 65535
resource_type	Must be set to the value ServiceManager	string
server	IP address or fully qualified domain name of server IP address or fully qualified domain name of the partner REST server.	string	Required
service_ids	Service IDs The IDs of services, provided by partner.	array of ResourceReference	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
thumbprint	Thumbprint of the certificate for partner console Thumbprint (SHA-256 hash represented in lower case hex) for the certificate on the partner console. This will be required to establish secure communication with the console and to avoid man-in-the-middle attacks.	string
uri	URI notification requests should be made on the server URI on which notification requests should be made on the specified server.	string	Required
vendor_id	Vendor ID Id which is unique to a vendor or partner for which the service is created.	string	Readonly

Example Response:

{ "resource_type": "ServiceManager", "id": "34ab3b14-5b73-424b-b521-6d1cabd7c151", "display_name": "SampleVendor Antivirus", "vendor_id": "SampleVendor1234", "service_ids": [ { "target_display_name": "ea9ae885-d3ec-4acc-8194-d5d96dc569cd", "target_type": "ServiceDefinition", "target_id": "ea9ae885-d3ec-4acc-8194-d5d96dc569cd" } ], "server": "10.0.0.1", "port": 12345, "uri": "/nsx-notifications", "authentication_scheme": { "scheme_name": CERTIFICATE, "certificate_id": "5e1a209d-5319-4342-9222-8809499c4927" }, "thumbprint": "0a8b3a7062e4c1405623a2365d56d63a83c890617234222c0b0dd8a6152ddf0d", "_create_time": 1530770939580, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_user": "admin", "_last_modified_time": 1530770939345, "_revision": 1 }

Required Permissions:

crud

Feature:

service_insertion_config

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable