NSX-T Data Center REST API

PolicyVsphereDeploymentConfig (type)

{
  "additionalProperties": false,
  "description": "The Vsphere deployment configuration determines where to deploy the edge node. It contains settings that are applied during install time.",
  "extends": {
    "$ref": "PolicyVmDeploymentConfig"
  },
  "id": "PolicyVsphereDeploymentConfig",
  "module_id": "PolicyEdgeTransportNode",
  "polymorphic-type-descriptor": {
    "type-identifier": "PolicyVsphereDeploymentConfig"
  },
  "properties": {
    "compute_folder_id": {
      "description": "The edge node vm will be deployed on the specified compute folder created in a datacenter, if compute folder is specified. Note - User must ensure that compute folder is accessible by specified cluster/host.",
      "required": false,
      "title": "Compute folder identifier in the specified vcenter server.",
      "type": "string"
    },
    "compute_id": {
      "description": "The edge node vm will be deployed on the specified cluster or resource pool. Note - all the hosts must have nsx fabric prepared in the specified cluster.",
      "required": true,
      "title": "Cluster identifier for specified vcenter server.",
      "type": "string"
    },
    "edge_host_affinity_config": {
      "$ref": "EdgeHostAffinityConfig",
      "description": "This allows edge VM to be pinned to a host group. Edge VM shall gracefully shutdown & power on with entry and exit of host maintenance mode respectively.",
      "required": false,
      "title": "Edge VM to host affinity configuration"
    },
    "host_id": {
      "description": "The edge node vm will be deployed on the specified Host within the cluster if host_id is specified. Note - User must ensure that storage and specified networks are accessible by this host.",
      "required": false,
      "title": "Host identifier in the specified vcenter server.",
      "type": "string"
    },
    "placement_type": {
      "enum": [
        "PolicyVsphereDeploymentConfig"
      ],
      "required": true,
      "type": "string"
    },
    "reservation_info": {
      "$ref": "ReservationInfo",
      "description": "Resource reservation for memory and CPU resources.",
      "required": false,
      "title": "Resource reservation settings."
    },
    "storage_id": {
      "description": "The edge node vm will be deployed on the specified datastore. User must ensure that storage is accessible by the specified cluster/host.",
      "required": true,
      "title": "Storage/datastore identifier in the specified vcenter server.",
      "type": "string"
    },
    "vc_id": {
      "description": "The vc specific identifiers will be resolved on this VC. So all other identifiers specified here must belong to this vcenter server.",
      "required": true,
      "title": "Vsphere compute identifier for identifying the vcenter server.",
      "type": "string"
    }
  },
  "type": "object"
}