NSX-T Data Center REST API

Add Solution Config for a given Service

Adds a solution config. Solution Config are service level objects,
required for configuring the NXGI partner Service after deployment.

Request:

Method:

POST

URI Path(s):

/api/v1/serviceinsertion/services/<service-id>/solution-configs

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

SolutionConfig+

SolutionConfig (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
control_ip	Control IP Partner needs to specify their assigned control IP with which they have configured their OVFs.	IPv4Address	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
listen_port	Port Partner needs to specify their port on which their solution application which consumes NXGI EPSec library listens.	int	Required Minimum: 48651 Maximum: 48655
resource_type	Must be set to the value SolutionConfig	string
service_id	Service Id The service to which the solution config belongs.	string	Readonly
solution_id	Solution Id Partner needs to specify Solution Id assigned by VMware.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/serviceinsertion/services/03a31751-beaa-4a75-a3c9-04043479f0ec/solution-configs { "solution_id" : "7498352642083520512", "control_ip" : "192.168.1.10", "listen_port" : "48651" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

SolutionConfig+

SolutionConfig (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
control_ip	Control IP Partner needs to specify their assigned control IP with which they have configured their OVFs.	IPv4Address	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
listen_port	Port Partner needs to specify their port on which their solution application which consumes NXGI EPSec library listens.	int	Required Minimum: 48651 Maximum: 48655
resource_type	Must be set to the value SolutionConfig	string
service_id	Service Id The service to which the solution config belongs.	string	Readonly
solution_id	Solution Id Partner needs to specify Solution Id assigned by VMware.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "SolutionConfig", "id": "96fd5b77-5514-4bab-a1c7-1c932fd5eadf", "display_name": "96fd5b77-5514-4bab-a1c7-1c932fd5eadf", "service_id": "aa627592-58d8-4492-8274-2c5c5649b67b", "solution_id" : "7498352642083520512", "control_ip" : "192.168.1.10", "listen_port" : "48651" "_create_user": "admin", "_last_modified_user": "admin", "_create_time": 1538390759534, "_system_owned": false, "_last_modified_time": 1538390759534, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

service_insertion_config

Additional Errors:

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