The Vsphere deployment configuration determines where to deploy the edge
node. It contains settings that are applied during install time.
If using DHCP, you must leave the following fields unset: search_domains,
management_port_subnets, dns_servers and default_gateway_addresses.
Use EdgeNodeSettings to specify host name, SSH, NTP and DNS settings for
both deployment and consequent update. These settings are editable for
manually deployed edge nodes as well.
EdgeNodeSettings reports current values configured on the edge node.
The following fields are deprecated Hostname, SSH, NTP and DNS settings.
| Name | Description | Type | Notes |
|---|---|---|---|
| allow_ssh_root_login | Allow root SSH logins. Allowing root SSH logins is not recommended for security reasons. This field is deprecated. Use allow_ssh_root_login property in EdgeNodeSettings section when creating transport nodes. |
boolean | Deprecated Default: "False" |
| compute_id | Cluster identifier or resourcepool identifier for specified vcenter server. The edge node vm will be deployed on the specified cluster or resourcepool. Note - all the hosts must have nsx fabric prepared in the specified cluster. |
string | Required |
| data_network_ids | Portgroup or logical switch identifiers for datapath connectivity. List of distributed portgroup or VLAN logical identifiers to which the datapath serving vnics of edge node vm will be connected. |
array of string | Required Minimum items: 1 Maximum items: 3 |
| default_gateway_addresses | Default gateway for the node. The default gateway for edge node must be specified if all the nodes it communicates with are not in the same subnet. Note: Only single IPv4 default gateway address is supported and it must belong to management network. |
array of IPAddress | Minimum items: 1 Maximum items: 1 |
| dns_servers | DNS servers. List of DNS servers. This field is deprecated. Use dns_servers property in EdgeNodeSettings section when creating or updating transport nodes. |
array of IPAddress | Deprecated |
| enable_ssh | Enable SSH. Enabling SSH service is not recommended for security reasons. This field is deprecated. Use enable_ssh property in EdgeNodeSettings section when creating or updating transport nodes. |
boolean | Deprecated Default: "False" |
| host_id | Host identifier in the specified vcenter server. 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. |
string | |
| hostname | Host name or FQDN for edge node. | string | Deprecated 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 or logical switch identifier for management network connectivity. Distributed portgroup identifier to which the management vnic of edge node vm will be connected. This portgroup must have connectivity with MP and CCP. A VLAN logical switch identifier may also be specified. |
string | Required |
| management_port_subnets | Port subnets for management port. Only one IPv4 Address is supported. IP Address and subnet configuration for the management port. Note: only one IPv4 address is supported for the management port. |
array of IPSubnet | Minimum items: 1 Maximum items: 1 |
| ntp_servers | NTP servers. List of NTP servers. This field is deprecated. Use ntp_servers property in EdgeNodeSettings section when creating or updating transport nodes. |
array of HostnameOrIPv4Address | Deprecated |
| placement_type | Must be set to the value VsphereDeploymentConfig | string | Required Enum: VsphereDeploymentConfig |
| reservation_info | Resource reservation settings. Resource reservation for memory and CPU resources. |
ReservationInfo | |
| resource_allocation | Current resource allocation. Allocation for memory and CPU resources. |
ResourceAssignment | |
| search_domains | Search domain names. List of domain names that are used to complete unqualified host names. This field is deprecated. Use search_domains property in EdgeNodeSettings section when creating or updating transport nodes. |
array of string | Deprecated |
| storage_id | Storage/datastore identifier in the specified vcenter server. The edge node vm will be deployed on the specified datastore. User must ensure that storage is accessible by the specified cluster/host. |
string | Required |
| vc_id | Vsphere compute identifier for identifying the vcenter server. The vc specific identifiers will be resolved on this VC. So all other identifiers specified here must belong to this vcenter server. |
string | Required |