Update a Host Transport Node Profile

Host transport node profile captures the configuration needed to create
a host transport node. A host transport node profile can be attached to
compute collections for automatic host transport node creation of member hosts.

When configurations of a host transport node profile(TNP) are updated, all the
host transport nodes in all the compute collections to which this TNP is attached
are updated to reflect the updated configuration.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/infra/host-transport-node-profiles/{transport-node-profile-id}

Request Headers:

n/a

Query Parameters:

ManagedObjectOwnershipRequestParameters+

Name	Description	Type	Notes
override_nsx_ownership	Override NSX Ownership Flag indicating whether the NSX ownership constraints (on Managed Objects like Host/Cluster/DVS) should be overridden/bypassed. Note: Overriding/bypassing NSX ownership constraints is not recommended at all. This indicates, you want to use/configure/own certain Managed Objects (like Cluster, Host or DVS) which seem to be already in use/configured/owned by some other NSX instance. This option should be used with caution. It should only be used to come out of situations where: a. The other NSX instance no longer intends to use the Managed Objects (and has already unconfigured NSX configurations) but the ownership still lies with it (incorrectly) and you want those Managed Objects to be used/configured/owned by this NSX instance. b. The other NSX instance has crashed or decommisioned but the ownership still lies with it and you want those Managed Objects to be used/configured/owned by this NSX instance. Enabling this option, while the Managed Objects affected by this operation are actively used by other NSX, can lead to problematic states on both the NSX instances. For example, if a TN is forcefully reconfigured by this NSX instance (using override_nsx_ownership=true), while it was already configured and in use by the other NSX instance, it could corrupt the HostSwitch configurations pushed down by the other NSX instance.	boolean	Default: "False"

Request Body:

PolicyHostTransportNodeProfile+

PolicyHostTransportNodeProfile (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
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Host 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 Host 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 Host Transport Node Profile and results in the host to be marked as overridden. If a Host Transport Node Profile is edited or a new Host Transport Node Profile is applied on a Host Transport Node Collection, by default, the host configuration will be overwritten with the Host 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 Host Transport Node Profile configuration when it is being updated or a new one is applied to the Host 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, Host Transport Node Profiles can be applied on multiple clusters. This field will dictate the behavior followed by all clusters using this Host Transport Node Profile.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated thier unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.	string	Readonly
resource_type	Must be set to the value PolicyHostTransportNodeProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Request:

PUT https://<nsx-mgr>/policy/api/v1/infra/host-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_name": "DSwitch2", "host_switch_id": "50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6", "host_switch_type": "VDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "/infra/host-switch-profiles/b7b04576-a249-4842-b21d-59a65ae51ec5" } ], "uplinks": [ { "vds_uplink_name": "Uplink 1", "uplink_name": "uplink-1" }, { "vds_uplink_name": "Uplink 2", "uplink_name": "uplink-2" }, { "vds_uplink_name": "Uplink 3", "uplink_name": "uplink-3" }, { "vds_uplink_name": "Uplink 4", "uplink_name": "uplink-4" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "AssignedByDhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/f82d3923-ce47-419c-8f39-71ef39d47426", "transport_zone_profile_ids": [] }, { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/7cd1b7b6-f1c4-46a1-93a8-8b60ea95e673", "transport_zone_profile_ids": [] } ], "not_ready": false } ] }, "_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:

PolicyHostTransportNodeProfile+

PolicyHostTransportNodeProfile (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
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
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	Host 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 Host 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 Host Transport Node Profile and results in the host to be marked as overridden. If a Host Transport Node Profile is edited or a new Host Transport Node Profile is applied on a Host Transport Node Collection, by default, the host configuration will be overwritten with the Host 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 Host Transport Node Profile configuration when it is being updated or a new one is applied to the Host 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, Host Transport Node Profiles can be applied on multiple clusters. This field will dictate the behavior followed by all clusters using this Host Transport Node Profile.	boolean	Default: "False"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in Pmaas	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated thier unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.	string	Readonly
resource_type	Must be set to the value PolicyHostTransportNodeProfile	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

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_name": "DSwitch2", "host_switch_id": "50 34 30 8b c9 77 64 57-1e 89 55 24 bd 32 70 e6", "host_switch_type": "VDS", "host_switch_mode": "STANDARD", "host_switch_profile_ids": [ { "key": "UplinkHostSwitchProfile", "value": "/infra/host-switch-profiles/b7b04576-a249-4842-b21d-59a65ae51ec5" } ], "uplinks": [ { "vds_uplink_name": "Uplink 1", "uplink_name": "uplink-1" }, { "vds_uplink_name": "Uplink 2", "uplink_name": "uplink-2" }, { "vds_uplink_name": "Uplink 3", "uplink_name": "uplink-3" }, { "vds_uplink_name": "Uplink 4", "uplink_name": "uplink-4" } ], "is_migrate_pnics": false, "ip_assignment_spec": { "resource_type": "AssignedByDhcp" }, "cpu_config": [], "transport_zone_endpoints": [ { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/f82d3923-ce47-419c-8f39-71ef39d47426", "transport_zone_profile_ids": [] }, { "transport_zone_id": "/infra/sites/default/enforcement-points/default/transport-zones/7cd1b7b6-f1c4-46a1-93a8-8b60ea95e673", "transport_zone_profile_ids": [] } ], "not_ready": false } ] }, "_create_time": 1485299990773, "_last_modified_user": "admin", "_last_modified_time": 1485301913130, "_create_user": "admin", "_revision": 1 }

Update a Host Transport Node Profile

Request:

ManagedObjectOwnershipRequestParameters (schema)

PolicyHostTransportNodeProfile (schema)

Example Request:

Successful Response:

PolicyHostTransportNodeProfile (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: