NSX-T Data Center REST API

Updates extended solution Config for a given Service

Updates a extended solution config. Extended Solution Config are service level objects,
used by the NXGI partner Service inside the SVM.

Request:

Method:

PUT

URI Path(s):

/api/v1/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ExtendedSolutionConfig+

ExtendedSolutionConfig (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
attributes	Servcie attributes List of attributes specific to a partner which needs to be passed to host.	array of Attribute	Maximum items: 128
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
resource_type	Must be set to the value ExtendedSolutionConfig	string
service_id	Service Id The service to which the solution config belongs.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/serviceinsertion/services/17a71bcb-e1cf-4c50-a4ba-220c2a47cfcc/solution-configs/e75dca65-71ce-4004-9221-82c1d727ef53/extended-solution-config { "service_id": "17a71bcb-e1cf-4c50-a4ba-220c2a47cfcc", "attributes": [ { "key": "key1", "display_name": "attribute1", "value": "value1", "attribute_type": "STRING", "read_only": false }, { "key": "key3", "display_name": "attribute3", "value": "value3", "attribute_type": "STRING", "read_only": false }, { "key": "key4", "display_name": "attribute4", "value": "value4", "attribute_type": "STRING", "read_only": false }, { "key": "key2", "display_name": "attribute2", "value": "value2", "attribute_type": "STRING", "read_only": false } ], "resource_type": "ExtendedSolutionConfig", "id": "e75dca65-71ce-4004-9221-82c1d727ef53", "display_name": "e75dca65-71ce-4004-9221-82c1d727ef53", "_create_user": "admin", "_create_time": 1606807386542, "_last_modified_user": "admin", "_last_modified_time": 1606807386542, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ExtendedSolutionConfig+

ExtendedSolutionConfig (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
attributes	Servcie attributes List of attributes specific to a partner which needs to be passed to host.	array of Attribute	Maximum items: 128
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
resource_type	Must be set to the value ExtendedSolutionConfig	string
service_id	Service Id The service to which the solution config belongs.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "service_id": "17a71bcb-e1cf-4c50-a4ba-220c2a47cfcc", "attributes": [ { "key": "key1", "display_name": "attribute1", "value": "value1", "attribute_type": "STRING", "read_only": false }, { "key": "key3", "display_name": "attribute3", "value": "value3", "attribute_type": "STRING", "read_only": false }, { "key": "key4", "display_name": "attribute4", "value": "value4", "attribute_type": "STRING", "read_only": false }, { "key": "key2", "display_name": "attribute2", "value": "value2", "attribute_type": "STRING", "read_only": false } ], "resource_type": "ExtendedSolutionConfig", "id": "e75dca65-71ce-4004-9221-82c1d727ef53", "display_name": "e75dca65-71ce-4004-9221-82c1d727ef53", "_create_user": "admin", "_create_time": 1606807386542, "_last_modified_user": "admin", "_last_modified_time": 1606808232935, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }

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