Class HostVirtualSwitch

Inheritance

System.Object

Resource

CustomResource

HostVirtualSwitch

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

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 class HostVirtualSwitch : CustomResource

Constructors

View Source

HostVirtualSwitch(String, HostVirtualSwitchArgs, CustomResourceOptions)

Create a HostVirtualSwitch resource with the given unique name, arguments, and options.

Declaration

public HostVirtualSwitch(string name, HostVirtualSwitchArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
HostVirtualSwitchArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

ActiveNics

The list of active network adapters used for load balancing.

Declaration

public Output<ImmutableArray<string>> ActiveNics { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

AllowForgedTransmits

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

Declaration

public Output<bool?> AllowForgedTransmits { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

AllowMacChanges

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

Declaration

public Output<bool?> AllowMacChanges { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

AllowPromiscuous

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

Declaration

public Output<bool?> AllowPromiscuous { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

BeaconInterval

The interval, in seconds, that a NIC beacon packet is sent out. This can be used with check_beacon to offer link failure capability beyond link status only. Default: 1.

Declaration

public Output<int?> BeaconInterval { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

CheckBeacon

Enable beacon probing - this requires that the beacon_interval option has been set in the bridge options. If this is set to false, only link status is used to check for failed NICs. Default: false.

Declaration

public Output<bool?> CheckBeacon { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

Failback

If set to true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up. Default: true.

Declaration

public Output<bool?> Failback { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

HostSystemId

The managed object ID of the host to set the virtual switch up on. Forces a new resource if changed.

Declaration

public Output<string> HostSystemId { get; }

Property Value

Type	Description
Output<System.String>

View Source

LinkDiscoveryOperation

Whether to advertise or listen for link discovery traffic. Default: listen.

Declaration

public Output<string> LinkDiscoveryOperation { get; }

Property Value

Type	Description
Output<System.String>

View Source

LinkDiscoveryProtocol

The discovery protocol type. Valid types are cpd and lldp. Default: cdp.

Declaration

public Output<string> LinkDiscoveryProtocol { get; }

Property Value

Type	Description
Output<System.String>

View Source

Mtu

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

Declaration

public Output<int?> Mtu { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

Name

The name of the virtual switch. Forces a new resource if changed.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NetworkAdapters

The network interfaces to bind to the bridge.

Declaration

public Output<ImmutableArray<string>> NetworkAdapters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

NotifySwitches

If set to true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates. Default: true.

Declaration

public Output<bool?> NotifySwitches { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

NumberOfPorts

The number of ports to create with this virtual switch. Default: 128.

Declaration

public Output<int?> NumberOfPorts { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

ShapingAverageBandwidth

The average bandwidth in bits per second if traffic shaping is enabled. Default: 0

Declaration

public Output<int?> ShapingAverageBandwidth { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

ShapingBurstSize

The maximum burst size allowed in bytes if shaping is enabled. Default: 0

Declaration

public Output<int?> ShapingBurstSize { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

ShapingEnabled

Set to true to enable the traffic shaper for ports managed by this virtual switch. Default: false.

Declaration

public Output<bool?> ShapingEnabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

ShapingPeakBandwidth

The peak bandwidth during bursts in bits per second if traffic shaping is enabled. Default: 0

Declaration

public Output<int?> ShapingPeakBandwidth { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

StandbyNics

The list of standby network adapters used for failover.

Declaration

public Output<ImmutableArray<string>> StandbyNics { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

TeamingPolicy

The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit. Default: loadbalance_srcid.

Declaration

public Output<string> TeamingPolicy { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, HostVirtualSwitchState, CustomResourceOptions)

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

Declaration

public static HostVirtualSwitch Get(string name, Input<string> id, HostVirtualSwitchState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
HostVirtualSwitchState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
HostVirtualSwitch