Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

DistributedPortGroup

Create a DistributedPortGroup Resource

new DistributedPortGroup(name: string, args: DistributedPortGroupArgs, opts?: CustomResourceOptions);
def DistributedPortGroup(resource_name: 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, 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, 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)
func NewDistributedPortGroup(ctx *Context, name string, args DistributedPortGroupArgs, opts ...ResourceOption) (*DistributedPortGroup, error)
public DistributedPortGroup(string name, DistributedPortGroupArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DistributedPortGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DistributedPortGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DistributedPortGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DistributedPortGroup Resource Properties

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

Inputs

The DistributedPortGroup resource accepts the following input properties:

DistributedVirtualSwitchUuid string

The ID of the DVS 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.

BlockAllPorts bool

Indicates whether to block all ports by default.

BlockOverrideAllowed bool

Allow the port shutdown policy to be overridden on an individual port.

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.

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 port in this port group to be moved to another port group while it is connected.

Name string

The name of the port group.

NetflowEnabled bool

Indicates whether to enable netflow on all ports.

NetflowOverrideAllowed bool

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

PortPrivateSecondaryVlanId int

The secondary VLAN ID for this port.

SecurityPolicyOverrideAllowed bool

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

ShapingOverrideAllowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

VlanId int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

VlanOverrideAllowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

VlanRanges List<Pulumi.VSphere.Inputs.DistributedPortGroupVlanRangeArgs>

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

DistributedVirtualSwitchUuid string

The ID of the DVS 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.

BlockAllPorts bool

Indicates whether to block all ports by default.

BlockOverrideAllowed bool

Allow the port shutdown policy to be overridden on an individual port.

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.

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 port in this port group to be moved to another port group while it is connected.

Name string

The name of the port group.

NetflowEnabled bool

Indicates whether to enable netflow on all ports.

NetflowOverrideAllowed bool

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

PortPrivateSecondaryVlanId int

The secondary VLAN ID for this port.

SecurityPolicyOverrideAllowed bool

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

ShapingOverrideAllowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

VlanId int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

VlanOverrideAllowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

VlanRanges []DistributedPortGroupVlanRange

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

distributedVirtualSwitchUuid string

The ID of the DVS 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.

blockAllPorts boolean

Indicates whether to block all ports by default.

blockOverrideAllowed boolean

Allow the port shutdown policy to be overridden on an individual port.

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.

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 port in this port group to be moved to another port group while it is connected.

name string

The name of the port group.

netflowEnabled boolean

Indicates whether to enable netflow on all ports.

netflowOverrideAllowed boolean

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

portPrivateSecondaryVlanId number

The secondary VLAN ID for this port.

securityPolicyOverrideAllowed boolean

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

shapingOverrideAllowed boolean

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

vlanId number

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

vlanOverrideAllowed boolean

Allow the VLAN settings on this port group to be overridden on an individual port.

vlanRanges DistributedPortGroupVlanRange[]

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

distributed_virtual_switch_uuid str

The ID of the DVS 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.

block_all_ports bool

Indicates whether to block all ports by default.

block_override_allowed bool

Allow the port shutdown policy to be overridden on an individual port.

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.

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 port in this port group to be moved to another port group while it is connected.

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 Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] 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 the security policy settings defined in this port group policy to be overridden on an individual port.

shaping_override_allowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

vlan_id int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

vlan_override_allowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

vlan_ranges Sequence[DistributedPortGroupVlanRangeArgs]

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

Version string of the configuration that this spec is trying to change.

Id string
The provider-assigned unique ID for this managed resource.
Key string

The generated UUID of the portgroup.

ConfigVersion string

Version string of the configuration that this spec is trying to change.

Id string
The provider-assigned unique ID for this managed resource.
Key string

The generated UUID of the portgroup.

configVersion string

Version string of the configuration that this spec is trying to change.

id string
The provider-assigned unique ID for this managed resource.
key string

The generated UUID of the portgroup.

config_version str

Version string of the configuration that this spec is trying to change.

id str
The provider-assigned unique ID for this managed resource.
key str

The generated UUID of the portgroup.

Look up an 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)
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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.

BlockAllPorts bool

Indicates whether to block all ports by default.

BlockOverrideAllowed bool

Allow the port shutdown policy to be overridden on an individual port.

CheckBeacon bool

Enable beacon probing on the ports this policy applies to.

ConfigVersion string

Version string of the configuration that this spec is trying to change.

CustomAttributes Dictionary<string, string>

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

Description string

An optional description for the port group.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 on the ports this policy applies to.

DistributedVirtualSwitchUuid string

The ID of the DVS 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 portgroup.

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 port in this port group to be moved to another port group while it is connected.

Name string

The name of the port group.

NetflowEnabled bool

Indicates whether to enable netflow on all ports.

NetflowOverrideAllowed bool

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

PortPrivateSecondaryVlanId int

The secondary VLAN ID for this port.

SecurityPolicyOverrideAllowed bool

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

ShapingOverrideAllowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

VlanId int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

VlanOverrideAllowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

VlanRanges List<Pulumi.VSphere.Inputs.DistributedPortGroupVlanRangeArgs>

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.

BlockAllPorts bool

Indicates whether to block all ports by default.

BlockOverrideAllowed bool

Allow the port shutdown policy to be overridden on an individual port.

CheckBeacon bool

Enable beacon probing on the ports this policy applies to.

ConfigVersion string

Version string of the configuration that this spec is trying to change.

CustomAttributes map[string]string

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

Description string

An optional description for the port group.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 on the ports this policy applies to.

DistributedVirtualSwitchUuid string

The ID of the DVS 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 portgroup.

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 port in this port group to be moved to another port group while it is connected.

Name string

The name of the port group.

NetflowEnabled bool

Indicates whether to enable netflow on all ports.

NetflowOverrideAllowed bool

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

PortPrivateSecondaryVlanId int

The secondary VLAN ID for this port.

SecurityPolicyOverrideAllowed bool

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

ShapingOverrideAllowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

VlanId int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

VlanOverrideAllowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

VlanRanges []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.

blockAllPorts boolean

Indicates whether to block all ports by default.

blockOverrideAllowed boolean

Allow the port shutdown policy to be overridden on an individual port.

checkBeacon boolean

Enable beacon probing on the ports this policy applies to.

configVersion string

Version string of the configuration that this spec is trying to change.

customAttributes {[key: string]: string}

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

description string

An optional description for the port group.

directpathGen2Allowed boolean

Allow VMDirectPath Gen2 on the ports this policy applies to.

distributedVirtualSwitchUuid string

The ID of the DVS 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 portgroup.

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 port in this port group to be moved to another port group while it is connected.

name string

The name of the port group.

netflowEnabled boolean

Indicates whether to enable netflow on all ports.

netflowOverrideAllowed boolean

Allow the Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] for details on the format syntax.

portPrivateSecondaryVlanId number

The secondary VLAN ID for this port.

securityPolicyOverrideAllowed boolean

Allow the security policy settings defined in this port group policy to be overridden on an individual port.

shapingOverrideAllowed boolean

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

vlanId number

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

vlanOverrideAllowed boolean

Allow the VLAN settings on this port group to be overridden on an individual port.

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.

block_all_ports bool

Indicates whether to block all ports by default.

block_override_allowed bool

Allow the port shutdown policy to be overridden on an individual port.

check_beacon bool

Enable beacon probing on the ports this policy applies to.

config_version str

Version string of the configuration that this spec is trying to change.

custom_attributes Mapping[str, str]

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

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 str

The ID of the DVS 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 portgroup.

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 port in this port group to be moved to another port group while it is connected.

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 Netflow policy on this port group to be overridden on an individual port.

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 set on this port group to be overridden on an individual port.

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 a port’s settings to the settings defined on this port group policy 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][ext-vsphere-portname-format] 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 the security policy settings defined in this port group policy to be overridden on an individual port.

shaping_override_allowed bool

Allow the traffic shaping options on this port group policy to be overridden on an individual port.

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 traffic filters on this port group to be overridden on an individual port.

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 options on this port group to be overridden on an individual port.

vlan_id int

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

vlan_override_allowed bool

Allow the VLAN settings on this port group to be overridden on an individual port.

vlan_ranges Sequence[DistributedPortGroupVlanRangeArgs]

The VLAN ID for single VLAN mode. 0 denotes no VLAN.

Supporting Types

DistributedPortGroupVlanRange

maxVlan number
minVlan number

Package Details

Repository
https://github.com/pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.