vsphere.DistributedVirtualSwitch
Explore with Pulumi AI
The vsphere.DistributedVirtualSwitch
resource can be used to manage vSphere
Distributed Switches (VDS).
An essential component of a distributed, scalable vSphere infrastructure, the
VDS provides centralized management and monitoring of the networking
configuration for all the hosts that are associated with the switch.
In addition to adding distributed port groups
(see the vsphere.DistributedPortGroup
resource)
that can be used as networks for virtual machines, a VDS can be configured to
perform advanced high availability, traffic shaping, network monitoring, etc.
For an overview on vSphere networking concepts, see this page.
For more information on the VDS, see this page.
NOTE: This resource requires vCenter and is not available on direct ESXi host connections.
Example Usage
The following example below demonstrates a “standard” example of configuring a
VDS in a 3-node vSphere datacenter named dc1
, across 4 NICs with two being
used as active, and two being used as passive. Note that the NIC failover order
propagates to any port groups configured on this VDS and can be overridden.
import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";
const config = new pulumi.Config();
const hosts = config.getObject("hosts") || [
"esxi-01.example.com",
"esxi-02.example.com",
"esxi-03.example.com",
];
const networkInterfaces = config.getObject("networkInterfaces") || [
"vmnic0",
"vmnic1",
"vmnic2",
"vmnic3",
];
const datacenter = vsphere.getDatacenter({
name: "dc-01",
});
const host = (new Array(hosts.length)).map((_, i) => i).map(__index => (vsphere.getHost({
name: hosts[__index],
datacenterId: _arg0_.id,
})));
const vds = new vsphere.DistributedVirtualSwitch("vds", {
name: "vds-01",
datacenterId: datacenter.then(datacenter => datacenter.id),
uplinks: [
"uplink1",
"uplink2",
"uplink3",
"uplink4",
],
activeUplinks: [
"uplink1",
"uplink2",
],
standbyUplinks: [
"uplink3",
"uplink4",
],
hosts: [
{
hostSystemId: host[0].then(host => host.id),
devices: [networkInterfaces],
},
{
hostSystemId: host[1].then(host => host.id),
devices: [networkInterfaces],
},
{
hostSystemId: host[2].then(host => host.id),
devices: [networkInterfaces],
},
],
});
import pulumi
import pulumi_vsphere as vsphere
config = pulumi.Config()
hosts = config.get_object("hosts")
if hosts is None:
hosts = [
"esxi-01.example.com",
"esxi-02.example.com",
"esxi-03.example.com",
]
network_interfaces = config.get_object("networkInterfaces")
if network_interfaces is None:
network_interfaces = [
"vmnic0",
"vmnic1",
"vmnic2",
"vmnic3",
]
datacenter = vsphere.get_datacenter(name="dc-01")
host = [vsphere.get_host(name=hosts[__index],
datacenter_id=datacenter.id) for __index in range(len(hosts))]
vds = vsphere.DistributedVirtualSwitch("vds",
name="vds-01",
datacenter_id=datacenter.id,
uplinks=[
"uplink1",
"uplink2",
"uplink3",
"uplink4",
],
active_uplinks=[
"uplink1",
"uplink2",
],
standby_uplinks=[
"uplink3",
"uplink4",
],
hosts=[
{
"host_system_id": host[0].id,
"devices": [network_interfaces],
},
{
"host_system_id": host[1].id,
"devices": [network_interfaces],
},
{
"host_system_id": host[2].id,
"devices": [network_interfaces],
},
])
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Uplink name and count control
The following abridged example below demonstrates how you can manage the number
of uplinks, and the name of the uplinks via the uplinks
parameter.
Note that if you change the uplink naming and count after creating the VDS, you
may need to explicitly specify active_uplinks
and standby_uplinks
as these
values are saved to state after creation, regardless of being
specified in config, and will drift if not modified, causing errors.
import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";
const vds = new vsphere.DistributedVirtualSwitch("vds", {
name: "vds-01",
datacenterId: datacenter.id,
uplinks: [
"uplink1",
"uplink2",
],
activeUplinks: ["uplink1"],
standbyUplinks: ["uplink2"],
});
import pulumi
import pulumi_vsphere as vsphere
vds = vsphere.DistributedVirtualSwitch("vds",
name="vds-01",
datacenter_id=datacenter["id"],
uplinks=[
"uplink1",
"uplink2",
],
active_uplinks=["uplink1"],
standby_uplinks=["uplink2"])
package main
import (
"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vsphere.NewDistributedVirtualSwitch(ctx, "vds", &vsphere.DistributedVirtualSwitchArgs{
Name: pulumi.String("vds-01"),
DatacenterId: pulumi.Any(datacenter.Id),
Uplinks: pulumi.StringArray{
pulumi.String("uplink1"),
pulumi.String("uplink2"),
},
ActiveUplinks: pulumi.StringArray{
pulumi.String("uplink1"),
},
StandbyUplinks: pulumi.StringArray{
pulumi.String("uplink2"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;
return await Deployment.RunAsync(() =>
{
var vds = new VSphere.DistributedVirtualSwitch("vds", new()
{
Name = "vds-01",
DatacenterId = datacenter.Id,
Uplinks = new[]
{
"uplink1",
"uplink2",
},
ActiveUplinks = new[]
{
"uplink1",
},
StandbyUplinks = new[]
{
"uplink2",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.DistributedVirtualSwitch;
import com.pulumi.vsphere.DistributedVirtualSwitchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var vds = new DistributedVirtualSwitch("vds", DistributedVirtualSwitchArgs.builder()
.name("vds-01")
.datacenterId(datacenter.id())
.uplinks(
"uplink1",
"uplink2")
.activeUplinks("uplink1")
.standbyUplinks("uplink2")
.build());
}
}
resources:
vds:
type: vsphere:DistributedVirtualSwitch
properties:
name: vds-01
datacenterId: ${datacenter.id}
uplinks:
- uplink1
- uplink2
activeUplinks:
- uplink1
standbyUplinks:
- uplink2
NOTE: The default uplink names when a VDS is created are
uplink1
through touplink4
, however this default is not guaranteed to be stable and you are encouraged to set your own.
Create DistributedVirtualSwitch Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DistributedVirtualSwitch(name: string, args: DistributedVirtualSwitchArgs, opts?: CustomResourceOptions);
@overload
def DistributedVirtualSwitch(resource_name: str,
args: DistributedVirtualSwitchArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DistributedVirtualSwitch(resource_name: str,
opts: Optional[ResourceOptions] = None,
datacenter_id: Optional[str] = None,
active_uplinks: Optional[Sequence[str]] = None,
allow_forged_transmits: Optional[bool] = None,
allow_mac_changes: Optional[bool] = None,
allow_promiscuous: Optional[bool] = None,
backupnfc_maximum_mbit: Optional[int] = None,
backupnfc_reservation_mbit: Optional[int] = None,
backupnfc_share_count: Optional[int] = None,
backupnfc_share_level: Optional[str] = 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,
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)
public DistributedVirtualSwitch(String name, DistributedVirtualSwitchArgs args)
public DistributedVirtualSwitch(String name, DistributedVirtualSwitchArgs args, CustomResourceOptions options)
type: vsphere:DistributedVirtualSwitch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args DistributedVirtualSwitchArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args DistributedVirtualSwitchArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var distributedVirtualSwitchResource = new VSphere.DistributedVirtualSwitch("distributedVirtualSwitchResource", new()
{
DatacenterId = "string",
ActiveUplinks = new[]
{
"string",
},
AllowForgedTransmits = false,
AllowMacChanges = false,
AllowPromiscuous = false,
BackupnfcMaximumMbit = 0,
BackupnfcReservationMbit = 0,
BackupnfcShareCount = 0,
BackupnfcShareLevel = "string",
BlockAllPorts = false,
CheckBeacon = false,
ContactDetail = "string",
ContactName = "string",
CustomAttributes =
{
{ "string", "string" },
},
Description = "string",
DirectpathGen2Allowed = false,
EgressShapingAverageBandwidth = 0,
EgressShapingBurstSize = 0,
EgressShapingEnabled = false,
EgressShapingPeakBandwidth = 0,
Failback = false,
FaulttoleranceMaximumMbit = 0,
FaulttoleranceReservationMbit = 0,
FaulttoleranceShareCount = 0,
FaulttoleranceShareLevel = "string",
Folder = "string",
HbrMaximumMbit = 0,
HbrReservationMbit = 0,
HbrShareCount = 0,
HbrShareLevel = "string",
Hosts = new[]
{
new VSphere.Inputs.DistributedVirtualSwitchHostArgs
{
HostSystemId = "string",
Devices = new[]
{
"string",
},
},
},
IgnoreOtherPvlanMappings = false,
IngressShapingAverageBandwidth = 0,
IngressShapingBurstSize = 0,
IngressShapingEnabled = false,
IngressShapingPeakBandwidth = 0,
Ipv4Address = "string",
IscsiMaximumMbit = 0,
IscsiReservationMbit = 0,
IscsiShareCount = 0,
IscsiShareLevel = "string",
LacpApiVersion = "string",
LacpEnabled = false,
LacpMode = "string",
LinkDiscoveryOperation = "string",
LinkDiscoveryProtocol = "string",
ManagementMaximumMbit = 0,
ManagementReservationMbit = 0,
ManagementShareCount = 0,
ManagementShareLevel = "string",
MaxMtu = 0,
MulticastFilteringMode = "string",
Name = "string",
NetflowActiveFlowTimeout = 0,
NetflowCollectorIpAddress = "string",
NetflowCollectorPort = 0,
NetflowEnabled = false,
NetflowIdleFlowTimeout = 0,
NetflowInternalFlowsOnly = false,
NetflowObservationDomainId = 0,
NetflowSamplingRate = 0,
NetworkResourceControlEnabled = false,
NetworkResourceControlVersion = "string",
NfsMaximumMbit = 0,
NfsReservationMbit = 0,
NfsShareCount = 0,
NfsShareLevel = "string",
NotifySwitches = false,
PortPrivateSecondaryVlanId = 0,
PvlanMappings = new[]
{
new VSphere.Inputs.DistributedVirtualSwitchPvlanMappingArgs
{
PrimaryVlanId = 0,
PvlanType = "string",
SecondaryVlanId = 0,
},
},
StandbyUplinks = new[]
{
"string",
},
Tags = new[]
{
"string",
},
TeamingPolicy = "string",
TxUplink = false,
Uplinks = new[]
{
"string",
},
VdpMaximumMbit = 0,
VdpReservationMbit = 0,
VdpShareCount = 0,
VdpShareLevel = "string",
Version = "string",
VirtualmachineMaximumMbit = 0,
VirtualmachineReservationMbit = 0,
VirtualmachineShareCount = 0,
VirtualmachineShareLevel = "string",
VlanId = 0,
VlanRanges = new[]
{
new VSphere.Inputs.DistributedVirtualSwitchVlanRangeArgs
{
MaxVlan = 0,
MinVlan = 0,
},
},
VmotionMaximumMbit = 0,
VmotionReservationMbit = 0,
VmotionShareCount = 0,
VmotionShareLevel = "string",
VsanMaximumMbit = 0,
VsanReservationMbit = 0,
VsanShareCount = 0,
VsanShareLevel = "string",
});
example, err := vsphere.NewDistributedVirtualSwitch(ctx, "distributedVirtualSwitchResource", &vsphere.DistributedVirtualSwitchArgs{
DatacenterId: pulumi.String("string"),
ActiveUplinks: pulumi.StringArray{
pulumi.String("string"),
},
AllowForgedTransmits: pulumi.Bool(false),
AllowMacChanges: pulumi.Bool(false),
AllowPromiscuous: pulumi.Bool(false),
BackupnfcMaximumMbit: pulumi.Int(0),
BackupnfcReservationMbit: pulumi.Int(0),
BackupnfcShareCount: pulumi.Int(0),
BackupnfcShareLevel: pulumi.String("string"),
BlockAllPorts: pulumi.Bool(false),
CheckBeacon: pulumi.Bool(false),
ContactDetail: pulumi.String("string"),
ContactName: pulumi.String("string"),
CustomAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DirectpathGen2Allowed: pulumi.Bool(false),
EgressShapingAverageBandwidth: pulumi.Int(0),
EgressShapingBurstSize: pulumi.Int(0),
EgressShapingEnabled: pulumi.Bool(false),
EgressShapingPeakBandwidth: pulumi.Int(0),
Failback: pulumi.Bool(false),
FaulttoleranceMaximumMbit: pulumi.Int(0),
FaulttoleranceReservationMbit: pulumi.Int(0),
FaulttoleranceShareCount: pulumi.Int(0),
FaulttoleranceShareLevel: pulumi.String("string"),
Folder: pulumi.String("string"),
HbrMaximumMbit: pulumi.Int(0),
HbrReservationMbit: pulumi.Int(0),
HbrShareCount: pulumi.Int(0),
HbrShareLevel: pulumi.String("string"),
Hosts: vsphere.DistributedVirtualSwitchHostArray{
&vsphere.DistributedVirtualSwitchHostArgs{
HostSystemId: pulumi.String("string"),
Devices: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IgnoreOtherPvlanMappings: pulumi.Bool(false),
IngressShapingAverageBandwidth: pulumi.Int(0),
IngressShapingBurstSize: pulumi.Int(0),
IngressShapingEnabled: pulumi.Bool(false),
IngressShapingPeakBandwidth: pulumi.Int(0),
Ipv4Address: pulumi.String("string"),
IscsiMaximumMbit: pulumi.Int(0),
IscsiReservationMbit: pulumi.Int(0),
IscsiShareCount: pulumi.Int(0),
IscsiShareLevel: pulumi.String("string"),
LacpApiVersion: pulumi.String("string"),
LacpEnabled: pulumi.Bool(false),
LacpMode: pulumi.String("string"),
LinkDiscoveryOperation: pulumi.String("string"),
LinkDiscoveryProtocol: pulumi.String("string"),
ManagementMaximumMbit: pulumi.Int(0),
ManagementReservationMbit: pulumi.Int(0),
ManagementShareCount: pulumi.Int(0),
ManagementShareLevel: pulumi.String("string"),
MaxMtu: pulumi.Int(0),
MulticastFilteringMode: pulumi.String("string"),
Name: pulumi.String("string"),
NetflowActiveFlowTimeout: pulumi.Int(0),
NetflowCollectorIpAddress: pulumi.String("string"),
NetflowCollectorPort: pulumi.Int(0),
NetflowEnabled: pulumi.Bool(false),
NetflowIdleFlowTimeout: pulumi.Int(0),
NetflowInternalFlowsOnly: pulumi.Bool(false),
NetflowObservationDomainId: pulumi.Int(0),
NetflowSamplingRate: pulumi.Int(0),
NetworkResourceControlEnabled: pulumi.Bool(false),
NetworkResourceControlVersion: pulumi.String("string"),
NfsMaximumMbit: pulumi.Int(0),
NfsReservationMbit: pulumi.Int(0),
NfsShareCount: pulumi.Int(0),
NfsShareLevel: pulumi.String("string"),
NotifySwitches: pulumi.Bool(false),
PortPrivateSecondaryVlanId: pulumi.Int(0),
PvlanMappings: vsphere.DistributedVirtualSwitchPvlanMappingArray{
&vsphere.DistributedVirtualSwitchPvlanMappingArgs{
PrimaryVlanId: pulumi.Int(0),
PvlanType: pulumi.String("string"),
SecondaryVlanId: pulumi.Int(0),
},
},
StandbyUplinks: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TeamingPolicy: pulumi.String("string"),
TxUplink: pulumi.Bool(false),
Uplinks: pulumi.StringArray{
pulumi.String("string"),
},
VdpMaximumMbit: pulumi.Int(0),
VdpReservationMbit: pulumi.Int(0),
VdpShareCount: pulumi.Int(0),
VdpShareLevel: pulumi.String("string"),
Version: pulumi.String("string"),
VirtualmachineMaximumMbit: pulumi.Int(0),
VirtualmachineReservationMbit: pulumi.Int(0),
VirtualmachineShareCount: pulumi.Int(0),
VirtualmachineShareLevel: pulumi.String("string"),
VlanId: pulumi.Int(0),
VlanRanges: vsphere.DistributedVirtualSwitchVlanRangeArray{
&vsphere.DistributedVirtualSwitchVlanRangeArgs{
MaxVlan: pulumi.Int(0),
MinVlan: pulumi.Int(0),
},
},
VmotionMaximumMbit: pulumi.Int(0),
VmotionReservationMbit: pulumi.Int(0),
VmotionShareCount: pulumi.Int(0),
VmotionShareLevel: pulumi.String("string"),
VsanMaximumMbit: pulumi.Int(0),
VsanReservationMbit: pulumi.Int(0),
VsanShareCount: pulumi.Int(0),
VsanShareLevel: pulumi.String("string"),
})
var distributedVirtualSwitchResource = new DistributedVirtualSwitch("distributedVirtualSwitchResource", DistributedVirtualSwitchArgs.builder()
.datacenterId("string")
.activeUplinks("string")
.allowForgedTransmits(false)
.allowMacChanges(false)
.allowPromiscuous(false)
.backupnfcMaximumMbit(0)
.backupnfcReservationMbit(0)
.backupnfcShareCount(0)
.backupnfcShareLevel("string")
.blockAllPorts(false)
.checkBeacon(false)
.contactDetail("string")
.contactName("string")
.customAttributes(Map.of("string", "string"))
.description("string")
.directpathGen2Allowed(false)
.egressShapingAverageBandwidth(0)
.egressShapingBurstSize(0)
.egressShapingEnabled(false)
.egressShapingPeakBandwidth(0)
.failback(false)
.faulttoleranceMaximumMbit(0)
.faulttoleranceReservationMbit(0)
.faulttoleranceShareCount(0)
.faulttoleranceShareLevel("string")
.folder("string")
.hbrMaximumMbit(0)
.hbrReservationMbit(0)
.hbrShareCount(0)
.hbrShareLevel("string")
.hosts(DistributedVirtualSwitchHostArgs.builder()
.hostSystemId("string")
.devices("string")
.build())
.ignoreOtherPvlanMappings(false)
.ingressShapingAverageBandwidth(0)
.ingressShapingBurstSize(0)
.ingressShapingEnabled(false)
.ingressShapingPeakBandwidth(0)
.ipv4Address("string")
.iscsiMaximumMbit(0)
.iscsiReservationMbit(0)
.iscsiShareCount(0)
.iscsiShareLevel("string")
.lacpApiVersion("string")
.lacpEnabled(false)
.lacpMode("string")
.linkDiscoveryOperation("string")
.linkDiscoveryProtocol("string")
.managementMaximumMbit(0)
.managementReservationMbit(0)
.managementShareCount(0)
.managementShareLevel("string")
.maxMtu(0)
.multicastFilteringMode("string")
.name("string")
.netflowActiveFlowTimeout(0)
.netflowCollectorIpAddress("string")
.netflowCollectorPort(0)
.netflowEnabled(false)
.netflowIdleFlowTimeout(0)
.netflowInternalFlowsOnly(false)
.netflowObservationDomainId(0)
.netflowSamplingRate(0)
.networkResourceControlEnabled(false)
.networkResourceControlVersion("string")
.nfsMaximumMbit(0)
.nfsReservationMbit(0)
.nfsShareCount(0)
.nfsShareLevel("string")
.notifySwitches(false)
.portPrivateSecondaryVlanId(0)
.pvlanMappings(DistributedVirtualSwitchPvlanMappingArgs.builder()
.primaryVlanId(0)
.pvlanType("string")
.secondaryVlanId(0)
.build())
.standbyUplinks("string")
.tags("string")
.teamingPolicy("string")
.txUplink(false)
.uplinks("string")
.vdpMaximumMbit(0)
.vdpReservationMbit(0)
.vdpShareCount(0)
.vdpShareLevel("string")
.version("string")
.virtualmachineMaximumMbit(0)
.virtualmachineReservationMbit(0)
.virtualmachineShareCount(0)
.virtualmachineShareLevel("string")
.vlanId(0)
.vlanRanges(DistributedVirtualSwitchVlanRangeArgs.builder()
.maxVlan(0)
.minVlan(0)
.build())
.vmotionMaximumMbit(0)
.vmotionReservationMbit(0)
.vmotionShareCount(0)
.vmotionShareLevel("string")
.vsanMaximumMbit(0)
.vsanReservationMbit(0)
.vsanShareCount(0)
.vsanShareLevel("string")
.build());
distributed_virtual_switch_resource = vsphere.DistributedVirtualSwitch("distributedVirtualSwitchResource",
datacenter_id="string",
active_uplinks=["string"],
allow_forged_transmits=False,
allow_mac_changes=False,
allow_promiscuous=False,
backupnfc_maximum_mbit=0,
backupnfc_reservation_mbit=0,
backupnfc_share_count=0,
backupnfc_share_level="string",
block_all_ports=False,
check_beacon=False,
contact_detail="string",
contact_name="string",
custom_attributes={
"string": "string",
},
description="string",
directpath_gen2_allowed=False,
egress_shaping_average_bandwidth=0,
egress_shaping_burst_size=0,
egress_shaping_enabled=False,
egress_shaping_peak_bandwidth=0,
failback=False,
faulttolerance_maximum_mbit=0,
faulttolerance_reservation_mbit=0,
faulttolerance_share_count=0,
faulttolerance_share_level="string",
folder="string",
hbr_maximum_mbit=0,
hbr_reservation_mbit=0,
hbr_share_count=0,
hbr_share_level="string",
hosts=[{
"host_system_id": "string",
"devices": ["string"],
}],
ignore_other_pvlan_mappings=False,
ingress_shaping_average_bandwidth=0,
ingress_shaping_burst_size=0,
ingress_shaping_enabled=False,
ingress_shaping_peak_bandwidth=0,
ipv4_address="string",
iscsi_maximum_mbit=0,
iscsi_reservation_mbit=0,
iscsi_share_count=0,
iscsi_share_level="string",
lacp_api_version="string",
lacp_enabled=False,
lacp_mode="string",
link_discovery_operation="string",
link_discovery_protocol="string",
management_maximum_mbit=0,
management_reservation_mbit=0,
management_share_count=0,
management_share_level="string",
max_mtu=0,
multicast_filtering_mode="string",
name="string",
netflow_active_flow_timeout=0,
netflow_collector_ip_address="string",
netflow_collector_port=0,
netflow_enabled=False,
netflow_idle_flow_timeout=0,
netflow_internal_flows_only=False,
netflow_observation_domain_id=0,
netflow_sampling_rate=0,
network_resource_control_enabled=False,
network_resource_control_version="string",
nfs_maximum_mbit=0,
nfs_reservation_mbit=0,
nfs_share_count=0,
nfs_share_level="string",
notify_switches=False,
port_private_secondary_vlan_id=0,
pvlan_mappings=[{
"primary_vlan_id": 0,
"pvlan_type": "string",
"secondary_vlan_id": 0,
}],
standby_uplinks=["string"],
tags=["string"],
teaming_policy="string",
tx_uplink=False,
uplinks=["string"],
vdp_maximum_mbit=0,
vdp_reservation_mbit=0,
vdp_share_count=0,
vdp_share_level="string",
version="string",
virtualmachine_maximum_mbit=0,
virtualmachine_reservation_mbit=0,
virtualmachine_share_count=0,
virtualmachine_share_level="string",
vlan_id=0,
vlan_ranges=[{
"max_vlan": 0,
"min_vlan": 0,
}],
vmotion_maximum_mbit=0,
vmotion_reservation_mbit=0,
vmotion_share_count=0,
vmotion_share_level="string",
vsan_maximum_mbit=0,
vsan_reservation_mbit=0,
vsan_share_count=0,
vsan_share_level="string")
const distributedVirtualSwitchResource = new vsphere.DistributedVirtualSwitch("distributedVirtualSwitchResource", {
datacenterId: "string",
activeUplinks: ["string"],
allowForgedTransmits: false,
allowMacChanges: false,
allowPromiscuous: false,
backupnfcMaximumMbit: 0,
backupnfcReservationMbit: 0,
backupnfcShareCount: 0,
backupnfcShareLevel: "string",
blockAllPorts: false,
checkBeacon: false,
contactDetail: "string",
contactName: "string",
customAttributes: {
string: "string",
},
description: "string",
directpathGen2Allowed: false,
egressShapingAverageBandwidth: 0,
egressShapingBurstSize: 0,
egressShapingEnabled: false,
egressShapingPeakBandwidth: 0,
failback: false,
faulttoleranceMaximumMbit: 0,
faulttoleranceReservationMbit: 0,
faulttoleranceShareCount: 0,
faulttoleranceShareLevel: "string",
folder: "string",
hbrMaximumMbit: 0,
hbrReservationMbit: 0,
hbrShareCount: 0,
hbrShareLevel: "string",
hosts: [{
hostSystemId: "string",
devices: ["string"],
}],
ignoreOtherPvlanMappings: false,
ingressShapingAverageBandwidth: 0,
ingressShapingBurstSize: 0,
ingressShapingEnabled: false,
ingressShapingPeakBandwidth: 0,
ipv4Address: "string",
iscsiMaximumMbit: 0,
iscsiReservationMbit: 0,
iscsiShareCount: 0,
iscsiShareLevel: "string",
lacpApiVersion: "string",
lacpEnabled: false,
lacpMode: "string",
linkDiscoveryOperation: "string",
linkDiscoveryProtocol: "string",
managementMaximumMbit: 0,
managementReservationMbit: 0,
managementShareCount: 0,
managementShareLevel: "string",
maxMtu: 0,
multicastFilteringMode: "string",
name: "string",
netflowActiveFlowTimeout: 0,
netflowCollectorIpAddress: "string",
netflowCollectorPort: 0,
netflowEnabled: false,
netflowIdleFlowTimeout: 0,
netflowInternalFlowsOnly: false,
netflowObservationDomainId: 0,
netflowSamplingRate: 0,
networkResourceControlEnabled: false,
networkResourceControlVersion: "string",
nfsMaximumMbit: 0,
nfsReservationMbit: 0,
nfsShareCount: 0,
nfsShareLevel: "string",
notifySwitches: false,
portPrivateSecondaryVlanId: 0,
pvlanMappings: [{
primaryVlanId: 0,
pvlanType: "string",
secondaryVlanId: 0,
}],
standbyUplinks: ["string"],
tags: ["string"],
teamingPolicy: "string",
txUplink: false,
uplinks: ["string"],
vdpMaximumMbit: 0,
vdpReservationMbit: 0,
vdpShareCount: 0,
vdpShareLevel: "string",
version: "string",
virtualmachineMaximumMbit: 0,
virtualmachineReservationMbit: 0,
virtualmachineShareCount: 0,
virtualmachineShareLevel: "string",
vlanId: 0,
vlanRanges: [{
maxVlan: 0,
minVlan: 0,
}],
vmotionMaximumMbit: 0,
vmotionReservationMbit: 0,
vmotionShareCount: 0,
vmotionShareLevel: "string",
vsanMaximumMbit: 0,
vsanReservationMbit: 0,
vsanShareCount: 0,
vsanShareLevel: "string",
});
type: vsphere:DistributedVirtualSwitch
properties:
activeUplinks:
- string
allowForgedTransmits: false
allowMacChanges: false
allowPromiscuous: false
backupnfcMaximumMbit: 0
backupnfcReservationMbit: 0
backupnfcShareCount: 0
backupnfcShareLevel: string
blockAllPorts: false
checkBeacon: false
contactDetail: string
contactName: string
customAttributes:
string: string
datacenterId: string
description: string
directpathGen2Allowed: false
egressShapingAverageBandwidth: 0
egressShapingBurstSize: 0
egressShapingEnabled: false
egressShapingPeakBandwidth: 0
failback: false
faulttoleranceMaximumMbit: 0
faulttoleranceReservationMbit: 0
faulttoleranceShareCount: 0
faulttoleranceShareLevel: string
folder: string
hbrMaximumMbit: 0
hbrReservationMbit: 0
hbrShareCount: 0
hbrShareLevel: string
hosts:
- devices:
- string
hostSystemId: string
ignoreOtherPvlanMappings: false
ingressShapingAverageBandwidth: 0
ingressShapingBurstSize: 0
ingressShapingEnabled: false
ingressShapingPeakBandwidth: 0
ipv4Address: string
iscsiMaximumMbit: 0
iscsiReservationMbit: 0
iscsiShareCount: 0
iscsiShareLevel: string
lacpApiVersion: string
lacpEnabled: false
lacpMode: string
linkDiscoveryOperation: string
linkDiscoveryProtocol: string
managementMaximumMbit: 0
managementReservationMbit: 0
managementShareCount: 0
managementShareLevel: string
maxMtu: 0
multicastFilteringMode: string
name: string
netflowActiveFlowTimeout: 0
netflowCollectorIpAddress: string
netflowCollectorPort: 0
netflowEnabled: false
netflowIdleFlowTimeout: 0
netflowInternalFlowsOnly: false
netflowObservationDomainId: 0
netflowSamplingRate: 0
networkResourceControlEnabled: false
networkResourceControlVersion: string
nfsMaximumMbit: 0
nfsReservationMbit: 0
nfsShareCount: 0
nfsShareLevel: string
notifySwitches: false
portPrivateSecondaryVlanId: 0
pvlanMappings:
- primaryVlanId: 0
pvlanType: string
secondaryVlanId: 0
standbyUplinks:
- string
tags:
- string
teamingPolicy: string
txUplink: false
uplinks:
- string
vdpMaximumMbit: 0
vdpReservationMbit: 0
vdpShareCount: 0
vdpShareLevel: string
version: string
virtualmachineMaximumMbit: 0
virtualmachineReservationMbit: 0
virtualmachineShareCount: 0
virtualmachineShareLevel: string
vlanId: 0
vlanRanges:
- maxVlan: 0
minVlan: 0
vmotionMaximumMbit: 0
vmotionReservationMbit: 0
vmotionShareCount: 0
vmotionShareLevel: string
vsanMaximumMbit: 0
vsanReservationMbit: 0
vsanShareCount: 0
vsanShareLevel: string
DistributedVirtualSwitch Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DistributedVirtualSwitch resource accepts the following input properties:
- Datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- Active
Uplinks List<string> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Allow
Forged boolTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- Allow
Mac boolChanges - 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.
- Backupnfc
Maximum intMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- Backupnfc
Reservation intMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- Block
All boolPorts - Indicates whether to block all ports by default.
- Check
Beacon bool - Enable beacon probing on the ports this policy applies to.
- Contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- Contact
Name string - The name of the person who is responsible for the VDS.
- Custom
Attributes Dictionary<string, string> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- Description string
- A detailed description for the VDS.
- Directpath
Gen2Allowed bool - Allow VMDirectPath Gen2 on the ports this policy applies to.
- Egress
Shaping intAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- Egress
Shaping intBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- Egress
Shaping boolEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- Egress
Shaping intPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- Failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- Faulttolerance
Maximum intMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- Faulttolerance
Reservation intMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- Folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- Hbr
Maximum intMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- Hbr
Reservation intMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- Hosts
List<Pulumi.
VSphere. Inputs. Distributed Virtual Switch Host> - A host member specification.
- Ignore
Other boolPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- Ingress
Shaping intAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- Ingress
Shaping intBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- Ingress
Shaping boolEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- Ingress
Shaping intPeak Bandwidth - The peak ingress 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.
- Iscsi
Maximum intMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- Iscsi
Reservation intMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- Lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - Lacp
Enabled bool - Whether or not to enable LACP on all uplink ports.
- Lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- Link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - Link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - Management
Maximum intMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- Management
Reservation intMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- 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 VDS.
- Multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - Name string
- The name of the VDS.
- Netflow
Active intFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- Netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- Netflow
Collector intPort - The port for the netflow collector.
- Netflow
Enabled bool - Indicates whether to enable netflow on all ports.
- Netflow
Idle intFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- Netflow
Internal boolFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- Netflow
Observation intDomain Id - The observation Domain ID for the netflow collector.
- Netflow
Sampling intRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- Network
Resource boolControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- Network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- Nfs
Maximum intMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- Nfs
Reservation intMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- 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 a NIC failover, triggering cache updates.
- Port
Private intSecondary Vlan Id - The secondary VLAN ID for this port.
- Pvlan
Mappings List<Pulumi.VSphere. Inputs. Distributed Virtual Switch Pvlan Mapping> - A private VLAN (PVLAN) mapping.
- Standby
Uplinks List<string> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<string>
- The IDs of any tags to attach to this resource.
- Teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- Tx
Uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- Uplinks List<string>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- Vdp
Maximum intMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- Vdp
Reservation intMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- Version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- Virtualmachine
Maximum intMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- Virtualmachine
Reservation intMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- 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 List<Pulumi.VSphere. Inputs. Distributed Virtual Switch Vlan Range> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- Vmotion
Maximum intMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- Vmotion
Reservation intMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- Vsan
Maximum intMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- Vsan
Reservation intMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- string
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- Datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- Active
Uplinks []string - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Allow
Forged boolTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- Allow
Mac boolChanges - 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.
- Backupnfc
Maximum intMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- Backupnfc
Reservation intMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- Block
All boolPorts - Indicates whether to block all ports by default.
- Check
Beacon bool - Enable beacon probing on the ports this policy applies to.
- Contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- Contact
Name string - The name of the person who is responsible for the VDS.
- Custom
Attributes map[string]string Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- Description string
- A detailed description for the VDS.
- Directpath
Gen2Allowed bool - Allow VMDirectPath Gen2 on the ports this policy applies to.
- Egress
Shaping intAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- Egress
Shaping intBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- Egress
Shaping boolEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- Egress
Shaping intPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- Failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- Faulttolerance
Maximum intMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- Faulttolerance
Reservation intMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- Folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- Hbr
Maximum intMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- Hbr
Reservation intMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- Hosts
[]Distributed
Virtual Switch Host Args - A host member specification.
- Ignore
Other boolPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- Ingress
Shaping intAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- Ingress
Shaping intBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- Ingress
Shaping boolEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- Ingress
Shaping intPeak Bandwidth - The peak ingress 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.
- Iscsi
Maximum intMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- Iscsi
Reservation intMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- Lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - Lacp
Enabled bool - Whether or not to enable LACP on all uplink ports.
- Lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- Link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - Link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - Management
Maximum intMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- Management
Reservation intMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- 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 VDS.
- Multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - Name string
- The name of the VDS.
- Netflow
Active intFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- Netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- Netflow
Collector intPort - The port for the netflow collector.
- Netflow
Enabled bool - Indicates whether to enable netflow on all ports.
- Netflow
Idle intFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- Netflow
Internal boolFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- Netflow
Observation intDomain Id - The observation Domain ID for the netflow collector.
- Netflow
Sampling intRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- Network
Resource boolControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- Network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- Nfs
Maximum intMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- Nfs
Reservation intMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- 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 a NIC failover, triggering cache updates.
- Port
Private intSecondary Vlan Id - The secondary VLAN ID for this port.
- Pvlan
Mappings []DistributedVirtual Switch Pvlan Mapping Args - A private VLAN (PVLAN) mapping.
- Standby
Uplinks []string - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- []string
- The IDs of any tags to attach to this resource.
- Teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- Tx
Uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- Uplinks []string
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- Vdp
Maximum intMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- Vdp
Reservation intMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- Version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- Virtualmachine
Maximum intMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- Virtualmachine
Reservation intMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- 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 []DistributedVirtual Switch Vlan Range Args - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- Vmotion
Maximum intMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- Vmotion
Reservation intMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- Vsan
Maximum intMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- Vsan
Reservation intMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- string
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- datacenter
Id String - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- active
Uplinks List<String> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged BooleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac BooleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous Boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum IntegerMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation IntegerMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- String
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All BooleanPorts - Indicates whether to block all ports by default.
- check
Beacon Boolean - Enable beacon probing on the ports this policy applies to.
- contact
Detail String - The detailed contact information for the person who is responsible for the VDS.
- contact
Name String - The name of the person who is responsible for the VDS.
- custom
Attributes Map<String,String> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- description String
- A detailed description for the VDS.
- directpath
Gen2Allowed Boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping IntegerAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping IntegerBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping BooleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping IntegerPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback Boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum IntegerMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation IntegerMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- String
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder String
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum IntegerMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation IntegerMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- String
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
List<Distributed
Virtual Switch Host> - A host member specification.
- ignore
Other BooleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping IntegerAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping IntegerBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping BooleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping IntegerPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum IntegerMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation IntegerMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- String
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api StringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled Boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode String - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery StringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery StringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum IntegerMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation IntegerMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the management traffic class for a custom share level.
- String
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu Integer - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering StringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name String
- The name of the VDS.
- netflow
Active IntegerFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector StringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector IntegerPort - The port for the netflow collector.
- netflow
Enabled Boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle IntegerFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal BooleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation IntegerDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling IntegerRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource BooleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource StringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum IntegerMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation IntegerMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- String
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches Boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private IntegerSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings List<DistributedVirtual Switch Pvlan Mapping> - A private VLAN (PVLAN) mapping.
- standby
Uplinks List<String> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<String>
- The IDs of any tags to attach to this resource.
- teaming
Policy String - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink Boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks List<String>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum IntegerMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- String
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version String
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum IntegerMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation IntegerMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- String
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id Integer - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges List<DistributedVirtual Switch Vlan Range> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum IntegerMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- String
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum IntegerMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- String
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- active
Uplinks string[] - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged booleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac booleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum numberMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation numberMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All booleanPorts - Indicates whether to block all ports by default.
- check
Beacon boolean - Enable beacon probing on the ports this policy applies to.
- contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- contact
Name string - The name of the person who is responsible for the VDS.
- custom
Attributes {[key: string]: string} Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- description string
- A detailed description for the VDS.
- directpath
Gen2Allowed boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping numberAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping numberBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping booleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping numberPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum numberMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation numberMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum numberMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation numberMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
Distributed
Virtual Switch Host[] - A host member specification.
- ignore
Other booleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping numberAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping numberBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping booleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping numberPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum numberMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation numberMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum numberMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation numberMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu number - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name string
- The name of the VDS.
- netflow
Active numberFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector numberPort - The port for the netflow collector.
- netflow
Enabled boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle numberFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal booleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation numberDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling numberRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource booleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum numberMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation numberMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private numberSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings DistributedVirtual Switch Pvlan Mapping[] - A private VLAN (PVLAN) mapping.
- standby
Uplinks string[] - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- string[]
- The IDs of any tags to attach to this resource.
- teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks string[]
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum numberMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation numberMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum numberMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation numberMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id number - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges DistributedVirtual Switch Vlan Range[] - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum numberMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation numberMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum numberMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation numberMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- 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 VDS will be created. Forces a new resource if changed.
- active_
uplinks Sequence[str] - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow_
forged_ booltransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow_
mac_ boolchanges - 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.
- backupnfc_
maximum_ intmbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc_
reservation_ intmbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- str
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block_
all_ boolports - Indicates whether to block all ports by default.
- check_
beacon bool - Enable beacon probing on the ports this policy applies to.
- contact_
detail str - The detailed contact information for the person who is responsible for the VDS.
- contact_
name str - The name of the person who is responsible for the VDS.
- custom_
attributes Mapping[str, str] Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- description str
- A detailed description for the VDS.
- directpath_
gen2_ boolallowed - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress_
shaping_ intaverage_ bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress_
shaping_ intburst_ size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress_
shaping_ boolenabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress_
shaping_ intpeak_ bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance_
maximum_ intmbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance_
reservation_ intmbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- str
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder str
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr_
maximum_ intmbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr_
reservation_ intmbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- str
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
Sequence[Distributed
Virtual Switch Host Args] - A host member specification.
- ignore_
other_ boolpvlan_ mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress_
shaping_ intaverage_ bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress_
shaping_ intburst_ size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress_
shaping_ boolenabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress_
shaping_ intpeak_ bandwidth - The peak ingress 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.
- iscsi_
maximum_ intmbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi_
reservation_ intmbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- str
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp_
api_ strversion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp_
enabled bool - Whether or not to enable LACP on all uplink ports.
- lacp_
mode str - The uplink LACP mode to use. Can be one of active or passive.
- link_
discovery_ stroperation - Whether to
advertise
orlisten
for link discovery traffic. - link_
discovery_ strprotocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management_
maximum_ intmbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management_
reservation_ intmbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom 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 VDS.
- multicast_
filtering_ strmode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name str
- The name of the VDS.
- netflow_
active_ intflow_ timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow_
collector_ strip_ address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow_
collector_ intport - The port for the netflow collector.
- netflow_
enabled bool - Indicates whether to enable netflow on all ports.
- netflow_
idle_ intflow_ timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow_
internal_ boolflows_ only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow_
observation_ intdomain_ id - The observation Domain ID for the netflow collector.
- netflow_
sampling_ intrate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network_
resource_ boolcontrol_ enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network_
resource_ strcontrol_ version - The network I/O control version to use. Can be one of version2 or version3.
- nfs_
maximum_ intmbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs_
reservation_ intmbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom 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 a NIC failover, triggering cache updates.
- port_
private_ intsecondary_ vlan_ id - The secondary VLAN ID for this port.
- pvlan_
mappings Sequence[DistributedVirtual Switch Pvlan Mapping Args] - A private VLAN (PVLAN) mapping.
- standby_
uplinks Sequence[str] - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Sequence[str]
- The IDs of any tags to attach to this resource.
- teaming_
policy str - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx_
uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks Sequence[str]
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp_
maximum_ intmbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp_
reservation_ intmbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom 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 VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine_
maximum_ intmbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine_
reservation_ intmbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom 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[DistributedVirtual Switch Vlan Range Args] - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion_
maximum_ intmbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion_
reservation_ intmbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- str
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan_
maximum_ intmbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan_
reservation_ intmbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- str
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- datacenter
Id String - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- active
Uplinks List<String> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged BooleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac BooleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous Boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum NumberMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation NumberMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- String
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All BooleanPorts - Indicates whether to block all ports by default.
- check
Beacon Boolean - Enable beacon probing on the ports this policy applies to.
- contact
Detail String - The detailed contact information for the person who is responsible for the VDS.
- contact
Name String - The name of the person who is responsible for the VDS.
- custom
Attributes Map<String> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- description String
- A detailed description for the VDS.
- directpath
Gen2Allowed Boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping NumberAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping NumberBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping BooleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping NumberPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback Boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum NumberMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation NumberMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- String
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder String
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum NumberMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation NumberMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- String
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts List<Property Map>
- A host member specification.
- ignore
Other BooleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping NumberAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping NumberBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping BooleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping NumberPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum NumberMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation NumberMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- String
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api StringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled Boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode String - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery StringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery StringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum NumberMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation NumberMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the management traffic class for a custom share level.
- String
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu Number - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering StringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name String
- The name of the VDS.
- netflow
Active NumberFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector StringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector NumberPort - The port for the netflow collector.
- netflow
Enabled Boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle NumberFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal BooleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation NumberDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling NumberRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource BooleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource StringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum NumberMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation NumberMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- String
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches Boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private NumberSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings List<Property Map> - A private VLAN (PVLAN) mapping.
- standby
Uplinks List<String> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<String>
- The IDs of any tags to attach to this resource.
- teaming
Policy String - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink Boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks List<String>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum NumberMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation NumberMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- String
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version String
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum NumberMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation NumberMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- String
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id Number - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges List<Property Map> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum NumberMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation NumberMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- String
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum NumberMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation NumberMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- String
- 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:
- Config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- Id string
- The provider-assigned unique ID for this managed resource.
- Config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- Id string
- The provider-assigned unique ID for this managed resource.
- config
Version String - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- id String
- The provider-assigned unique ID for this managed resource.
- config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- id string
- The provider-assigned unique ID for this managed resource.
- config_
version str - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- id str
- The provider-assigned unique ID for this managed resource.
- config
Version String - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- id String
- The provider-assigned unique ID for this managed resource.
Look up 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,
backupnfc_maximum_mbit: Optional[int] = None,
backupnfc_reservation_mbit: Optional[int] = None,
backupnfc_share_count: Optional[int] = None,
backupnfc_share_level: Optional[str] = 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)
public static DistributedVirtualSwitch get(String name, Output<String> id, DistributedVirtualSwitchState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Active
Uplinks List<string> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Allow
Forged boolTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- Allow
Mac boolChanges - 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.
- Backupnfc
Maximum intMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- Backupnfc
Reservation intMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- Block
All boolPorts - Indicates whether to block all ports by default.
- Check
Beacon bool - Enable beacon probing on the ports this policy applies to.
- Config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- Contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- Contact
Name string - The name of the person who is responsible for the VDS.
- Custom
Attributes Dictionary<string, string> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- Datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- Description string
- A detailed description for the VDS.
- Directpath
Gen2Allowed bool - Allow VMDirectPath Gen2 on the ports this policy applies to.
- Egress
Shaping intAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- Egress
Shaping intBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- Egress
Shaping boolEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- Egress
Shaping intPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- Failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- Faulttolerance
Maximum intMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- Faulttolerance
Reservation intMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- Folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- Hbr
Maximum intMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- Hbr
Reservation intMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- Hosts
List<Pulumi.
VSphere. Inputs. Distributed Virtual Switch Host> - A host member specification.
- Ignore
Other boolPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- Ingress
Shaping intAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- Ingress
Shaping intBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- Ingress
Shaping boolEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- Ingress
Shaping intPeak Bandwidth - The peak ingress 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.
- Iscsi
Maximum intMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- Iscsi
Reservation intMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- Lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - Lacp
Enabled bool - Whether or not to enable LACP on all uplink ports.
- Lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- Link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - Link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - Management
Maximum intMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- Management
Reservation intMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- 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 VDS.
- Multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - Name string
- The name of the VDS.
- Netflow
Active intFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- Netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- Netflow
Collector intPort - The port for the netflow collector.
- Netflow
Enabled bool - Indicates whether to enable netflow on all ports.
- Netflow
Idle intFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- Netflow
Internal boolFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- Netflow
Observation intDomain Id - The observation Domain ID for the netflow collector.
- Netflow
Sampling intRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- Network
Resource boolControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- Network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- Nfs
Maximum intMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- Nfs
Reservation intMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- 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 a NIC failover, triggering cache updates.
- Port
Private intSecondary Vlan Id - The secondary VLAN ID for this port.
- Pvlan
Mappings List<Pulumi.VSphere. Inputs. Distributed Virtual Switch Pvlan Mapping> - A private VLAN (PVLAN) mapping.
- Standby
Uplinks List<string> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<string>
- The IDs of any tags to attach to this resource.
- Teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- Tx
Uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- Uplinks List<string>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- Vdp
Maximum intMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- Vdp
Reservation intMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- Version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- Virtualmachine
Maximum intMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- Virtualmachine
Reservation intMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- 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 List<Pulumi.VSphere. Inputs. Distributed Virtual Switch Vlan Range> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- Vmotion
Maximum intMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- Vmotion
Reservation intMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- Vsan
Maximum intMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- Vsan
Reservation intMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- string
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- Active
Uplinks []string - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Allow
Forged boolTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- Allow
Mac boolChanges - 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.
- Backupnfc
Maximum intMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- Backupnfc
Reservation intMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- Block
All boolPorts - Indicates whether to block all ports by default.
- Check
Beacon bool - Enable beacon probing on the ports this policy applies to.
- Config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- Contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- Contact
Name string - The name of the person who is responsible for the VDS.
- Custom
Attributes map[string]string Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- Datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- Description string
- A detailed description for the VDS.
- Directpath
Gen2Allowed bool - Allow VMDirectPath Gen2 on the ports this policy applies to.
- Egress
Shaping intAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- Egress
Shaping intBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- Egress
Shaping boolEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- Egress
Shaping intPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- Failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- Faulttolerance
Maximum intMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- Faulttolerance
Reservation intMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- Folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- Hbr
Maximum intMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- Hbr
Reservation intMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- Hosts
[]Distributed
Virtual Switch Host Args - A host member specification.
- Ignore
Other boolPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- Ingress
Shaping intAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- Ingress
Shaping intBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- Ingress
Shaping boolEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- Ingress
Shaping intPeak Bandwidth - The peak ingress 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.
- Iscsi
Maximum intMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- Iscsi
Reservation intMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- Lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - Lacp
Enabled bool - Whether or not to enable LACP on all uplink ports.
- Lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- Link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - Link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - Management
Maximum intMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- Management
Reservation intMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- 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 VDS.
- Multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - Name string
- The name of the VDS.
- Netflow
Active intFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- Netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- Netflow
Collector intPort - The port for the netflow collector.
- Netflow
Enabled bool - Indicates whether to enable netflow on all ports.
- Netflow
Idle intFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- Netflow
Internal boolFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- Netflow
Observation intDomain Id - The observation Domain ID for the netflow collector.
- Netflow
Sampling intRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- Network
Resource boolControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- Network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- Nfs
Maximum intMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- Nfs
Reservation intMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- 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 a NIC failover, triggering cache updates.
- Port
Private intSecondary Vlan Id - The secondary VLAN ID for this port.
- Pvlan
Mappings []DistributedVirtual Switch Pvlan Mapping Args - A private VLAN (PVLAN) mapping.
- Standby
Uplinks []string - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- []string
- The IDs of any tags to attach to this resource.
- Teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- Tx
Uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- Uplinks []string
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- Vdp
Maximum intMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- Vdp
Reservation intMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- Version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- Virtualmachine
Maximum intMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- Virtualmachine
Reservation intMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- 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 []DistributedVirtual Switch Vlan Range Args - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- Vmotion
Maximum intMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- Vmotion
Reservation intMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- Vsan
Maximum intMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- Vsan
Reservation intMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- string
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- active
Uplinks List<String> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged BooleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac BooleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous Boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum IntegerMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation IntegerMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- String
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All BooleanPorts - Indicates whether to block all ports by default.
- check
Beacon Boolean - Enable beacon probing on the ports this policy applies to.
- config
Version String - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- contact
Detail String - The detailed contact information for the person who is responsible for the VDS.
- contact
Name String - The name of the person who is responsible for the VDS.
- custom
Attributes Map<String,String> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- datacenter
Id String - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- description String
- A detailed description for the VDS.
- directpath
Gen2Allowed Boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping IntegerAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping IntegerBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping BooleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping IntegerPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback Boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum IntegerMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation IntegerMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- String
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder String
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum IntegerMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation IntegerMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- String
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
List<Distributed
Virtual Switch Host> - A host member specification.
- ignore
Other BooleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping IntegerAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping IntegerBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping BooleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping IntegerPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum IntegerMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation IntegerMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- String
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api StringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled Boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode String - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery StringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery StringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum IntegerMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation IntegerMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the management traffic class for a custom share level.
- String
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu Integer - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering StringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name String
- The name of the VDS.
- netflow
Active IntegerFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector StringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector IntegerPort - The port for the netflow collector.
- netflow
Enabled Boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle IntegerFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal BooleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation IntegerDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling IntegerRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource BooleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource StringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum IntegerMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation IntegerMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- String
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches Boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private IntegerSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings List<DistributedVirtual Switch Pvlan Mapping> - A private VLAN (PVLAN) mapping.
- standby
Uplinks List<String> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<String>
- The IDs of any tags to attach to this resource.
- teaming
Policy String - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink Boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks List<String>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum IntegerMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- String
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version String
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum IntegerMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation IntegerMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- String
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id Integer - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges List<DistributedVirtual Switch Vlan Range> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum IntegerMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- String
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum IntegerMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation IntegerMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- Integer
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- String
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- active
Uplinks string[] - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged booleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac booleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum numberMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation numberMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- string
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All booleanPorts - Indicates whether to block all ports by default.
- check
Beacon boolean - Enable beacon probing on the ports this policy applies to.
- config
Version string - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- contact
Detail string - The detailed contact information for the person who is responsible for the VDS.
- contact
Name string - The name of the person who is responsible for the VDS.
- custom
Attributes {[key: string]: string} Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- datacenter
Id string - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- description string
- A detailed description for the VDS.
- directpath
Gen2Allowed boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping numberAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping numberBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping booleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping numberPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum numberMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation numberMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- string
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder string
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum numberMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation numberMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- string
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
Distributed
Virtual Switch Host[] - A host member specification.
- ignore
Other booleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping numberAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping numberBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping booleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping numberPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum numberMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation numberMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- string
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api stringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode string - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery stringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery stringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum numberMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation numberMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the management traffic class for a custom share level.
- string
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu number - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering stringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name string
- The name of the VDS.
- netflow
Active numberFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector stringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector numberPort - The port for the netflow collector.
- netflow
Enabled boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle numberFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal booleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation numberDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling numberRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource booleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource stringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum numberMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation numberMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- string
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private numberSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings DistributedVirtual Switch Pvlan Mapping[] - A private VLAN (PVLAN) mapping.
- standby
Uplinks string[] - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- string[]
- The IDs of any tags to attach to this resource.
- teaming
Policy string - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks string[]
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum numberMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation numberMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- string
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version string
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum numberMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation numberMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- string
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id number - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges DistributedVirtual Switch Vlan Range[] - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum numberMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation numberMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- string
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum numberMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation numberMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- number
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- string
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- active_
uplinks Sequence[str] - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow_
forged_ booltransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow_
mac_ boolchanges - 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.
- backupnfc_
maximum_ intmbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc_
reservation_ intmbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- str
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block_
all_ boolports - Indicates whether to block all ports by default.
- check_
beacon bool - Enable beacon probing on the ports this policy applies to.
- config_
version str - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- contact_
detail str - The detailed contact information for the person who is responsible for the VDS.
- contact_
name str - The name of the person who is responsible for the VDS.
- custom_
attributes Mapping[str, str] Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- datacenter_
id str - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- description str
- A detailed description for the VDS.
- directpath_
gen2_ boolallowed - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress_
shaping_ intaverage_ bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress_
shaping_ intburst_ size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress_
shaping_ boolenabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress_
shaping_ intpeak_ bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback bool
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance_
maximum_ intmbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance_
reservation_ intmbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- str
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder str
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr_
maximum_ intmbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr_
reservation_ intmbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- str
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts
Sequence[Distributed
Virtual Switch Host Args] - A host member specification.
- ignore_
other_ boolpvlan_ mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress_
shaping_ intaverage_ bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress_
shaping_ intburst_ size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress_
shaping_ boolenabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress_
shaping_ intpeak_ bandwidth - The peak ingress 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.
- iscsi_
maximum_ intmbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi_
reservation_ intmbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- str
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp_
api_ strversion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp_
enabled bool - Whether or not to enable LACP on all uplink ports.
- lacp_
mode str - The uplink LACP mode to use. Can be one of active or passive.
- link_
discovery_ stroperation - Whether to
advertise
orlisten
for link discovery traffic. - link_
discovery_ strprotocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management_
maximum_ intmbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management_
reservation_ intmbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the management traffic class for a custom 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 VDS.
- multicast_
filtering_ strmode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name str
- The name of the VDS.
- netflow_
active_ intflow_ timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow_
collector_ strip_ address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow_
collector_ intport - The port for the netflow collector.
- netflow_
enabled bool - Indicates whether to enable netflow on all ports.
- netflow_
idle_ intflow_ timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow_
internal_ boolflows_ only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow_
observation_ intdomain_ id - The observation Domain ID for the netflow collector.
- netflow_
sampling_ intrate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network_
resource_ boolcontrol_ enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network_
resource_ strcontrol_ version - The network I/O control version to use. Can be one of version2 or version3.
- nfs_
maximum_ intmbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs_
reservation_ intmbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the nfs traffic class for a custom 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 a NIC failover, triggering cache updates.
- port_
private_ intsecondary_ vlan_ id - The secondary VLAN ID for this port.
- pvlan_
mappings Sequence[DistributedVirtual Switch Pvlan Mapping Args] - A private VLAN (PVLAN) mapping.
- standby_
uplinks Sequence[str] - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- Sequence[str]
- The IDs of any tags to attach to this resource.
- teaming_
policy str - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx_
uplink bool - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks Sequence[str]
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp_
maximum_ intmbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp_
reservation_ intmbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vdp traffic class for a custom 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 VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine_
maximum_ intmbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine_
reservation_ intmbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the virtualMachine traffic class for a custom 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[DistributedVirtual Switch Vlan Range Args] - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion_
maximum_ intmbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion_
reservation_ intmbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- str
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan_
maximum_ intmbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan_
reservation_ intmbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- int
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- str
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
- active
Uplinks List<String> - List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- allow
Forged BooleanTransmits - Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
- allow
Mac BooleanChanges - Controls whether or not the Media Access Control (MAC) address can be changed.
- allow
Promiscuous Boolean - Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
- backupnfc
Maximum NumberMbit - The maximum allowed usage for the backupNfc traffic class, in Mbits/sec.
- backupnfc
Reservation NumberMbit - The amount of guaranteed bandwidth for the backupNfc traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the backupNfc traffic class for a custom share level.
- String
- The allocation level for the backupNfc traffic class. Can be one of high, low, normal, or custom.
- block
All BooleanPorts - Indicates whether to block all ports by default.
- check
Beacon Boolean - Enable beacon probing on the ports this policy applies to.
- config
Version String - The current version of the VDS configuration, incremented by subsequent updates to the VDS.
- contact
Detail String - The detailed contact information for the person who is responsible for the VDS.
- contact
Name String - The name of the person who is responsible for the VDS.
- custom
Attributes Map<String> Map of custom attribute ids to attribute value strings to set for VDS.
NOTE: Custom attributes are unsupported on direct ESXi host connections and requires vCenter Server.
- datacenter
Id String - The ID of the datacenter where the VDS will be created. Forces a new resource if changed.
- description String
- A detailed description for the VDS.
- directpath
Gen2Allowed Boolean - Allow VMDirectPath Gen2 on the ports this policy applies to.
- egress
Shaping NumberAverage Bandwidth - The average egress bandwidth in bits per second if egress shaping is enabled on the port.
- egress
Shaping NumberBurst Size - The maximum egress burst size allowed in bytes if egress shaping is enabled on the port.
- egress
Shaping BooleanEnabled - True if the traffic shaper is enabled for egress traffic on the port.
- egress
Shaping NumberPeak Bandwidth - The peak egress bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
- failback Boolean
- If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
- faulttolerance
Maximum NumberMbit - The maximum allowed usage for the faultTolerance traffic class, in Mbits/sec.
- faulttolerance
Reservation NumberMbit - The amount of guaranteed bandwidth for the faultTolerance traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the faultTolerance traffic class for a custom share level.
- String
- The allocation level for the faultTolerance traffic class. Can be one of high, low, normal, or custom.
- folder String
- The folder in which to create the VDS. Forces a new resource if changed.
- hbr
Maximum NumberMbit - The maximum allowed usage for the hbr traffic class, in Mbits/sec.
- hbr
Reservation NumberMbit - The amount of guaranteed bandwidth for the hbr traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the hbr traffic class for a custom share level.
- String
- The allocation level for the hbr traffic class. Can be one of high, low, normal, or custom.
- hosts List<Property Map>
- A host member specification.
- ignore
Other BooleanPvlan Mappings - Whether to ignore existing PVLAN mappings not managed by this resource. Defaults to false.
- ingress
Shaping NumberAverage Bandwidth - The average ingress bandwidth in bits per second if ingress shaping is enabled on the port.
- ingress
Shaping NumberBurst Size - The maximum ingress burst size allowed in bytes if ingress shaping is enabled on the port.
- ingress
Shaping BooleanEnabled - True if the traffic shaper is enabled for ingress traffic on the port.
- ingress
Shaping NumberPeak Bandwidth - The peak ingress 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.
- iscsi
Maximum NumberMbit - The maximum allowed usage for the iSCSI traffic class, in Mbits/sec.
- iscsi
Reservation NumberMbit - The amount of guaranteed bandwidth for the iSCSI traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the iSCSI traffic class for a custom share level.
- String
- The allocation level for the iSCSI traffic class. Can be one of high, low, normal, or custom.
- lacp
Api StringVersion - The Link Aggregation Control Protocol group
version to use with the VDS. Possible values are
singleLag
andmultipleLag
. - lacp
Enabled Boolean - Whether or not to enable LACP on all uplink ports.
- lacp
Mode String - The uplink LACP mode to use. Can be one of active or passive.
- link
Discovery StringOperation - Whether to
advertise
orlisten
for link discovery traffic. - link
Discovery StringProtocol - The discovery protocol type. Valid
types are
cdp
andlldp
. - management
Maximum NumberMbit - The maximum allowed usage for the management traffic class, in Mbits/sec.
- management
Reservation NumberMbit - The amount of guaranteed bandwidth for the management traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the management traffic class for a custom share level.
- String
- The allocation level for the management traffic class. Can be one of high, low, normal, or custom.
- max
Mtu Number - The maximum transmission unit (MTU) for the VDS.
- multicast
Filtering StringMode - The multicast filtering mode to use
with the VDS. Can be one of
legacyFiltering
orsnooping
. - name String
- The name of the VDS.
- netflow
Active NumberFlow Timeout - The number of seconds after which active flows are forced to be exported to the collector.
- netflow
Collector StringIp Address - IP address for the netflow collector, using IPv4 or IPv6.
- netflow
Collector NumberPort - The port for the netflow collector.
- netflow
Enabled Boolean - Indicates whether to enable netflow on all ports.
- netflow
Idle NumberFlow Timeout - The number of seconds after which idle flows are forced to be exported to the collector.
- netflow
Internal BooleanFlows Only - Whether to limit analysis to traffic that has both source and destination served by the same host.
- netflow
Observation NumberDomain Id - The observation Domain ID for the netflow collector.
- netflow
Sampling NumberRate - The ratio of total number of packets to the number of packets analyzed. Set to 0 to disable sampling, meaning that all packets are analyzed.
- network
Resource BooleanControl Enabled - Whether or not to enable network resource control, enabling advanced traffic shaping and resource control features.
- network
Resource StringControl Version - The network I/O control version to use. Can be one of version2 or version3.
- nfs
Maximum NumberMbit - The maximum allowed usage for the nfs traffic class, in Mbits/sec.
- nfs
Reservation NumberMbit - The amount of guaranteed bandwidth for the nfs traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the nfs traffic class for a custom share level.
- String
- The allocation level for the nfs traffic class. Can be one of high, low, normal, or custom.
- notify
Switches Boolean - If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
- port
Private NumberSecondary Vlan Id - The secondary VLAN ID for this port.
- pvlan
Mappings List<Property Map> - A private VLAN (PVLAN) mapping.
- standby
Uplinks List<String> - List of standby uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
- List<String>
- The IDs of any tags to attach to this resource.
- teaming
Policy String - The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, or loadbalance_loadbased.
- tx
Uplink Boolean - If true, a copy of packets sent to the switch will always be forwarded to an uplink in addition to the regular packet forwarded done by the switch.
- uplinks List<String>
- A list of uplink ports. The contents of this list control both the uplink count and names of the uplinks on the DVS across hosts.
- vdp
Maximum NumberMbit - The maximum allowed usage for the vdp traffic class, in Mbits/sec.
- vdp
Reservation NumberMbit - The amount of guaranteed bandwidth for the vdp traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vdp traffic class for a custom share level.
- String
- The allocation level for the vdp traffic class. Can be one of high, low, normal, or custom.
- version String
- The version of the VDS. BY default, a VDS is created at the latest version supported by the vSphere version if not specified. A VDS can be upgraded to a newer version, but can not be downgraded.
- virtualmachine
Maximum NumberMbit - The maximum allowed usage for the virtualMachine traffic class, in Mbits/sec.
- virtualmachine
Reservation NumberMbit - The amount of guaranteed bandwidth for the virtualMachine traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the virtualMachine traffic class for a custom share level.
- String
- The allocation level for the virtualMachine traffic class. Can be one of high, low, normal, or custom.
- vlan
Id Number - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vlan
Ranges List<Property Map> - The VLAN ID for single VLAN mode. 0 denotes no VLAN.
- vmotion
Maximum NumberMbit - The maximum allowed usage for the vmotion traffic class, in Mbits/sec.
- vmotion
Reservation NumberMbit - The amount of guaranteed bandwidth for the vmotion traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vmotion traffic class for a custom share level.
- String
- The allocation level for the vmotion traffic class. Can be one of high, low, normal, or custom.
- vsan
Maximum NumberMbit - The maximum allowed usage for the vsan traffic class, in Mbits/sec.
- vsan
Reservation NumberMbit - The amount of guaranteed bandwidth for the vsan traffic class, in Mbits/sec.
- Number
- The amount of shares to allocate to the vsan traffic class for a custom share level.
- String
- The allocation level for the vsan traffic class. Can be one of high, low, normal, or custom.
Supporting Types
DistributedVirtualSwitchHost, DistributedVirtualSwitchHostArgs
- Host
System stringId - The managed object ID of the host this specification applies to.
- Devices List<string>
- Name of the physical NIC to be added to the proxy switch.
- Host
System stringId - The managed object ID of the host this specification applies to.
- Devices []string
- Name of the physical NIC to be added to the proxy switch.
- host
System StringId - The managed object ID of the host this specification applies to.
- devices List<String>
- Name of the physical NIC to be added to the proxy switch.
- host
System stringId - The managed object ID of the host this specification applies to.
- devices string[]
- Name of the physical NIC to be added to the proxy switch.
- host_
system_ strid - The managed object ID of the host this specification applies to.
- devices Sequence[str]
- Name of the physical NIC to be added to the proxy switch.
- host
System StringId - The managed object ID of the host this specification applies to.
- devices List<String>
- Name of the physical NIC to be added to the proxy switch.
DistributedVirtualSwitchPvlanMapping, DistributedVirtualSwitchPvlanMappingArgs
- Primary
Vlan intId - The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- Pvlan
Type string - The private VLAN type. Valid values are promiscuous, community and isolated.
- Secondary
Vlan intId - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- Primary
Vlan intId - The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- Pvlan
Type string - The private VLAN type. Valid values are promiscuous, community and isolated.
- Secondary
Vlan intId - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- primary
Vlan IntegerId - The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- pvlan
Type String - The private VLAN type. Valid values are promiscuous, community and isolated.
- secondary
Vlan IntegerId - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- primary
Vlan numberId - The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- pvlan
Type string - The private VLAN type. Valid values are promiscuous, community and isolated.
- secondary
Vlan numberId - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- primary_
vlan_ intid - 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_ intid - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- primary
Vlan NumberId - The primary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
- pvlan
Type String - The private VLAN type. Valid values are promiscuous, community and isolated.
- secondary
Vlan NumberId - The secondary VLAN ID. The VLAN IDs of 0 and 4095 are reserved and cannot be used in this property.
DistributedVirtualSwitchVlanRange, DistributedVirtualSwitchVlanRangeArgs
Import
An existing VDS can be imported into this resource via the path
to the VDS, via the following command:
$ pulumi import vsphere:index/distributedVirtualSwitch:DistributedVirtualSwitch vds /dc-01/network/vds-01
The above would import the VDS named vds-01
that is located in the dc-01
datacenter.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- vSphere pulumi/pulumi-vsphere
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vsphere
Terraform Provider.