pulumi-vsphere 4.10.0a1710245029__py3-none-any.whl → 4.13.0a1736849827__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pulumi_vsphere/__init__.py +28 -0
- pulumi_vsphere/_inputs.py +1816 -277
- pulumi_vsphere/_utilities.py +41 -5
- pulumi_vsphere/compute_cluster.py +937 -1488
- pulumi_vsphere/compute_cluster_host_group.py +67 -2
- pulumi_vsphere/compute_cluster_vm_affinity_rule.py +69 -34
- pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py +41 -2
- pulumi_vsphere/compute_cluster_vm_dependency_rule.py +205 -2
- pulumi_vsphere/compute_cluster_vm_group.py +198 -2
- pulumi_vsphere/compute_cluster_vm_host_rule.py +73 -2
- pulumi_vsphere/config/__init__.pyi +5 -0
- pulumi_vsphere/config/vars.py +5 -0
- pulumi_vsphere/content_library.py +113 -12
- pulumi_vsphere/content_library_item.py +143 -2
- pulumi_vsphere/custom_attribute.py +77 -2
- pulumi_vsphere/datacenter.py +48 -40
- pulumi_vsphere/datastore_cluster.py +217 -366
- pulumi_vsphere/datastore_cluster_vm_anti_affinity_rule.py +159 -2
- pulumi_vsphere/distributed_port_group.py +416 -189
- pulumi_vsphere/distributed_virtual_switch.py +571 -830
- pulumi_vsphere/dpm_host_override.py +63 -2
- pulumi_vsphere/drs_vm_override.py +67 -2
- pulumi_vsphere/entity_permissions.py +64 -38
- pulumi_vsphere/file.py +21 -24
- pulumi_vsphere/folder.py +148 -30
- pulumi_vsphere/get_compute_cluster.py +16 -9
- pulumi_vsphere/get_compute_cluster_host_group.py +36 -25
- pulumi_vsphere/get_content_library.py +23 -15
- pulumi_vsphere/get_content_library_item.py +29 -13
- pulumi_vsphere/get_custom_attribute.py +14 -9
- pulumi_vsphere/get_datacenter.py +30 -12
- pulumi_vsphere/get_datastore.py +29 -21
- pulumi_vsphere/get_datastore_cluster.py +31 -10
- pulumi_vsphere/get_datastore_stats.py +63 -57
- pulumi_vsphere/get_distributed_virtual_switch.py +18 -9
- pulumi_vsphere/get_dynamic.py +35 -25
- pulumi_vsphere/get_folder.py +23 -11
- pulumi_vsphere/get_guest_os_customization.py +26 -52
- pulumi_vsphere/get_host.py +16 -9
- pulumi_vsphere/get_host_base_images.py +104 -0
- pulumi_vsphere/get_host_pci_device.py +28 -19
- pulumi_vsphere/get_host_thumbprint.py +41 -25
- pulumi_vsphere/get_host_vgpu_profile.py +20 -15
- pulumi_vsphere/get_license.py +20 -10
- pulumi_vsphere/get_network.py +80 -24
- pulumi_vsphere/get_ovf_vm_template.py +56 -5
- pulumi_vsphere/get_policy.py +13 -9
- pulumi_vsphere/get_resource_pool.py +29 -23
- pulumi_vsphere/get_role.py +23 -13
- pulumi_vsphere/get_tag.py +16 -9
- pulumi_vsphere/get_tag_category.py +16 -9
- pulumi_vsphere/get_vapp_container.py +15 -9
- pulumi_vsphere/get_virtual_machine.py +205 -48
- pulumi_vsphere/get_vmfs_disks.py +18 -9
- pulumi_vsphere/guest_os_customization.py +60 -5
- pulumi_vsphere/ha_vm_override.py +352 -380
- pulumi_vsphere/host.py +244 -64
- pulumi_vsphere/host_port_group.py +27 -24
- pulumi_vsphere/host_virtual_switch.py +209 -289
- pulumi_vsphere/license.py +5 -32
- pulumi_vsphere/nas_datastore.py +74 -9
- pulumi_vsphere/offline_software_depot.py +185 -0
- pulumi_vsphere/outputs.py +717 -270
- pulumi_vsphere/provider.py +7 -6
- pulumi_vsphere/pulumi-plugin.json +2 -1
- pulumi_vsphere/resource_pool.py +168 -411
- pulumi_vsphere/role.py +33 -2
- pulumi_vsphere/storage_drs_vm_override.py +133 -2
- pulumi_vsphere/supervisor.py +967 -0
- pulumi_vsphere/tag.py +159 -2
- pulumi_vsphere/tag_category.py +83 -2
- pulumi_vsphere/vapp_container.py +163 -2
- pulumi_vsphere/vapp_entity.py +147 -2
- pulumi_vsphere/virtual_disk.py +123 -36
- pulumi_vsphere/virtual_machine.py +698 -829
- pulumi_vsphere/virtual_machine_class.py +447 -0
- pulumi_vsphere/virtual_machine_snapshot.py +13 -12
- pulumi_vsphere/vm_storage_policy.py +120 -127
- pulumi_vsphere/vmfs_datastore.py +271 -2
- pulumi_vsphere/vnic.py +104 -105
- {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.13.0a1736849827.dist-info}/METADATA +7 -6
- pulumi_vsphere-4.13.0a1736849827.dist-info/RECORD +86 -0
- {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.13.0a1736849827.dist-info}/WHEEL +1 -1
- pulumi_vsphere-4.10.0a1710245029.dist-info/RECORD +0 -82
- {pulumi_vsphere-4.10.0a1710245029.dist-info → pulumi_vsphere-4.13.0a1736849827.dist-info}/top_level.txt +0 -0
|
@@ -4,9 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
import copy
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
|
|
12
17
|
__all__ = ['HostVirtualSwitchArgs', 'HostVirtualSwitch']
|
|
@@ -37,58 +42,37 @@ class HostVirtualSwitchArgs:
|
|
|
37
42
|
teaming_policy: Optional[pulumi.Input[str]] = None):
|
|
38
43
|
"""
|
|
39
44
|
The set of arguments for constructing a HostVirtualSwitch resource.
|
|
40
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics:
|
|
41
|
-
balancing.
|
|
45
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics: List of active network adapters used for load balancing.
|
|
42
46
|
:param pulumi.Input[str] host_system_id: The managed object ID of
|
|
43
47
|
the host to set the virtual switch up on. Forces a new resource if changed.
|
|
44
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The network
|
|
45
|
-
:param pulumi.Input[bool] allow_forged_transmits: Controls whether or not the virtual
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
:param pulumi.Input[bool]
|
|
49
|
-
|
|
50
|
-
:param pulumi.Input[bool]
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
:param pulumi.Input[
|
|
54
|
-
|
|
55
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
56
|
-
:param pulumi.Input[bool] check_beacon: Enable beacon probing - this requires that the
|
|
57
|
-
`beacon_interval` option has been set in the bridge
|
|
58
|
-
options. If this is set to `false`, only link status is used to check for
|
|
59
|
-
failed NICs. Default: `false`.
|
|
60
|
-
:param pulumi.Input[bool] failback: If set to `true`, the teaming policy will re-activate
|
|
61
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
62
|
-
`true`.
|
|
63
|
-
:param pulumi.Input[str] link_discovery_operation: Whether to `advertise` or `listen`
|
|
64
|
-
for link discovery traffic. Default: `listen`.
|
|
65
|
-
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid
|
|
66
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
48
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The list of network adapters to bind to this virtual switch.
|
|
49
|
+
:param pulumi.Input[bool] allow_forged_transmits: Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
50
|
+
that of its own.
|
|
51
|
+
:param pulumi.Input[bool] allow_mac_changes: Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
52
|
+
:param pulumi.Input[bool] allow_promiscuous: Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
53
|
+
:param pulumi.Input[int] beacon_interval: Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
54
|
+
:param pulumi.Input[bool] check_beacon: Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
55
|
+
only.
|
|
56
|
+
:param pulumi.Input[bool] failback: If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
57
|
+
:param pulumi.Input[str] link_discovery_operation: Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
58
|
+
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid values are cdp and lldp.
|
|
67
59
|
:param pulumi.Input[int] mtu: The maximum transmission unit (MTU) for the virtual
|
|
68
60
|
switch. Default: `1500`.
|
|
69
61
|
:param pulumi.Input[str] name: The name of the virtual switch. Forces a new resource if
|
|
70
62
|
changed.
|
|
71
|
-
:param pulumi.Input[bool] notify_switches: If
|
|
72
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
73
|
-
Default: `true`.
|
|
63
|
+
:param pulumi.Input[bool] notify_switches: If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
74
64
|
:param pulumi.Input[int] number_of_ports: The number of ports to create with this
|
|
75
65
|
virtual switch. Default: `128`.
|
|
76
66
|
|
|
77
67
|
> **NOTE:** Changing the port count requires a reboot of the host. This provider
|
|
78
68
|
will not restart the host for you.
|
|
79
|
-
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per
|
|
80
|
-
|
|
81
|
-
:param pulumi.Input[
|
|
82
|
-
|
|
83
|
-
:param pulumi.Input[
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
87
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: The list of standby network adapters used for
|
|
88
|
-
failover.
|
|
89
|
-
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one
|
|
90
|
-
of `loadbalance_ip`, `loadbalance_srcmac`, `loadbalance_srcid`, or
|
|
91
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
69
|
+
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per second if traffic shaping is enabled.
|
|
70
|
+
:param pulumi.Input[int] shaping_burst_size: The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
71
|
+
:param pulumi.Input[bool] shaping_enabled: Enable traffic shaping on this virtual switch or port group.
|
|
72
|
+
:param pulumi.Input[int] shaping_peak_bandwidth: The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
73
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: List of standby network adapters used for failover.
|
|
74
|
+
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
75
|
+
failover_explicit.
|
|
92
76
|
"""
|
|
93
77
|
pulumi.set(__self__, "active_nics", active_nics)
|
|
94
78
|
pulumi.set(__self__, "host_system_id", host_system_id)
|
|
@@ -134,8 +118,7 @@ class HostVirtualSwitchArgs:
|
|
|
134
118
|
@pulumi.getter(name="activeNics")
|
|
135
119
|
def active_nics(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
|
|
136
120
|
"""
|
|
137
|
-
|
|
138
|
-
balancing.
|
|
121
|
+
List of active network adapters used for load balancing.
|
|
139
122
|
"""
|
|
140
123
|
return pulumi.get(self, "active_nics")
|
|
141
124
|
|
|
@@ -160,7 +143,7 @@ class HostVirtualSwitchArgs:
|
|
|
160
143
|
@pulumi.getter(name="networkAdapters")
|
|
161
144
|
def network_adapters(self) -> pulumi.Input[Sequence[pulumi.Input[str]]]:
|
|
162
145
|
"""
|
|
163
|
-
The network
|
|
146
|
+
The list of network adapters to bind to this virtual switch.
|
|
164
147
|
"""
|
|
165
148
|
return pulumi.get(self, "network_adapters")
|
|
166
149
|
|
|
@@ -172,9 +155,8 @@ class HostVirtualSwitchArgs:
|
|
|
172
155
|
@pulumi.getter(name="allowForgedTransmits")
|
|
173
156
|
def allow_forged_transmits(self) -> Optional[pulumi.Input[bool]]:
|
|
174
157
|
"""
|
|
175
|
-
Controls whether or not the virtual
|
|
176
|
-
|
|
177
|
-
address than that of its own. Default: `true`.
|
|
158
|
+
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
159
|
+
that of its own.
|
|
178
160
|
"""
|
|
179
161
|
return pulumi.get(self, "allow_forged_transmits")
|
|
180
162
|
|
|
@@ -186,8 +168,7 @@ class HostVirtualSwitchArgs:
|
|
|
186
168
|
@pulumi.getter(name="allowMacChanges")
|
|
187
169
|
def allow_mac_changes(self) -> Optional[pulumi.Input[bool]]:
|
|
188
170
|
"""
|
|
189
|
-
Controls whether or not the Media Access
|
|
190
|
-
Control (MAC) address can be changed. Default: `true`.
|
|
171
|
+
Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
191
172
|
"""
|
|
192
173
|
return pulumi.get(self, "allow_mac_changes")
|
|
193
174
|
|
|
@@ -199,9 +180,7 @@ class HostVirtualSwitchArgs:
|
|
|
199
180
|
@pulumi.getter(name="allowPromiscuous")
|
|
200
181
|
def allow_promiscuous(self) -> Optional[pulumi.Input[bool]]:
|
|
201
182
|
"""
|
|
202
|
-
Enable promiscuous mode on the network. This
|
|
203
|
-
flag indicates whether or not all traffic is seen on a given port. Default:
|
|
204
|
-
`false`.
|
|
183
|
+
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
205
184
|
"""
|
|
206
185
|
return pulumi.get(self, "allow_promiscuous")
|
|
207
186
|
|
|
@@ -213,9 +192,7 @@ class HostVirtualSwitchArgs:
|
|
|
213
192
|
@pulumi.getter(name="beaconInterval")
|
|
214
193
|
def beacon_interval(self) -> Optional[pulumi.Input[int]]:
|
|
215
194
|
"""
|
|
216
|
-
|
|
217
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
218
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
195
|
+
Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
219
196
|
"""
|
|
220
197
|
return pulumi.get(self, "beacon_interval")
|
|
221
198
|
|
|
@@ -227,10 +204,8 @@ class HostVirtualSwitchArgs:
|
|
|
227
204
|
@pulumi.getter(name="checkBeacon")
|
|
228
205
|
def check_beacon(self) -> Optional[pulumi.Input[bool]]:
|
|
229
206
|
"""
|
|
230
|
-
Enable beacon probing
|
|
231
|
-
|
|
232
|
-
options. If this is set to `false`, only link status is used to check for
|
|
233
|
-
failed NICs. Default: `false`.
|
|
207
|
+
Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
208
|
+
only.
|
|
234
209
|
"""
|
|
235
210
|
return pulumi.get(self, "check_beacon")
|
|
236
211
|
|
|
@@ -242,9 +217,7 @@ class HostVirtualSwitchArgs:
|
|
|
242
217
|
@pulumi.getter
|
|
243
218
|
def failback(self) -> Optional[pulumi.Input[bool]]:
|
|
244
219
|
"""
|
|
245
|
-
If
|
|
246
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
247
|
-
`true`.
|
|
220
|
+
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
248
221
|
"""
|
|
249
222
|
return pulumi.get(self, "failback")
|
|
250
223
|
|
|
@@ -256,8 +229,7 @@ class HostVirtualSwitchArgs:
|
|
|
256
229
|
@pulumi.getter(name="linkDiscoveryOperation")
|
|
257
230
|
def link_discovery_operation(self) -> Optional[pulumi.Input[str]]:
|
|
258
231
|
"""
|
|
259
|
-
Whether to
|
|
260
|
-
for link discovery traffic. Default: `listen`.
|
|
232
|
+
Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
261
233
|
"""
|
|
262
234
|
return pulumi.get(self, "link_discovery_operation")
|
|
263
235
|
|
|
@@ -269,8 +241,7 @@ class HostVirtualSwitchArgs:
|
|
|
269
241
|
@pulumi.getter(name="linkDiscoveryProtocol")
|
|
270
242
|
def link_discovery_protocol(self) -> Optional[pulumi.Input[str]]:
|
|
271
243
|
"""
|
|
272
|
-
The discovery protocol type.
|
|
273
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
244
|
+
The discovery protocol type. Valid values are cdp and lldp.
|
|
274
245
|
"""
|
|
275
246
|
return pulumi.get(self, "link_discovery_protocol")
|
|
276
247
|
|
|
@@ -308,9 +279,7 @@ class HostVirtualSwitchArgs:
|
|
|
308
279
|
@pulumi.getter(name="notifySwitches")
|
|
309
280
|
def notify_switches(self) -> Optional[pulumi.Input[bool]]:
|
|
310
281
|
"""
|
|
311
|
-
If
|
|
312
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
313
|
-
Default: `true`.
|
|
282
|
+
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
314
283
|
"""
|
|
315
284
|
return pulumi.get(self, "notify_switches")
|
|
316
285
|
|
|
@@ -338,8 +307,7 @@ class HostVirtualSwitchArgs:
|
|
|
338
307
|
@pulumi.getter(name="shapingAverageBandwidth")
|
|
339
308
|
def shaping_average_bandwidth(self) -> Optional[pulumi.Input[int]]:
|
|
340
309
|
"""
|
|
341
|
-
The average bandwidth in bits per
|
|
342
|
-
second if traffic shaping is enabled. Default: `0`
|
|
310
|
+
The average bandwidth in bits per second if traffic shaping is enabled.
|
|
343
311
|
"""
|
|
344
312
|
return pulumi.get(self, "shaping_average_bandwidth")
|
|
345
313
|
|
|
@@ -351,8 +319,7 @@ class HostVirtualSwitchArgs:
|
|
|
351
319
|
@pulumi.getter(name="shapingBurstSize")
|
|
352
320
|
def shaping_burst_size(self) -> Optional[pulumi.Input[int]]:
|
|
353
321
|
"""
|
|
354
|
-
The maximum burst size allowed in bytes if
|
|
355
|
-
shaping is enabled. Default: `0`
|
|
322
|
+
The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
356
323
|
"""
|
|
357
324
|
return pulumi.get(self, "shaping_burst_size")
|
|
358
325
|
|
|
@@ -364,8 +331,7 @@ class HostVirtualSwitchArgs:
|
|
|
364
331
|
@pulumi.getter(name="shapingEnabled")
|
|
365
332
|
def shaping_enabled(self) -> Optional[pulumi.Input[bool]]:
|
|
366
333
|
"""
|
|
367
|
-
|
|
368
|
-
ports managed by this virtual switch. Default: `false`.
|
|
334
|
+
Enable traffic shaping on this virtual switch or port group.
|
|
369
335
|
"""
|
|
370
336
|
return pulumi.get(self, "shaping_enabled")
|
|
371
337
|
|
|
@@ -377,8 +343,7 @@ class HostVirtualSwitchArgs:
|
|
|
377
343
|
@pulumi.getter(name="shapingPeakBandwidth")
|
|
378
344
|
def shaping_peak_bandwidth(self) -> Optional[pulumi.Input[int]]:
|
|
379
345
|
"""
|
|
380
|
-
The peak bandwidth during bursts in
|
|
381
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
346
|
+
The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
382
347
|
"""
|
|
383
348
|
return pulumi.get(self, "shaping_peak_bandwidth")
|
|
384
349
|
|
|
@@ -390,8 +355,7 @@ class HostVirtualSwitchArgs:
|
|
|
390
355
|
@pulumi.getter(name="standbyNics")
|
|
391
356
|
def standby_nics(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
392
357
|
"""
|
|
393
|
-
|
|
394
|
-
failover.
|
|
358
|
+
List of standby network adapters used for failover.
|
|
395
359
|
"""
|
|
396
360
|
return pulumi.get(self, "standby_nics")
|
|
397
361
|
|
|
@@ -403,9 +367,8 @@ class HostVirtualSwitchArgs:
|
|
|
403
367
|
@pulumi.getter(name="teamingPolicy")
|
|
404
368
|
def teaming_policy(self) -> Optional[pulumi.Input[str]]:
|
|
405
369
|
"""
|
|
406
|
-
The network adapter teaming policy. Can be one
|
|
407
|
-
|
|
408
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
370
|
+
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
371
|
+
failover_explicit.
|
|
409
372
|
"""
|
|
410
373
|
return pulumi.get(self, "teaming_policy")
|
|
411
374
|
|
|
@@ -440,58 +403,37 @@ class _HostVirtualSwitchState:
|
|
|
440
403
|
teaming_policy: Optional[pulumi.Input[str]] = None):
|
|
441
404
|
"""
|
|
442
405
|
Input properties used for looking up and filtering HostVirtualSwitch resources.
|
|
443
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics:
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
:param pulumi.Input[
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
`false`.
|
|
453
|
-
:param pulumi.Input[int] beacon_interval: The interval, in seconds, that a NIC beacon
|
|
454
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
455
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
456
|
-
:param pulumi.Input[bool] check_beacon: Enable beacon probing - this requires that the
|
|
457
|
-
`beacon_interval` option has been set in the bridge
|
|
458
|
-
options. If this is set to `false`, only link status is used to check for
|
|
459
|
-
failed NICs. Default: `false`.
|
|
460
|
-
:param pulumi.Input[bool] failback: If set to `true`, the teaming policy will re-activate
|
|
461
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
462
|
-
`true`.
|
|
406
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics: List of active network adapters used for load balancing.
|
|
407
|
+
:param pulumi.Input[bool] allow_forged_transmits: Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
408
|
+
that of its own.
|
|
409
|
+
:param pulumi.Input[bool] allow_mac_changes: Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
410
|
+
:param pulumi.Input[bool] allow_promiscuous: Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
411
|
+
:param pulumi.Input[int] beacon_interval: Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
412
|
+
:param pulumi.Input[bool] check_beacon: Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
413
|
+
only.
|
|
414
|
+
:param pulumi.Input[bool] failback: If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
463
415
|
:param pulumi.Input[str] host_system_id: The managed object ID of
|
|
464
416
|
the host to set the virtual switch up on. Forces a new resource if changed.
|
|
465
|
-
:param pulumi.Input[str] link_discovery_operation: Whether to
|
|
466
|
-
|
|
467
|
-
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid
|
|
468
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
417
|
+
:param pulumi.Input[str] link_discovery_operation: Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
418
|
+
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid values are cdp and lldp.
|
|
469
419
|
:param pulumi.Input[int] mtu: The maximum transmission unit (MTU) for the virtual
|
|
470
420
|
switch. Default: `1500`.
|
|
471
421
|
:param pulumi.Input[str] name: The name of the virtual switch. Forces a new resource if
|
|
472
422
|
changed.
|
|
473
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The network
|
|
474
|
-
:param pulumi.Input[bool] notify_switches: If
|
|
475
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
476
|
-
Default: `true`.
|
|
423
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The list of network adapters to bind to this virtual switch.
|
|
424
|
+
:param pulumi.Input[bool] notify_switches: If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
477
425
|
:param pulumi.Input[int] number_of_ports: The number of ports to create with this
|
|
478
426
|
virtual switch. Default: `128`.
|
|
479
427
|
|
|
480
428
|
> **NOTE:** Changing the port count requires a reboot of the host. This provider
|
|
481
429
|
will not restart the host for you.
|
|
482
|
-
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per
|
|
483
|
-
|
|
484
|
-
:param pulumi.Input[
|
|
485
|
-
|
|
486
|
-
:param pulumi.Input[
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
490
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: The list of standby network adapters used for
|
|
491
|
-
failover.
|
|
492
|
-
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one
|
|
493
|
-
of `loadbalance_ip`, `loadbalance_srcmac`, `loadbalance_srcid`, or
|
|
494
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
430
|
+
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per second if traffic shaping is enabled.
|
|
431
|
+
:param pulumi.Input[int] shaping_burst_size: The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
432
|
+
:param pulumi.Input[bool] shaping_enabled: Enable traffic shaping on this virtual switch or port group.
|
|
433
|
+
:param pulumi.Input[int] shaping_peak_bandwidth: The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
434
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: List of standby network adapters used for failover.
|
|
435
|
+
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
436
|
+
failover_explicit.
|
|
495
437
|
"""
|
|
496
438
|
if active_nics is not None:
|
|
497
439
|
pulumi.set(__self__, "active_nics", active_nics)
|
|
@@ -540,8 +482,7 @@ class _HostVirtualSwitchState:
|
|
|
540
482
|
@pulumi.getter(name="activeNics")
|
|
541
483
|
def active_nics(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
542
484
|
"""
|
|
543
|
-
|
|
544
|
-
balancing.
|
|
485
|
+
List of active network adapters used for load balancing.
|
|
545
486
|
"""
|
|
546
487
|
return pulumi.get(self, "active_nics")
|
|
547
488
|
|
|
@@ -553,9 +494,8 @@ class _HostVirtualSwitchState:
|
|
|
553
494
|
@pulumi.getter(name="allowForgedTransmits")
|
|
554
495
|
def allow_forged_transmits(self) -> Optional[pulumi.Input[bool]]:
|
|
555
496
|
"""
|
|
556
|
-
Controls whether or not the virtual
|
|
557
|
-
|
|
558
|
-
address than that of its own. Default: `true`.
|
|
497
|
+
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
498
|
+
that of its own.
|
|
559
499
|
"""
|
|
560
500
|
return pulumi.get(self, "allow_forged_transmits")
|
|
561
501
|
|
|
@@ -567,8 +507,7 @@ class _HostVirtualSwitchState:
|
|
|
567
507
|
@pulumi.getter(name="allowMacChanges")
|
|
568
508
|
def allow_mac_changes(self) -> Optional[pulumi.Input[bool]]:
|
|
569
509
|
"""
|
|
570
|
-
Controls whether or not the Media Access
|
|
571
|
-
Control (MAC) address can be changed. Default: `true`.
|
|
510
|
+
Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
572
511
|
"""
|
|
573
512
|
return pulumi.get(self, "allow_mac_changes")
|
|
574
513
|
|
|
@@ -580,9 +519,7 @@ class _HostVirtualSwitchState:
|
|
|
580
519
|
@pulumi.getter(name="allowPromiscuous")
|
|
581
520
|
def allow_promiscuous(self) -> Optional[pulumi.Input[bool]]:
|
|
582
521
|
"""
|
|
583
|
-
Enable promiscuous mode on the network. This
|
|
584
|
-
flag indicates whether or not all traffic is seen on a given port. Default:
|
|
585
|
-
`false`.
|
|
522
|
+
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
586
523
|
"""
|
|
587
524
|
return pulumi.get(self, "allow_promiscuous")
|
|
588
525
|
|
|
@@ -594,9 +531,7 @@ class _HostVirtualSwitchState:
|
|
|
594
531
|
@pulumi.getter(name="beaconInterval")
|
|
595
532
|
def beacon_interval(self) -> Optional[pulumi.Input[int]]:
|
|
596
533
|
"""
|
|
597
|
-
|
|
598
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
599
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
534
|
+
Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
600
535
|
"""
|
|
601
536
|
return pulumi.get(self, "beacon_interval")
|
|
602
537
|
|
|
@@ -608,10 +543,8 @@ class _HostVirtualSwitchState:
|
|
|
608
543
|
@pulumi.getter(name="checkBeacon")
|
|
609
544
|
def check_beacon(self) -> Optional[pulumi.Input[bool]]:
|
|
610
545
|
"""
|
|
611
|
-
Enable beacon probing
|
|
612
|
-
|
|
613
|
-
options. If this is set to `false`, only link status is used to check for
|
|
614
|
-
failed NICs. Default: `false`.
|
|
546
|
+
Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
547
|
+
only.
|
|
615
548
|
"""
|
|
616
549
|
return pulumi.get(self, "check_beacon")
|
|
617
550
|
|
|
@@ -623,9 +556,7 @@ class _HostVirtualSwitchState:
|
|
|
623
556
|
@pulumi.getter
|
|
624
557
|
def failback(self) -> Optional[pulumi.Input[bool]]:
|
|
625
558
|
"""
|
|
626
|
-
If
|
|
627
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
628
|
-
`true`.
|
|
559
|
+
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
629
560
|
"""
|
|
630
561
|
return pulumi.get(self, "failback")
|
|
631
562
|
|
|
@@ -650,8 +581,7 @@ class _HostVirtualSwitchState:
|
|
|
650
581
|
@pulumi.getter(name="linkDiscoveryOperation")
|
|
651
582
|
def link_discovery_operation(self) -> Optional[pulumi.Input[str]]:
|
|
652
583
|
"""
|
|
653
|
-
Whether to
|
|
654
|
-
for link discovery traffic. Default: `listen`.
|
|
584
|
+
Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
655
585
|
"""
|
|
656
586
|
return pulumi.get(self, "link_discovery_operation")
|
|
657
587
|
|
|
@@ -663,8 +593,7 @@ class _HostVirtualSwitchState:
|
|
|
663
593
|
@pulumi.getter(name="linkDiscoveryProtocol")
|
|
664
594
|
def link_discovery_protocol(self) -> Optional[pulumi.Input[str]]:
|
|
665
595
|
"""
|
|
666
|
-
The discovery protocol type.
|
|
667
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
596
|
+
The discovery protocol type. Valid values are cdp and lldp.
|
|
668
597
|
"""
|
|
669
598
|
return pulumi.get(self, "link_discovery_protocol")
|
|
670
599
|
|
|
@@ -702,7 +631,7 @@ class _HostVirtualSwitchState:
|
|
|
702
631
|
@pulumi.getter(name="networkAdapters")
|
|
703
632
|
def network_adapters(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
704
633
|
"""
|
|
705
|
-
The network
|
|
634
|
+
The list of network adapters to bind to this virtual switch.
|
|
706
635
|
"""
|
|
707
636
|
return pulumi.get(self, "network_adapters")
|
|
708
637
|
|
|
@@ -714,9 +643,7 @@ class _HostVirtualSwitchState:
|
|
|
714
643
|
@pulumi.getter(name="notifySwitches")
|
|
715
644
|
def notify_switches(self) -> Optional[pulumi.Input[bool]]:
|
|
716
645
|
"""
|
|
717
|
-
If
|
|
718
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
719
|
-
Default: `true`.
|
|
646
|
+
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
720
647
|
"""
|
|
721
648
|
return pulumi.get(self, "notify_switches")
|
|
722
649
|
|
|
@@ -744,8 +671,7 @@ class _HostVirtualSwitchState:
|
|
|
744
671
|
@pulumi.getter(name="shapingAverageBandwidth")
|
|
745
672
|
def shaping_average_bandwidth(self) -> Optional[pulumi.Input[int]]:
|
|
746
673
|
"""
|
|
747
|
-
The average bandwidth in bits per
|
|
748
|
-
second if traffic shaping is enabled. Default: `0`
|
|
674
|
+
The average bandwidth in bits per second if traffic shaping is enabled.
|
|
749
675
|
"""
|
|
750
676
|
return pulumi.get(self, "shaping_average_bandwidth")
|
|
751
677
|
|
|
@@ -757,8 +683,7 @@ class _HostVirtualSwitchState:
|
|
|
757
683
|
@pulumi.getter(name="shapingBurstSize")
|
|
758
684
|
def shaping_burst_size(self) -> Optional[pulumi.Input[int]]:
|
|
759
685
|
"""
|
|
760
|
-
The maximum burst size allowed in bytes if
|
|
761
|
-
shaping is enabled. Default: `0`
|
|
686
|
+
The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
762
687
|
"""
|
|
763
688
|
return pulumi.get(self, "shaping_burst_size")
|
|
764
689
|
|
|
@@ -770,8 +695,7 @@ class _HostVirtualSwitchState:
|
|
|
770
695
|
@pulumi.getter(name="shapingEnabled")
|
|
771
696
|
def shaping_enabled(self) -> Optional[pulumi.Input[bool]]:
|
|
772
697
|
"""
|
|
773
|
-
|
|
774
|
-
ports managed by this virtual switch. Default: `false`.
|
|
698
|
+
Enable traffic shaping on this virtual switch or port group.
|
|
775
699
|
"""
|
|
776
700
|
return pulumi.get(self, "shaping_enabled")
|
|
777
701
|
|
|
@@ -783,8 +707,7 @@ class _HostVirtualSwitchState:
|
|
|
783
707
|
@pulumi.getter(name="shapingPeakBandwidth")
|
|
784
708
|
def shaping_peak_bandwidth(self) -> Optional[pulumi.Input[int]]:
|
|
785
709
|
"""
|
|
786
|
-
The peak bandwidth during bursts in
|
|
787
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
710
|
+
The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
788
711
|
"""
|
|
789
712
|
return pulumi.get(self, "shaping_peak_bandwidth")
|
|
790
713
|
|
|
@@ -796,8 +719,7 @@ class _HostVirtualSwitchState:
|
|
|
796
719
|
@pulumi.getter(name="standbyNics")
|
|
797
720
|
def standby_nics(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
798
721
|
"""
|
|
799
|
-
|
|
800
|
-
failover.
|
|
722
|
+
List of standby network adapters used for failover.
|
|
801
723
|
"""
|
|
802
724
|
return pulumi.get(self, "standby_nics")
|
|
803
725
|
|
|
@@ -809,9 +731,8 @@ class _HostVirtualSwitchState:
|
|
|
809
731
|
@pulumi.getter(name="teamingPolicy")
|
|
810
732
|
def teaming_policy(self) -> Optional[pulumi.Input[str]]:
|
|
811
733
|
"""
|
|
812
|
-
The network adapter teaming policy. Can be one
|
|
813
|
-
|
|
814
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
734
|
+
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
735
|
+
failover_explicit.
|
|
815
736
|
"""
|
|
816
737
|
return pulumi.get(self, "teaming_policy")
|
|
817
738
|
|
|
@@ -848,61 +769,71 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
848
769
|
teaming_policy: Optional[pulumi.Input[str]] = None,
|
|
849
770
|
__props__=None):
|
|
850
771
|
"""
|
|
851
|
-
|
|
772
|
+
The `HostVirtualSwitch` resource can be used to manage vSphere
|
|
773
|
+
standard switches on an ESXi host. These switches can be used as a backing for
|
|
774
|
+
standard port groups, which can be managed by the
|
|
775
|
+
`HostPortGroup` resource.
|
|
776
|
+
|
|
777
|
+
For an overview on vSphere networking concepts, see [this
|
|
778
|
+
page][ref-vsphere-net-concepts].
|
|
779
|
+
|
|
780
|
+
[ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
|
|
781
|
+
|
|
782
|
+
## Example Usage
|
|
783
|
+
|
|
784
|
+
## Import
|
|
785
|
+
|
|
786
|
+
An existing vSwitch can be imported into this resource by its ID.
|
|
787
|
+
|
|
788
|
+
The convention of the id is a prefix, the host system [managed objectID][docs-about-morefs], and the virtual switch
|
|
789
|
+
|
|
790
|
+
name. An example would be `tf-HostVirtualSwitch:host-10:vSwitchTerraformTest`.
|
|
791
|
+
|
|
792
|
+
Import can the be done via the following command:
|
|
793
|
+
|
|
794
|
+
[docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
|
|
795
|
+
|
|
796
|
+
```sh
|
|
797
|
+
$ pulumi import vsphere:index/hostVirtualSwitch:HostVirtualSwitch switch tf-HostVirtualSwitch:host-10:vSwitchTerraformTest
|
|
798
|
+
```
|
|
799
|
+
|
|
800
|
+
The above would import the vSwitch named `vSwitchTerraformTest` that is located in the `host-10`
|
|
801
|
+
|
|
802
|
+
vSphere host.
|
|
803
|
+
|
|
852
804
|
:param str resource_name: The name of the resource.
|
|
853
805
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
854
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics:
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
:param pulumi.Input[
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
`false`.
|
|
864
|
-
:param pulumi.Input[int] beacon_interval: The interval, in seconds, that a NIC beacon
|
|
865
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
866
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
867
|
-
:param pulumi.Input[bool] check_beacon: Enable beacon probing - this requires that the
|
|
868
|
-
`beacon_interval` option has been set in the bridge
|
|
869
|
-
options. If this is set to `false`, only link status is used to check for
|
|
870
|
-
failed NICs. Default: `false`.
|
|
871
|
-
:param pulumi.Input[bool] failback: If set to `true`, the teaming policy will re-activate
|
|
872
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
873
|
-
`true`.
|
|
806
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics: List of active network adapters used for load balancing.
|
|
807
|
+
:param pulumi.Input[bool] allow_forged_transmits: Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
808
|
+
that of its own.
|
|
809
|
+
:param pulumi.Input[bool] allow_mac_changes: Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
810
|
+
:param pulumi.Input[bool] allow_promiscuous: Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
811
|
+
:param pulumi.Input[int] beacon_interval: Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
812
|
+
:param pulumi.Input[bool] check_beacon: Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
813
|
+
only.
|
|
814
|
+
:param pulumi.Input[bool] failback: If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
874
815
|
:param pulumi.Input[str] host_system_id: The managed object ID of
|
|
875
816
|
the host to set the virtual switch up on. Forces a new resource if changed.
|
|
876
|
-
:param pulumi.Input[str] link_discovery_operation: Whether to
|
|
877
|
-
|
|
878
|
-
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid
|
|
879
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
817
|
+
:param pulumi.Input[str] link_discovery_operation: Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
818
|
+
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid values are cdp and lldp.
|
|
880
819
|
:param pulumi.Input[int] mtu: The maximum transmission unit (MTU) for the virtual
|
|
881
820
|
switch. Default: `1500`.
|
|
882
821
|
:param pulumi.Input[str] name: The name of the virtual switch. Forces a new resource if
|
|
883
822
|
changed.
|
|
884
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The network
|
|
885
|
-
:param pulumi.Input[bool] notify_switches: If
|
|
886
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
887
|
-
Default: `true`.
|
|
823
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The list of network adapters to bind to this virtual switch.
|
|
824
|
+
:param pulumi.Input[bool] notify_switches: If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
888
825
|
:param pulumi.Input[int] number_of_ports: The number of ports to create with this
|
|
889
826
|
virtual switch. Default: `128`.
|
|
890
827
|
|
|
891
828
|
> **NOTE:** Changing the port count requires a reboot of the host. This provider
|
|
892
829
|
will not restart the host for you.
|
|
893
|
-
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per
|
|
894
|
-
|
|
895
|
-
:param pulumi.Input[
|
|
896
|
-
|
|
897
|
-
:param pulumi.Input[
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
901
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: The list of standby network adapters used for
|
|
902
|
-
failover.
|
|
903
|
-
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one
|
|
904
|
-
of `loadbalance_ip`, `loadbalance_srcmac`, `loadbalance_srcid`, or
|
|
905
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
830
|
+
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per second if traffic shaping is enabled.
|
|
831
|
+
:param pulumi.Input[int] shaping_burst_size: The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
832
|
+
:param pulumi.Input[bool] shaping_enabled: Enable traffic shaping on this virtual switch or port group.
|
|
833
|
+
:param pulumi.Input[int] shaping_peak_bandwidth: The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
834
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: List of standby network adapters used for failover.
|
|
835
|
+
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
836
|
+
failover_explicit.
|
|
906
837
|
"""
|
|
907
838
|
...
|
|
908
839
|
@overload
|
|
@@ -911,7 +842,38 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
911
842
|
args: HostVirtualSwitchArgs,
|
|
912
843
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
913
844
|
"""
|
|
914
|
-
|
|
845
|
+
The `HostVirtualSwitch` resource can be used to manage vSphere
|
|
846
|
+
standard switches on an ESXi host. These switches can be used as a backing for
|
|
847
|
+
standard port groups, which can be managed by the
|
|
848
|
+
`HostPortGroup` resource.
|
|
849
|
+
|
|
850
|
+
For an overview on vSphere networking concepts, see [this
|
|
851
|
+
page][ref-vsphere-net-concepts].
|
|
852
|
+
|
|
853
|
+
[ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
|
|
854
|
+
|
|
855
|
+
## Example Usage
|
|
856
|
+
|
|
857
|
+
## Import
|
|
858
|
+
|
|
859
|
+
An existing vSwitch can be imported into this resource by its ID.
|
|
860
|
+
|
|
861
|
+
The convention of the id is a prefix, the host system [managed objectID][docs-about-morefs], and the virtual switch
|
|
862
|
+
|
|
863
|
+
name. An example would be `tf-HostVirtualSwitch:host-10:vSwitchTerraformTest`.
|
|
864
|
+
|
|
865
|
+
Import can the be done via the following command:
|
|
866
|
+
|
|
867
|
+
[docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
|
|
868
|
+
|
|
869
|
+
```sh
|
|
870
|
+
$ pulumi import vsphere:index/hostVirtualSwitch:HostVirtualSwitch switch tf-HostVirtualSwitch:host-10:vSwitchTerraformTest
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
The above would import the vSwitch named `vSwitchTerraformTest` that is located in the `host-10`
|
|
874
|
+
|
|
875
|
+
vSphere host.
|
|
876
|
+
|
|
915
877
|
:param str resource_name: The name of the resource.
|
|
916
878
|
:param HostVirtualSwitchArgs args: The arguments to use to populate this resource's properties.
|
|
917
879
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
@@ -1022,58 +984,37 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1022
984
|
:param str resource_name: The unique name of the resulting resource.
|
|
1023
985
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
1024
986
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1025
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics:
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
:param pulumi.Input[
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
`false`.
|
|
1035
|
-
:param pulumi.Input[int] beacon_interval: The interval, in seconds, that a NIC beacon
|
|
1036
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
1037
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
1038
|
-
:param pulumi.Input[bool] check_beacon: Enable beacon probing - this requires that the
|
|
1039
|
-
`beacon_interval` option has been set in the bridge
|
|
1040
|
-
options. If this is set to `false`, only link status is used to check for
|
|
1041
|
-
failed NICs. Default: `false`.
|
|
1042
|
-
:param pulumi.Input[bool] failback: If set to `true`, the teaming policy will re-activate
|
|
1043
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
1044
|
-
`true`.
|
|
987
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics: List of active network adapters used for load balancing.
|
|
988
|
+
:param pulumi.Input[bool] allow_forged_transmits: Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
989
|
+
that of its own.
|
|
990
|
+
:param pulumi.Input[bool] allow_mac_changes: Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
991
|
+
:param pulumi.Input[bool] allow_promiscuous: Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
992
|
+
:param pulumi.Input[int] beacon_interval: Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
993
|
+
:param pulumi.Input[bool] check_beacon: Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
994
|
+
only.
|
|
995
|
+
:param pulumi.Input[bool] failback: If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
1045
996
|
:param pulumi.Input[str] host_system_id: The managed object ID of
|
|
1046
997
|
the host to set the virtual switch up on. Forces a new resource if changed.
|
|
1047
|
-
:param pulumi.Input[str] link_discovery_operation: Whether to
|
|
1048
|
-
|
|
1049
|
-
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid
|
|
1050
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
998
|
+
:param pulumi.Input[str] link_discovery_operation: Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
999
|
+
:param pulumi.Input[str] link_discovery_protocol: The discovery protocol type. Valid values are cdp and lldp.
|
|
1051
1000
|
:param pulumi.Input[int] mtu: The maximum transmission unit (MTU) for the virtual
|
|
1052
1001
|
switch. Default: `1500`.
|
|
1053
1002
|
:param pulumi.Input[str] name: The name of the virtual switch. Forces a new resource if
|
|
1054
1003
|
changed.
|
|
1055
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The network
|
|
1056
|
-
:param pulumi.Input[bool] notify_switches: If
|
|
1057
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
1058
|
-
Default: `true`.
|
|
1004
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] network_adapters: The list of network adapters to bind to this virtual switch.
|
|
1005
|
+
:param pulumi.Input[bool] notify_switches: If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
1059
1006
|
:param pulumi.Input[int] number_of_ports: The number of ports to create with this
|
|
1060
1007
|
virtual switch. Default: `128`.
|
|
1061
1008
|
|
|
1062
1009
|
> **NOTE:** Changing the port count requires a reboot of the host. This provider
|
|
1063
1010
|
will not restart the host for you.
|
|
1064
|
-
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per
|
|
1065
|
-
|
|
1066
|
-
:param pulumi.Input[
|
|
1067
|
-
|
|
1068
|
-
:param pulumi.Input[
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
1072
|
-
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: The list of standby network adapters used for
|
|
1073
|
-
failover.
|
|
1074
|
-
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one
|
|
1075
|
-
of `loadbalance_ip`, `loadbalance_srcmac`, `loadbalance_srcid`, or
|
|
1076
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
1011
|
+
:param pulumi.Input[int] shaping_average_bandwidth: The average bandwidth in bits per second if traffic shaping is enabled.
|
|
1012
|
+
:param pulumi.Input[int] shaping_burst_size: The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
1013
|
+
:param pulumi.Input[bool] shaping_enabled: Enable traffic shaping on this virtual switch or port group.
|
|
1014
|
+
:param pulumi.Input[int] shaping_peak_bandwidth: The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
1015
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] standby_nics: List of standby network adapters used for failover.
|
|
1016
|
+
:param pulumi.Input[str] teaming_policy: The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
1017
|
+
failover_explicit.
|
|
1077
1018
|
"""
|
|
1078
1019
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
1079
1020
|
|
|
@@ -1106,8 +1047,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1106
1047
|
@pulumi.getter(name="activeNics")
|
|
1107
1048
|
def active_nics(self) -> pulumi.Output[Sequence[str]]:
|
|
1108
1049
|
"""
|
|
1109
|
-
|
|
1110
|
-
balancing.
|
|
1050
|
+
List of active network adapters used for load balancing.
|
|
1111
1051
|
"""
|
|
1112
1052
|
return pulumi.get(self, "active_nics")
|
|
1113
1053
|
|
|
@@ -1115,9 +1055,8 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1115
1055
|
@pulumi.getter(name="allowForgedTransmits")
|
|
1116
1056
|
def allow_forged_transmits(self) -> pulumi.Output[Optional[bool]]:
|
|
1117
1057
|
"""
|
|
1118
|
-
Controls whether or not the virtual
|
|
1119
|
-
|
|
1120
|
-
address than that of its own. Default: `true`.
|
|
1058
|
+
Controls whether or not the virtual network adapter is allowed to send network traffic with a different MAC address than
|
|
1059
|
+
that of its own.
|
|
1121
1060
|
"""
|
|
1122
1061
|
return pulumi.get(self, "allow_forged_transmits")
|
|
1123
1062
|
|
|
@@ -1125,8 +1064,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1125
1064
|
@pulumi.getter(name="allowMacChanges")
|
|
1126
1065
|
def allow_mac_changes(self) -> pulumi.Output[Optional[bool]]:
|
|
1127
1066
|
"""
|
|
1128
|
-
Controls whether or not the Media Access
|
|
1129
|
-
Control (MAC) address can be changed. Default: `true`.
|
|
1067
|
+
Controls whether or not the Media Access Control (MAC) address can be changed.
|
|
1130
1068
|
"""
|
|
1131
1069
|
return pulumi.get(self, "allow_mac_changes")
|
|
1132
1070
|
|
|
@@ -1134,9 +1072,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1134
1072
|
@pulumi.getter(name="allowPromiscuous")
|
|
1135
1073
|
def allow_promiscuous(self) -> pulumi.Output[Optional[bool]]:
|
|
1136
1074
|
"""
|
|
1137
|
-
Enable promiscuous mode on the network. This
|
|
1138
|
-
flag indicates whether or not all traffic is seen on a given port. Default:
|
|
1139
|
-
`false`.
|
|
1075
|
+
Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
|
|
1140
1076
|
"""
|
|
1141
1077
|
return pulumi.get(self, "allow_promiscuous")
|
|
1142
1078
|
|
|
@@ -1144,9 +1080,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1144
1080
|
@pulumi.getter(name="beaconInterval")
|
|
1145
1081
|
def beacon_interval(self) -> pulumi.Output[Optional[int]]:
|
|
1146
1082
|
"""
|
|
1147
|
-
|
|
1148
|
-
packet is sent out. This can be used with `check_beacon` to
|
|
1149
|
-
offer link failure capability beyond link status only. Default: `1`.
|
|
1083
|
+
Determines how often, in seconds, a beacon should be sent to probe for the validity of a link.
|
|
1150
1084
|
"""
|
|
1151
1085
|
return pulumi.get(self, "beacon_interval")
|
|
1152
1086
|
|
|
@@ -1154,10 +1088,8 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1154
1088
|
@pulumi.getter(name="checkBeacon")
|
|
1155
1089
|
def check_beacon(self) -> pulumi.Output[Optional[bool]]:
|
|
1156
1090
|
"""
|
|
1157
|
-
Enable beacon probing
|
|
1158
|
-
|
|
1159
|
-
options. If this is set to `false`, only link status is used to check for
|
|
1160
|
-
failed NICs. Default: `false`.
|
|
1091
|
+
Enable beacon probing. Requires that the vSwitch has been configured to use a beacon. If disabled, link status is used
|
|
1092
|
+
only.
|
|
1161
1093
|
"""
|
|
1162
1094
|
return pulumi.get(self, "check_beacon")
|
|
1163
1095
|
|
|
@@ -1165,9 +1097,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1165
1097
|
@pulumi.getter
|
|
1166
1098
|
def failback(self) -> pulumi.Output[Optional[bool]]:
|
|
1167
1099
|
"""
|
|
1168
|
-
If
|
|
1169
|
-
failed interfaces higher in precedence when they come back up. Default:
|
|
1170
|
-
`true`.
|
|
1100
|
+
If true, the teaming policy will re-activate failed interfaces higher in precedence when they come back up.
|
|
1171
1101
|
"""
|
|
1172
1102
|
return pulumi.get(self, "failback")
|
|
1173
1103
|
|
|
@@ -1184,8 +1114,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1184
1114
|
@pulumi.getter(name="linkDiscoveryOperation")
|
|
1185
1115
|
def link_discovery_operation(self) -> pulumi.Output[Optional[str]]:
|
|
1186
1116
|
"""
|
|
1187
|
-
Whether to
|
|
1188
|
-
for link discovery traffic. Default: `listen`.
|
|
1117
|
+
Whether to advertise or listen for link discovery. Valid values are advertise, both, listen, and none.
|
|
1189
1118
|
"""
|
|
1190
1119
|
return pulumi.get(self, "link_discovery_operation")
|
|
1191
1120
|
|
|
@@ -1193,8 +1122,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1193
1122
|
@pulumi.getter(name="linkDiscoveryProtocol")
|
|
1194
1123
|
def link_discovery_protocol(self) -> pulumi.Output[Optional[str]]:
|
|
1195
1124
|
"""
|
|
1196
|
-
The discovery protocol type.
|
|
1197
|
-
types are `cpd` and `lldp`. Default: `cdp`.
|
|
1125
|
+
The discovery protocol type. Valid values are cdp and lldp.
|
|
1198
1126
|
"""
|
|
1199
1127
|
return pulumi.get(self, "link_discovery_protocol")
|
|
1200
1128
|
|
|
@@ -1220,7 +1148,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1220
1148
|
@pulumi.getter(name="networkAdapters")
|
|
1221
1149
|
def network_adapters(self) -> pulumi.Output[Sequence[str]]:
|
|
1222
1150
|
"""
|
|
1223
|
-
The network
|
|
1151
|
+
The list of network adapters to bind to this virtual switch.
|
|
1224
1152
|
"""
|
|
1225
1153
|
return pulumi.get(self, "network_adapters")
|
|
1226
1154
|
|
|
@@ -1228,9 +1156,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1228
1156
|
@pulumi.getter(name="notifySwitches")
|
|
1229
1157
|
def notify_switches(self) -> pulumi.Output[Optional[bool]]:
|
|
1230
1158
|
"""
|
|
1231
|
-
If
|
|
1232
|
-
notify the broadcast network of a NIC failover, triggering cache updates.
|
|
1233
|
-
Default: `true`.
|
|
1159
|
+
If true, the teaming policy will notify the broadcast network of a NIC failover, triggering cache updates.
|
|
1234
1160
|
"""
|
|
1235
1161
|
return pulumi.get(self, "notify_switches")
|
|
1236
1162
|
|
|
@@ -1250,8 +1176,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1250
1176
|
@pulumi.getter(name="shapingAverageBandwidth")
|
|
1251
1177
|
def shaping_average_bandwidth(self) -> pulumi.Output[Optional[int]]:
|
|
1252
1178
|
"""
|
|
1253
|
-
The average bandwidth in bits per
|
|
1254
|
-
second if traffic shaping is enabled. Default: `0`
|
|
1179
|
+
The average bandwidth in bits per second if traffic shaping is enabled.
|
|
1255
1180
|
"""
|
|
1256
1181
|
return pulumi.get(self, "shaping_average_bandwidth")
|
|
1257
1182
|
|
|
@@ -1259,8 +1184,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1259
1184
|
@pulumi.getter(name="shapingBurstSize")
|
|
1260
1185
|
def shaping_burst_size(self) -> pulumi.Output[Optional[int]]:
|
|
1261
1186
|
"""
|
|
1262
|
-
The maximum burst size allowed in bytes if
|
|
1263
|
-
shaping is enabled. Default: `0`
|
|
1187
|
+
The maximum burst size allowed in bytes if traffic shaping is enabled.
|
|
1264
1188
|
"""
|
|
1265
1189
|
return pulumi.get(self, "shaping_burst_size")
|
|
1266
1190
|
|
|
@@ -1268,8 +1192,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1268
1192
|
@pulumi.getter(name="shapingEnabled")
|
|
1269
1193
|
def shaping_enabled(self) -> pulumi.Output[Optional[bool]]:
|
|
1270
1194
|
"""
|
|
1271
|
-
|
|
1272
|
-
ports managed by this virtual switch. Default: `false`.
|
|
1195
|
+
Enable traffic shaping on this virtual switch or port group.
|
|
1273
1196
|
"""
|
|
1274
1197
|
return pulumi.get(self, "shaping_enabled")
|
|
1275
1198
|
|
|
@@ -1277,8 +1200,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1277
1200
|
@pulumi.getter(name="shapingPeakBandwidth")
|
|
1278
1201
|
def shaping_peak_bandwidth(self) -> pulumi.Output[Optional[int]]:
|
|
1279
1202
|
"""
|
|
1280
|
-
The peak bandwidth during bursts in
|
|
1281
|
-
bits per second if traffic shaping is enabled. Default: `0`
|
|
1203
|
+
The peak bandwidth during bursts in bits per second if traffic shaping is enabled.
|
|
1282
1204
|
"""
|
|
1283
1205
|
return pulumi.get(self, "shaping_peak_bandwidth")
|
|
1284
1206
|
|
|
@@ -1286,8 +1208,7 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1286
1208
|
@pulumi.getter(name="standbyNics")
|
|
1287
1209
|
def standby_nics(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1288
1210
|
"""
|
|
1289
|
-
|
|
1290
|
-
failover.
|
|
1211
|
+
List of standby network adapters used for failover.
|
|
1291
1212
|
"""
|
|
1292
1213
|
return pulumi.get(self, "standby_nics")
|
|
1293
1214
|
|
|
@@ -1295,9 +1216,8 @@ class HostVirtualSwitch(pulumi.CustomResource):
|
|
|
1295
1216
|
@pulumi.getter(name="teamingPolicy")
|
|
1296
1217
|
def teaming_policy(self) -> pulumi.Output[Optional[str]]:
|
|
1297
1218
|
"""
|
|
1298
|
-
The network adapter teaming policy. Can be one
|
|
1299
|
-
|
|
1300
|
-
`failover_explicit`. Default: `loadbalance_srcid`.
|
|
1219
|
+
The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or
|
|
1220
|
+
failover_explicit.
|
|
1301
1221
|
"""
|
|
1302
1222
|
return pulumi.get(self, "teaming_policy")
|
|
1303
1223
|
|