NSX-T Data Center REST API

Sets configuration for enabling opt-in features for host transport nodes

Sets the minimum OS version for host transport nodes. OS version of all existing host transport nodes must be same or
higher than the specified value, otherwise API will fail.
Once this value is set, the NSX opt-in features which are applicable from this version can be used.
Any new host transport node must be same or higher than the specified value

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/host-transport-nodes/feature-opt-in

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

FeatureOptIn+

FeatureOptIn (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
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
host_tn_min_os_version	This value indicates the minimum OS version for all host transport nodes in the system. The system does not permit transport nodes of a lower version to be included in the system inventory. This restriction is applicable for hosts version ESX9 and above. ESX8 hosts are always supported. This value is automatically increased when the system is upgraded across a major/minor version, but can be further increased to a specific maintenance version by the user in order to make certain datapath features available. 9.1.1.0: * Advanced Networking Services for EVPN-VXLAN and DTGW	string	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value FeatureOptIn	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/feature-opt-in { "host_tn_min_os_version": "9.1.1" }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

FeatureOptIn+

FeatureOptIn (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
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
host_tn_min_os_version	This value indicates the minimum OS version for all host transport nodes in the system. The system does not permit transport nodes of a lower version to be included in the system inventory. This restriction is applicable for hosts version ESX9 and above. ESX8 hosts are always supported. This value is automatically increased when the system is upgraded across a major/minor version, but can be further increased to a specific maintenance version by the user in order to make certain datapath features available. 9.1.1.0: * Advanced Networking Services for EVPN-VXLAN and DTGW	string	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value FeatureOptIn	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "host_tn_min_os_version": "9.1.1", "resource_type": "FeatureOptIn", "id": "eaa823e9-aed5-4c93-a556-a8d707634be5", "display_name": "eaa823e9-aed5-4c93-a556-a8d707634be5", "_create_time": 1780982377053, "_create_user": "admin", "_last_modified_time": 1780982377053, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

nodes_transport_nodes

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