This resource type represents a network on VMware vCenter. You must use VMware NSX to access this resource type.

This resource type is provided with the engine, but it is not implemented. You can use it in blueprints and in configuration files, but when you provision an environment, this resource type is ignored. However, the blueprint uses the core properties and extended properties, if any, from this resource type. Review and configure the applicable heat resources that apply to your configuration information.

In the blueprint designer, you can configure the properties that the following table includes. Properties are listed as either core or extended. Each type of property is located in separate sections of the heat resource that you can view in the blueprint designer. You set the core properties in the properties section and set the extended properties in the metadata section of the blueprint.

Table 1. Properties
Name Type Required Core or extended Description
admin_state_up Boolean False Core A Boolean value that specifies the administrative status of the network. The default value is true.
appliance_size String False Extended The size of the edge appliance.
datastore String False Extended The datastore to put the VM in.
dhcp_agent_ids List False Core The IDs of the DHCP agent to schedule the network.
Note: The default policy setting in Neutron restricts usage of this property to administrative users only.
edge_name String True Extended The name of the edge appliance.
name String False Core A string that specifies a symbolic name for the network, which is not required to be unique.
resource_pool String False Extended The resource pool to put the VM in.
shared Boolean False Core Whether this network should be shared across all tenants.
Note: The default policy setting restricts usage of this attribute to administrative users only.
tenant_id String False Core The ID of the tenant that owns the network. Only administrative users can set the tenant identifier, and the identifier cannot be changed by using authorization policies.
transport_zone_id String True Extended The transport zone ID.
value_specs Map False Core Extra parameters to include in the "network" object in the creation request. Parameters are often specific to installed hardware or extensions.
Table 2. Attributes
Name Description
edge_id The ID of the service gateway edge.
logical_switch_id The ID of the logical switch.
portgroup_id The ID of the distributed virtual port group.