Update a transport zone profile (Deprecated)

Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.
Deprecated: This api is now deprecated. Please use new api - PATCH /policy/api/v1/infra/transport-zone-profiles/<tz-profile>

Request:

Method:

PUT

URI Path(s):

/api/v1/transportzone-profiles/{transportzone-profile-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

BfdHealthMonitoringProfile+

BfdHealthMonitoringProfile (schema)

(Deprecated)

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
enabled	Whether the heartbeat is enabled. A POST or PUT request with "enabled" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value.	boolean	Required
id	Unique identifier of this resource	string	Sortable
latency_enabled	Whether the latency is enabled. The flag is to turn on/off latency. A POST or PUT request with "latency_enabled" true will enable NSX to send the networking latency data to thrid-party monitoring tools like vRNI.	boolean
probe_interval	The time interval (in millisec) between probe packets for tunnels between transport nodes.	integer	Minimum: 300 Default: "1000"
resource_type	Must be set to the value BfdHealthMonitoringProfile	string	Required Enum: BfdHealthMonitoringProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/transportzone-profiles/4b772ead-0b70-4e96-8752-3cf87cdb98f5 { "resource_type": "BfdHealthMonitoringProfile", "id": "4b772ead-0b70-4e96-8752-3cf87cdb98f5", "display_name": "transport-zone-profile-East", "tags": [ { "scope": "home", "tag": "green" } ], "probe_interval": 500, "enabled": false, "latency_enabled": false, "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BfdHealthMonitoringProfile+

BfdHealthMonitoringProfile (schema)

(Deprecated)

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
enabled	Whether the heartbeat is enabled. A POST or PUT request with "enabled" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value.	boolean	Required
id	Unique identifier of this resource	string	Sortable
latency_enabled	Whether the latency is enabled. The flag is to turn on/off latency. A POST or PUT request with "latency_enabled" true will enable NSX to send the networking latency data to thrid-party monitoring tools like vRNI.	boolean
probe_interval	The time interval (in millisec) between probe packets for tunnels between transport nodes.	integer	Minimum: 300 Default: "1000"
resource_type	Must be set to the value BfdHealthMonitoringProfile	string	Required Enum: BfdHealthMonitoringProfile
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "BfdHealthMonitoringProfile", "id": "4b772ead-0b70-4e96-8752-3cf87cdb98f5", "display_name": "transport-zone-profile-East", "tags": [ { "scope": "home", "tag": "green" } ], "probe_interval": 500, "enabled": false, "latency_enabled": false, "_last_modified_time": 1458590898614, "_create_time": 1458590226240, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 1 }

Update a transport zone profile (Deprecated)

Request:

BfdHealthMonitoringProfile (schema)

Example Request:

Successful Response:

BfdHealthMonitoringProfile (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: