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

DistributedVirtualSwitch

Create a DistributedVirtualSwitch Resource

new DistributedVirtualSwitch(name: string, args: DistributedVirtualSwitchArgs, opts?: CustomResourceOptions);
def DistributedVirtualSwitch(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, block_all_ports: Optional[bool] = None, check_beacon: Optional[bool] = None, contact_detail: Optional[str] = None, contact_name: Optional[str] = None, custom_attributes: Optional[Mapping[str, str]] = None, datacenter_id: Optional[str] = None, description: Optional[str] = None, directpath_gen2_allowed: Optional[bool] = 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, faulttolerance_maximum_mbit: Optional[int] = None, faulttolerance_reservation_mbit: Optional[int] = None, faulttolerance_share_count: Optional[int] = None, faulttolerance_share_level: Optional[str] = None, folder: Optional[str] = None, hbr_maximum_mbit: Optional[int] = None, hbr_reservation_mbit: Optional[int] = None, hbr_share_count: Optional[int] = None, hbr_share_level: Optional[str] = None, hosts: Optional[Sequence[DistributedVirtualSwitchHostArgs]] = None, ignore_other_pvlan_mappings: 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, ipv4_address: Optional[str] = None, iscsi_maximum_mbit: Optional[int] = None, iscsi_reservation_mbit: Optional[int] = None, iscsi_share_count: Optional[int] = None, iscsi_share_level: Optional[str] = None, lacp_api_version: Optional[str] = None, lacp_enabled: Optional[bool] = None, lacp_mode: Optional[str] = None, link_discovery_operation: Optional[str] = None, link_discovery_protocol: Optional[str] = None, management_maximum_mbit: Optional[int] = None, management_reservation_mbit: Optional[int] = None, management_share_count: Optional[int] = None, management_share_level: Optional[str] = None, max_mtu: Optional[int] = None, multicast_filtering_mode: Optional[str] = None, name: Optional[str] = None, netflow_active_flow_timeout: Optional[int] = None, netflow_collector_ip_address: Optional[str] = None, netflow_collector_port: Optional[int] = None, netflow_enabled: Optional[bool] = None, netflow_idle_flow_timeout: Optional[int] = None, netflow_internal_flows_only: Optional[bool] = None, netflow_observation_domain_id: Optional[int] = None, netflow_sampling_rate: Optional[int] = None, network_resource_control_enabled: Optional[bool] = None, network_resource_control_version: Optional[str] = None, nfs_maximum_mbit: Optional[int] = None, nfs_reservation_mbit: Optional[int] = None, nfs_share_count: Optional[int] = None, nfs_share_level: Optional[str] = None, notify_switches: Optional[bool] = None, port_private_secondary_vlan_id: Optional[int] = None, pvlan_mappings: Optional[Sequence[DistributedVirtualSwitchPvlanMappingArgs]] = None, standby_uplinks: Optional[Sequence[str]] = None, tags: Optional[Sequence[str]] = None, teaming_policy: Optional[str] = None, tx_uplink: Optional[bool] = None, uplinks: Optional[Sequence[str]] = None, vdp_maximum_mbit: Optional[int] = None, vdp_reservation_mbit: Optional[int] = None, vdp_share_count: Optional[int] = None, vdp_share_level: Optional[str] = None, version: Optional[str] = None, virtualmachine_maximum_mbit: Optional[int] = None, virtualmachine_reservation_mbit: Optional[int] = None, virtualmachine_share_count: Optional[int] = None, virtualmachine_share_level: Optional[str] = None, vlan_id: Optional[int] = None, vlan_ranges: Optional[Sequence[DistributedVirtualSwitchVlanRangeArgs]] = None, vmotion_maximum_mbit: Optional[int] = None, vmotion_reservation_mbit: Optional[int] = None, vmotion_share_count: Optional[int] = None, vmotion_share_level: Optional[str] = None, vsan_maximum_mbit: Optional[int] = None, vsan_reservation_mbit: Optional[int] = None, vsan_share_count: Optional[int] = None, vsan_share_level: Optional[str] = None)
func NewDistributedVirtualSwitch(ctx *Context, name string, args DistributedVirtualSwitchArgs, opts ...ResourceOption) (*DistributedVirtualSwitch, error)
public DistributedVirtualSwitch(string name, DistributedVirtualSwitchArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DistributedVirtualSwitchArgs
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 DistributedVirtualSwitchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DistributedVirtualSwitchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DistributedVirtualSwitch Resource Properties

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

Inputs

The DistributedVirtualSwitch resource accepts the following input properties:

DatacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

ActiveUplinks List<string>

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

AllowForgedTransmits bool

Controls whether or not a 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.

BlockAllPorts bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

CheckBeacon bool

Enables beacon probing as an additional measure to detect NIC failure.

ContactDetail string

The detailed contact information for the person who is responsible for the DVS.

ContactName string

The name of the person who is responsible for the DVS.

CustomAttributes Dictionary<string, string>

Map of custom attribute ids to attribute value strings to set for virtual switch.

Description string

A detailed description for the DVS.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

EgressShapingAverageBandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

EgressShapingBurstSize int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

EgressShapingEnabled bool

true if the traffic shaper is enabled on the port for egress traffic.

EgressShapingPeakBandwidth int

The peak 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 uplinks higher in precedence when they come back up.

FaulttoleranceMaximumMbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceReservationMbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceShareCount int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

FaulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

Folder string

The folder to create the DVS in. Forces a new resource if changed.

HbrMaximumMbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

HbrReservationMbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

HbrShareCount int

The amount of shares to allocate to the hbr traffic class for a custom share level.

HbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

Hosts List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchHostArgs>

Use the host block to declare a host specification. The options are:

IgnoreOtherPvlanMappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

IngressShapingAverageBandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

IngressShapingBurstSize int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

IngressShapingEnabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

IngressShapingPeakBandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

Ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

IscsiMaximumMbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

IscsiReservationMbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

IscsiShareCount int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

IscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

LacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

LacpEnabled bool

Enables LACP for the ports that this policy applies to.

LacpMode string

The LACP mode. Can be one of active or passive.

LinkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

LinkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

ManagementMaximumMbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

ManagementReservationMbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

ManagementShareCount int

The amount of shares to allocate to the management traffic class for a custom share level.

ManagementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

MaxMtu int

The maximum transmission unit (MTU) for the virtual switch.

MulticastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

Name string

The name of the distributed virtual switch.

NetflowActiveFlowTimeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

NetflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

NetflowCollectorPort int

Port for the Netflow collector. This must be set before Netflow can be enabled.

NetflowEnabled bool

Enables Netflow on all ports that this policy applies to.

NetflowIdleFlowTimeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

NetflowInternalFlowsOnly bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

NetflowObservationDomainId int

The observation domain ID for the Netflow collector.

NetflowSamplingRate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

NetworkResourceControlEnabled bool

Set to true to enable network I/O control. Default: false.

NetworkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

NfsMaximumMbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

NfsReservationMbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

NfsShareCount int

The amount of shares to allocate to the nfs traffic class for a custom share level.

NfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

NotifySwitches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

PortPrivateSecondaryVlanId int

Used to define a secondary VLAN ID when using private VLANs.

PvlanMappings List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchPvlanMappingArgs>

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

StandbyUplinks List<string>

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

Tags List<string>

The IDs of any tags to attach to this resource.

TeamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

TxUplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

Uplinks List<string>

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

VdpMaximumMbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

VdpReservationMbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

VdpShareCount int

The amount of shares to allocate to the vdp traffic class for a custom share level.

VdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

Version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
VirtualmachineMaximumMbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineReservationMbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineShareCount int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

VirtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

VlanId int

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

VlanRanges List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchVlanRangeArgs>

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

VmotionMaximumMbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

VmotionReservationMbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

VmotionShareCount int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

VmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

VsanMaximumMbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

VsanReservationMbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

VsanShareCount int

The amount of shares to allocate to the vsan traffic class for a custom share level.

VsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

DatacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

ActiveUplinks []string

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

AllowForgedTransmits bool

Controls whether or not a 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.

BlockAllPorts bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

CheckBeacon bool

Enables beacon probing as an additional measure to detect NIC failure.

ContactDetail string

The detailed contact information for the person who is responsible for the DVS.

ContactName string

The name of the person who is responsible for the DVS.

CustomAttributes map[string]string

Map of custom attribute ids to attribute value strings to set for virtual switch.

Description string

A detailed description for the DVS.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

EgressShapingAverageBandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

EgressShapingBurstSize int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

EgressShapingEnabled bool

true if the traffic shaper is enabled on the port for egress traffic.

EgressShapingPeakBandwidth int

The peak 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 uplinks higher in precedence when they come back up.

FaulttoleranceMaximumMbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceReservationMbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceShareCount int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

FaulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

Folder string

The folder to create the DVS in. Forces a new resource if changed.

HbrMaximumMbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

HbrReservationMbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

HbrShareCount int

The amount of shares to allocate to the hbr traffic class for a custom share level.

HbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

Hosts []DistributedVirtualSwitchHost

Use the host block to declare a host specification. The options are:

IgnoreOtherPvlanMappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

IngressShapingAverageBandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

IngressShapingBurstSize int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

IngressShapingEnabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

IngressShapingPeakBandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

Ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

IscsiMaximumMbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

IscsiReservationMbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

IscsiShareCount int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

IscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

LacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

LacpEnabled bool

Enables LACP for the ports that this policy applies to.

LacpMode string

The LACP mode. Can be one of active or passive.

LinkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

LinkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

ManagementMaximumMbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

ManagementReservationMbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

ManagementShareCount int

The amount of shares to allocate to the management traffic class for a custom share level.

ManagementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

MaxMtu int

The maximum transmission unit (MTU) for the virtual switch.

MulticastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

Name string

The name of the distributed virtual switch.

NetflowActiveFlowTimeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

NetflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

NetflowCollectorPort int

Port for the Netflow collector. This must be set before Netflow can be enabled.

NetflowEnabled bool

Enables Netflow on all ports that this policy applies to.

NetflowIdleFlowTimeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

NetflowInternalFlowsOnly bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

NetflowObservationDomainId int

The observation domain ID for the Netflow collector.

NetflowSamplingRate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

NetworkResourceControlEnabled bool

Set to true to enable network I/O control. Default: false.

NetworkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

NfsMaximumMbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

NfsReservationMbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

NfsShareCount int

The amount of shares to allocate to the nfs traffic class for a custom share level.

NfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

NotifySwitches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

PortPrivateSecondaryVlanId int

Used to define a secondary VLAN ID when using private VLANs.

PvlanMappings []DistributedVirtualSwitchPvlanMapping

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

StandbyUplinks []string

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

Tags []string

The IDs of any tags to attach to this resource.

TeamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

TxUplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

Uplinks []string

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

VdpMaximumMbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

VdpReservationMbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

VdpShareCount int

The amount of shares to allocate to the vdp traffic class for a custom share level.

VdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

Version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
VirtualmachineMaximumMbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineReservationMbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineShareCount int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

VirtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

VlanId int

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

VlanRanges []DistributedVirtualSwitchVlanRange

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

VmotionMaximumMbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

VmotionReservationMbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

VmotionShareCount int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

VmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

VsanMaximumMbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

VsanReservationMbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

VsanShareCount int

The amount of shares to allocate to the vsan traffic class for a custom share level.

VsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

datacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

activeUplinks string[]

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

allowForgedTransmits boolean

Controls whether or not a 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.

blockAllPorts boolean

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

checkBeacon boolean

Enables beacon probing as an additional measure to detect NIC failure.

contactDetail string

The detailed contact information for the person who is responsible for the DVS.

contactName string

The name of the person who is responsible for the DVS.

customAttributes {[key: string]: string}

Map of custom attribute ids to attribute value strings to set for virtual switch.

description string

A detailed description for the DVS.

directpathGen2Allowed boolean

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

egressShapingAverageBandwidth number

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

egressShapingBurstSize number

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

egressShapingEnabled boolean

true if the traffic shaper is enabled on the port for egress traffic.

egressShapingPeakBandwidth number

The peak 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 uplinks higher in precedence when they come back up.

faulttoleranceMaximumMbit number

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

faulttoleranceReservationMbit number

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

faulttoleranceShareCount number

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

faulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

folder string

The folder to create the DVS in. Forces a new resource if changed.

hbrMaximumMbit number

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

hbrReservationMbit number

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

hbrShareCount number

The amount of shares to allocate to the hbr traffic class for a custom share level.

hbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

hosts DistributedVirtualSwitchHost[]

Use the host block to declare a host specification. The options are:

ignoreOtherPvlanMappings boolean

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

ingressShapingAverageBandwidth number

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

ingressShapingBurstSize number

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

ingressShapingEnabled boolean

true if the traffic shaper is enabled on the port for ingress traffic.

ingressShapingPeakBandwidth number

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

iscsiMaximumMbit number

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

iscsiReservationMbit number

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

iscsiShareCount number

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

iscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

lacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

lacpEnabled boolean

Enables LACP for the ports that this policy applies to.

lacpMode string

The LACP mode. Can be one of active or passive.

linkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

linkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

managementMaximumMbit number

The maximum allowed usage for the management traffic class, in Mbits/sec.

managementReservationMbit number

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

managementShareCount number

The amount of shares to allocate to the management traffic class for a custom share level.

managementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

maxMtu number

The maximum transmission unit (MTU) for the virtual switch.

multicastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

name string

The name of the distributed virtual switch.

netflowActiveFlowTimeout number

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

netflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

netflowCollectorPort number

Port for the Netflow collector. This must be set before Netflow can be enabled.

netflowEnabled boolean

Enables Netflow on all ports that this policy applies to.

netflowIdleFlowTimeout number

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

netflowInternalFlowsOnly boolean

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

netflowObservationDomainId number

The observation domain ID for the Netflow collector.

netflowSamplingRate number

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

networkResourceControlEnabled boolean

Set to true to enable network I/O control. Default: false.

networkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

nfsMaximumMbit number

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

nfsReservationMbit number

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

nfsShareCount number

The amount of shares to allocate to the nfs traffic class for a custom share level.

nfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

notifySwitches boolean

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

portPrivateSecondaryVlanId number

Used to define a secondary VLAN ID when using private VLANs.

pvlanMappings DistributedVirtualSwitchPvlanMapping[]

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

standbyUplinks string[]

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

tags string[]

The IDs of any tags to attach to this resource.

teamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

txUplink boolean

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

uplinks string[]

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

vdpMaximumMbit number

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

vdpReservationMbit number

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

vdpShareCount number

The amount of shares to allocate to the vdp traffic class for a custom share level.

vdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
virtualmachineMaximumMbit number

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

virtualmachineReservationMbit number

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

virtualmachineShareCount number

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

virtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

vlanId number

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

vlanRanges DistributedVirtualSwitchVlanRange[]

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

vmotionMaximumMbit number

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

vmotionReservationMbit number

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

vmotionShareCount number

The amount of shares to allocate to the vmotion traffic class for a custom share level.

vmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

vsanMaximumMbit number

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

vsanReservationMbit number

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

vsanShareCount number

The amount of shares to allocate to the vsan traffic class for a custom share level.

vsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

datacenter_id str

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

active_uplinks Sequence[str]

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

allow_forged_transmits bool

Controls whether or not a 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.

block_all_ports bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

check_beacon bool

Enables beacon probing as an additional measure to detect NIC failure.

contact_detail str

The detailed contact information for the person who is responsible for the DVS.

contact_name str

The name of the person who is responsible for the DVS.

custom_attributes Mapping[str, str]

Map of custom attribute ids to attribute value strings to set for virtual switch.

description str

A detailed description for the DVS.

directpath_gen2_allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

egress_shaping_average_bandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

egress_shaping_burst_size int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

egress_shaping_enabled bool

true if the traffic shaper is enabled on the port for egress traffic.

egress_shaping_peak_bandwidth int

The peak 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 uplinks higher in precedence when they come back up.

faulttolerance_maximum_mbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

faulttolerance_reservation_mbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

faulttolerance_share_count int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

faulttolerance_share_level str

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

folder str

The folder to create the DVS in. Forces a new resource if changed.

hbr_maximum_mbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

hbr_reservation_mbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

hbr_share_count int

The amount of shares to allocate to the hbr traffic class for a custom share level.

hbr_share_level str

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

hosts Sequence[DistributedVirtualSwitchHostArgs]

Use the host block to declare a host specification. The options are:

ignore_other_pvlan_mappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

ingress_shaping_average_bandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

ingress_shaping_burst_size int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

ingress_shaping_enabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

ingress_shaping_peak_bandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

ipv4_address str

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

iscsi_maximum_mbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

iscsi_reservation_mbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

iscsi_share_count int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

iscsi_share_level str

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

lacp_api_version str

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

lacp_enabled bool

Enables LACP for the ports that this policy applies to.

lacp_mode str

The LACP mode. Can be one of active or passive.

link_discovery_operation str

Whether to advertise or listen for link discovery traffic.

link_discovery_protocol str

The discovery protocol type. Valid types are cdp and lldp.

management_maximum_mbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

management_reservation_mbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

management_share_count int

The amount of shares to allocate to the management traffic class for a custom share level.

management_share_level str

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

max_mtu int

The maximum transmission unit (MTU) for the virtual switch.

multicast_filtering_mode str

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

name str

The name of the distributed virtual switch.

netflow_active_flow_timeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

netflow_collector_ip_address str

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

netflow_collector_port int

Port for the Netflow collector. This must be set before Netflow can be enabled.

netflow_enabled bool

Enables Netflow on all ports that this policy applies to.

netflow_idle_flow_timeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

netflow_internal_flows_only bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

netflow_observation_domain_id int

The observation domain ID for the Netflow collector.

netflow_sampling_rate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

network_resource_control_enabled bool

Set to true to enable network I/O control. Default: false.

network_resource_control_version str

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

nfs_maximum_mbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

nfs_reservation_mbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

nfs_share_count int

The amount of shares to allocate to the nfs traffic class for a custom share level.

nfs_share_level str

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

notify_switches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

port_private_secondary_vlan_id int

Used to define a secondary VLAN ID when using private VLANs.

pvlan_mappings Sequence[DistributedVirtualSwitchPvlanMappingArgs]

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

standby_uplinks Sequence[str]

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

tags Sequence[str]

The IDs of any tags to attach to this resource.

teaming_policy str

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

tx_uplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

uplinks Sequence[str]

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

vdp_maximum_mbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

vdp_reservation_mbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

vdp_share_count int

The amount of shares to allocate to the vdp traffic class for a custom share level.

vdp_share_level str

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

version str
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
virtualmachine_maximum_mbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

virtualmachine_reservation_mbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

virtualmachine_share_count int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

virtualmachine_share_level str

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

vlan_id int

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

vlan_ranges Sequence[DistributedVirtualSwitchVlanRangeArgs]

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

vmotion_maximum_mbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

vmotion_reservation_mbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

vmotion_share_count int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

vmotion_share_level str

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

vsan_maximum_mbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

vsan_reservation_mbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

vsan_share_count int

The amount of shares to allocate to the vsan traffic class for a custom share level.

vsan_share_level str

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

Outputs

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

ConfigVersion string

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

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

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

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

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

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

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

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

Look up an Existing DistributedVirtualSwitch Resource

Get an existing DistributedVirtualSwitch 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?: DistributedVirtualSwitchState, opts?: CustomResourceOptions): DistributedVirtualSwitch
@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, block_all_ports: Optional[bool] = None, check_beacon: Optional[bool] = None, config_version: Optional[str] = None, contact_detail: Optional[str] = None, contact_name: Optional[str] = None, custom_attributes: Optional[Mapping[str, str]] = None, datacenter_id: Optional[str] = None, description: Optional[str] = None, directpath_gen2_allowed: Optional[bool] = 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, faulttolerance_maximum_mbit: Optional[int] = None, faulttolerance_reservation_mbit: Optional[int] = None, faulttolerance_share_count: Optional[int] = None, faulttolerance_share_level: Optional[str] = None, folder: Optional[str] = None, hbr_maximum_mbit: Optional[int] = None, hbr_reservation_mbit: Optional[int] = None, hbr_share_count: Optional[int] = None, hbr_share_level: Optional[str] = None, hosts: Optional[Sequence[DistributedVirtualSwitchHostArgs]] = None, ignore_other_pvlan_mappings: 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, ipv4_address: Optional[str] = None, iscsi_maximum_mbit: Optional[int] = None, iscsi_reservation_mbit: Optional[int] = None, iscsi_share_count: Optional[int] = None, iscsi_share_level: Optional[str] = None, lacp_api_version: Optional[str] = None, lacp_enabled: Optional[bool] = None, lacp_mode: Optional[str] = None, link_discovery_operation: Optional[str] = None, link_discovery_protocol: Optional[str] = None, management_maximum_mbit: Optional[int] = None, management_reservation_mbit: Optional[int] = None, management_share_count: Optional[int] = None, management_share_level: Optional[str] = None, max_mtu: Optional[int] = None, multicast_filtering_mode: Optional[str] = None, name: Optional[str] = None, netflow_active_flow_timeout: Optional[int] = None, netflow_collector_ip_address: Optional[str] = None, netflow_collector_port: Optional[int] = None, netflow_enabled: Optional[bool] = None, netflow_idle_flow_timeout: Optional[int] = None, netflow_internal_flows_only: Optional[bool] = None, netflow_observation_domain_id: Optional[int] = None, netflow_sampling_rate: Optional[int] = None, network_resource_control_enabled: Optional[bool] = None, network_resource_control_version: Optional[str] = None, nfs_maximum_mbit: Optional[int] = None, nfs_reservation_mbit: Optional[int] = None, nfs_share_count: Optional[int] = None, nfs_share_level: Optional[str] = None, notify_switches: Optional[bool] = None, port_private_secondary_vlan_id: Optional[int] = None, pvlan_mappings: Optional[Sequence[DistributedVirtualSwitchPvlanMappingArgs]] = None, standby_uplinks: Optional[Sequence[str]] = None, tags: Optional[Sequence[str]] = None, teaming_policy: Optional[str] = None, tx_uplink: Optional[bool] = None, uplinks: Optional[Sequence[str]] = None, vdp_maximum_mbit: Optional[int] = None, vdp_reservation_mbit: Optional[int] = None, vdp_share_count: Optional[int] = None, vdp_share_level: Optional[str] = None, version: Optional[str] = None, virtualmachine_maximum_mbit: Optional[int] = None, virtualmachine_reservation_mbit: Optional[int] = None, virtualmachine_share_count: Optional[int] = None, virtualmachine_share_level: Optional[str] = None, vlan_id: Optional[int] = None, vlan_ranges: Optional[Sequence[DistributedVirtualSwitchVlanRangeArgs]] = None, vmotion_maximum_mbit: Optional[int] = None, vmotion_reservation_mbit: Optional[int] = None, vmotion_share_count: Optional[int] = None, vmotion_share_level: Optional[str] = None, vsan_maximum_mbit: Optional[int] = None, vsan_reservation_mbit: Optional[int] = None, vsan_share_count: Optional[int] = None, vsan_share_level: Optional[str] = None) -> DistributedVirtualSwitch
func GetDistributedVirtualSwitch(ctx *Context, name string, id IDInput, state *DistributedVirtualSwitchState, opts ...ResourceOption) (*DistributedVirtualSwitch, error)
public static DistributedVirtualSwitch Get(string name, Input<string> id, DistributedVirtualSwitchState? 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>

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

AllowForgedTransmits bool

Controls whether or not a 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.

BlockAllPorts bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

CheckBeacon bool

Enables beacon probing as an additional measure to detect NIC failure.

ConfigVersion string

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

ContactDetail string

The detailed contact information for the person who is responsible for the DVS.

ContactName string

The name of the person who is responsible for the DVS.

CustomAttributes Dictionary<string, string>

Map of custom attribute ids to attribute value strings to set for virtual switch.

DatacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

Description string

A detailed description for the DVS.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

EgressShapingAverageBandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

EgressShapingBurstSize int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

EgressShapingEnabled bool

true if the traffic shaper is enabled on the port for egress traffic.

EgressShapingPeakBandwidth int

The peak 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 uplinks higher in precedence when they come back up.

FaulttoleranceMaximumMbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceReservationMbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceShareCount int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

FaulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

Folder string

The folder to create the DVS in. Forces a new resource if changed.

HbrMaximumMbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

HbrReservationMbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

HbrShareCount int

The amount of shares to allocate to the hbr traffic class for a custom share level.

HbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

Hosts List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchHostArgs>

Use the host block to declare a host specification. The options are:

IgnoreOtherPvlanMappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

IngressShapingAverageBandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

IngressShapingBurstSize int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

IngressShapingEnabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

IngressShapingPeakBandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

Ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

IscsiMaximumMbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

IscsiReservationMbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

IscsiShareCount int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

IscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

LacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

LacpEnabled bool

Enables LACP for the ports that this policy applies to.

LacpMode string

The LACP mode. Can be one of active or passive.

LinkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

LinkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

ManagementMaximumMbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

ManagementReservationMbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

ManagementShareCount int

The amount of shares to allocate to the management traffic class for a custom share level.

ManagementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

MaxMtu int

The maximum transmission unit (MTU) for the virtual switch.

MulticastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

Name string

The name of the distributed virtual switch.

NetflowActiveFlowTimeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

NetflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

NetflowCollectorPort int

Port for the Netflow collector. This must be set before Netflow can be enabled.

NetflowEnabled bool

Enables Netflow on all ports that this policy applies to.

NetflowIdleFlowTimeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

NetflowInternalFlowsOnly bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

NetflowObservationDomainId int

The observation domain ID for the Netflow collector.

NetflowSamplingRate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

NetworkResourceControlEnabled bool

Set to true to enable network I/O control. Default: false.

NetworkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

NfsMaximumMbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

NfsReservationMbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

NfsShareCount int

The amount of shares to allocate to the nfs traffic class for a custom share level.

NfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

NotifySwitches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

PortPrivateSecondaryVlanId int

Used to define a secondary VLAN ID when using private VLANs.

PvlanMappings List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchPvlanMappingArgs>

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

StandbyUplinks List<string>

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

Tags List<string>

The IDs of any tags to attach to this resource.

TeamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

TxUplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

Uplinks List<string>

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

VdpMaximumMbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

VdpReservationMbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

VdpShareCount int

The amount of shares to allocate to the vdp traffic class for a custom share level.

VdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

Version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
VirtualmachineMaximumMbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineReservationMbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineShareCount int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

VirtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

VlanId int

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

VlanRanges List<Pulumi.VSphere.Inputs.DistributedVirtualSwitchVlanRangeArgs>

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

VmotionMaximumMbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

VmotionReservationMbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

VmotionShareCount int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

VmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

VsanMaximumMbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

VsanReservationMbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

VsanShareCount int

The amount of shares to allocate to the vsan traffic class for a custom share level.

VsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

ActiveUplinks []string

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

AllowForgedTransmits bool

Controls whether or not a 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.

BlockAllPorts bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

CheckBeacon bool

Enables beacon probing as an additional measure to detect NIC failure.

ConfigVersion string

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

ContactDetail string

The detailed contact information for the person who is responsible for the DVS.

ContactName string

The name of the person who is responsible for the DVS.

CustomAttributes map[string]string

Map of custom attribute ids to attribute value strings to set for virtual switch.

DatacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

Description string

A detailed description for the DVS.

DirectpathGen2Allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

EgressShapingAverageBandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

EgressShapingBurstSize int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

EgressShapingEnabled bool

true if the traffic shaper is enabled on the port for egress traffic.

EgressShapingPeakBandwidth int

The peak 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 uplinks higher in precedence when they come back up.

FaulttoleranceMaximumMbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceReservationMbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

FaulttoleranceShareCount int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

FaulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

Folder string

The folder to create the DVS in. Forces a new resource if changed.

HbrMaximumMbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

HbrReservationMbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

HbrShareCount int

The amount of shares to allocate to the hbr traffic class for a custom share level.

HbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

Hosts []DistributedVirtualSwitchHost

Use the host block to declare a host specification. The options are:

IgnoreOtherPvlanMappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

IngressShapingAverageBandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

IngressShapingBurstSize int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

IngressShapingEnabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

IngressShapingPeakBandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

Ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

IscsiMaximumMbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

IscsiReservationMbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

IscsiShareCount int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

IscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

LacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

LacpEnabled bool

Enables LACP for the ports that this policy applies to.

LacpMode string

The LACP mode. Can be one of active or passive.

LinkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

LinkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

ManagementMaximumMbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

ManagementReservationMbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

ManagementShareCount int

The amount of shares to allocate to the management traffic class for a custom share level.

ManagementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

MaxMtu int

The maximum transmission unit (MTU) for the virtual switch.

MulticastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

Name string

The name of the distributed virtual switch.

NetflowActiveFlowTimeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

NetflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

NetflowCollectorPort int

Port for the Netflow collector. This must be set before Netflow can be enabled.

NetflowEnabled bool

Enables Netflow on all ports that this policy applies to.

NetflowIdleFlowTimeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

NetflowInternalFlowsOnly bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

NetflowObservationDomainId int

The observation domain ID for the Netflow collector.

NetflowSamplingRate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

NetworkResourceControlEnabled bool

Set to true to enable network I/O control. Default: false.

NetworkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

NfsMaximumMbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

NfsReservationMbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

NfsShareCount int

The amount of shares to allocate to the nfs traffic class for a custom share level.

NfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

NotifySwitches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

PortPrivateSecondaryVlanId int

Used to define a secondary VLAN ID when using private VLANs.

PvlanMappings []DistributedVirtualSwitchPvlanMapping

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

StandbyUplinks []string

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

Tags []string

The IDs of any tags to attach to this resource.

TeamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

TxUplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

Uplinks []string

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

VdpMaximumMbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

VdpReservationMbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

VdpShareCount int

The amount of shares to allocate to the vdp traffic class for a custom share level.

VdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

Version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
VirtualmachineMaximumMbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineReservationMbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

VirtualmachineShareCount int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

VirtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

VlanId int

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

VlanRanges []DistributedVirtualSwitchVlanRange

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

VmotionMaximumMbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

VmotionReservationMbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

VmotionShareCount int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

VmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

VsanMaximumMbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

VsanReservationMbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

VsanShareCount int

The amount of shares to allocate to the vsan traffic class for a custom share level.

VsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

activeUplinks string[]

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

allowForgedTransmits boolean

Controls whether or not a 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.

blockAllPorts boolean

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

checkBeacon boolean

Enables beacon probing as an additional measure to detect NIC failure.

configVersion string

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

contactDetail string

The detailed contact information for the person who is responsible for the DVS.

contactName string

The name of the person who is responsible for the DVS.

customAttributes {[key: string]: string}

Map of custom attribute ids to attribute value strings to set for virtual switch.

datacenterId string

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

description string

A detailed description for the DVS.

directpathGen2Allowed boolean

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

egressShapingAverageBandwidth number

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

egressShapingBurstSize number

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

egressShapingEnabled boolean

true if the traffic shaper is enabled on the port for egress traffic.

egressShapingPeakBandwidth number

The peak 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 uplinks higher in precedence when they come back up.

faulttoleranceMaximumMbit number

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

faulttoleranceReservationMbit number

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

faulttoleranceShareCount number

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

faulttoleranceShareLevel string

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

folder string

The folder to create the DVS in. Forces a new resource if changed.

hbrMaximumMbit number

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

hbrReservationMbit number

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

hbrShareCount number

The amount of shares to allocate to the hbr traffic class for a custom share level.

hbrShareLevel string

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

hosts DistributedVirtualSwitchHost[]

Use the host block to declare a host specification. The options are:

ignoreOtherPvlanMappings boolean

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

ingressShapingAverageBandwidth number

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

ingressShapingBurstSize number

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

ingressShapingEnabled boolean

true if the traffic shaper is enabled on the port for ingress traffic.

ingressShapingPeakBandwidth number

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

ipv4Address string

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

iscsiMaximumMbit number

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

iscsiReservationMbit number

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

iscsiShareCount number

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

iscsiShareLevel string

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

lacpApiVersion string

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

lacpEnabled boolean

Enables LACP for the ports that this policy applies to.

lacpMode string

The LACP mode. Can be one of active or passive.

linkDiscoveryOperation string

Whether to advertise or listen for link discovery traffic.

linkDiscoveryProtocol string

The discovery protocol type. Valid types are cdp and lldp.

managementMaximumMbit number

The maximum allowed usage for the management traffic class, in Mbits/sec.

managementReservationMbit number

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

managementShareCount number

The amount of shares to allocate to the management traffic class for a custom share level.

managementShareLevel string

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

maxMtu number

The maximum transmission unit (MTU) for the virtual switch.

multicastFilteringMode string

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

name string

The name of the distributed virtual switch.

netflowActiveFlowTimeout number

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

netflowCollectorIpAddress string

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

netflowCollectorPort number

Port for the Netflow collector. This must be set before Netflow can be enabled.

netflowEnabled boolean

Enables Netflow on all ports that this policy applies to.

netflowIdleFlowTimeout number

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

netflowInternalFlowsOnly boolean

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

netflowObservationDomainId number

The observation domain ID for the Netflow collector.

netflowSamplingRate number

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

networkResourceControlEnabled boolean

Set to true to enable network I/O control. Default: false.

networkResourceControlVersion string

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

nfsMaximumMbit number

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

nfsReservationMbit number

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

nfsShareCount number

The amount of shares to allocate to the nfs traffic class for a custom share level.

nfsShareLevel string

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

notifySwitches boolean

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

portPrivateSecondaryVlanId number

Used to define a secondary VLAN ID when using private VLANs.

pvlanMappings DistributedVirtualSwitchPvlanMapping[]

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

standbyUplinks string[]

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

tags string[]

The IDs of any tags to attach to this resource.

teamingPolicy string

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

txUplink boolean

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

uplinks string[]

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

vdpMaximumMbit number

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

vdpReservationMbit number

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

vdpShareCount number

The amount of shares to allocate to the vdp traffic class for a custom share level.

vdpShareLevel string

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

version string
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
virtualmachineMaximumMbit number

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

virtualmachineReservationMbit number

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

virtualmachineShareCount number

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

virtualmachineShareLevel string

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

vlanId number

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

vlanRanges DistributedVirtualSwitchVlanRange[]

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

vmotionMaximumMbit number

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

vmotionReservationMbit number

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

vmotionShareCount number

The amount of shares to allocate to the vmotion traffic class for a custom share level.

vmotionShareLevel string

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

vsanMaximumMbit number

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

vsanReservationMbit number

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

vsanShareCount number

The amount of shares to allocate to the vsan traffic class for a custom share level.

vsanShareLevel string

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

active_uplinks Sequence[str]

A list of active uplinks to be used in load balancing. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

allow_forged_transmits bool

Controls whether or not a 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.

block_all_ports bool

Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.

check_beacon bool

Enables beacon probing as an additional measure to detect NIC failure.

config_version str

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

contact_detail str

The detailed contact information for the person who is responsible for the DVS.

contact_name str

The name of the person who is responsible for the DVS.

custom_attributes Mapping[str, str]

Map of custom attribute ids to attribute value strings to set for virtual switch.

datacenter_id str

The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.

description str

A detailed description for the DVS.

directpath_gen2_allowed bool

Allow VMDirectPath Gen2 for the ports for which this policy applies to.

egress_shaping_average_bandwidth int

The average bandwidth in bits per second if egress traffic shaping is enabled on the port.

egress_shaping_burst_size int

The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.

egress_shaping_enabled bool

true if the traffic shaper is enabled on the port for egress traffic.

egress_shaping_peak_bandwidth int

The peak 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 uplinks higher in precedence when they come back up.

faulttolerance_maximum_mbit int

The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.

faulttolerance_reservation_mbit int

The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.

faulttolerance_share_count int

The amount of shares to allocate to the faultTolerance traffic class for a custom share level.

faulttolerance_share_level str

The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.

folder str

The folder to create the DVS in. Forces a new resource if changed.

hbr_maximum_mbit int

The maximum allowed usage for the hbr traffic class, in Mbits/sec.

hbr_reservation_mbit int

The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.

hbr_share_count int

The amount of shares to allocate to the hbr traffic class for a custom share level.

hbr_share_level str

The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.

hosts Sequence[DistributedVirtualSwitchHostArgs]

Use the host block to declare a host specification. The options are:

ignore_other_pvlan_mappings bool

Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.

ingress_shaping_average_bandwidth int

The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.

ingress_shaping_burst_size int

The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.

ingress_shaping_enabled bool

true if the traffic shaper is enabled on the port for ingress traffic.

ingress_shaping_peak_bandwidth int

The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.

ipv4_address str

An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.

iscsi_maximum_mbit int

The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.

iscsi_reservation_mbit int

The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.

iscsi_share_count int

The amount of shares to allocate to the iSCSI traffic class for a custom share level.

iscsi_share_level str

The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.

lacp_api_version str

The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.

lacp_enabled bool

Enables LACP for the ports that this policy applies to.

lacp_mode str

The LACP mode. Can be one of active or passive.

link_discovery_operation str

Whether to advertise or listen for link discovery traffic.

link_discovery_protocol str

The discovery protocol type. Valid types are cdp and lldp.

management_maximum_mbit int

The maximum allowed usage for the management traffic class, in Mbits/sec.

management_reservation_mbit int

The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.

management_share_count int

The amount of shares to allocate to the management traffic class for a custom share level.

management_share_level str

The allocation level for the management traffic class. Can be one of high, low, normal, or custom.

max_mtu int

The maximum transmission unit (MTU) for the virtual switch.

multicast_filtering_mode str

The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.

name str

The name of the distributed virtual switch.

netflow_active_flow_timeout int

The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.

netflow_collector_ip_address str

IP address for the Netflow collector, using IPv4 or IPv6. IPv6 is supported in vSphere Distributed Switch Version 6.0 or later. Must be set before Netflow can be enabled.

netflow_collector_port int

Port for the Netflow collector. This must be set before Netflow can be enabled.

netflow_enabled bool

Enables Netflow on all ports that this policy applies to.

netflow_idle_flow_timeout int

The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.

netflow_internal_flows_only bool

Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.

netflow_observation_domain_id int

The observation domain ID for the Netflow collector.

netflow_sampling_rate int

The ratio of total number of packets to the number of packets analyzed. The default is 0, which indicates that the switch should analyze all packets. The maximum value is 1000, which indicates an analysis rate of 0.001%.

network_resource_control_enabled bool

Set to true to enable network I/O control. Default: false.

network_resource_control_version str

The version of network I/O control to use. Can be one of version2 or version3. Default: version2.

nfs_maximum_mbit int

The maximum allowed usage for the nfs traffic class, in Mbits/sec.

nfs_reservation_mbit int

The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.

nfs_share_count int

The amount of shares to allocate to the nfs traffic class for a custom share level.

nfs_share_level str

The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.

notify_switches bool

If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.

port_private_secondary_vlan_id int

Used to define a secondary VLAN ID when using private VLANs.

pvlan_mappings Sequence[DistributedVirtualSwitchPvlanMappingArgs]

Use the pvlan_mapping block to declare a private VLAN mapping. The options are:

standby_uplinks Sequence[str]

A list of standby uplinks to be used in failover. These uplinks need to match the definitions in the uplinks DVS argument. See here for more details.

tags Sequence[str]

The IDs of any tags to attach to this resource.

teaming_policy str

The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.

tx_uplink bool

Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.

uplinks Sequence[str]

A list of strings that uniquely identifies the names of the uplinks on the DVS across hosts. The number of items in this list controls the number of uplinks that exist on the DVS, in addition to the names. See here for an example on how to use this option.

vdp_maximum_mbit int

The maximum allowed usage for the vdp traffic class, in Mbits/sec.

vdp_reservation_mbit int

The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.

vdp_share_count int

The amount of shares to allocate to the vdp traffic class for a custom share level.

vdp_share_level str

The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.

version str
  • The version of the DVS to create. The default is to create the DVS at the latest version supported by the version of vSphere being used. A DVS can be upgraded to another version, but cannot be downgraded.
virtualmachine_maximum_mbit int

The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.

virtualmachine_reservation_mbit int

The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.

virtualmachine_share_count int

The amount of shares to allocate to the virtualMachine traffic class for a custom share level.

virtualmachine_share_level str

The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.

vlan_id int

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

vlan_ranges Sequence[DistributedVirtualSwitchVlanRangeArgs]

Used to denote VLAN trunking. Use the min_vlan and max_vlan sub-arguments to define the tagged VLAN range. Multiple vlan_range definitions are allowed, but they must not overlap. Example below:

vmotion_maximum_mbit int

The maximum allowed usage for the vmotion traffic class, in Mbits/sec.

vmotion_reservation_mbit int

The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.

vmotion_share_count int

The amount of shares to allocate to the vmotion traffic class for a custom share level.

vmotion_share_level str

The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.

vsan_maximum_mbit int

The maximum allowed usage for the vsan traffic class, in Mbits/sec.

vsan_reservation_mbit int

The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.

vsan_share_count int

The amount of shares to allocate to the vsan traffic class for a custom share level.

vsan_share_level str

The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.

Supporting Types

DistributedVirtualSwitchHost

Devices List<string>

The list of NIC devices to map to uplinks on the DVS, added in order they are specified.

HostSystemId string

The host system ID of the host to add to the DVS.

Devices []string

The list of NIC devices to map to uplinks on the DVS, added in order they are specified.

HostSystemId string

The host system ID of the host to add to the DVS.

devices string[]

The list of NIC devices to map to uplinks on the DVS, added in order they are specified.

hostSystemId string

The host system ID of the host to add to the DVS.

devices Sequence[str]

The list of NIC devices to map to uplinks on the DVS, added in order they are specified.

host_system_id str

The host system ID of the host to add to the DVS.

DistributedVirtualSwitchPvlanMapping

PrimaryVlanId int

The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

PvlanType string

The private VLAN type. Valid values are promiscuous, community and isolated.

SecondaryVlanId int

The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

PrimaryVlanId int

The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

PvlanType string

The private VLAN type. Valid values are promiscuous, community and isolated.

SecondaryVlanId int

The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

primaryVlanId number

The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

pvlanType string

The private VLAN type. Valid values are promiscuous, community and isolated.

secondaryVlanId number

The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

primary_vlan_id int

The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

pvlan_type str

The private VLAN type. Valid values are promiscuous, community and isolated.

secondary_vlan_id int

The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.

DistributedVirtualSwitchVlanRange

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.