NSX-T Data Center REST API

UplinkHostSwitchProfile (type) (Deprecated)

{
  "deprecated": true, 
  "extends": {
    "$ref": "BaseHostSwitchProfile
  }, 
  "id": "UplinkHostSwitchProfile", 
  "module_id": "UplinkHostSwitchProfile", 
  "polymorphic-type-descriptor": {
    "type-identifier": "UplinkHostSwitchProfile"
  }, 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "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.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "computed": true, 
      "description": "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.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "computed": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "lags": {
      "help_summary": "Valid only for a NVDS Hostswitch. For VDS Lags are configured from VC.", 
      "items": {
        "$ref": "Lag
      }, 
      "maxItems": 64, 
      "required": false, 
      "title": "list of LACP group", 
      "type": "array"
    }, 
    "mtu": {
      "help_summary": "If this field is not provided, the value of the \"physical_uplink_mtu\" from the GlobalConfigs module will be used as the default.", 
      "minimum": 1280, 
      "required": false, 
      "title": "Maximum Transmission Unit used for uplinks", 
      "type": "int"
    }, 
    "named_teamings": {
      "help_summary": "If this field is not provided, logical switches will not have specific teaming policies applied to them; the default teaming policy will be used. For Non-ESX transport nodes that do not support specific uplink teaming policies on logical switches, their UplinkHostSwitchProfiles must NOT set this property; the default TeamingPolicy will always be used.", 
      "items": {
        "$ref": "NamedTeamingPolicy
      }, 
      "maxItems": 32, 
      "required": false, 
      "title": "List of named uplink teaming policies that can be used by logical switches", 
      "type": "array"
    }, 
    "overlay_encap": {
      "default": "GENEVE", 
      "enum": [
        "VXLAN", 
        "GENEVE"
      ], 
      "required": false, 
      "title": "The protocol used to encapsulate overlay traffic", 
      "type": "string"
    }, 
    "required_capabilities": {
      "help_summary": "List of capabilities required on the fabric node if this profile is used.\nThe required capabilities is determined by whether specific features are enabled in the profile.\n", 
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "required": false, 
      "type": "array"
    }, 
    "resource_type": {
      "$ref": "HostSwitchProfileType, 
      "required": true
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "teaming": {
      "$ref": "TeamingPolicy, 
      "help_summary": "This is the default TeamingPolicy used on TransportNodes that use this UplinkHostSwitchProfile for the logical switches that do not have any NamedTeamingPolicy assigned.", 
      "required": true, 
      "title": "Default TeamingPolicy associated with this UplinkProfile"
    }, 
    "transport_vlan": {
      "$ref": "VlanID, 
      "default": 0, 
      "required": false, 
      "title": "VLAN used for tagging Overlay traffic of associated HostSwitch"
    }
  }, 
  "title": "Profile for uplink policies", 
  "type": "object"
}