Deployment config on the Vsphere platform
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
| Name | Description | Type | Notes |
|---|---|---|---|
| allow_ssh_root_login | Allow root SSH logins. If true, the root user will be allowed to log into the VM. Allowing root SSH logins is not recommended for security reasons. |
boolean | Default: "False" |
| compute_id | Cluster identifier or resourcepool identifier The NSX-Intelligence cluster node VM will be deployed on the specified cluster or resourcepool for specified VC server. |
string | Required |
| default_gateway_addresses | Default gateway for the VM 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. |
array of IPAddress | Minimum items: 1 Maximum items: 1 |
| disk_provisioning | Disk provitioning type Specifies the disk provisioning type of the VM. |
DiskProvisioning | Default: "THIN" |
| display_name | NSX-Intelligence VM display name Desired display name for NSX-Intelligence VM to be deployed |
string | |
| dns_servers | DNS servers. 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. |
array of IPv4Address | Minimum items: 1 |
| enable_ssh | Enable SSH. If true, the SSH service will automatically be started on the VM. Enabling SSH service is not recommended for security reasons. |
boolean | Default: "False" |
| host_id | Host identifier 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. |
string | |
| hostname | Host name or FQDN for the VM Desired host name/FQDN for the VM to be deployed |
string | Required 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])?)*?$" |
| management_network_id | Portgroup identifier for management network connectivity Distributed portgroup identifier to which the management vnic of NSX-Intelligence cluster node VM will be connected. |
string | Required |
| management_port_subnets | Port subnets for management port 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. |
array of IPSubnet | Minimum items: 1 Maximum items: 1 |
| ntp_servers | NTP servers. 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. |
array of HostnameOrIPv4Address | |
| ovf_url | URL of the ovf file to deploy 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. |
string | Deprecated |
| placement_type | Must be set to the value IntelligenceVsphereClusterNodeVMDeploymentConfig | string | Required Enum: IntelligenceVsphereClusterNodeVMDeploymentConfig |
| storage_id | Storage/datastore identifier 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. |
string | Required |
| vc_id | Vsphere compute identifier for identifying VC server The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this vCenter server. |
string | Required |