1. Types
  2. vcenter
  3. nsx

vcenter nsx: NSX enable spec

The NSX_enable_spec structure contains the specification that can be used to enable NSX networking on a vSphere cluster. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

{
    "edge_cluster_enable_spec" : {
        "management_network" : {
            "subnet_mask" : "string",
            "gateway" : "string",
            "network" : "obj-103"
        },
        "placement" : {
            "create_resource_pool" : true,
            "resource_pool_name" : "string",
            "resource_pool" : "obj-103"
        },
        "overlay_network" : {
            "vlan" : 1,
            "ip_pool_spec" : {
                "ip_range" : {
                    "size_specifier" : "ENDING_ADDRESS",
                    "ending_address" : "string",
                    "subnet_mask" : "string",
                    "starting_address" : "string",
                    "address_count" : 1
                },
                "name" : "obj-103",
                "cidr" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway" : "string"
            },
            "ip_pool" : "obj-103",
            "create_ip_pool" : true
        },
        "uplink_network" : {
            "vlan" : 1,
            "subnet_mask" : "string",
            "gateway" : "string"
        },
        "edge_nodes" : [
            {
                "password" : "secret string",
                "hostname" : "string",
                "datastore" : "obj-103",
                "name" : "string",
                "uplink_ip_address" : "string",
                "management_ip_address" : "string"
            },
            {
                "password" : "secret string",
                "hostname" : "string",
                "datastore" : "obj-103",
                "name" : "string",
                "uplink_ip_address" : "string",
                "management_ip_address" : "string"
            }
        ]
    },
    "cluster_enable_spec" : {
        "dv_switch" : "obj-103",
        "overlay_network" : {
            "mode" : "DHCP",
            "vlan" : 1,
            "ip_pool_spec" : {
                "ip_range" : {
                    "size_specifier" : "ENDING_ADDRESS",
                    "ending_address" : "string",
                    "subnet_mask" : "string",
                    "starting_address" : "string",
                    "address_count" : 1
                },
                "name" : "obj-103",
                "cidr" : {
                    "address" : "string",
                    "prefix" : 1
                },
                "gateway" : "string"
            },
            "ip_pool" : "obj-103",
            "create_ip_pool" : true
        }
    }
}

Attributes:

Name Type Description
Required
cluster_enable_spec cluster_enable_spec The spec that can be used to enable NSX networking with transport node configuration on the hosts in a vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.dv_switch string The vSphere Distributed Switch (VDS) to be used for hosts' transport node configuration. All the hosts in the vSphere cluster must be connected to this VDS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: DistributedVirtualSwitch. When operations return a value of this structure as a result, the field will be an identifier for the resource type: DistributedVirtualSwitch.
cluster_enable_spec.overlay_network cluster_overlay_network_spec The network specification for the hosts' transport node configuration. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.name string The ID(Name) of the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.nsx.pools.ip_pool.
cluster_enable_spec.overlay_network.ip_pool_spec.cidr.address string The IPv4 address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.cidr.prefix long The prefix length in the IPv4 CIDR notation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.starting_address string The IPv4 address denoting the start of the range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.size_specifier string The size specification used for the range. This field must be set to ENDING_ADDRESS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the ways to specify the ending address in an IPv4 address range. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
ENDING_ADDRESS: The end address of the IPv4 address range is specified by providing the IPv4 end address. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
ADDRESS_COUNT: The end address of the IPv4 address range is derived from the specified starting address and address count. This option is for future use. It is not supported yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.subnet_mask string The subnet mask to be set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
cluster_enable_spec.overlay_network.ip_pool_spec.gateway string The IPv4 address of the gateway associated with the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec edge_cluster_enable_spec The spec that can be used to enable NSX Edge cluster on a vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.edge_nodes uplink_node_spec[] List of specifications for the NSX Edge node(s). This list must have two elements. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.placement placement_spec Specification for the placement associated with the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.placement.create_resource_pool boolean Specifies if a new resource pool should be created. If it is set to true, a new resource pool with the name vcenter.nsx.placement_spec.resource_pool_name will be created and used for NSX Edge node(s). If it is set to false and vcenter.nsx.placement_spec.resource_pool is set, then the existing resource pool identified by vcenter.nsx.placement_spec.resource_pool will be used for NSX Edge node(s). If it is set to false and vcenter.nsx.placement_spec.resource_pool unset, then the root resource pool will be associated with the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.management_network management_network_spec Specification for the management network for the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.management_network.network string Identifier for the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: DistributedVirtualPortgroup. When operations return a value of this structure as a result, the field will be an identifier for the resource type: DistributedVirtualPortgroup.
edge_cluster_enable_spec.management_network.subnet_mask string Subnet mask for the interface on the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.management_network.gateway string Gateway IP address for the interface on the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.uplink_network uplink_network_spec Specification for the uplink network for the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.uplink_network.subnet_mask string Subnet mask for the interface on the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.uplink_network.gateway string Gateway IP address for the interface on the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network edge_overlay_network_spec Specification for the overlay network for the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.create_ip_pool boolean Specifies if a new NSX IP pool must be used for IP address allocation for this network interface. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.name string The ID(Name) of the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.nsx.pools.ip_pool.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.cidr.address string The IPv4 address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.cidr.prefix long The prefix length in the IPv4 CIDR notation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.starting_address string The IPv4 address denoting the start of the range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.size_specifier string The size specification used for the range. This field must be set to ENDING_ADDRESS. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Defines the ways to specify the ending address in an IPv4 address range. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
ENDING_ADDRESS: The end address of the IPv4 address range is specified by providing the IPv4 end address. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
ADDRESS_COUNT: The end address of the IPv4 address range is derived from the specified starting address and address count. This option is for future use. It is not supported yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.subnet_mask string The subnet mask to be set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.gateway string The IPv4 address of the gateway associated with the NSX IP pool. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Optional
cluster_enable_spec.overlay_network.vlan long The VLAN identifier for this network. Possible values:
  • A value from 1 to 4094 specifies a VLAN ID for the network.
  • Any other value (including 0) is invalid.
. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field is currently required. It is optional for future development.
cluster_enable_spec.overlay_network.mode string The IP address allocation mode. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, DHCP is assumed.
cluster_enable_spec.overlay_network.create_ip_pool boolean Specifies if a new NSX IP pool must be used for IP address allocation for this network interface. This field is required if vcenter.nsx.cluster_overlay_network_spec.mode is set to IP_POOL. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value IP_POOL. This field is optional and it is only relevant when the value of mode is IP_POOL.
cluster_enable_spec.overlay_network.ip_pool_spec ip_pool_create_spec New NSX IP pool information. If the vcenter.nsx.cluster_overlay_network_spec.mode is set to IP_POOL and vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is set to true, then this field contains the specification for the new NSX IP pool to be created and used for the network interface. The IP address from this NSX IP pool is assigned to a new vmnic on each host in the vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value IP_POOL. To be unset when vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is false. If it is set when vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is set to false, then it is ignored.
cluster_enable_spec.overlay_network.ip_pool_spec.cidr ipv4_cidr The CIDR string denoting the range of IP addresses and the prefix length. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.ip_pool_create_spec.ip_range is set. If vcenter.nsx.ip_pool_create_spec.cidr and vcenter.nsx.ip_pool_create_spec.ip_range are both set, then InvalidArgument error is thrown.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range ipv4_range The IPv4 address range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.ip_pool_create_spec.cidr is set. If vcenter.nsx.ip_pool_create_spec.cidr and vcenter.nsx.ip_pool_create_spec.ip_range are both set, then InvalidArgument error is thrown.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.ending_address string The IPv4 address denoting the end of the range. The range includes the vcenter.nsx.ipv4_range.ending_address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when size_specifier has value ENDING_ADDRESS. This field is optional and it is only relevant when the value of size_specifier is ENDING_ADDRESS.
cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.address_count long A positive number denoting the number of IP addresses in the range. Addresses are derived by incrementing vcenter.nsx.ipv4_range.starting_address. This field is for future use. It is not supported yet. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when size_specifier has value ADDRESS_COUNT. This field is optional and it is only relevant when the value of size_specifier is ADDRESS_COUNT.
cluster_enable_spec.overlay_network.ip_pool string ID(Name) of the existing NSX IP pool. If the vcenter.nsx.cluster_overlay_network_spec.mode is set to IP_POOL and vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is set to false, then this field contains the ID of an existing NSX IP pool to be used for the network interface. The IP address from this NSX IP pool is assigned to a new vmnic on each host in the vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when mode has value IP_POOL. To be unset when vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is true. If it is set when vcenter.nsx.cluster_overlay_network_spec.create_ip_pool is set to true, then it is ignored.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.nsx.pools.ip_pool.
edge_cluster_enable_spec.placement.resource_pool string Identifier for the resource pool associated with the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.placement_spec.create_resource_pool is true. If unset and vcenter.nsx.placement_spec.create_resource_pool is set to false, then the root resource pool will be associated with the NSX Edge node(s).When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool.
edge_cluster_enable_spec.placement.resource_pool_name string Name of the new resource pool to be created and associated with the NSX Edge node(s). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.placement_spec.create_resource_pool is false.
edge_cluster_enable_spec.uplink_network.vlan long The VLAN identifier for the network. Possible values:
  • A value from 1 to 4094 specifies a VLAN ID for the network.
  • Any other value (including 0) is invalid.
. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field is currently required. It is optional for future development.
edge_cluster_enable_spec.overlay_network.vlan long The VLAN identifier for this network. Possible values:
  • A value from 1 to 4094 specifies a VLAN ID for the network.
  • Any other value (including 0) is invalid.
. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field is currently required. It is optional for future development.
edge_cluster_enable_spec.overlay_network.ip_pool_spec ip_pool_create_spec New NSX IP pool information. If vcenter.nsx.edge_overlay_network_spec.create_ip_pool is set to true, then this field contains the specification for the new NSX IP pool to be created and used for the network interface. The IP address from this NSX IP pool is assigned to the tunnel endpoint on each NSX Edge node in the vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.edge_overlay_network_spec.create_ip_pool is false. If it is set when vcenter.nsx.edge_overlay_network_spec.create_ip_pool is set to false, then it is ignored.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.cidr ipv4_cidr The CIDR string denoting the range of IP addresses and the prefix length. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.ip_pool_create_spec.ip_range is set. If vcenter.nsx.ip_pool_create_spec.cidr and vcenter.nsx.ip_pool_create_spec.ip_range are both set, then InvalidArgument error is thrown.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range ipv4_range The IPv4 address range. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.ip_pool_create_spec.cidr is set. If vcenter.nsx.ip_pool_create_spec.cidr and vcenter.nsx.ip_pool_create_spec.ip_range are both set, then InvalidArgument error is thrown.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.ending_address string The IPv4 address denoting the end of the range. The range includes the vcenter.nsx.ipv4_range.ending_address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when size_specifier has value ENDING_ADDRESS. This field is optional and it is only relevant when the value of size_specifier is ENDING_ADDRESS.
edge_cluster_enable_spec.overlay_network.ip_pool_spec.ip_range.address_count long A positive number denoting the number of IP addresses in the range. Addresses are derived by incrementing vcenter.nsx.ipv4_range.starting_address. This field is for future use. It is not supported yet. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when size_specifier has value ADDRESS_COUNT. This field is optional and it is only relevant when the value of size_specifier is ADDRESS_COUNT.
edge_cluster_enable_spec.overlay_network.ip_pool string ID(Name) of the existing NSX IP pool. If vcenter.nsx.edge_overlay_network_spec.create_ip_pool is set to false, then this field contains the ID of an existing NSX IP pool to be used for the network interface. The IP address from this NSX IP pool is assigned to the tunnel endpoint on each NSX Edge node in the vSphere cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. To be unset when vcenter.nsx.edge_overlay_network_spec.create_ip_pool is true. If it is set when vcenter.nsx.edge_overlay_network_spec.create_ip_pool is set to true, then it is ignored.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.nsx.pools.ip_pool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.nsx.pools.ip_pool.