NSX-T Data Center REST API

Update a Transport Node Profile (Deprecated)

When configurations of a transport node profile(TNP) is updated, all the
transport nodes in all the compute collections to which this TNP is attached
are updated to reflect the updated configuration.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>

Request:

Method:

PUT

URI Path(s):

/api/v1/transport-node-profiles/<transport-node-profile-id>

Request Headers:

n/a

Query Parameters:

TransportNodeUpdateParameters+

TransportNodeUpdateParameters (schema)

(Deprecated)

Name	Description	Type	Notes
esx_mgmt_if_migration_dest	The network ids to which the ESX vmk interfaces will be migrated A comma separated list of network ids. When migrating vmks into logical switches, the ids are the logical switches's ids. When migrating out of logical switches, the ids are vSphere Standard Switch portgroup names in a single vSphere Standard Switch, or distributed virtual portgroup names in a single distributed virtual switch (DVS). This property can only used together with 'if_id'.	string
if_id	The ESX vmk interfaces to migrate A comma separated list of vmk interfaces (for example, vmk0,vmk1). This property can only used along with 'esx_mgmt_if_migration_dest'. If all vmk interfaces will be migrated into the same logical switch or DV portgroup, the 'esx_mgmt_if_migration_dest' can be just one logical switch id or DV portgroup name. Otherwise the number of vmks in this list must equal the number of ids in 'esx_mgmt_if_migration_dest' list, and the orders of the two lists are important because the vmks match the network ids one by one in the same order.	string
ping_ip	IP Addresses to ping right after ESX vmk interfaces were migrated. A comma separated list of IP addresses that match the vmk interfaces given in property 'if_id" or 'vnic' one-by-one in the same order. '0.0.0.0' is a special IP that indicates the pre-migration gateway of the vmk will be pinged post-migration. If a VMK does not need the ping ip or a VM NIC is given inside 'vnic', the ping ip must be skipped but the comma has to stay. For example, '0.0.0.0,,10.1.1.1' indicates the vmk or VM NIC at the 2nd position does not need ping post-migration. Right after all ESX vmk interfaces are migrated, ping packets will be sent through each vmk to its given ping_ip to check if the migraton will break the network connectivity or not. If any vmk_ping fails, the whole migration of all vmks will be rolled back and transport-node will be in failed state.	string
skip_validation	Whether to skip front-end validation for vmk/vnic/pnic migration If this property is set true, all front-end validation for vmk, vnic, and/or pnic migration will be skipped. This is useful when the remote host becomes unreachable as a result of a migration; in which case the front-end validation will always fail because data from the remote host is no longer available. Skipping the validation will allow user to undo the migration by updating the transport node first and then restoring the host network connectivity.	boolean	Default: "False"
vnic	The ESX vmk interfaces and/or VM NIC to migrate A comma separated list of vmk interfaces and/or one VM NIC. Only one VM NIC is allowed in the list; the format must be vmInstanceUuid:DeviceId like '50ca5f2d-1fa2-432d-991e-f01e0e16d182:4000'. An example list is 'vmk0,vmk1,50ca5f2d-1fa2-432d-991e-f01e0e16d182:4000'. The property can only be used along with 'vnic_migration_dest'.	string
vnic_migration_dest	The migration destinations of ESX vmk interfaces and/or VM NIC A comma separated list of vif ids, or port group names. When migrating into logical switches, the ids are vif ids in the logical ports created in the logical switches. When migrating out of logical switches, the ids are vSphere Standard Switch portgroup names in a single vSphere Standard Switch, or distributed virtual portgroup names in a single distributed virtual switch (DVS). The property can only be used in combination with property 'vnic'. The number of vnic interfaces in 'vnic' must equal the number of vif ids or port-group names in this list. The items in the two lists match by the the order.	string

Request Body:

TransportNodeProfile+

TransportNodeProfile (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
host_switch_spec	Transport node host switch specification The HostSwitchSpec is the base class for standard and preconfigured host switch specifications. Only standard host switches are supported in the transport node profile.	HostSwitchSpec (Abstract type: pass one of the following concrete types) PreconfiguredHostSwitchSpec StandardHostSwitchSpec
id	Unique identifier of this resource	string	Sortable
ignore_overridden_hosts	Determines if cluster-level configuration should be applied on overridden hosts Transport Node Profiles specify the configuration that is applied to all hosts in a cluster. The user has the ability to update the configuration on individual hosts within a cluster which will cause the host configuration to differ from the Transport Node Profile and results in the host to be marked as overridden. If a Transport Node Profile is edited or a new Transport Node Profile is applied on a Transport Node Collection, by default, the host configuration will be overwritten with the Transport Node Profile configuration and the overridden flag will be reset to false. This flag should be used when hosts that are set as overridden should not adopt the Transport Node Profile configuration when it is being updated or a new one is applied to the Transport Node Collection. In other words, when this flag is set to the default value of false and configuration is applied at the cluster level, the configuration will be applied on all hosts regardless if overridden or not. When this flag is set to true, all hosts that are set as overridden, i.e., have been updated invidivually, will be ignored and the cluster-level configuration will not be applied. Note, Transport Node Profiles can be applied on multiple clusters. This field will dictate the behavior followed by all clusters using this Transport Node Profile.	boolean	Default: "False"
resource_type	Must be set to the value TransportNodeProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/transport-node-profiles/77816de2-39c3-436c-b891-54d31f580961 { "resource_type": "TransportNodeProfile", "id": "77816de2-39c3-436c-b891-54d31f580961", "display_name": "Transport Node Profile For Finance Department Cluster", "description": "Transport Node Profile to be applied to cluster", "host_switch_spec": { "resource_type": "StandardHostSwitchSpec", "host_switches": [ { "host_switch_profile_ids": [ { "value": "e331116d-f59e-4004-8cfd-c577aefe563a", "key": "UplinkHostSwitchProfile" } ], "host_switch_name": "nsxvswitch", "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink1" } ], "ip_assignment_spec": { "resource_type": "StaticIpPoolSpec", "ip_pool_id": "ecddcdde-4dc5-4026-ad4f-8857995d4c92", "vmk_install_migration": [ { "device_name": "vmk1", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" }, { "device_name": "vmk2", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" } ], "vmk_uninstall_migration": [ ] } ] }, "_create_time": 1485299990773, "_last_modified_user": "admin", "_last_modified_time": 1485301913130, "_create_user": "admin", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportNodeProfile+

TransportNodeProfile (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
host_switch_spec	Transport node host switch specification The HostSwitchSpec is the base class for standard and preconfigured host switch specifications. Only standard host switches are supported in the transport node profile.	HostSwitchSpec (Abstract type: pass one of the following concrete types) PreconfiguredHostSwitchSpec StandardHostSwitchSpec
id	Unique identifier of this resource	string	Sortable
ignore_overridden_hosts	Determines if cluster-level configuration should be applied on overridden hosts Transport Node Profiles specify the configuration that is applied to all hosts in a cluster. The user has the ability to update the configuration on individual hosts within a cluster which will cause the host configuration to differ from the Transport Node Profile and results in the host to be marked as overridden. If a Transport Node Profile is edited or a new Transport Node Profile is applied on a Transport Node Collection, by default, the host configuration will be overwritten with the Transport Node Profile configuration and the overridden flag will be reset to false. This flag should be used when hosts that are set as overridden should not adopt the Transport Node Profile configuration when it is being updated or a new one is applied to the Transport Node Collection. In other words, when this flag is set to the default value of false and configuration is applied at the cluster level, the configuration will be applied on all hosts regardless if overridden or not. When this flag is set to true, all hosts that are set as overridden, i.e., have been updated invidivually, will be ignored and the cluster-level configuration will not be applied. Note, Transport Node Profiles can be applied on multiple clusters. This field will dictate the behavior followed by all clusters using this Transport Node Profile.	boolean	Default: "False"
resource_type	Must be set to the value TransportNodeProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "TransportNodeProfile", "id": "77816de2-39c3-436c-b891-54d31f580961", "display_name": "Transport Node Profile For Finance Department Cluster", "description": "Transport Node Profile to be applied to a cluster", "host_switch_spec": { "resource_type": "StandardHostSwitchSpec", "host_switches": [ { "host_switch_profile_ids": [ { "value": "e331116d-f59e-4004-8cfd-c577aefe563a", "key": "UplinkHostSwitchProfile" } ], "host_switch_name": "nsxvswitch", "pnics": [ { "device_name": "vmnic1", "uplink_name": "uplink1" } ], "ip_assignment_spec": { "resource_type": "StaticIpPoolSpec", "ip_pool_id": "ecddcdde-4dc5-4026-ad4f-8857995d4c92", "vmk_install_migration": [ { "device_name": "vmk1", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" }, { "device_name": "vmk2", "destination_network": "849e339e-64b7-47cb-9480-33068f70dc5a" } ], "vmk_uninstall_migration": [ ] } ] }, "_create_time": 1485299990773, "_last_modified_user": "admin", "_last_modified_time": 1485301913130, "_create_user": "admin", "_revision": 1 }

Required Permissions:

crud

Feature:

nodes_transport_nodes

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