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

HostVirtualSwitch

Create a HostVirtualSwitch Resource

new HostVirtualSwitch(name: string, args: HostVirtualSwitchArgs, opts?: CustomResourceOptions);
def HostVirtualSwitch(resource_name: str, opts: Optional[ResourceOptions] = None, active_nics: Optional[Sequence[str]] = None, allow_forged_transmits: Optional[bool] = None, allow_mac_changes: Optional[bool] = None, allow_promiscuous: Optional[bool] = None, beacon_interval: Optional[int] = None, check_beacon: Optional[bool] = None, failback: Optional[bool] = None, host_system_id: Optional[str] = None, link_discovery_operation: Optional[str] = None, link_discovery_protocol: Optional[str] = None, mtu: Optional[int] = None, name: Optional[str] = None, network_adapters: Optional[Sequence[str]] = None, notify_switches: Optional[bool] = None, number_of_ports: Optional[int] = None, shaping_average_bandwidth: Optional[int] = None, shaping_burst_size: Optional[int] = None, shaping_enabled: Optional[bool] = None, shaping_peak_bandwidth: Optional[int] = None, standby_nics: Optional[Sequence[str]] = None, teaming_policy: Optional[str] = None)
func NewHostVirtualSwitch(ctx *Context, name string, args HostVirtualSwitchArgs, opts ...ResourceOption) (*HostVirtualSwitch, error)
public HostVirtualSwitch(string name, HostVirtualSwitchArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args HostVirtualSwitchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args HostVirtualSwitchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HostVirtualSwitchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

HostVirtualSwitch Resource Properties

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

Inputs

The HostVirtualSwitch resource accepts the following input properties:

ActiveNics List<string>

The list of active network adapters used for load balancing.

HostSystemId string

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

NetworkAdapters List<string>

The network interfaces to bind to the bridge.

StandbyNics List<string>

The list of standby network adapters used for failover.

AllowForgedTransmits bool

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

AllowMacChanges bool

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

AllowPromiscuous bool

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

BeaconInterval int

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.

CheckBeacon bool

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.

Failback bool

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

LinkDiscoveryOperation string

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

LinkDiscoveryProtocol string

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

Mtu int

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

Name string

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

NotifySwitches bool

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

NumberOfPorts int

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

ShapingAverageBandwidth int

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

ShapingBurstSize int

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

ShapingEnabled bool

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

ShapingPeakBandwidth int

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

TeamingPolicy string

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

ActiveNics []string

The list of active network adapters used for load balancing.

HostSystemId string

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

NetworkAdapters []string

The network interfaces to bind to the bridge.

StandbyNics []string

The list of standby network adapters used for failover.

AllowForgedTransmits bool

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

AllowMacChanges bool

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

AllowPromiscuous bool

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

BeaconInterval int

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.

CheckBeacon bool

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.

Failback bool

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

LinkDiscoveryOperation string

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

LinkDiscoveryProtocol string

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

Mtu int

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

Name string

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

NotifySwitches bool

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

NumberOfPorts int

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

ShapingAverageBandwidth int

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

ShapingBurstSize int

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

ShapingEnabled bool

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

ShapingPeakBandwidth int

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

TeamingPolicy string

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

activeNics string[]

The list of active network adapters used for load balancing.

hostSystemId string

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

networkAdapters string[]

The network interfaces to bind to the bridge.

standbyNics string[]

The list of standby network adapters used for failover.

allowForgedTransmits boolean

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

allowMacChanges boolean

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

allowPromiscuous boolean

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

beaconInterval number

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.

checkBeacon boolean

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.

failback boolean

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

linkDiscoveryOperation string

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

linkDiscoveryProtocol string

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

mtu number

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

name string

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

notifySwitches boolean

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

numberOfPorts number

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

shapingAverageBandwidth number

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

shapingBurstSize number

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

shapingEnabled boolean

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

shapingPeakBandwidth number

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

teamingPolicy string

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

active_nics Sequence[str]

The list of active network adapters used for load balancing.

host_system_id str

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

network_adapters Sequence[str]

The network interfaces to bind to the bridge.

standby_nics Sequence[str]

The list of standby network adapters used for failover.

allow_forged_transmits bool

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

allow_mac_changes bool

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

allow_promiscuous bool

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

beacon_interval int

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.

check_beacon bool

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.

failback bool

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

link_discovery_operation str

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

link_discovery_protocol str

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

mtu int

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

name str

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

notify_switches bool

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

number_of_ports int

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

shaping_average_bandwidth int

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

shaping_burst_size int

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

shaping_enabled bool

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

shaping_peak_bandwidth int

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

teaming_policy str

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

Outputs

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

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

Look up an Existing HostVirtualSwitch Resource

Get an existing HostVirtualSwitch 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?: HostVirtualSwitchState, opts?: CustomResourceOptions): HostVirtualSwitch
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, active_nics: Optional[Sequence[str]] = None, allow_forged_transmits: Optional[bool] = None, allow_mac_changes: Optional[bool] = None, allow_promiscuous: Optional[bool] = None, beacon_interval: Optional[int] = None, check_beacon: Optional[bool] = None, failback: Optional[bool] = None, host_system_id: Optional[str] = None, link_discovery_operation: Optional[str] = None, link_discovery_protocol: Optional[str] = None, mtu: Optional[int] = None, name: Optional[str] = None, network_adapters: Optional[Sequence[str]] = None, notify_switches: Optional[bool] = None, number_of_ports: Optional[int] = None, shaping_average_bandwidth: Optional[int] = None, shaping_burst_size: Optional[int] = None, shaping_enabled: Optional[bool] = None, shaping_peak_bandwidth: Optional[int] = None, standby_nics: Optional[Sequence[str]] = None, teaming_policy: Optional[str] = None) -> HostVirtualSwitch
func GetHostVirtualSwitch(ctx *Context, name string, id IDInput, state *HostVirtualSwitchState, opts ...ResourceOption) (*HostVirtualSwitch, error)
public static HostVirtualSwitch Get(string name, Input<string> id, HostVirtualSwitchState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ActiveNics List<string>

The list of active network adapters used for load balancing.

AllowForgedTransmits bool

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

AllowMacChanges bool

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

AllowPromiscuous bool

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

BeaconInterval int

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.

CheckBeacon bool

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.

Failback bool

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

HostSystemId string

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

LinkDiscoveryOperation string

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

LinkDiscoveryProtocol string

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

Mtu int

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

Name string

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

NetworkAdapters List<string>

The network interfaces to bind to the bridge.

NotifySwitches bool

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

NumberOfPorts int

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

ShapingAverageBandwidth int

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

ShapingBurstSize int

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

ShapingEnabled bool

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

ShapingPeakBandwidth int

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

StandbyNics List<string>

The list of standby network adapters used for failover.

TeamingPolicy string

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

ActiveNics []string

The list of active network adapters used for load balancing.

AllowForgedTransmits bool

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

AllowMacChanges bool

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

AllowPromiscuous bool

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

BeaconInterval int

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.

CheckBeacon bool

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.

Failback bool

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

HostSystemId string

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

LinkDiscoveryOperation string

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

LinkDiscoveryProtocol string

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

Mtu int

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

Name string

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

NetworkAdapters []string

The network interfaces to bind to the bridge.

NotifySwitches bool

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

NumberOfPorts int

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

ShapingAverageBandwidth int

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

ShapingBurstSize int

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

ShapingEnabled bool

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

ShapingPeakBandwidth int

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

StandbyNics []string

The list of standby network adapters used for failover.

TeamingPolicy string

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

activeNics string[]

The list of active network adapters used for load balancing.

allowForgedTransmits boolean

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

allowMacChanges boolean

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

allowPromiscuous boolean

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

beaconInterval number

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.

checkBeacon boolean

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.

failback boolean

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

hostSystemId string

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

linkDiscoveryOperation string

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

linkDiscoveryProtocol string

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

mtu number

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

name string

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

networkAdapters string[]

The network interfaces to bind to the bridge.

notifySwitches boolean

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

numberOfPorts number

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

shapingAverageBandwidth number

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

shapingBurstSize number

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

shapingEnabled boolean

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

shapingPeakBandwidth number

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

standbyNics string[]

The list of standby network adapters used for failover.

teamingPolicy string

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

active_nics Sequence[str]

The list of active network adapters used for load balancing.

allow_forged_transmits bool

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

allow_mac_changes bool

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

allow_promiscuous bool

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

beacon_interval int

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.

check_beacon bool

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.

failback bool

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

host_system_id str

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

link_discovery_operation str

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

link_discovery_protocol str

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

mtu int

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

name str

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

network_adapters Sequence[str]

The network interfaces to bind to the bridge.

notify_switches bool

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

number_of_ports int

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

shaping_average_bandwidth int

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

shaping_burst_size int

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

shaping_enabled bool

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

shaping_peak_bandwidth int

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

standby_nics Sequence[str]

The list of standby network adapters used for failover.

teaming_policy str

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

Package Details

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