Class DistributedVirtualSwitchArgs

Inheritance

System.Object

InputArgs

ResourceArgs

DistributedVirtualSwitchArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.VSphere

Assembly: Pulumi.VSphere.dll

Syntax

public sealed class DistributedVirtualSwitchArgs : ResourceArgs

Constructors

DistributedVirtualSwitchArgs()

Declaration

public DistributedVirtualSwitchArgs()

Properties

ActiveUplinks

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

Declaration

public InputList<string> ActiveUplinks { get; set; }

Property Value

Type	Description
InputList<System.String>

AllowForgedTransmits

Controls whether or not a virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.

Declaration

public Input<bool> AllowForgedTransmits { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AllowMacChanges

Controls whether or not the Media Access Control (MAC) address can be changed.

Declaration

public Input<bool> AllowMacChanges { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AllowPromiscuous

Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.

Declaration

public Input<bool> AllowPromiscuous { get; set; }

Property Value

Type	Description
Input<System.Boolean>

BlockAllPorts

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

Declaration

public Input<bool> BlockAllPorts { get; set; }

Property Value

Type	Description
Input<System.Boolean>

CheckBeacon

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

Declaration

public Input<bool> CheckBeacon { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ContactDetail

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

Declaration

public Input<string> ContactDetail { get; set; }

Property Value

Type	Description
Input<System.String>

ContactName

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

Declaration

public Input<string> ContactName { get; set; }

Property Value

Type	Description
Input<System.String>

CustomAttributes

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

Declaration

public InputMap<string> CustomAttributes { get; set; }

Property Value

Type	Description
InputMap<System.String>

DatacenterId

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

Declaration

public Input<string> DatacenterId { get; set; }

Property Value

Type	Description
Input<System.String>

Description

A detailed description for the DVS.

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

DirectpathGen2Allowed

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

Declaration

public Input<bool> DirectpathGen2Allowed { get; set; }

Property Value

Type	Description
Input<System.Boolean>

EgressShapingAverageBandwidth

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

Declaration

public Input<int> EgressShapingAverageBandwidth { get; set; }

Property Value

Type	Description
Input<System.Int32>

EgressShapingBurstSize

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

Declaration

public Input<int> EgressShapingBurstSize { get; set; }

Property Value

Type	Description
Input<System.Int32>

EgressShapingEnabled

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

Declaration

public Input<bool> EgressShapingEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

EgressShapingPeakBandwidth

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

Declaration

public Input<int> EgressShapingPeakBandwidth { get; set; }

Property Value

Type	Description
Input<System.Int32>

Failback

If true, the teaming policy will re-activate failed uplinks higher in precedence when they come back up.

Declaration

public Input<bool> Failback { get; set; }

Property Value

Type	Description
Input<System.Boolean>

FaulttoleranceMaximumMbit

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

Declaration

public Input<int> FaulttoleranceMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

FaulttoleranceReservationMbit

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

Declaration

public Input<int> FaulttoleranceReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

FaulttoleranceShareCount

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

Declaration

public Input<int> FaulttoleranceShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

FaulttoleranceShareLevel

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

Declaration

public Input<string> FaulttoleranceShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

Folder

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

Declaration

public Input<string> Folder { get; set; }

Property Value

Type	Description
Input<System.String>

HbrMaximumMbit

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

Declaration

public Input<int> HbrMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

HbrReservationMbit

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

Declaration

public Input<int> HbrReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

HbrShareCount

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

Declaration

public Input<int> HbrShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

HbrShareLevel

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

Declaration

public Input<string> HbrShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

Hosts

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

Declaration

public InputList<DistributedVirtualSwitchHostArgs> Hosts { get; set; }

Property Value

Type	Description
InputList<DistributedVirtualSwitchHostArgs>

IngressShapingAverageBandwidth

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

Declaration

public Input<int> IngressShapingAverageBandwidth { get; set; }

Property Value

Type	Description
Input<System.Int32>

IngressShapingBurstSize

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

Declaration

public Input<int> IngressShapingBurstSize { get; set; }

Property Value

Type	Description
Input<System.Int32>

IngressShapingEnabled

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

Declaration

public Input<bool> IngressShapingEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

IngressShapingPeakBandwidth

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

Declaration

public Input<int> IngressShapingPeakBandwidth { get; set; }

Property Value

Type	Description
Input<System.Int32>

Ipv4Address

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

Declaration

public Input<string> Ipv4Address { get; set; }

Property Value

Type	Description
Input<System.String>

IscsiMaximumMbit

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

Declaration

public Input<int> IscsiMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

IscsiReservationMbit

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

Declaration

public Input<int> IscsiReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

IscsiShareCount

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

Declaration

public Input<int> IscsiShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

IscsiShareLevel

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

Declaration

public Input<string> IscsiShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

LacpApiVersion

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

Declaration

public Input<string> LacpApiVersion { get; set; }

Property Value

Type	Description
Input<System.String>

LacpEnabled

Enables LACP for the ports that this policy applies to.

Declaration

public Input<bool> LacpEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

LacpMode

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

Declaration

public Input<string> LacpMode { get; set; }

Property Value

Type	Description
Input<System.String>

LinkDiscoveryOperation

Whether to advertise or listen for link discovery traffic.

Declaration

public Input<string> LinkDiscoveryOperation { get; set; }

Property Value

Type	Description
Input<System.String>

LinkDiscoveryProtocol

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

Declaration

public Input<string> LinkDiscoveryProtocol { get; set; }

Property Value

Type	Description
Input<System.String>

ManagementMaximumMbit

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

Declaration

public Input<int> ManagementMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

ManagementReservationMbit

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

Declaration

public Input<int> ManagementReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

ManagementShareCount

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

Declaration

public Input<int> ManagementShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

ManagementShareLevel

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

Declaration

public Input<string> ManagementShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

MaxMtu

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

Declaration

public Input<int> MaxMtu { get; set; }

Property Value

Type	Description
Input<System.Int32>

MulticastFilteringMode

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

Declaration

public Input<string> MulticastFilteringMode { get; set; }

Property Value

Type	Description
Input<System.String>

Name

The name of the distributed virtual switch.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

NetflowActiveFlowTimeout

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

Declaration

public Input<int> NetflowActiveFlowTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

NetflowCollectorIpAddress

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

Declaration

public Input<string> NetflowCollectorIpAddress { get; set; }

Property Value

Type	Description
Input<System.String>

NetflowCollectorPort

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

Declaration

public Input<int> NetflowCollectorPort { get; set; }

Property Value

Type	Description
Input<System.Int32>

NetflowEnabled

Enables Netflow on all ports that this policy applies to.

Declaration

public Input<bool> NetflowEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

NetflowIdleFlowTimeout

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

Declaration

public Input<int> NetflowIdleFlowTimeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

NetflowInternalFlowsOnly

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

Declaration

public Input<bool> NetflowInternalFlowsOnly { get; set; }

Property Value

Type	Description
Input<System.Boolean>

NetflowObservationDomainId

The observation domain ID for the Netflow collector.

Declaration

public Input<int> NetflowObservationDomainId { get; set; }

Property Value

Type	Description
Input<System.Int32>

NetflowSamplingRate

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

Declaration

public Input<int> NetflowSamplingRate { get; set; }

Property Value

Type	Description
Input<System.Int32>

NetworkResourceControlEnabled

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

Declaration

public Input<bool> NetworkResourceControlEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

NetworkResourceControlVersion

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

Declaration

public Input<string> NetworkResourceControlVersion { get; set; }

Property Value

Type	Description
Input<System.String>

NfsMaximumMbit

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

Declaration

public Input<int> NfsMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

NfsReservationMbit

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

Declaration

public Input<int> NfsReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

NfsShareCount

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

Declaration

public Input<int> NfsShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

NfsShareLevel

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

Declaration

public Input<string> NfsShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

NotifySwitches

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

Declaration

public Input<bool> NotifySwitches { get; set; }

Property Value

Type	Description
Input<System.Boolean>

PortPrivateSecondaryVlanId

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

Declaration

public Input<int> PortPrivateSecondaryVlanId { get; set; }

Property Value

Type	Description
Input<System.Int32>

StandbyUplinks

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

Declaration

public InputList<string> StandbyUplinks { get; set; }

Property Value

Type	Description
InputList<System.String>

Tags

The IDs of any tags to attach to this resource.

Declaration

public InputList<string> Tags { get; set; }

Property Value

Type	Description
InputList<System.String>

TeamingPolicy

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

Declaration

public Input<string> TeamingPolicy { get; set; }

Property Value

Type	Description
Input<System.String>

TxUplink

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

Declaration

public Input<bool> TxUplink { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Uplinks

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

Declaration

public InputList<string> Uplinks { get; set; }

Property Value

Type	Description
InputList<System.String>

VdpMaximumMbit

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

Declaration

public Input<int> VdpMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VdpReservationMbit

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

Declaration

public Input<int> VdpReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VdpShareCount

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

Declaration

public Input<int> VdpShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

VdpShareLevel

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

Declaration

public Input<string> VdpShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

Version

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

Declaration

public Input<string> Version { get; set; }

Property Value

Type	Description
Input<System.String>

VirtualmachineMaximumMbit

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

Declaration

public Input<int> VirtualmachineMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VirtualmachineReservationMbit

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

Declaration

public Input<int> VirtualmachineReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VirtualmachineShareCount

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

Declaration

public Input<int> VirtualmachineShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

VirtualmachineShareLevel

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

Declaration

public Input<string> VirtualmachineShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

VlanId

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

Declaration

public Input<int> VlanId { get; set; }

Property Value

Type	Description
Input<System.Int32>

VlanRanges

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

Declaration

public InputList<DistributedVirtualSwitchVlanRangeArgs> VlanRanges { get; set; }

Property Value

Type	Description
InputList<DistributedVirtualSwitchVlanRangeArgs>

VmotionMaximumMbit

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

Declaration

public Input<int> VmotionMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VmotionReservationMbit

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

Declaration

public Input<int> VmotionReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VmotionShareCount

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

Declaration

public Input<int> VmotionShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

VmotionShareLevel

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

Declaration

public Input<string> VmotionShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>

VsanMaximumMbit

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

Declaration

public Input<int> VsanMaximumMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VsanReservationMbit

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

Declaration

public Input<int> VsanReservationMbit { get; set; }

Property Value

Type	Description
Input<System.Int32>

VsanShareCount

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

Declaration

public Input<int> VsanShareCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

VsanShareLevel

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

Declaration

public Input<string> VsanShareLevel { get; set; }

Property Value

Type	Description
Input<System.String>