NSX-T Data Center REST API

AlbControllerVsphereClusterNodeVmDeploymentConfig (type)

{
  "description": "The vSphere deployment configuration determines where to deploy the Avi Load Balancer Controller node through a vCenter server. It contains settings that are applied during install time. If using DHCP, the following fields must be left unset - management_port_subnets, and default_gateway_addresses",
  "extends": {
    "$ref": "ALBControllerNodeVMDeploymentConfig"
  },
  "id": "AlbControllerVsphereClusterNodeVmDeploymentConfig",
  "module_id": "PolicyALBControllerDeployment",
  "polymorphic-type-descriptor": {
    "type-identifier": "AlbControllerVsphereClusterNodeVmDeploymentConfig"
  },
  "properties": {
    "compute_id": {
      "description": "The Avi Load Balancer Controller node will be deployed on the specified cluster or resourcepool for specified VC server.",
      "required": true,
      "title": "Cluster identifier or resourcepool identifier",
      "type": "string"
    },
    "default_gateway_addresses": {
      "description": "The default gateway for the Avi Load Balancer Controller node to be deployed must be specified if all the other nodes it communicates with are not in the same subnet. Do not specify this field and management_port_subnets to use DHCP. Note: only single IPv4 default gateway address is supported and it must belong to management network.",
      "items": {
        "$ref": "IPAddress"
      },
      "maxItems": 1,
      "minItems": 1,
      "required": false,
      "title": "Default gateway for the Avi Load Balancer Controller node",
      "type": "array"
    },
    "disk_provisioning": {
      "$ref": "DiskProvisioning",
      "default": "THIN",
      "description": "Specifies the disk provisioning type of the Avi Load Balancer Controller node.",
      "required": false,
      "title": "Disk provitioning type"
    },
    "display_name": {
      "description": "Desired display name for Avi Load Balancer Controller node to be deployed.",
      "required": false,
      "title": "Avi Load Balancer Controller node display name",
      "type": "string"
    },
    "dns_servers": {
      "description": "List of DNS servers.",
      "items": {
        "$ref": "IPv4Address"
      },
      "required": false,
      "title": "DNS servers",
      "type": "array"
    },
    "host_id": {
      "description": "The Avi Load Balancer Controller node will be deployed on the specified host in the specified VC server 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",
      "type": "string"
    },
    "hostname": {
      "description": "Desired host name/FQDN for the Avi Load Balancer Controller node to be deployed.",
      "format": "hostname-or-ip",
      "required": true,
      "title": "Host name or FQDN for the Avi Load Balancer Controller node",
      "type": "string"
    },
    "management_network_id": {
      "description": "Distributed portgroup identifier to which the management vnic of Avi Load Balancer Controller node will be connected.",
      "required": true,
      "title": "Portgroup identifier for management network connectivity",
      "type": "string"
    },
    "management_port_subnets": {
      "description": "IP Address and subnet configuration for the management port. Do not specify this field and default_gateway_addresses to use DHCP. Note: only one IPv4 address is supported for the management port.",
      "items": {
        "$ref": "IPSubnet"
      },
      "maxItems": 1,
      "minItems": 1,
      "required": false,
      "title": "Port subnets for management port",
      "type": "array"
    },
    "ntp_servers": {
      "description": "List of NTP servers.",
      "items": {
        "$ref": "HostnameOrIPv4Address"
      },
      "required": false,
      "title": "NTP servers",
      "type": "array"
    },
    "placement_type": {
      "description": "Specifies the config for the platform through which to deploy the Avi Load Balancer Controller node.",
      "enum": [
        "AlbControllerVsphereClusterNodeVmDeploymentConfig"
      ],
      "required": true,
      "title": "Type of deployment",
      "type": "string"
    },
    "storage_id": {
      "description": "The Avi Load Balancer Controller node will be deployed on the specified datastore in the specified VC server. User must ensure that storage is accessible by the specified cluster/host.",
      "required": true,
      "title": "Storage/datastore identifier",
      "type": "string"
    },
    "storage_policy_id": {
      "description": "The Avi Controller cluster node will be deployed with the specified storage policy on the specified datastore in the specified VC server. User must ensure that the storage policy is applicable on the given datastore.",
      "required": false,
      "title": "Storage policy uuid",
      "type": "string"
    },
    "vc_id": {
      "description": "The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this vCenter server.",
      "required": true,
      "title": "vSphere compute identifier for identifying VC server",
      "type": "string"
    }
  },
  "title": "Deployment config on the vSphere platform",
  "type": "object"
}