Create a Hostswitch Profile

Creates a hostswitch profile. The resource_type is required. For uplink
profiles, the teaming and policy parameters are required. By default, the
mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280
through (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default.
Range can be extended by modifying (uplink_mtu_threshold) in
SwitchingGlobalConfig to the required upper threshold.

Request:

Method:

POST

URI Path(s):

/api/v1/host-switch-profiles

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ExtraConfigHostSwitchProfile+

ExtraConfigHostSwitchProfile (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
extra_configs	list of extra configs	array of ExtraConfig
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value ExtraConfigHostSwitchProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

LldpHostSwitchProfile+

LldpHostSwitchProfile (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
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value LldpHostSwitchProfile	HostSwitchProfileType	Required
send_enabled	Enabled or disabled sending LLDP packets	boolean	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

NiocProfile+

NiocProfile (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
enabled	Enabled status of NIOC feature The enabled property specifies the status of NIOC feature. When enabled is set to true, NIOC feature is turned on and the bandwidth allocations specified for the traffic resources are enforced. When enabled is set to false, NIOC feature is turned off and no bandwidth allocation is guaranteed. By default, enabled will be set to true.	boolean	Default: "True"
host_infra_traffic_res	Resource allocation associated with NiocProfile host_infra_traffic_res specifies bandwidth allocation for various traffic resources.	array of ResourceAllocation
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value NiocProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

UplinkHostSwitchProfile+

UplinkHostSwitchProfile (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
id	Unique identifier of this resource	string	Sortable
lags	list of LACP group	array of Lag	Maximum items: 64
mtu	Maximum Transmission Unit used for uplinks	int	Minimum: 1280
named_teamings	List of named uplink teaming policies that can be used by logical switches	array of NamedTeamingPolicy	Maximum items: 32
overlay_encap	The protocol used to encapsulate overlay traffic	string	Enum: VXLAN, GENEVE Default: "GENEVE"
required_capabilities		array of string	Readonly
resource_type	Must be set to the value UplinkHostSwitchProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
teaming	Default TeamingPolicy associated with this UplinkProfile	TeamingPolicy	Required
transport_vlan	VLAN used for tagging Overlay traffic of associated HostSwitch	VlanID	Default: "0"

Example Request:

POST https://<nsx-mgr>/api/v1/host-switch-profiles { "resource_type": "UplinkHostSwitchProfile", "display_name": "uplinkProfile2", "mtu": 1600, "teaming": { "standby_list": [], "active_list": [ { "uplink_name": "uplink3", "uplink_type": "PNIC" } ], "policy": "FAILOVER_ORDER" }, "transport_vlan": 0 }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

ExtraConfigHostSwitchProfile+

ExtraConfigHostSwitchProfile (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
extra_configs	list of extra configs	array of ExtraConfig
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value ExtraConfigHostSwitchProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

LldpHostSwitchProfile+

LldpHostSwitchProfile (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
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value LldpHostSwitchProfile	HostSwitchProfileType	Required
send_enabled	Enabled or disabled sending LLDP packets	boolean	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

NiocProfile+

NiocProfile (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
enabled	Enabled status of NIOC feature The enabled property specifies the status of NIOC feature. When enabled is set to true, NIOC feature is turned on and the bandwidth allocations specified for the traffic resources are enforced. When enabled is set to false, NIOC feature is turned off and no bandwidth allocation is guaranteed. By default, enabled will be set to true.	boolean	Default: "True"
host_infra_traffic_res	Resource allocation associated with NiocProfile host_infra_traffic_res specifies bandwidth allocation for various traffic resources.	array of ResourceAllocation
id	Unique identifier of this resource	string	Sortable
required_capabilities		array of string	Readonly
resource_type	Must be set to the value NiocProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

UplinkHostSwitchProfile+

UplinkHostSwitchProfile (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
id	Unique identifier of this resource	string	Sortable
lags	list of LACP group	array of Lag	Maximum items: 64
mtu	Maximum Transmission Unit used for uplinks	int	Minimum: 1280
named_teamings	List of named uplink teaming policies that can be used by logical switches	array of NamedTeamingPolicy	Maximum items: 32
overlay_encap	The protocol used to encapsulate overlay traffic	string	Enum: VXLAN, GENEVE Default: "GENEVE"
required_capabilities		array of string	Readonly
resource_type	Must be set to the value UplinkHostSwitchProfile	HostSwitchProfileType	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
teaming	Default TeamingPolicy associated with this UplinkProfile	TeamingPolicy	Required
transport_vlan	VLAN used for tagging Overlay traffic of associated HostSwitch	VlanID	Default: "0"

Example Response:

{ "resource_type": "UplinkHostSwitchProfile", "id": "fe3e8766-383c-42fc-bfa9-aa7d193c89d9", "display_name": "uplinkProfile2", "mtu": 1600, "teaming": { "standby_list": [], "active_list": [ { "uplink_name": "uplink1", "uplink_type": "PNIC" } ], "policy": "FAILOVER_ORDER" }, "transport_vlan": 0, "_last_modified_user": "admin", "_last_modified_time": 1433452542652, "_create_time": 1433452542652, "_create_user": "admin", "_revision": 0 }

Create a Hostswitch Profile

Request:

ExtraConfigHostSwitchProfile (schema)

LldpHostSwitchProfile (schema)

NiocProfile (schema)

UplinkHostSwitchProfile (schema)

Example Request:

Successful Response:

ExtraConfigHostSwitchProfile (schema)

LldpHostSwitchProfile (schema)

NiocProfile (schema)

UplinkHostSwitchProfile (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: