1. Packages
  2. Vsphere Provider
  3. API Docs
  4. DistributedPortGroup
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi

vsphere.DistributedPortGroup

Explore with Pulumi AI

The vsphere.DistributedPortGroup resource can be used to manage distributed port groups connected to vSphere Distributed Switches (VDS). A vSphere Distributed Switch can be managed by the vsphere.DistributedVirtualSwitch resource.

Distributed port groups can be used as networks for virtual machines, allowing the virtual machines to use the networking supplied by a vSphere Distributed Switch, with a set of policies that apply to that individual network, if desired.

NOTE: This resource requires vCenter and is not available on direct ESXi host connections.

Example Usage

The configuration below builds on the example given in the vsphere.DistributedVirtualSwitch resource by adding the vsphere.DistributedPortGroup resource, attaching itself to the vSphere Distributed Switch and assigning VLAN ID 1000.

import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const config = new pulumi.Config();
const hosts = config.getObject<any>("hosts") || [
    "esxi-01.example.com",
    "esxi-02.example.com",
    "esxi-03.example.com",
];
const networkInterfaces = config.getObject<any>("networkInterfaces") || [
    "vmnic0",
    "vmnic1",
    "vmnic2",
    "vmnic3",
];
const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const host = (new Array(hosts.length)).map((_, i) => i).map(__index => (vsphere.getHost({
    name: hosts[__index],
    datacenterId: _arg0_.id,
})));
const vds = new vsphere.DistributedVirtualSwitch("vds", {
    name: "vds-01",
    datacenterId: datacenter.then(datacenter => datacenter.id),
    uplinks: [
        "uplink1",
        "uplink2",
        "uplink3",
        "uplink4",
    ],
    activeUplinks: [
        "uplink1",
        "uplink2",
    ],
    standbyUplinks: [
        "uplink3",
        "uplink4",
    ],
    hosts: [
        {
            hostSystemId: host[0].then(host => host.id),
            devices: [networkInterfaces],
        },
        {
            hostSystemId: host[1].then(host => host.id),
            devices: [networkInterfaces],
        },
        {
            hostSystemId: host[2].then(host => host.id),
            devices: [networkInterfaces],
        },
    ],
});
const pg = new vsphere.DistributedPortGroup("pg", {
    name: "pg-01",
    distributedVirtualSwitchUuid: vds.id,
    vlanId: 1000,
});
Copy
import pulumi
import pulumi_vsphere as vsphere

config = pulumi.Config()
hosts = config.get_object("hosts")
if hosts is None:
    hosts = [
        "esxi-01.example.com",
        "esxi-02.example.com",
        "esxi-03.example.com",
    ]
network_interfaces = config.get_object("networkInterfaces")
if network_interfaces is None:
    network_interfaces = [
        "vmnic0",
        "vmnic1",
        "vmnic2",
        "vmnic3",
    ]
datacenter = vsphere.get_datacenter(name="dc-01")
host = [vsphere.get_host(name=hosts[__index],
    datacenter_id=datacenter.id) for __index in range(len(hosts))]
vds = vsphere.DistributedVirtualSwitch("vds",
    name="vds-01",
    datacenter_id=datacenter.id,
    uplinks=[
        "uplink1",
        "uplink2",
        "uplink3",
        "uplink4",
    ],
    active_uplinks=[
        "uplink1",
        "uplink2",
    ],
    standby_uplinks=[
        "uplink3",
        "uplink4",
    ],
    hosts=[
        {
            "host_system_id": host[0].id,
            "devices": [network_interfaces],
        },
        {
            "host_system_id": host[1].id,
            "devices": [network_interfaces],
        },
        {
            "host_system_id": host[2].id,
            "devices": [network_interfaces],
        },
    ])
pg = vsphere.DistributedPortGroup("pg",
    name="pg-01",
    distributed_virtual_switch_uuid=vds.id,
    vlan_id=1000)
Copy
Coming soon!
Coming soon!
Coming soon!
Coming soon!

Overriding VDS policies

All of the default port policies available in the vsphere.DistributedVirtualSwitch resource can be overridden on the port group level by specifying new settings for them.

As an example, we also take this example from the vsphere.DistributedVirtualSwitch resource where we manually specify our uplink count and uplink order. While the vSphere Distributed Switch has a default policy of using the first uplink as an active uplink and the second one as a standby, the overridden port group policy means that both uplinks will be used as active uplinks in this specific port group.

import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const vds = new vsphere.DistributedVirtualSwitch("vds", {
    name: "vds-01",
    datacenterId: datacenter.id,
    uplinks: [
        "uplink1",
        "uplink2",
    ],
    activeUplinks: ["uplink1"],
    standbyUplinks: ["uplink2"],
});
const pg = new vsphere.DistributedPortGroup("pg", {
    name: "pg-01",
    distributedVirtualSwitchUuid: vds.id,
    vlanId: 1000,
    activeUplinks: [
        "uplink1",
        "uplink2",
    ],
    standbyUplinks: [],
});
Copy
import pulumi
import pulumi_vsphere as vsphere

vds = vsphere.DistributedVirtualSwitch("vds",
    name="vds-01",
    datacenter_id=datacenter["id"],
    uplinks=[
        "uplink1",
        "uplink2",
    ],
    active_uplinks=["uplink1"],
    standby_uplinks=["uplink2"])
pg = vsphere.DistributedPortGroup("pg",
    name="pg-01",
    distributed_virtual_switch_uuid=vds.id,
    vlan_id=1000,
    active_uplinks=[
        "uplink1",
        "uplink2",
    ],
    standby_uplinks=[])
Copy
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		vds, err := vsphere.NewDistributedVirtualSwitch(ctx, "vds", &vsphere.DistributedVirtualSwitchArgs{
			Name:         pulumi.String("vds-01"),
			DatacenterId: pulumi.Any(datacenter.Id),
			Uplinks: pulumi.StringArray{
				pulumi.String("uplink1"),
				pulumi.String("uplink2"),
			},
			ActiveUplinks: pulumi.StringArray{
				pulumi.String("uplink1"),
			},
			StandbyUplinks: pulumi.StringArray{
				pulumi.String("uplink2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = vsphere.NewDistributedPortGroup(ctx, "pg", &vsphere.DistributedPortGroupArgs{
			Name:                         pulumi.String("pg-01"),
			DistributedVirtualSwitchUuid: vds.ID(),
			VlanId:                       pulumi.Int(1000),
			ActiveUplinks: pulumi.StringArray{
				pulumi.String("uplink1"),
				pulumi.String("uplink2"),
			},
			StandbyUplinks: pulumi.StringArray{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var vds = new VSphere.DistributedVirtualSwitch("vds", new()
    {
        Name = "vds-01",
        DatacenterId = datacenter.Id,
        Uplinks = new[]
        {
            "uplink1",
            "uplink2",
        },
        ActiveUplinks = new[]
        {
            "uplink1",
        },
        StandbyUplinks = new[]
        {
            "uplink2",
        },
    });

    var pg = new VSphere.DistributedPortGroup("pg", new()
    {
        Name = "pg-01",
        DistributedVirtualSwitchUuid = vds.Id,
        VlanId = 1000,
        ActiveUplinks = new[]
        {
            "uplink1",
            "uplink2",
        },
        StandbyUplinks = new[] {},
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.DistributedVirtualSwitch;
import com.pulumi.vsphere.DistributedVirtualSwitchArgs;
import com.pulumi.vsphere.DistributedPortGroup;
import com.pulumi.vsphere.DistributedPortGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vds = new DistributedVirtualSwitch("vds", DistributedVirtualSwitchArgs.builder()
            .name("vds-01")
            .datacenterId(datacenter.id())
            .uplinks(            
                "uplink1",
                "uplink2")
            .activeUplinks("uplink1")
            .standbyUplinks("uplink2")
            .build());

        var pg = new DistributedPortGroup("pg", DistributedPortGroupArgs.builder()
            .name("pg-01")
            .distributedVirtualSwitchUuid(vds.id())
            .vlanId(1000)
            .activeUplinks(            
                "uplink1",
                "uplink2")
            .standbyUplinks()
            .build());

    }
}
Copy
resources:
  vds:
    type: vsphere:DistributedVirtualSwitch
    properties:
      name: vds-01
      datacenterId: ${datacenter.id}
      uplinks:
        - uplink1
        - uplink2
      activeUplinks:
        - uplink1
      standbyUplinks:
        - uplink2
  pg:
    type: vsphere:DistributedPortGroup
    properties:
      name: pg-01
      distributedVirtualSwitchUuid: ${vds.id}
      vlanId: 1000
      activeUplinks:
        - uplink1
        - uplink2
      standbyUplinks: []
Copy

Create DistributedPortGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DistributedPortGroup(name: string, args: DistributedPortGroupArgs, opts?: CustomResourceOptions);
@overload
def DistributedPortGroup(resource_name: str,
                         args: DistributedPortGroupArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DistributedPortGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         distributed_virtual_switch_uuid: Optional[str] = None,
                         lacp_mode: Optional[str] = None,
                         failback: Optional[bool] = None,
                         allow_promiscuous: Optional[bool] = None,
                         auto_expand: Optional[bool] = None,
                         block_all_ports: Optional[bool] = None,
                         block_override_allowed: Optional[bool] = None,
                         check_beacon: Optional[bool] = None,
                         custom_attributes: Optional[Mapping[str, str]] = None,
                         description: Optional[str] = None,
                         directpath_gen2_allowed: Optional[bool] = None,
                         allow_forged_transmits: Optional[bool] = None,
                         egress_shaping_average_bandwidth: Optional[int] = None,
                         egress_shaping_burst_size: Optional[int] = None,
                         netflow_enabled: Optional[bool] = None,
                         egress_shaping_peak_bandwidth: Optional[int] = None,
                         name: Optional[str] = None,
                         ingress_shaping_average_bandwidth: Optional[int] = None,
                         ingress_shaping_burst_size: Optional[int] = None,
                         ingress_shaping_enabled: Optional[bool] = None,
                         ingress_shaping_peak_bandwidth: Optional[int] = None,
                         lacp_enabled: Optional[bool] = None,
                         active_uplinks: Optional[Sequence[str]] = None,
                         allow_mac_changes: Optional[bool] = None,
                         live_port_moving_allowed: Optional[bool] = None,
                         egress_shaping_enabled: Optional[bool] = None,
                         netflow_override_allowed: Optional[bool] = None,
                         network_resource_pool_key: Optional[str] = None,
                         network_resource_pool_override_allowed: Optional[bool] = None,
                         notify_switches: Optional[bool] = None,
                         number_of_ports: Optional[int] = None,
                         port_config_reset_at_disconnect: Optional[bool] = None,
                         port_name_format: Optional[str] = None,
                         port_private_secondary_vlan_id: Optional[int] = None,
                         security_policy_override_allowed: Optional[bool] = None,
                         shaping_override_allowed: Optional[bool] = None,
                         standby_uplinks: Optional[Sequence[str]] = None,
                         tags: Optional[Sequence[str]] = None,
                         teaming_policy: Optional[str] = None,
                         traffic_filter_override_allowed: Optional[bool] = None,
                         tx_uplink: Optional[bool] = None,
                         type: Optional[str] = None,
                         uplink_teaming_override_allowed: Optional[bool] = None,
                         vlan_id: Optional[int] = None,
                         vlan_override_allowed: Optional[bool] = None,
                         vlan_ranges: Optional[Sequence[DistributedPortGroupVlanRangeArgs]] = None)
func NewDistributedPortGroup(ctx *Context, name string, args DistributedPortGroupArgs, opts ...ResourceOption) (*DistributedPortGroup, error)
public DistributedPortGroup(string name, DistributedPortGroupArgs args, CustomResourceOptions? opts = null)
public DistributedPortGroup(String name, DistributedPortGroupArgs args)
public DistributedPortGroup(String name, DistributedPortGroupArgs args, CustomResourceOptions options)
type: vsphere:DistributedPortGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DistributedPortGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DistributedPortGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DistributedPortGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DistributedPortGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DistributedPortGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var distributedPortGroupResource = new VSphere.DistributedPortGroup("distributedPortGroupResource", new()
{
    DistributedVirtualSwitchUuid = "string",
    LacpMode = "string",
    Failback = false,
    AllowPromiscuous = false,
    AutoExpand = false,
    BlockAllPorts = false,
    BlockOverrideAllowed = false,
    CheckBeacon = false,
    CustomAttributes = 
    {
        { "string", "string" },
    },
    Description = "string",
    DirectpathGen2Allowed = false,
    AllowForgedTransmits = false,
    EgressShapingAverageBandwidth = 0,
    EgressShapingBurstSize = 0,
    NetflowEnabled = false,
    EgressShapingPeakBandwidth = 0,
    Name = "string",
    IngressShapingAverageBandwidth = 0,
    IngressShapingBurstSize = 0,
    IngressShapingEnabled = false,
    IngressShapingPeakBandwidth = 0,
    LacpEnabled = false,
    ActiveUplinks = new[]
    {
        "string",
    },
    AllowMacChanges = false,
    LivePortMovingAllowed = false,
    EgressShapingEnabled = false,
    NetflowOverrideAllowed = false,
    NetworkResourcePoolKey = "string",
    NetworkResourcePoolOverrideAllowed = false,
    NotifySwitches = false,
    NumberOfPorts = 0,
    PortConfigResetAtDisconnect = false,
    PortNameFormat = "string",
    PortPrivateSecondaryVlanId = 0,
    SecurityPolicyOverrideAllowed = false,
    ShapingOverrideAllowed = false,
    StandbyUplinks = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    TeamingPolicy = "string",
    TrafficFilterOverrideAllowed = false,
    TxUplink = false,
    Type = "string",
    UplinkTeamingOverrideAllowed = false,
    VlanId = 0,
    VlanOverrideAllowed = false,
    VlanRanges = new[]
    {
        new VSphere.Inputs.DistributedPortGroupVlanRangeArgs
        {
            MaxVlan = 0,
            MinVlan = 0,
        },
    },
});
Copy
example, err := vsphere.NewDistributedPortGroup(ctx, "distributedPortGroupResource", &vsphere.DistributedPortGroupArgs{
	DistributedVirtualSwitchUuid: pulumi.String("string"),
	LacpMode:                     pulumi.String("string"),
	Failback:                     pulumi.Bool(false),
	AllowPromiscuous:             pulumi.Bool(false),
	AutoExpand:                   pulumi.Bool(false),
	BlockAllPorts:                pulumi.Bool(false),
	BlockOverrideAllowed:         pulumi.Bool(false),
	CheckBeacon:                  pulumi.Bool(false),
	CustomAttributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:                    pulumi.String("string"),
	DirectpathGen2Allowed:          pulumi.Bool(false),
	AllowForgedTransmits:           pulumi.Bool(false),
	EgressShapingAverageBandwidth:  pulumi.Int(0),
	EgressShapingBurstSize:         pulumi.Int(0),
	NetflowEnabled:                 pulumi.Bool(false),
	EgressShapingPeakBandwidth:     pulumi.Int(0),
	Name:                           pulumi.String("string"),
	IngressShapingAverageBandwidth: pulumi.Int(0),
	IngressShapingBurstSize:        pulumi.Int(0),
	IngressShapingEnabled:          pulumi.Bool(false),
	IngressShapingPeakBandwidth:    pulumi.Int(0),
	LacpEnabled:                    pulumi.Bool(false),
	ActiveUplinks: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowMacChanges:                    pulumi.Bool(false),
	LivePortMovingAllowed:              pulumi.Bool(false),
	EgressShapingEnabled:               pulumi.Bool(false),
	NetflowOverrideAllowed:             pulumi.Bool(false),
	NetworkResourcePoolKey:             pulumi.String("string"),
	NetworkResourcePoolOverrideAllowed: pulumi.Bool(false),
	NotifySwitches:                     pulumi.Bool(false),
	NumberOfPorts:                      pulumi.Int(0),
	PortConfigResetAtDisconnect:        pulumi.Bool(false),
	PortNameFormat:                     pulumi.String("string"),
	PortPrivateSecondaryVlanId:         pulumi.Int(0),
	SecurityPolicyOverrideAllowed:      pulumi.Bool(false),
	ShapingOverrideAllowed:             pulumi.Bool(false),
	StandbyUplinks: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TeamingPolicy:                pulumi.String("string"),
	TrafficFilterOverrideAllowed: pulumi.Bool(false),
	TxUplink:                     pulumi.Bool(false),
	Type:                         pulumi.String("string"),
	UplinkTeamingOverrideAllowed: pulumi.Bool(false),
	VlanId:                       pulumi.Int(0),
	VlanOverrideAllowed:          pulumi.Bool(false),
	VlanRanges: vsphere.DistributedPortGroupVlanRangeArray{
		&vsphere.DistributedPortGroupVlanRangeArgs{
			MaxVlan: pulumi.Int(0),
			MinVlan: pulumi.Int(0),
		},
	},
})
Copy
var distributedPortGroupResource = new DistributedPortGroup("distributedPortGroupResource", DistributedPortGroupArgs.builder()
    .distributedVirtualSwitchUuid("string")
    .lacpMode("string")
    .failback(false)
    .allowPromiscuous(false)
    .autoExpand(false)
    .blockAllPorts(false)
    .blockOverrideAllowed(false)
    .checkBeacon(false)
    .customAttributes(Map.of("string", "string"))
    .description("string")
    .directpathGen2Allowed(false)
    .allowForgedTransmits(false)
    .egressShapingAverageBandwidth(0)
    .egressShapingBurstSize(0)
    .netflowEnabled(false)
    .egressShapingPeakBandwidth(0)
    .name("string")
    .ingressShapingAverageBandwidth(0)
    .ingressShapingBurstSize(0)
    .ingressShapingEnabled(false)
    .ingressShapingPeakBandwidth(0)
    .lacpEnabled(false)
    .activeUplinks("string")
    .allowMacChanges(false)
    .livePortMovingAllowed(false)
    .egressShapingEnabled(false)
    .netflowOverrideAllowed(false)
    .networkResourcePoolKey("string")
    .networkResourcePoolOverrideAllowed(false)
    .notifySwitches(false)
    .numberOfPorts(0)
    .portConfigResetAtDisconnect(false)
    .portNameFormat("string")
    .portPrivateSecondaryVlanId(0)
    .securityPolicyOverrideAllowed(false)
    .shapingOverrideAllowed(false)
    .standbyUplinks("string")
    .tags("string")
    .teamingPolicy("string")
    .trafficFilterOverrideAllowed(false)
    .txUplink(false)
    .type("string")
    .uplinkTeamingOverrideAllowed(false)
    .vlanId(0)
    .vlanOverrideAllowed(false)
    .vlanRanges(DistributedPortGroupVlanRangeArgs.builder()
        .maxVlan(0)
        .minVlan(0)
        .build())
    .build());
Copy
distributed_port_group_resource = vsphere.DistributedPortGroup("distributedPortGroupResource",
    distributed_virtual_switch_uuid="string",
    lacp_mode="string",
    failback=False,
    allow_promiscuous=False,
    auto_expand=False,
    block_all_ports=False,
    block_override_allowed=False,
    check_beacon=False,
    custom_attributes={
        "string": "string",
    },
    description="string",
    directpath_gen2_allowed=False,
    allow_forged_transmits=False,
    egress_shaping_average_bandwidth=0,
    egress_shaping_burst_size=0,
    netflow_enabled=False,
    egress_shaping_peak_bandwidth=0,
    name="string",
    ingress_shaping_average_bandwidth=0,
    ingress_shaping_burst_size=0,
    ingress_shaping_enabled=False,
    ingress_shaping_peak_bandwidth=0,
    lacp_enabled=False,
    active_uplinks=["string"],
    allow_mac_changes=False,
    live_port_moving_allowed=False,
    egress_shaping_enabled=False,
    netflow_override_allowed=False,
    network_resource_pool_key="string",
    network_resource_pool_override_allowed=False,
    notify_switches=False,
    number_of_ports=0,
    port_config_reset_at_disconnect=False,
    port_name_format="string",
    port_private_secondary_vlan_id=0,
    security_policy_override_allowed=False,
    shaping_override_allowed=False,
    standby_uplinks=["string"],
    tags=["string"],
    teaming_policy="string",
    traffic_filter_override_allowed=False,
    tx_uplink=False,
    type="string",
    uplink_teaming_override_allowed=False,
    vlan_id=0,
    vlan_override_allowed=False,
    vlan_ranges=[{
        "max_vlan": 0,
        "min_vlan": 0,
    }])
Copy
const distributedPortGroupResource = new vsphere.DistributedPortGroup("distributedPortGroupResource", {
    distributedVirtualSwitchUuid: "string",
    lacpMode: "string",
    failback: false,
    allowPromiscuous: false,
    autoExpand: false,
    blockAllPorts: false,
    blockOverrideAllowed: false,
    checkBeacon: false,
    customAttributes: {
        string: "string",
    },
    description: "string",
    directpathGen2Allowed: false,
    allowForgedTransmits: false,
    egressShapingAverageBandwidth: 0,
    egressShapingBurstSize: 0,
    netflowEnabled: false,
    egressShapingPeakBandwidth: 0,
    name: "string",
    ingressShapingAverageBandwidth: 0,
    ingressShapingBurstSize: 0,
    ingressShapingEnabled: false,
    ingressShapingPeakBandwidth: 0,
    lacpEnabled: false,
    activeUplinks: ["string"],
    allowMacChanges: false,
    livePortMovingAllowed: false,
    egressShapingEnabled: false,
    netflowOverrideAllowed: false,
    networkResourcePoolKey: "string",
    networkResourcePoolOverrideAllowed: false,
    notifySwitches: false,
    numberOfPorts: 0,
    portConfigResetAtDisconnect: false,
    portNameFormat: "string",
    portPrivateSecondaryVlanId: 0,
    securityPolicyOverrideAllowed: false,
    shapingOverrideAllowed: false,
    standbyUplinks: ["string"],
    tags: ["string"],
    teamingPolicy: "string",
    trafficFilterOverrideAllowed: false,
    txUplink: false,
    type: "string",
    uplinkTeamingOverrideAllowed: false,
    vlanId: 0,
    vlanOverrideAllowed: false,
    vlanRanges: [{
        maxVlan: 0,
        minVlan: 0,
    }],
});
Copy
type: vsphere:DistributedPortGroup
properties:
    activeUplinks:
        - string
    allowForgedTransmits: false
    allowMacChanges: false
    allowPromiscuous: false
    autoExpand: false
    blockAllPorts: false
    blockOverrideAllowed: false
    checkBeacon: false
    customAttributes:
        string: string
    description: string
    directpathGen2Allowed: false
    distributedVirtualSwitchUuid: string
    egressShapingAverageBandwidth: 0
    egressShapingBurstSize: 0
    egressShapingEnabled: false
    egressShapingPeakBandwidth: 0
    failback: false
    ingressShapingAverageBandwidth: 0
    ingressShapingBurstSize: 0
    ingressShapingEnabled: false
    ingressShapingPeakBandwidth: 0
    lacpEnabled: false
    lacpMode: string
    livePortMovingAllowed: false
    name: string
    netflowEnabled: false
    netflowOverrideAllowed: false
    networkResourcePoolKey: string
    networkResourcePoolOverrideAllowed: false
    notifySwitches: false
    numberOfPorts: 0
    portConfigResetAtDisconnect: false
    portNameFormat: string
    portPrivateSecondaryVlanId: 0
    securityPolicyOverrideAllowed: false
    shapingOverrideAllowed: false
    standbyUplinks:
        - string
    tags:
        - string
    teamingPolicy: string
    trafficFilterOverrideAllowed: false
    txUplink: false
    type: string
    uplinkTeamingOverrideAllowed: false
    vlanId: 0
    vlanOverrideAllowed: false
    vlanRanges:
        - maxVlan: 0
          minVlan: 0
Copy

DistributedPortGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DistributedPortGroup resource accepts the following input properties:

DistributedVirtualSwitchUuid
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VDS to add the port group to. Forces a new resource if changed.
ActiveUplinks List<string>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
AllowForgedTransmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
AllowMacChanges bool
Controls whether or not the Media Access Control (MAC) address can be changed.
AllowPromiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
AutoExpand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

BlockAllPorts bool
Indicates whether to block all ports by default.
BlockOverrideAllowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
CheckBeacon bool
Enable beacon probing on the ports this policy applies to.
CustomAttributes Dictionary<string, string>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

Description string
An optional description for the port group.
DirectpathGen2Allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
EgressShapingAverageBandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
EgressShapingBurstSize int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
EgressShapingEnabled bool
True if the traffic shaper is enabled for egress traffic on the port.
EgressShapingPeakBandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
Failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
IngressShapingAverageBandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
IngressShapingBurstSize int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
IngressShapingEnabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
IngressShapingPeakBandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
LacpEnabled bool
Whether or not to enable LACP on all uplink ports.
LacpMode string
The uplink LACP mode to use. Can be one of active or passive.
LivePortMovingAllowed bool
Allow a live port to be moved in and out of the portgroup.
Name string
The name of the port group.
NetflowEnabled bool
Indicates whether to enable netflow on all ports.
NetflowOverrideAllowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
NetworkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
NetworkResourcePoolOverrideAllowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
NotifySwitches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
NumberOfPorts int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
PortConfigResetAtDisconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
PortNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
PortPrivateSecondaryVlanId int
The secondary VLAN ID for this port.
SecurityPolicyOverrideAllowed bool
Allow security policy settings on a port to override those on the portgroup.
ShapingOverrideAllowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
StandbyUplinks List<string>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
Tags List<string>
A list of tag IDs to apply to this object.
TeamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
TrafficFilterOverrideAllowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
TxUplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
Type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
UplinkTeamingOverrideAllowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
VlanId int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
VlanOverrideAllowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
VlanRanges List<Pulumi.VSphere.Inputs.DistributedPortGroupVlanRange>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
DistributedVirtualSwitchUuid
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VDS to add the port group to. Forces a new resource if changed.
ActiveUplinks []string
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
AllowForgedTransmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
AllowMacChanges bool
Controls whether or not the Media Access Control (MAC) address can be changed.
AllowPromiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
AutoExpand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

BlockAllPorts bool
Indicates whether to block all ports by default.
BlockOverrideAllowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
CheckBeacon bool
Enable beacon probing on the ports this policy applies to.
CustomAttributes map[string]string

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

Description string
An optional description for the port group.
DirectpathGen2Allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
EgressShapingAverageBandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
EgressShapingBurstSize int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
EgressShapingEnabled bool
True if the traffic shaper is enabled for egress traffic on the port.
EgressShapingPeakBandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
Failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
IngressShapingAverageBandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
IngressShapingBurstSize int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
IngressShapingEnabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
IngressShapingPeakBandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
LacpEnabled bool
Whether or not to enable LACP on all uplink ports.
LacpMode string
The uplink LACP mode to use. Can be one of active or passive.
LivePortMovingAllowed bool
Allow a live port to be moved in and out of the portgroup.
Name string
The name of the port group.
NetflowEnabled bool
Indicates whether to enable netflow on all ports.
NetflowOverrideAllowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
NetworkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
NetworkResourcePoolOverrideAllowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
NotifySwitches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
NumberOfPorts int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
PortConfigResetAtDisconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
PortNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
PortPrivateSecondaryVlanId int
The secondary VLAN ID for this port.
SecurityPolicyOverrideAllowed bool
Allow security policy settings on a port to override those on the portgroup.
ShapingOverrideAllowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
StandbyUplinks []string
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
Tags []string
A list of tag IDs to apply to this object.
TeamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
TrafficFilterOverrideAllowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
TxUplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
Type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
UplinkTeamingOverrideAllowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
VlanId int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
VlanOverrideAllowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
VlanRanges []DistributedPortGroupVlanRangeArgs
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
distributedVirtualSwitchUuid
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VDS to add the port group to. Forces a new resource if changed.
activeUplinks List<String>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits Boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges Boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous Boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand Boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts Boolean
Indicates whether to block all ports by default.
blockOverrideAllowed Boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon Boolean
Enable beacon probing on the ports this policy applies to.
customAttributes Map<String,String>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description String
An optional description for the port group.
directpathGen2Allowed Boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
egressShapingAverageBandwidth Integer
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize Integer
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled Boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth Integer
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback Boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth Integer
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize Integer
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled Boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth Integer
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
lacpEnabled Boolean
Whether or not to enable LACP on all uplink ports.
lacpMode String
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed Boolean
Allow a live port to be moved in and out of the portgroup.
name String
The name of the port group.
netflowEnabled Boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed Boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey String
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed Boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches Boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts Integer
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect Boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat String
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId Integer
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed Boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed Boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks List<String>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags List<String>
A list of tag IDs to apply to this object.
teamingPolicy String
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed Boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink Boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type String
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed Boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId Integer
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed Boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges List<DistributedPortGroupVlanRange>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
distributedVirtualSwitchUuid
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VDS to add the port group to. Forces a new resource if changed.
activeUplinks string[]
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts boolean
Indicates whether to block all ports by default.
blockOverrideAllowed boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon boolean
Enable beacon probing on the ports this policy applies to.
customAttributes {[key: string]: string}

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description string
An optional description for the port group.
directpathGen2Allowed boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
egressShapingAverageBandwidth number
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize number
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth number
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth number
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize number
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth number
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
lacpEnabled boolean
Whether or not to enable LACP on all uplink ports.
lacpMode string
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed boolean
Allow a live port to be moved in and out of the portgroup.
name string
The name of the port group.
netflowEnabled boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts number
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId number
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks string[]
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags string[]
A list of tag IDs to apply to this object.
teamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId number
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges DistributedPortGroupVlanRange[]
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
distributed_virtual_switch_uuid
This property is required.
Changes to this property will trigger replacement.
str
The ID of the VDS to add the port group to. Forces a new resource if changed.
active_uplinks Sequence[str]
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allow_forged_transmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allow_mac_changes bool
Controls whether or not the Media Access Control (MAC) address can be changed.
allow_promiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
auto_expand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

block_all_ports bool
Indicates whether to block all ports by default.
block_override_allowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
check_beacon bool
Enable beacon probing on the ports this policy applies to.
custom_attributes Mapping[str, str]

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description str
An optional description for the port group.
directpath_gen2_allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
egress_shaping_average_bandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egress_shaping_burst_size int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egress_shaping_enabled bool
True if the traffic shaper is enabled for egress traffic on the port.
egress_shaping_peak_bandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingress_shaping_average_bandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingress_shaping_burst_size int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingress_shaping_enabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
ingress_shaping_peak_bandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
lacp_enabled bool
Whether or not to enable LACP on all uplink ports.
lacp_mode str
The uplink LACP mode to use. Can be one of active or passive.
live_port_moving_allowed bool
Allow a live port to be moved in and out of the portgroup.
name str
The name of the port group.
netflow_enabled bool
Indicates whether to enable netflow on all ports.
netflow_override_allowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
network_resource_pool_key str
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
network_resource_pool_override_allowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
notify_switches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
number_of_ports int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
port_config_reset_at_disconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
port_name_format str
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
port_private_secondary_vlan_id int
The secondary VLAN ID for this port.
security_policy_override_allowed bool
Allow security policy settings on a port to override those on the portgroup.
shaping_override_allowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standby_uplinks Sequence[str]
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags Sequence[str]
A list of tag IDs to apply to this object.
teaming_policy str
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
traffic_filter_override_allowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
tx_uplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type str
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplink_teaming_override_allowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
vlan_id int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlan_override_allowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
vlan_ranges Sequence[DistributedPortGroupVlanRangeArgs]
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
distributedVirtualSwitchUuid
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VDS to add the port group to. Forces a new resource if changed.
activeUplinks List<String>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits Boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges Boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous Boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand Boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts Boolean
Indicates whether to block all ports by default.
blockOverrideAllowed Boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon Boolean
Enable beacon probing on the ports this policy applies to.
customAttributes Map<String>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description String
An optional description for the port group.
directpathGen2Allowed Boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
egressShapingAverageBandwidth Number
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize Number
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled Boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth Number
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback Boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth Number
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize Number
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled Boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth Number
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
lacpEnabled Boolean
Whether or not to enable LACP on all uplink ports.
lacpMode String
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed Boolean
Allow a live port to be moved in and out of the portgroup.
name String
The name of the port group.
netflowEnabled Boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed Boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey String
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed Boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches Boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts Number
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect Boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat String
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId Number
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed Boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed Boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks List<String>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags List<String>
A list of tag IDs to apply to this object.
teamingPolicy String
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed Boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink Boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type String
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed Boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId Number
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed Boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges List<Property Map>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.

Outputs

All input properties are implicitly available as output properties. Additionally, the DistributedPortGroup resource produces the following output properties:

ConfigVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
Id string
The provider-assigned unique ID for this managed resource.
Key string
The generated UUID of the port group.
ConfigVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
Id string
The provider-assigned unique ID for this managed resource.
Key string
The generated UUID of the port group.
configVersion String
The current version of the port group configuration, incremented by subsequent updates to the port group.
id String
The provider-assigned unique ID for this managed resource.
key String
The generated UUID of the port group.
configVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
id string
The provider-assigned unique ID for this managed resource.
key string
The generated UUID of the port group.
config_version str
The current version of the port group configuration, incremented by subsequent updates to the port group.
id str
The provider-assigned unique ID for this managed resource.
key str
The generated UUID of the port group.
configVersion String
The current version of the port group configuration, incremented by subsequent updates to the port group.
id String
The provider-assigned unique ID for this managed resource.
key String
The generated UUID of the port group.

Look up Existing DistributedPortGroup Resource

Get an existing DistributedPortGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DistributedPortGroupState, opts?: CustomResourceOptions): DistributedPortGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_uplinks: Optional[Sequence[str]] = None,
        allow_forged_transmits: Optional[bool] = None,
        allow_mac_changes: Optional[bool] = None,
        allow_promiscuous: Optional[bool] = None,
        auto_expand: Optional[bool] = None,
        block_all_ports: Optional[bool] = None,
        block_override_allowed: Optional[bool] = None,
        check_beacon: Optional[bool] = None,
        config_version: Optional[str] = None,
        custom_attributes: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        directpath_gen2_allowed: Optional[bool] = None,
        distributed_virtual_switch_uuid: Optional[str] = None,
        egress_shaping_average_bandwidth: Optional[int] = None,
        egress_shaping_burst_size: Optional[int] = None,
        egress_shaping_enabled: Optional[bool] = None,
        egress_shaping_peak_bandwidth: Optional[int] = None,
        failback: Optional[bool] = None,
        ingress_shaping_average_bandwidth: Optional[int] = None,
        ingress_shaping_burst_size: Optional[int] = None,
        ingress_shaping_enabled: Optional[bool] = None,
        ingress_shaping_peak_bandwidth: Optional[int] = None,
        key: Optional[str] = None,
        lacp_enabled: Optional[bool] = None,
        lacp_mode: Optional[str] = None,
        live_port_moving_allowed: Optional[bool] = None,
        name: Optional[str] = None,
        netflow_enabled: Optional[bool] = None,
        netflow_override_allowed: Optional[bool] = None,
        network_resource_pool_key: Optional[str] = None,
        network_resource_pool_override_allowed: Optional[bool] = None,
        notify_switches: Optional[bool] = None,
        number_of_ports: Optional[int] = None,
        port_config_reset_at_disconnect: Optional[bool] = None,
        port_name_format: Optional[str] = None,
        port_private_secondary_vlan_id: Optional[int] = None,
        security_policy_override_allowed: Optional[bool] = None,
        shaping_override_allowed: Optional[bool] = None,
        standby_uplinks: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        teaming_policy: Optional[str] = None,
        traffic_filter_override_allowed: Optional[bool] = None,
        tx_uplink: Optional[bool] = None,
        type: Optional[str] = None,
        uplink_teaming_override_allowed: Optional[bool] = None,
        vlan_id: Optional[int] = None,
        vlan_override_allowed: Optional[bool] = None,
        vlan_ranges: Optional[Sequence[DistributedPortGroupVlanRangeArgs]] = None) -> DistributedPortGroup
func GetDistributedPortGroup(ctx *Context, name string, id IDInput, state *DistributedPortGroupState, opts ...ResourceOption) (*DistributedPortGroup, error)
public static DistributedPortGroup Get(string name, Input<string> id, DistributedPortGroupState? state, CustomResourceOptions? opts = null)
public static DistributedPortGroup get(String name, Output<String> id, DistributedPortGroupState state, CustomResourceOptions options)
resources:  _:    type: vsphere:DistributedPortGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActiveUplinks List<string>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
AllowForgedTransmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
AllowMacChanges bool
Controls whether or not the Media Access Control (MAC) address can be changed.
AllowPromiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
AutoExpand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

BlockAllPorts bool
Indicates whether to block all ports by default.
BlockOverrideAllowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
CheckBeacon bool
Enable beacon probing on the ports this policy applies to.
ConfigVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
CustomAttributes Dictionary<string, string>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

Description string
An optional description for the port group.
DirectpathGen2Allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
DistributedVirtualSwitchUuid Changes to this property will trigger replacement. string
The ID of the VDS to add the port group to. Forces a new resource if changed.
EgressShapingAverageBandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
EgressShapingBurstSize int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
EgressShapingEnabled bool
True if the traffic shaper is enabled for egress traffic on the port.
EgressShapingPeakBandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
Failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
IngressShapingAverageBandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
IngressShapingBurstSize int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
IngressShapingEnabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
IngressShapingPeakBandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
Key string
The generated UUID of the port group.
LacpEnabled bool
Whether or not to enable LACP on all uplink ports.
LacpMode string
The uplink LACP mode to use. Can be one of active or passive.
LivePortMovingAllowed bool
Allow a live port to be moved in and out of the portgroup.
Name string
The name of the port group.
NetflowEnabled bool
Indicates whether to enable netflow on all ports.
NetflowOverrideAllowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
NetworkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
NetworkResourcePoolOverrideAllowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
NotifySwitches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
NumberOfPorts int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
PortConfigResetAtDisconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
PortNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
PortPrivateSecondaryVlanId int
The secondary VLAN ID for this port.
SecurityPolicyOverrideAllowed bool
Allow security policy settings on a port to override those on the portgroup.
ShapingOverrideAllowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
StandbyUplinks List<string>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
Tags List<string>
A list of tag IDs to apply to this object.
TeamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
TrafficFilterOverrideAllowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
TxUplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
Type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
UplinkTeamingOverrideAllowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
VlanId int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
VlanOverrideAllowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
VlanRanges List<Pulumi.VSphere.Inputs.DistributedPortGroupVlanRange>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
ActiveUplinks []string
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
AllowForgedTransmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
AllowMacChanges bool
Controls whether or not the Media Access Control (MAC) address can be changed.
AllowPromiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
AutoExpand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

BlockAllPorts bool
Indicates whether to block all ports by default.
BlockOverrideAllowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
CheckBeacon bool
Enable beacon probing on the ports this policy applies to.
ConfigVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
CustomAttributes map[string]string

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

Description string
An optional description for the port group.
DirectpathGen2Allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
DistributedVirtualSwitchUuid Changes to this property will trigger replacement. string
The ID of the VDS to add the port group to. Forces a new resource if changed.
EgressShapingAverageBandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
EgressShapingBurstSize int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
EgressShapingEnabled bool
True if the traffic shaper is enabled for egress traffic on the port.
EgressShapingPeakBandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
Failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
IngressShapingAverageBandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
IngressShapingBurstSize int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
IngressShapingEnabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
IngressShapingPeakBandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
Key string
The generated UUID of the port group.
LacpEnabled bool
Whether or not to enable LACP on all uplink ports.
LacpMode string
The uplink LACP mode to use. Can be one of active or passive.
LivePortMovingAllowed bool
Allow a live port to be moved in and out of the portgroup.
Name string
The name of the port group.
NetflowEnabled bool
Indicates whether to enable netflow on all ports.
NetflowOverrideAllowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
NetworkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
NetworkResourcePoolOverrideAllowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
NotifySwitches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
NumberOfPorts int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
PortConfigResetAtDisconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
PortNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
PortPrivateSecondaryVlanId int
The secondary VLAN ID for this port.
SecurityPolicyOverrideAllowed bool
Allow security policy settings on a port to override those on the portgroup.
ShapingOverrideAllowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
StandbyUplinks []string
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
Tags []string
A list of tag IDs to apply to this object.
TeamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
TrafficFilterOverrideAllowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
TxUplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
Type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
UplinkTeamingOverrideAllowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
VlanId int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
VlanOverrideAllowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
VlanRanges []DistributedPortGroupVlanRangeArgs
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
activeUplinks List<String>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits Boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges Boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous Boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand Boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts Boolean
Indicates whether to block all ports by default.
blockOverrideAllowed Boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon Boolean
Enable beacon probing on the ports this policy applies to.
configVersion String
The current version of the port group configuration, incremented by subsequent updates to the port group.
customAttributes Map<String,String>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description String
An optional description for the port group.
directpathGen2Allowed Boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
distributedVirtualSwitchUuid Changes to this property will trigger replacement. String
The ID of the VDS to add the port group to. Forces a new resource if changed.
egressShapingAverageBandwidth Integer
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize Integer
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled Boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth Integer
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback Boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth Integer
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize Integer
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled Boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth Integer
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
key String
The generated UUID of the port group.
lacpEnabled Boolean
Whether or not to enable LACP on all uplink ports.
lacpMode String
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed Boolean
Allow a live port to be moved in and out of the portgroup.
name String
The name of the port group.
netflowEnabled Boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed Boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey String
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed Boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches Boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts Integer
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect Boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat String
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId Integer
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed Boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed Boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks List<String>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags List<String>
A list of tag IDs to apply to this object.
teamingPolicy String
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed Boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink Boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type String
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed Boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId Integer
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed Boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges List<DistributedPortGroupVlanRange>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
activeUplinks string[]
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts boolean
Indicates whether to block all ports by default.
blockOverrideAllowed boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon boolean
Enable beacon probing on the ports this policy applies to.
configVersion string
The current version of the port group configuration, incremented by subsequent updates to the port group.
customAttributes {[key: string]: string}

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description string
An optional description for the port group.
directpathGen2Allowed boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
distributedVirtualSwitchUuid Changes to this property will trigger replacement. string
The ID of the VDS to add the port group to. Forces a new resource if changed.
egressShapingAverageBandwidth number
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize number
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth number
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth number
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize number
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth number
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
key string
The generated UUID of the port group.
lacpEnabled boolean
Whether or not to enable LACP on all uplink ports.
lacpMode string
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed boolean
Allow a live port to be moved in and out of the portgroup.
name string
The name of the port group.
netflowEnabled boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey string
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts number
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat string
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId number
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks string[]
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags string[]
A list of tag IDs to apply to this object.
teamingPolicy string
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type string
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId number
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges DistributedPortGroupVlanRange[]
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
active_uplinks Sequence[str]
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allow_forged_transmits bool
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allow_mac_changes bool
Controls whether or not the Media Access Control (MAC) address can be changed.
allow_promiscuous bool
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
auto_expand bool

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

block_all_ports bool
Indicates whether to block all ports by default.
block_override_allowed bool
Allow the blocked setting of an individual port to override the setting in the portgroup.
check_beacon bool
Enable beacon probing on the ports this policy applies to.
config_version str
The current version of the port group configuration, incremented by subsequent updates to the port group.
custom_attributes Mapping[str, str]

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description str
An optional description for the port group.
directpath_gen2_allowed bool
Allow VMDirectPath Gen2 on the ports this policy applies to.
distributed_virtual_switch_uuid Changes to this property will trigger replacement. str
The ID of the VDS to add the port group to. Forces a new resource if changed.
egress_shaping_average_bandwidth int
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egress_shaping_burst_size int
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egress_shaping_enabled bool
True if the traffic shaper is enabled for egress traffic on the port.
egress_shaping_peak_bandwidth int
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback bool
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingress_shaping_average_bandwidth int
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingress_shaping_burst_size int
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingress_shaping_enabled bool
True if the traffic shaper is enabled for ingress traffic on the port.
ingress_shaping_peak_bandwidth int
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
key str
The generated UUID of the port group.
lacp_enabled bool
Whether or not to enable LACP on all uplink ports.
lacp_mode str
The uplink LACP mode to use. Can be one of active or passive.
live_port_moving_allowed bool
Allow a live port to be moved in and out of the portgroup.
name str
The name of the port group.
netflow_enabled bool
Indicates whether to enable netflow on all ports.
netflow_override_allowed bool
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
network_resource_pool_key str
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
network_resource_pool_override_allowed bool
Allow the network resource pool of an individual port to override the setting in the portgroup.
notify_switches bool
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
number_of_ports int
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
port_config_reset_at_disconnect bool
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
port_name_format str
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
port_private_secondary_vlan_id int
The secondary VLAN ID for this port.
security_policy_override_allowed bool
Allow security policy settings on a port to override those on the portgroup.
shaping_override_allowed bool
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standby_uplinks Sequence[str]
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags Sequence[str]
A list of tag IDs to apply to this object.
teaming_policy str
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
traffic_filter_override_allowed bool
Allow any filter policies set on the individual port to override those in the portgroup.
tx_uplink bool
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type str
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplink_teaming_override_allowed bool
Allow the uplink teaming policies on a port to override those on the portgroup.
vlan_id int
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlan_override_allowed bool
Allow the VLAN configuration on a port to override those on the portgroup.
vlan_ranges Sequence[DistributedPortGroupVlanRangeArgs]
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
activeUplinks List<String>
List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
allowForgedTransmits Boolean
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
allowMacChanges Boolean
Controls whether or not the Media Access Control (MAC) address can be changed.
allowPromiscuous Boolean
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
autoExpand Boolean

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

NOTE: Using auto_expand with a statically defined number_of_ports may lead to errors when the port count grows past the amount specified. If you specify number_of_ports, you may wish to set auto_expand to false.

blockAllPorts Boolean
Indicates whether to block all ports by default.
blockOverrideAllowed Boolean
Allow the blocked setting of an individual port to override the setting in the portgroup.
checkBeacon Boolean
Enable beacon probing on the ports this policy applies to.
configVersion String
The current version of the port group configuration, incremented by subsequent updates to the port group.
customAttributes Map<String>

Map of custom attribute ids to attribute value string to set for port group.

NOTE: Custom attributes are not supported on direct ESXi host connections and require vCenter Server.

description String
An optional description for the port group.
directpathGen2Allowed Boolean
Allow VMDirectPath Gen2 on the ports this policy applies to.
distributedVirtualSwitchUuid Changes to this property will trigger replacement. String
The ID of the VDS to add the port group to. Forces a new resource if changed.
egressShapingAverageBandwidth Number
The average egress bandwidth in bits per second if egress shaping is enabled on the port.
egressShapingBurstSize Number
The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
egressShapingEnabled Boolean
True if the traffic shaper is enabled for egress traffic on the port.
egressShapingPeakBandwidth Number
The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
failback Boolean
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
ingressShapingAverageBandwidth Number
The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
ingressShapingBurstSize Number
The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
ingressShapingEnabled Boolean
True if the traffic shaper is enabled for ingress traffic on the port.
ingressShapingPeakBandwidth Number
The peak ingress bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
key String
The generated UUID of the port group.
lacpEnabled Boolean
Whether or not to enable LACP on all uplink ports.
lacpMode String
The uplink LACP mode to use. Can be one of active or passive.
livePortMovingAllowed Boolean
Allow a live port to be moved in and out of the portgroup.
name String
The name of the port group.
netflowEnabled Boolean
Indicates whether to enable netflow on all ports.
netflowOverrideAllowed Boolean
Allow the enabling or disabling of Netflow on a port, contrary to the policy in the portgroup.
networkResourcePoolKey String
The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
networkResourcePoolOverrideAllowed Boolean
Allow the network resource pool of an individual port to override the setting in the portgroup.
notifySwitches Boolean
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
numberOfPorts Number
The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
portConfigResetAtDisconnect Boolean
Reset the setting of any ports in this portgroup back to the default setting when the port disconnects.
portNameFormat String
An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed here for details on the format syntax.
portPrivateSecondaryVlanId Number
The secondary VLAN ID for this port.
securityPolicyOverrideAllowed Boolean
Allow security policy settings on a port to override those on the portgroup.
shapingOverrideAllowed Boolean
Allow the traffic shaping policies of an individual port to override the settings in the portgroup.
standbyUplinks List<String>
List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
tags List<String>
A list of tag IDs to apply to this object.
teamingPolicy String
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
trafficFilterOverrideAllowed Boolean
Allow any filter policies set on the individual port to override those in the portgroup.
txUplink Boolean
If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
type String
The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
uplinkTeamingOverrideAllowed Boolean
Allow the uplink teaming policies on a port to override those on the portgroup.
vlanId Number
The VLAN ID for single VLAN mode. 0 denotes no VLAN.
vlanOverrideAllowed Boolean
Allow the VLAN configuration on a port to override those on the portgroup.
vlanRanges List<Property Map>
The VLAN ID for single VLAN mode. 0 denotes no VLAN.

Supporting Types

DistributedPortGroupVlanRange
, DistributedPortGroupVlanRangeArgs

MaxVlan This property is required. int
The minimum VLAN to use in the range.
MinVlan This property is required. int
The minimum VLAN to use in the range.
MaxVlan This property is required. int
The minimum VLAN to use in the range.
MinVlan This property is required. int
The minimum VLAN to use in the range.
maxVlan This property is required. Integer
The minimum VLAN to use in the range.
minVlan This property is required. Integer
The minimum VLAN to use in the range.
maxVlan This property is required. number
The minimum VLAN to use in the range.
minVlan This property is required. number
The minimum VLAN to use in the range.
max_vlan This property is required. int
The minimum VLAN to use in the range.
min_vlan This property is required. int
The minimum VLAN to use in the range.
maxVlan This property is required. Number
The minimum VLAN to use in the range.
minVlan This property is required. Number
The minimum VLAN to use in the range.

Import

An existing port group can be imported into this resource using

the managed object id of the port group, via the following command:

$ pulumi import vsphere:index/distributedPortGroup:DistributedPortGroup pg /dc-01/network/pg-01
Copy

The above would import the port group named pg-01 that is located in the dc-01

datacenter.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.