{
"description": "The Vsphere deployment configuration determines where to deploy the NSX-Intelligence cluster node VM through a vCenter server. It contains settings that are applied during install time. If using DHCP, the following fields must be left unset - dns_servers, management_port_subnets, and default_gateway_addresses",
"extends": {
"$ref": "IntelligenceClusterNodeVMDeploymentConfig
},
"id": "IntelligenceVsphereClusterNodeVMDeploymentConfig",
"module_id": "NsxIntelligenceDeployment",
"polymorphic-type-descriptor": {
"type-identifier": "IntelligenceVsphereClusterNodeVMDeploymentConfig"
},
"properties": {
"allow_ssh_root_login": {
"default": false,
"description": "If true, the root user will be allowed to log into the VM. Allowing root SSH logins is not recommended for security reasons.",
"required": false,
"title": "Allow root SSH logins.",
"type": "boolean"
},
"compute_id": {
"description": "The NSX-Intelligence cluster node VM 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 VM to be deployed must be specified if all the other VMs 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. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified.",
"items": {
"$ref": "IPAddress
},
"maxItems": 1,
"minItems": 1,
"required": false,
"title": "Default gateway for the VM",
"type": "array"
},
"disk_provisioning": {
"$ref": "DiskProvisioning,
"default": "THIN",
"description": "Specifies the disk provisioning type of the VM.",
"required": false,
"title": "Disk provitioning type"
},
"display_name": {
"description": "Desired display name for NSX-Intelligence VM to be deployed",
"required": false,
"title": "NSX-Intelligence VM display name",
"type": "string"
},
"dns_servers": {
"description": "List of DNS servers. If DHCP is used, the default DNS servers associated with the DHCP server will be used instead. Required if using static IP.",
"items": {
"$ref": "IPv4Address
},
"minItems": 1,
"required": false,
"title": "DNS servers.",
"type": "array"
},
"enable_ssh": {
"default": false,
"description": "If true, the SSH service will automatically be started on the VM. Enabling SSH service is not recommended for security reasons.",
"required": false,
"title": "Enable SSH.",
"type": "boolean"
},
"host_id": {
"description": "The NSX-Intelligence cluster node VM 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 VM to be deployed",
"pattern": "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*?$",
"required": true,
"title": "Host name or FQDN for the VM",
"type": "string"
},
"management_network_id": {
"description": "Distributed portgroup identifier to which the management vnic of NSX-Intelligence cluster node VM 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. IMPORTANT: VMs deployed using DHCP are currently not supported, so this parameter should be specified.",
"items": {
"$ref": "IPSubnet
},
"maxItems": 1,
"minItems": 1,
"required": false,
"title": "Port subnets for management port",
"type": "array"
},
"ntp_servers": {
"description": "List of NTP servers. To use hostnames, a DNS server must be defined. If not using DHCP, a DNS server should be specified under dns_servers.",
"items": {
"$ref": "HostnameOrIPv4Address
},
"required": false,
"title": "NTP servers.",
"type": "array"
},
"ovf_url": {
"deprecated": true,
"description": "The NSX-Intelligence cluster node VM OVF URL to download and install the OVF file. This field is deprecated now. Please upload OVA file using \"/repository/bundles\" API and then try deployment without providing this field.",
"required": false,
"title": "URL of the ovf file to deploy",
"type": "string"
},
"placement_type": {
"description": "Specifies the config for the platform through which to deploy the VM",
"enum": [
"IntelligenceVsphereClusterNodeVMDeploymentConfig"
],
"required": true,
"title": "Type of deployment",
"type": "string"
},
"storage_id": {
"description": "The NSX-Intelligence cluster node VM 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"
},
"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"
}