Package pulumi_vsphere

Pulumi vSphere

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-vsphere repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-vsphere repo.
class pulumi_vsphere.AwaitableGetComputeClusterResult(datacenter_id=None, name=None, resource_pool_id=None, id=None)
class pulumi_vsphere.AwaitableGetCustomAttributeResult(managed_object_type=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetDatacenterResult(name=None, id=None)
class pulumi_vsphere.AwaitableGetDatastoreClusterResult(datacenter_id=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetDatastoreResult(datacenter_id=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetDistributedVirtualSwitchResult(datacenter_id=None, name=None, uplinks=None, id=None)
class pulumi_vsphere.AwaitableGetFolderResult(path=None, id=None)
class pulumi_vsphere.AwaitableGetHostResult(datacenter_id=None, name=None, resource_pool_id=None, id=None)
class pulumi_vsphere.AwaitableGetNetworkResult(datacenter_id=None, name=None, type=None, id=None)
class pulumi_vsphere.AwaitableGetResourcePoolResult(datacenter_id=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetTagCategoryResult(associable_types=None, cardinality=None, description=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetTagResult(category_id=None, description=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetVappContainerResult(datacenter_id=None, name=None, id=None)
class pulumi_vsphere.AwaitableGetVirtualMachineResult(alternate_guest_name=None, datacenter_id=None, disks=None, firmware=None, guest_id=None, name=None, network_interface_types=None, scsi_bus_sharing=None, scsi_controller_scan_count=None, scsi_type=None, id=None)
class pulumi_vsphere.AwaitableGetVmfsDisksResult(disks=None, filter=None, host_system_id=None, rescan=None, id=None)
class pulumi_vsphere.ComputeCluster(resource_name, opts=None, custom_attributes=None, datacenter_id=None, dpm_automation_level=None, dpm_enabled=None, dpm_threshold=None, drs_advanced_options=None, drs_automation_level=None, drs_enable_predictive_drs=None, drs_enable_vm_overrides=None, drs_enabled=None, drs_migration_threshold=None, folder=None, force_evacuate_on_destroy=None, ha_admission_control_failover_host_system_ids=None, ha_admission_control_host_failure_tolerance=None, ha_admission_control_performance_tolerance=None, ha_admission_control_policy=None, ha_admission_control_resource_percentage_auto_compute=None, ha_admission_control_resource_percentage_cpu=None, ha_admission_control_resource_percentage_memory=None, ha_admission_control_slot_policy_explicit_cpu=None, ha_admission_control_slot_policy_explicit_memory=None, ha_admission_control_slot_policy_use_explicit_size=None, ha_advanced_options=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_enabled=None, ha_heartbeat_datastore_ids=None, ha_heartbeat_datastore_policy=None, ha_host_isolation_response=None, ha_host_monitoring=None, ha_vm_component_protection=None, ha_vm_dependency_restart_condition=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_restart_additional_delay=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, host_cluster_exit_timeout=None, host_system_ids=None, name=None, proactive_ha_automation_level=None, proactive_ha_enabled=None, proactive_ha_moderate_remediation=None, proactive_ha_provider_ids=None, proactive_ha_severe_remediation=None, tags=None, __props__=None, __name__=None, __opts__=None)

Create a ComputeCluster resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • custom_attributes (pulumi.Input[dict]) – A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datacenter_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the datacenter to create the cluster in. Forces a new resource if changed.
  • dpm_automation_level (pulumi.Input[str]) – The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
  • dpm_enabled (pulumi.Input[bool]) – Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
  • dpm_threshold (pulumi.Input[float]) – A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
  • drs_advanced_options (pulumi.Input[dict]) – A key/value map that specifies advanced options for DRS and DPM.
  • drs_automation_level (pulumi.Input[str]) – The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
  • drs_enable_predictive_drs (pulumi.Input[bool]) – When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. \*
  • drs_enable_vm_overrides (pulumi.Input[bool]) – Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
  • drs_enabled (pulumi.Input[bool]) – Enable DRS for this cluster. Default: false.
  • drs_migration_threshold (pulumi.Input[float]) – A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
  • ha_admission_control_failover_host_system_ids (pulumi.Input[list]) – Defines the [managed object IDs][docs-about-morefs] of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
  • ha_admission_control_host_failure_tolerance (pulumi.Input[float]) – The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. \*
  • ha_admission_control_performance_tolerance (pulumi.Input[float]) – The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
  • ha_admission_control_policy (pulumi.Input[str]) – The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
  • ha_admission_control_resource_percentage_auto_compute (pulumi.Input[bool]) – Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. \*
  • ha_admission_control_resource_percentage_cpu (pulumi.Input[float]) – Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
  • ha_admission_control_resource_percentage_memory (pulumi.Input[float]) – Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
  • ha_admission_control_slot_policy_explicit_cpu (pulumi.Input[float]) – Controls the user-defined CPU slot size, in MHz. Default: 32.
  • ha_admission_control_slot_policy_explicit_memory (pulumi.Input[float]) – Controls the user-defined memory slot size, in MB. Default: 100.
  • ha_admission_control_slot_policy_use_explicit_size (pulumi.Input[bool]) – Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
  • ha_advanced_options (pulumi.Input[dict]) – A key/value map that specifies advanced options for vSphere HA.
  • ha_datastore_apd_recovery_action (pulumi.Input[str]) – Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. \*
  • ha_datastore_apd_response (pulumi.Input[str]) – Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. \*
  • ha_datastore_apd_response_delay (pulumi.Input[float]) – Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. \*
  • ha_datastore_pdl_response (pulumi.Input[str]) – Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. \*
  • ha_enabled (pulumi.Input[bool]) – Enable vSphere HA for this cluster. Default: false.
  • ha_heartbeat_datastore_ids (pulumi.Input[list]) – The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
  • ha_heartbeat_datastore_policy (pulumi.Input[str]) – The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
  • ha_host_isolation_response (pulumi.Input[str]) – The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
  • ha_host_monitoring (pulumi.Input[str]) – Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
  • ha_vm_component_protection (pulumi.Input[str]) – Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. \*
  • ha_vm_dependency_restart_condition (pulumi.Input[str]) – The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. \*
  • ha_vm_failure_interval (pulumi.Input[float]) – If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
  • ha_vm_maximum_failure_window (pulumi.Input[float]) – The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
  • ha_vm_maximum_resets (pulumi.Input[float]) – The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
  • ha_vm_minimum_uptime (pulumi.Input[float]) – The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
  • ha_vm_monitoring (pulumi.Input[str]) – The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
  • ha_vm_restart_additional_delay (pulumi.Input[float]) – Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). \*
  • ha_vm_restart_priority (pulumi.Input[str]) – The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
  • ha_vm_restart_timeout (pulumi.Input[float]) – The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). \*
  • host_cluster_exit_timeout (pulumi.Input[float]) – The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.
  • name (pulumi.Input[str]) – The name of the cluster.
  • proactive_ha_automation_level (pulumi.Input[str]) – Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. \*
  • proactive_ha_enabled (pulumi.Input[bool]) – Enables Proactive HA. Default: false. \*
  • proactive_ha_moderate_remediation (pulumi.Input[str]) – The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. \*
  • proactive_ha_provider_ids (pulumi.Input[list]) – The list of IDs for health update providers configured for this cluster. \*
  • proactive_ha_severe_remediation (pulumi.Input[str]) – The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. \*
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
custom_attributes = None

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenter_id = None

The [managed object ID][docs-about-morefs] of the datacenter to create the cluster in. Forces a new resource if changed.

dpm_automation_level = None

The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.

dpm_enabled = None

Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.

dpm_threshold = None

A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.

drs_advanced_options = None

A key/value map that specifies advanced options for DRS and DPM.

drs_automation_level = None

The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

drs_enable_predictive_drs = None

When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. \*

drs_enable_vm_overrides = None

Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.

drs_enabled = None

Enable DRS for this cluster. Default: false.

drs_migration_threshold = None

A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.

ha_admission_control_failover_host_system_ids = None

Defines the [managed object IDs][docs-about-morefs] of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.

ha_admission_control_host_failure_tolerance = None

The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. \*

ha_admission_control_performance_tolerance = None

The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).

ha_admission_control_policy = None

The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.

ha_admission_control_resource_percentage_auto_compute = None

Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. \*

ha_admission_control_resource_percentage_cpu = None

Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.

ha_admission_control_resource_percentage_memory = None

Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.

ha_admission_control_slot_policy_explicit_cpu = None

Controls the user-defined CPU slot size, in MHz. Default: 32.

ha_admission_control_slot_policy_explicit_memory = None

Controls the user-defined memory slot size, in MB. Default: 100.

ha_admission_control_slot_policy_use_explicit_size = None

Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.

ha_advanced_options = None

A key/value map that specifies advanced options for vSphere HA.

ha_datastore_apd_recovery_action = None

Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. \*

ha_datastore_apd_response = None

Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. \*

ha_datastore_apd_response_delay = None

Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. \*

ha_datastore_pdl_response = None

Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. \*

ha_enabled = None

Enable vSphere HA for this cluster. Default: false.

ha_heartbeat_datastore_ids = None

The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.

ha_heartbeat_datastore_policy = None

The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.

ha_host_isolation_response = None

The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.

ha_host_monitoring = None

Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.

ha_vm_component_protection = None

Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. \*

ha_vm_dependency_restart_condition = None

The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. \*

ha_vm_failure_interval = None

If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.

ha_vm_maximum_failure_window = None

The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).

ha_vm_maximum_resets = None

The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3

ha_vm_minimum_uptime = None

The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).

ha_vm_monitoring = None

The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.

ha_vm_restart_additional_delay = None

Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). \*

ha_vm_restart_priority = None

The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.

ha_vm_restart_timeout = None

The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). \*

host_cluster_exit_timeout = None

The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).

host_system_ids = None

The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.

name = None

The name of the cluster.

proactive_ha_automation_level = None

Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. \*

proactive_ha_enabled = None

Enables Proactive HA. Default: false. \*

proactive_ha_moderate_remediation = None

The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. \*

proactive_ha_provider_ids = None

The list of IDs for health update providers configured for this cluster. \*

proactive_ha_severe_remediation = None

The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. \*

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

static get(resource_name, id, opts=None, custom_attributes=None, datacenter_id=None, dpm_automation_level=None, dpm_enabled=None, dpm_threshold=None, drs_advanced_options=None, drs_automation_level=None, drs_enable_predictive_drs=None, drs_enable_vm_overrides=None, drs_enabled=None, drs_migration_threshold=None, folder=None, force_evacuate_on_destroy=None, ha_admission_control_failover_host_system_ids=None, ha_admission_control_host_failure_tolerance=None, ha_admission_control_performance_tolerance=None, ha_admission_control_policy=None, ha_admission_control_resource_percentage_auto_compute=None, ha_admission_control_resource_percentage_cpu=None, ha_admission_control_resource_percentage_memory=None, ha_admission_control_slot_policy_explicit_cpu=None, ha_admission_control_slot_policy_explicit_memory=None, ha_admission_control_slot_policy_use_explicit_size=None, ha_advanced_options=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_enabled=None, ha_heartbeat_datastore_ids=None, ha_heartbeat_datastore_policy=None, ha_host_isolation_response=None, ha_host_monitoring=None, ha_vm_component_protection=None, ha_vm_dependency_restart_condition=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_restart_additional_delay=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, host_cluster_exit_timeout=None, host_system_ids=None, name=None, proactive_ha_automation_level=None, proactive_ha_enabled=None, proactive_ha_moderate_remediation=None, proactive_ha_provider_ids=None, proactive_ha_severe_remediation=None, resource_pool_id=None, tags=None)

Get an existing ComputeCluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] custom_attributes: A map of custom attribute ids to attribute

value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
Parameters:
  • datacenter_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the datacenter to create the cluster in. Forces a new resource if changed.
  • dpm_automation_level (pulumi.Input[str]) – The automation level for host power operations in this cluster. Can be one of manual or automated. Default: manual.
  • dpm_enabled (pulumi.Input[bool]) – Enable DPM support for DRS in this cluster. Requires drs_enabled to be true in order to be effective. Default: false.
  • dpm_threshold (pulumi.Input[float]) – A value between 1 and 5 indicating the threshold of load within the cluster that influences host power operations. This affects both power on and power off operations - a lower setting will tolerate more of a surplus/deficit than a higher setting. Default: 3.
  • drs_advanced_options (pulumi.Input[dict]) – A key/value map that specifies advanced options for DRS and DPM.
  • drs_automation_level (pulumi.Input[str]) – The default automation level for all virtual machines in this cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
  • drs_enable_predictive_drs (pulumi.Input[bool]) – When true, enables DRS to use data from [vRealize Operations Manager][ref-vsphere-vro] to make proactive DRS recommendations. \*
  • drs_enable_vm_overrides (pulumi.Input[bool]) – Allow individual DRS overrides to be set for virtual machines in the cluster. Default: true.
  • drs_enabled (pulumi.Input[bool]) – Enable DRS for this cluster. Default: false.
  • drs_migration_threshold (pulumi.Input[float]) – A value between 1 and 5 indicating the threshold of imbalance tolerated between hosts. A lower setting will tolerate more imbalance while a higher setting will tolerate less. Default: 3.
  • ha_admission_control_failover_host_system_ids (pulumi.Input[list]) – Defines the [managed object IDs][docs-about-morefs] of hosts to use as dedicated failover hosts. These hosts are kept as available as possible - admission control will block access to the host, and DRS will ignore the host when making recommendations.
  • ha_admission_control_host_failure_tolerance (pulumi.Input[float]) – The maximum number of failed hosts that admission control tolerates when making decisions on whether to permit virtual machine operations. The maximum is one less than the number of hosts in the cluster. Default: 1. \*
  • ha_admission_control_performance_tolerance (pulumi.Input[float]) – The percentage of resource reduction that a cluster of virtual machines can tolerate in case of a failover. A value of 0 produces warnings only, whereas a value of 100 disables the setting. Default: 100 (disabled).
  • ha_admission_control_policy (pulumi.Input[str]) – The type of admission control policy to use with vSphere HA. Can be one of resourcePercentage, slotPolicy, failoverHosts, or disabled. Default: resourcePercentage.
  • ha_admission_control_resource_percentage_auto_compute (pulumi.Input[bool]) – Automatically determine available resource percentages by subtracting the average number of host resources represented by the ha_admission_control_host_failure_tolerance setting from the total amount of resources in the cluster. Disable to supply user-defined values. Default: true. \*
  • ha_admission_control_resource_percentage_cpu (pulumi.Input[float]) – Controls the user-defined percentage of CPU resources in the cluster to reserve for failover. Default: 100.
  • ha_admission_control_resource_percentage_memory (pulumi.Input[float]) – Controls the user-defined percentage of memory resources in the cluster to reserve for failover. Default: 100.
  • ha_admission_control_slot_policy_explicit_cpu (pulumi.Input[float]) – Controls the user-defined CPU slot size, in MHz. Default: 32.
  • ha_admission_control_slot_policy_explicit_memory (pulumi.Input[float]) – Controls the user-defined memory slot size, in MB. Default: 100.
  • ha_admission_control_slot_policy_use_explicit_size (pulumi.Input[bool]) – Controls whether or not you wish to supply explicit values to CPU and memory slot sizes. The default is false, which tells vSphere to gather a automatic average based on all powered-on virtual machines currently in the cluster.
  • ha_advanced_options (pulumi.Input[dict]) – A key/value map that specifies advanced options for vSphere HA.
  • ha_datastore_apd_recovery_action (pulumi.Input[str]) – Controls the action to take on virtual machines if an APD status on an affected datastore clears in the middle of an APD event. Can be one of none or reset. Default: none. \*
  • ha_datastore_apd_response (pulumi.Input[str]) – Controls the action to take on virtual machines when the cluster has detected loss to all paths to a relevant datastore. Can be one of disabled, warning, restartConservative, or restartAggressive. Default: disabled. \*
  • ha_datastore_apd_response_delay (pulumi.Input[float]) – Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Default: 3 minutes. \*
  • ha_datastore_pdl_response (pulumi.Input[str]) – Controls the action to take on virtual machines when the cluster has detected a permanent device loss to a relevant datastore. Can be one of disabled, warning, or restartAggressive. Default: disabled. \*
  • ha_enabled (pulumi.Input[bool]) – Enable vSphere HA for this cluster. Default: false.
  • ha_heartbeat_datastore_ids (pulumi.Input[list]) – The list of managed object IDs for preferred datastores to use for HA heartbeating. This setting is only useful when ha_heartbeat_datastore_policy is set to either userSelectedDs or allFeasibleDsWithUserPreference.
  • ha_heartbeat_datastore_policy (pulumi.Input[str]) – The selection policy for HA heartbeat datastores. Can be one of allFeasibleDs, userSelectedDs, or allFeasibleDsWithUserPreference. Default: allFeasibleDsWithUserPreference.
  • ha_host_isolation_response (pulumi.Input[str]) – The action to take on virtual machines when a host has detected that it has been isolated from the rest of the cluster. Can be one of none, powerOff, or shutdown. Default: none.
  • ha_host_monitoring (pulumi.Input[str]) – Global setting that controls whether vSphere HA remediates virtual machines on host failure. Can be one of enabled or disabled. Default: enabled.
  • ha_vm_component_protection (pulumi.Input[str]) – Controls vSphere VM component protection for virtual machines in this cluster. Can be one of enabled or disabled. Default: enabled. \*
  • ha_vm_dependency_restart_condition (pulumi.Input[str]) – The condition used to determine whether or not virtual machines in a certain restart priority class are online, allowing HA to move on to restarting virtual machines on the next priority. Can be one of none, poweredOn, guestHbStatusGreen, or appHbStatusGreen. The default is none, which means that a virtual machine is considered ready immediately after a host is found to start it on. \*
  • ha_vm_failure_interval (pulumi.Input[float]) – If a heartbeat from a virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
  • ha_vm_maximum_failure_window (pulumi.Input[float]) – The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
  • ha_vm_maximum_resets (pulumi.Input[float]) – The maximum number of resets that HA will perform to a virtual machine when responding to a failure event. Default: 3
  • ha_vm_minimum_uptime (pulumi.Input[float]) – The time, in seconds, that HA waits after powering on a virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
  • ha_vm_monitoring (pulumi.Input[str]) – The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
  • ha_vm_restart_additional_delay (pulumi.Input[float]) – Additional delay in seconds after ready condition is met. A VM is considered ready at this point. Default: 0 (no delay). \*
  • ha_vm_restart_priority (pulumi.Input[str]) – The default restart priority for affected virtual machines when vSphere detects a host failure. Can be one of lowest, low, medium, high, or highest. Default: medium.
  • ha_vm_restart_timeout (pulumi.Input[float]) – The maximum time, in seconds, that vSphere HA will wait for virtual machines in one priority to be ready before proceeding with the next priority. Default: 600 (10 minutes). \*
  • host_cluster_exit_timeout (pulumi.Input[float]) – The timeout for each host maintenance mode operation when removing hosts from a cluster. The value is specified in seconds. Default: 3600 (1 hour).
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.
  • name (pulumi.Input[str]) – The name of the cluster.
  • proactive_ha_automation_level (pulumi.Input[str]) – Determines how the host quarantine, maintenance mode, or virtual machine migration recommendations made by proactive HA are to be handled. Can be one of Automated or Manual. Default: Manual. \*
  • proactive_ha_enabled (pulumi.Input[bool]) – Enables Proactive HA. Default: false. \*
  • proactive_ha_moderate_remediation (pulumi.Input[str]) – The configured remediation for moderately degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to MaintenanceMode when proactive_ha_severe_remediation is set to QuarantineMode. Default: QuarantineMode. \*
  • proactive_ha_provider_ids (pulumi.Input[list]) – The list of IDs for health update providers configured for this cluster. \*
  • proactive_ha_severe_remediation (pulumi.Input[str]) – The configured remediation for severely degraded hosts. Can be one of MaintenanceMode or QuarantineMode. Note that this cannot be set to QuarantineMode when proactive_ha_moderate_remediation is set to MaintenanceMode. Default: QuarantineMode. \*
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterHostGroup(resource_name, opts=None, compute_cluster_id=None, host_system_ids=None, name=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterHostGroup resource can be used to manage groups of hosts in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

This resource mainly serves as an input to the `.ComputeClusterVmHostRule`` </docs/providers/vsphere/r/compute_cluster_vm_host_rule.html>`_ resource - see the documentation for that resource for further details on how to use host groups.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.
  • name (pulumi.Input[str]) – The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

host_system_ids = None

The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.

name = None

The name of the host group. This must be unique in the cluster. Forces a new resource if changed.

static get(resource_name, id, opts=None, compute_cluster_id=None, host_system_ids=None, name=None)

Get an existing ComputeClusterHostGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
Parameters:
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to put in the cluster.
  • name (pulumi.Input[str]) – The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterVmAffinityRule(resource_name, opts=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterVmAffinityRule resource can be used to manage VM affinity rules in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

This rule can be used to tell a set to virtual machines to run together on a single host within a cluster. When configured, DRS will make a best effort to ensure that the virtual machines run on the same host, or prevent any operation that would keep that from happening, depending on the value of the mandatory flag.

Keep in mind that this rule can only be used to tell VMs to run together on a non-specific host - it can’t be used to pin VMs to a host. For that, see the `.ComputeClusterVmHostRule`` </docs/providers/vsphere/r/compute_cluster_vm_host_rule.html>`_ resource.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on the same host together.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

enabled = None

Enable this rule in the cluster. Default: true.

mandatory = None

When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

name = None

The name of the rule. This must be unique in the cluster.

virtual_machine_ids = None

The UUIDs of the virtual machines to run on the same host together.

static get(resource_name, id, opts=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None)

Get an existing ComputeClusterVmAffinityRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
Parameters:
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on the same host together.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterVmAntiAffinityRule(resource_name, opts=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterVmAntiAffinityRule resource can be used to manage VM anti-affinity rules in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

This rule can be used to tell a set to virtual machines to run on different hosts within a cluster, useful for preventing single points of failure in application cluster scenarios. When configured, DRS will make a best effort to ensure that the virtual machines run on different hosts, or prevent any operation that would keep that from happening, depending on the value of the mandatory flag.

Keep in mind that this rule can only be used to tell VMs to run separately on non-specific hosts - specific hosts cannot be specified with this rule. For that, see the `.ComputeClusterVmHostRule`` </docs/providers/vsphere/r/compute_cluster_vm_host_rule.html>`_ resource.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on hosts different from each other.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

enabled = None

Enable this rule in the cluster. Default: true.

mandatory = None

When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

name = None

The name of the rule. This must be unique in the cluster.

virtual_machine_ids = None

The UUIDs of the virtual machines to run on hosts different from each other.

static get(resource_name, id, opts=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None)

Get an existing ComputeClusterVmAntiAffinityRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
Parameters:
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on hosts different from each other.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterVmDependencyRule(resource_name, opts=None, compute_cluster_id=None, dependency_vm_group_name=None, enabled=None, mandatory=None, name=None, vm_group_name=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterVmDependencyRule resource can be used to manage VM dependency rules in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

A virtual machine dependency rule applies to vSphere HA, and allows user-defined startup orders for virtual machines in the case of host failure. Virtual machines are supplied via groups, which can be managed via the `.ComputeClusterVmGroup`` </docs/providers/vsphere/r/compute_cluster_vm_group.html>`_ resource.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • dependency_vm_group_name (pulumi.Input[str]) – The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • vm_group_name (pulumi.Input[str]) – The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

dependency_vm_group_name = None

The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.

enabled = None

Enable this rule in the cluster. Default: true.

mandatory = None

When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

name = None

The name of the rule. This must be unique in the cluster.

vm_group_name = None

The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

static get(resource_name, id, opts=None, compute_cluster_id=None, dependency_vm_group_name=None, enabled=None, mandatory=None, name=None, vm_group_name=None)

Get an existing ComputeClusterVmDependencyRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
Parameters:
  • dependency_vm_group_name (pulumi.Input[str]) – The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • vm_group_name (pulumi.Input[str]) – The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterVmGroup(resource_name, opts=None, compute_cluster_id=None, name=None, virtual_machine_ids=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterVmGroup resource can be used to manage groups of virtual machines in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

This resource mainly serves as an input to the `.ComputeClusterVmDependencyRule`` </docs/providers/vsphere/r/compute_cluster_vm_dependency_rule.html>`_ and `.ComputeClusterVmHostRule`` </docs/providers/vsphere/r/compute_cluster_vm_host_rule.html>`_ resources. See the individual resource documentation pages for more information.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the VM group. This must be unique in the cluster. Forces a new resource if changed.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines in this group.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

name = None

The name of the VM group. This must be unique in the cluster. Forces a new resource if changed.

virtual_machine_ids = None

The UUIDs of the virtual machines in this group.

static get(resource_name, id, opts=None, compute_cluster_id=None, name=None, virtual_machine_ids=None)

Get an existing ComputeClusterVmGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
Parameters:
  • name (pulumi.Input[str]) – The name of the VM group. This must be unique in the cluster. Forces a new resource if changed.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines in this group.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ComputeClusterVmHostRule(resource_name, opts=None, affinity_host_group_name=None, anti_affinity_host_group_name=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, vm_group_name=None, __props__=None, __name__=None, __opts__=None)

The .ComputeClusterVmHostRule resource can be used to manage VM-to-host rules in a cluster, either created by the `.ComputeCluster`` </docs/providers/vsphere/r/compute_cluster.html>`_ resource or looked up by the `.ComputeCluster`` </docs/providers/vsphere/d/compute_cluster.html>`_ data source.

This resource can create both affinity rules, where virtual machines run on specified hosts, or anti-affinity rules, where virtual machines run on hosts outside of the ones specified in the rule. Virtual machines and hosts are supplied via groups, which can be managed via the `.ComputeClusterVmGroup`` </docs/providers/vsphere/r/compute_cluster_vm_group.html>`_ and `.ComputeClusterHostGroup`` </docs/providers/vsphere/r/compute_cluster_host_group.html>`_ resources.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • affinity_host_group_name (pulumi.Input[str]) – When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.
  • anti_affinity_host_group_name (pulumi.Input[str]) – When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • vm_group_name (pulumi.Input[str]) – The name of the virtual machine group to use with this rule.
affinity_host_group_name = None

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

anti_affinity_host_group_name = None

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.

enabled = None

Enable this rule in the cluster. Default: true.

mandatory = None

When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

name = None

The name of the rule. This must be unique in the cluster.

vm_group_name = None

The name of the virtual machine group to use with this rule.

static get(resource_name, id, opts=None, affinity_host_group_name=None, anti_affinity_host_group_name=None, compute_cluster_id=None, enabled=None, mandatory=None, name=None, vm_group_name=None)

Get an existing ComputeClusterVmHostRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] affinity_host_group_name: When this field is used, the virtual

machines defined in vm_group_name will be run on the hosts defined in this host group.
Parameters:
  • anti_affinity_host_group_name (pulumi.Input[str]) – When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the group in. Forces a new resource if changed.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • vm_group_name (pulumi.Input[str]) – The name of the virtual machine group to use with this rule.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.CustomAttribute(resource_name, opts=None, managed_object_type=None, name=None, __props__=None, __name__=None, __opts__=None)

The .CustomAttribute resource can be used to create and manage custom attributes, which allow users to associate user-specific meta-information with vSphere managed objects. Custom attribute values must be strings and are stored on the vCenter Server and not the managed object.

For more information about custom attributes, click here.

NOTE: Custom attributes are unsupported on direct ESXi connections and require vCenter.

The following table will help you determine what value you need to enter for the managed object type you want the attribute to apply to.

Note that if you want a attribute to apply to all objects, leave the type unspecified.

TypeValue
Folders`Folder`
Clusters`ClusterComputeResource`
Datacenters`Datacenter`
Datastores`Datastore`
Datastore Clusters`StoragePod`
DVS Portgroups`DistributedVirtualPortgroup`
Distributed vSwitches`DistributedVirtualSwitch`
`VmwareDistributedVirtualSwitch`
Hosts`HostSystem`
Content Libraries`com.vmware.content.Library`
Content Library Items`com.vmware.content.library.Item`
Networks`HostNetwork`
`Network`
`OpaqueNetwork`
Resource Pools`ResourcePool`
vApps`VirtualApp`
Virtual Machines`VirtualMachine`
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • managed_object_type (pulumi.Input[str]) – The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, click here. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the custom attribute.
managed_object_type = None

The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, click here. Forces a new resource if changed.

name = None

The name of the custom attribute.

static get(resource_name, id, opts=None, managed_object_type=None, name=None)

Get an existing CustomAttribute resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] managed_object_type: The object type that this attribute may be

applied to. If not set, the custom attribute may be applied to any object type. For a full list, click here. Forces a new resource if changed.
Parameters:name (pulumi.Input[str]) – The name of the custom attribute.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.Datacenter(resource_name, opts=None, custom_attributes=None, folder=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a VMware vSphere datacenter resource. This can be used as the primary container of inventory objects such as hosts and virtual machines.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to value strings to set for datacenter resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • folder (pulumi.Input[str]) – The folder where the datacenter should be created. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the datacenter. This name needs to be unique within the folder. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
custom_attributes = None

Map of custom attribute ids to value strings to set for datacenter resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

folder = None

The folder where the datacenter should be created. Forces a new resource if changed.

moid = None

[Managed object ID][docs-about-morefs] of this datacenter.

name = None

The name of the datacenter. This name needs to be unique within the folder. Forces a new resource if changed.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

static get(resource_name, id, opts=None, custom_attributes=None, folder=None, moid=None, name=None, tags=None)

Get an existing Datacenter resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] custom_attributes: Map of custom attribute ids to value

strings to set for datacenter resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
Parameters:
  • folder (pulumi.Input[str]) – The folder where the datacenter should be created. Forces a new resource if changed.
  • moid (pulumi.Input[str]) – [Managed object ID][docs-about-morefs] of this datacenter.
  • name (pulumi.Input[str]) – The name of the datacenter. This name needs to be unique within the folder. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DatastoreCluster(resource_name, opts=None, custom_attributes=None, datacenter_id=None, folder=None, name=None, sdrs_advanced_options=None, sdrs_automation_level=None, sdrs_default_intra_vm_affinity=None, sdrs_enabled=None, sdrs_free_space_threshold=None, sdrs_free_space_threshold_mode=None, sdrs_free_space_utilization_difference=None, sdrs_io_balance_automation_level=None, sdrs_io_latency_threshold=None, sdrs_io_load_balance_enabled=None, sdrs_io_load_imbalance_threshold=None, sdrs_io_reservable_iops_threshold=None, sdrs_io_reservable_percent_threshold=None, sdrs_io_reservable_threshold_mode=None, sdrs_load_balance_interval=None, sdrs_policy_enforcement_automation_level=None, sdrs_rule_enforcement_automation_level=None, sdrs_space_balance_automation_level=None, sdrs_space_utilization_threshold=None, sdrs_vm_evacuation_automation_level=None, tags=None, __props__=None, __name__=None, __opts__=None)

The .DatastoreCluster resource can be used to create and manage datastore clusters. This can be used to create groups of datastores with a shared management interface, allowing for resource control and load balancing through Storage DRS.

For more information on vSphere datastore clusters and Storage DRS, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: Storage DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • custom_attributes (pulumi.Input[dict]) – A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datacenter_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the datacenter to create the datastore cluster in. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the datastore cluster.
  • sdrs_automation_level (pulumi.Input[str]) – The global automation level for all virtual machines in this datastore cluster. Default: manual.
  • sdrs_default_intra_vm_affinity (pulumi.Input[bool]) – When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.
  • sdrs_enabled (pulumi.Input[bool]) – Enable Storage DRS for this datastore cluster. Default: false.
  • sdrs_free_space_threshold (pulumi.Input[float]) – The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.
  • sdrs_free_space_utilization_difference (pulumi.Input[float]) – The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.
  • sdrs_io_balance_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting I/O load imbalances.
  • sdrs_io_latency_threshold (pulumi.Input[float]) – The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.
  • sdrs_io_load_balance_enabled (pulumi.Input[bool]) – Enable I/O load balancing for this datastore cluster. Default: true.
  • sdrs_io_load_imbalance_threshold (pulumi.Input[float]) – The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.
  • sdrs_io_reservable_iops_threshold (pulumi.Input[float]) – The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.
  • sdrs_io_reservable_percent_threshold (pulumi.Input[float]) – The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.
  • sdrs_io_reservable_threshold_mode (pulumi.Input[str]) – The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.
  • sdrs_load_balance_interval (pulumi.Input[float]) – The storage DRS poll interval, in minutes. Default: 480 minutes.
  • sdrs_policy_enforcement_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting storage and VM policy violations.
  • sdrs_rule_enforcement_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting affinity rule violations.
  • sdrs_space_balance_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting disk space imbalances.
  • sdrs_vm_evacuation_automation_level (pulumi.Input[str]) – Overrides the default automation settings when generating recommendations for datastore evacuation.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
custom_attributes = None

A map of custom attribute ids to attribute value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenter_id = None

The [managed object ID][docs-about-morefs] of the datacenter to create the datastore cluster in. Forces a new resource if changed.

name = None

The name of the datastore cluster.

sdrs_automation_level = None

The global automation level for all virtual machines in this datastore cluster. Default: manual.

sdrs_default_intra_vm_affinity = None

When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.

sdrs_enabled = None

Enable Storage DRS for this datastore cluster. Default: false.

sdrs_free_space_threshold = None

The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.

sdrs_free_space_utilization_difference = None

The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.

sdrs_io_balance_automation_level = None

Overrides the default automation settings when correcting I/O load imbalances.

sdrs_io_latency_threshold = None

The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.

sdrs_io_load_balance_enabled = None

Enable I/O load balancing for this datastore cluster. Default: true.

sdrs_io_load_imbalance_threshold = None

The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.

sdrs_io_reservable_iops_threshold = None

The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.

sdrs_io_reservable_percent_threshold = None

The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.

sdrs_io_reservable_threshold_mode = None

The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.

sdrs_load_balance_interval = None

The storage DRS poll interval, in minutes. Default: 480 minutes.

sdrs_policy_enforcement_automation_level = None

Overrides the default automation settings when correcting storage and VM policy violations.

sdrs_rule_enforcement_automation_level = None

Overrides the default automation settings when correcting affinity rule violations.

sdrs_space_balance_automation_level = None

Overrides the default automation settings when correcting disk space imbalances.

sdrs_vm_evacuation_automation_level = None

Overrides the default automation settings when generating recommendations for datastore evacuation.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

static get(resource_name, id, opts=None, custom_attributes=None, datacenter_id=None, folder=None, name=None, sdrs_advanced_options=None, sdrs_automation_level=None, sdrs_default_intra_vm_affinity=None, sdrs_enabled=None, sdrs_free_space_threshold=None, sdrs_free_space_threshold_mode=None, sdrs_free_space_utilization_difference=None, sdrs_io_balance_automation_level=None, sdrs_io_latency_threshold=None, sdrs_io_load_balance_enabled=None, sdrs_io_load_imbalance_threshold=None, sdrs_io_reservable_iops_threshold=None, sdrs_io_reservable_percent_threshold=None, sdrs_io_reservable_threshold_mode=None, sdrs_load_balance_interval=None, sdrs_policy_enforcement_automation_level=None, sdrs_rule_enforcement_automation_level=None, sdrs_space_balance_automation_level=None, sdrs_space_utilization_threshold=None, sdrs_vm_evacuation_automation_level=None, tags=None)

Get an existing DatastoreCluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] custom_attributes: A map of custom attribute ids to attribute

value strings to set for the datastore cluster. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
Parameters:
  • datacenter_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the datacenter to create the datastore cluster in. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the datastore cluster.
  • sdrs_automation_level (pulumi.Input[str]) – The global automation level for all virtual machines in this datastore cluster. Default: manual.
  • sdrs_default_intra_vm_affinity (pulumi.Input[bool]) – When true, all disks in a single virtual machine will be kept on the same datastore. Default: true.
  • sdrs_enabled (pulumi.Input[bool]) – Enable Storage DRS for this datastore cluster. Default: false.
  • sdrs_free_space_threshold (pulumi.Input[float]) – The free space threshold to use. When set to utilization, drs_space_utilization_threshold is used, and when set to freeSpace, drs_free_space_threshold is used. Default: utilization.
  • sdrs_free_space_utilization_difference (pulumi.Input[float]) – The threshold, in percent, of difference between space utilization in datastores before storage DRS makes decisions to balance the space. Default: 5 percent.
  • sdrs_io_balance_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting I/O load imbalances.
  • sdrs_io_latency_threshold (pulumi.Input[float]) – The I/O latency threshold, in milliseconds, that storage DRS uses to make recommendations to move disks from this datastore. Default: 15 seconds.
  • sdrs_io_load_balance_enabled (pulumi.Input[bool]) – Enable I/O load balancing for this datastore cluster. Default: true.
  • sdrs_io_load_imbalance_threshold (pulumi.Input[float]) – The difference between load in datastores in the cluster before storage DRS makes recommendations to balance the load. Default: 5 percent.
  • sdrs_io_reservable_iops_threshold (pulumi.Input[float]) – The threshold of reservable IOPS of all virtual machines on the datastore before storage DRS makes recommendations to move VMs off of a datastore. Note that this setting should only be set if sdrs_io_reservable_percent_threshold cannot make an accurate estimate of the capacity of the datastores in your cluster, and should be set to roughly 50-60% of the worst case peak performance of the backing LUNs.
  • sdrs_io_reservable_percent_threshold (pulumi.Input[float]) – The threshold, in percent, of actual estimated performance of the datastore (in IOPS) that storage DRS uses to make recommendations to move VMs off of a datastore when the total reservable IOPS exceeds the threshold. Default: 60 percent.
  • sdrs_io_reservable_threshold_mode (pulumi.Input[str]) – The reservable IOPS threshold setting to use, sdrs_io_reservable_percent_threshold in the event of automatic, or sdrs_io_reservable_iops_threshold in the event of manual. Default: automatic.
  • sdrs_load_balance_interval (pulumi.Input[float]) – The storage DRS poll interval, in minutes. Default: 480 minutes.
  • sdrs_policy_enforcement_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting storage and VM policy violations.
  • sdrs_rule_enforcement_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting affinity rule violations.
  • sdrs_space_balance_automation_level (pulumi.Input[str]) – Overrides the default automation settings when correcting disk space imbalances.
  • sdrs_vm_evacuation_automation_level (pulumi.Input[str]) – Overrides the default automation settings when generating recommendations for datastore evacuation.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DatastoreClusterVmAntiAffinityRule(resource_name, opts=None, datastore_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None, __props__=None, __name__=None, __opts__=None)

The .DatastoreClusterVmAntiAffinityRule resource can be used to manage VM anti-affinity rules in a datastore cluster, either created by the `.DatastoreCluster`` </docs/providers/vsphere/r/datastore_cluster.html>`_ resource or looked up by the `.DatastoreCluster`` </docs/providers/vsphere/d/datastore_cluster.html>`_ data source.

This rule can be used to tell a set to virtual machines to run on different datastores within a cluster, useful for preventing single points of failure in application cluster scenarios. When configured, Storage DRS will make a best effort to ensure that the virtual machines run on different datastores, or prevent any operation that would keep that from happening, depending on the value of the mandatory flag.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: Storage DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the datastore cluster to put the group in. Forces a new resource if changed.
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on different datastores from each other.
datastore_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the datastore cluster to put the group in. Forces a new resource if changed.

enabled = None

Enable this rule in the cluster. Default: true.

mandatory = None

When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

name = None

The name of the rule. This must be unique in the cluster.

virtual_machine_ids = None

The UUIDs of the virtual machines to run on different datastores from each other.

static get(resource_name, id, opts=None, datastore_cluster_id=None, enabled=None, mandatory=None, name=None, virtual_machine_ids=None)

Get an existing DatastoreClusterVmAntiAffinityRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] datastore_cluster_id: The [managed object reference

ID][docs-about-morefs] of the datastore cluster to put the group in. Forces a new resource if changed.
Parameters:
  • enabled (pulumi.Input[bool]) – Enable this rule in the cluster. Default: true.
  • mandatory (pulumi.Input[bool]) – When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
  • name (pulumi.Input[str]) – The name of the rule. This must be unique in the cluster.
  • virtual_machine_ids (pulumi.Input[list]) – The UUIDs of the virtual machines to run on different datastores from each other.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DistributedPortGroup(resource_name, opts=None, active_uplinks=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, auto_expand=None, block_all_ports=None, block_override_allowed=None, check_beacon=None, custom_attributes=None, description=None, directpath_gen2_allowed=None, distributed_virtual_switch_uuid=None, egress_shaping_average_bandwidth=None, egress_shaping_burst_size=None, egress_shaping_enabled=None, egress_shaping_peak_bandwidth=None, failback=None, ingress_shaping_average_bandwidth=None, ingress_shaping_burst_size=None, ingress_shaping_enabled=None, ingress_shaping_peak_bandwidth=None, lacp_enabled=None, lacp_mode=None, live_port_moving_allowed=None, name=None, netflow_enabled=None, netflow_override_allowed=None, network_resource_pool_key=None, network_resource_pool_override_allowed=None, notify_switches=None, number_of_ports=None, port_config_reset_at_disconnect=None, port_name_format=None, port_private_secondary_vlan_id=None, security_policy_override_allowed=None, shaping_override_allowed=None, standby_uplinks=None, tags=None, teaming_policy=None, traffic_filter_override_allowed=None, tx_uplink=None, type=None, uplink_teaming_override_allowed=None, vlan_id=None, vlan_override_allowed=None, vlan_ranges=None, __props__=None, __name__=None, __opts__=None)

The .DistributedPortGroup resource can be used to manage vSphere distributed virtual port groups. These port groups are connected to distributed virtual switches, which can be managed by the `.DistributedVirtualSwitch`` </docs/providers/vsphere/r/distributed_virtual_switch.html>`_ resource.

Distributed port groups can be used as networks for virtual machines, allowing VMs to use the networking supplied by a distributed virtual switch (DVS), with a set of policies that apply to that individual newtork, if desired.

For an overview on vSphere networking concepts, see this page. For more information on vSphere DVS portgroups, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • auto_expand (pulumi.Input[bool]) – Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.
  • block_override_allowed (pulumi.Input[bool]) – Allow the [port shutdown policy][port-shutdown-policy] to be overridden on an individual port.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value string to set for port group. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • description (pulumi.Input[str]) – An optional description for the port group.
  • distributed_virtual_switch_uuid (pulumi.Input[str]) – The ID of the DVS to add the port group to. Forces a new resource if changed.
  • live_port_moving_allowed (pulumi.Input[bool]) – Allow a port in this port group to be moved to another port group while it is connected.
  • name (pulumi.Input[str]) – The name of the port group.
  • netflow_override_allowed (pulumi.Input[bool]) – Allow the [Netflow policy][netflow-policy] on this port group to be overridden on an individual port.
  • network_resource_pool_key (pulumi.Input[str]) – The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
  • network_resource_pool_override_allowed (pulumi.Input[bool]) – Allow the network resource pool set on this port group to be overridden on an individual port.
  • number_of_ports (pulumi.Input[float]) – The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
  • port_config_reset_at_disconnect (pulumi.Input[bool]) – Reset a port’s settings to the settings defined on this port group policy when the port disconnects.
  • port_name_format (pulumi.Input[str]) – An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed [here][ext-vsphere-portname-format] for details on the format syntax.
  • security_policy_override_allowed (pulumi.Input[bool]) – Allow the [security policy settings][sec-policy-settings] defined in this port group policy to be overridden on an individual port.
  • shaping_override_allowed (pulumi.Input[bool]) – Allow the [traffic shaping options][traffic-shaping-settings] on this port group policy to be overridden on an individual port.
  • traffic_filter_override_allowed (pulumi.Input[bool]) – Allow any traffic filters on this port group to be overridden on an individual port.
  • type (pulumi.Input[str]) – The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
  • uplink_teaming_override_allowed (pulumi.Input[bool]) – Allow the [uplink teaming options][uplink-teaming-settings] on this port group to be overridden on an individual port.
  • vlan_override_allowed (pulumi.Input[bool]) – Allow the [VLAN settings][vlan-settings] on this port group to be overridden on an individual port.
auto_expand = None

Allows the port group to create additional ports past the limit specified in number_of_ports if necessary. Default: true.

block_override_allowed = None

Allow the [port shutdown policy][port-shutdown-policy] to be overridden on an individual port.

custom_attributes = None

Map of custom attribute ids to attribute value string to set for port group. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

description = None

An optional description for the port group.

distributed_virtual_switch_uuid = None

The ID of the DVS to add the port group to. Forces a new resource if changed.

live_port_moving_allowed = None

Allow a port in this port group to be moved to another port group while it is connected.

name = None

The name of the port group.

netflow_override_allowed = None

Allow the [Netflow policy][netflow-policy] on this port group to be overridden on an individual port.

network_resource_pool_key = None

The key of a network resource pool to associate with this port group. The default is -1, which implies no association.

network_resource_pool_override_allowed = None

Allow the network resource pool set on this port group to be overridden on an individual port.

number_of_ports = None

The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.

port_config_reset_at_disconnect = None

Reset a port’s settings to the settings defined on this port group policy when the port disconnects.

port_name_format = None

An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed [here][ext-vsphere-portname-format] for details on the format syntax.

security_policy_override_allowed = None

Allow the [security policy settings][sec-policy-settings] defined in this port group policy to be overridden on an individual port.

shaping_override_allowed = None

Allow the [traffic shaping options][traffic-shaping-settings] on this port group policy to be overridden on an individual port.

traffic_filter_override_allowed = None

Allow any traffic filters on this port group to be overridden on an individual port.

type = None

The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.

Allow the [uplink teaming options][uplink-teaming-settings] on this port group to be overridden on an individual port.

vlan_override_allowed = None

Allow the [VLAN settings][vlan-settings] on this port group to be overridden on an individual port.

static get(resource_name, id, opts=None, active_uplinks=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, auto_expand=None, block_all_ports=None, block_override_allowed=None, check_beacon=None, config_version=None, custom_attributes=None, description=None, directpath_gen2_allowed=None, distributed_virtual_switch_uuid=None, egress_shaping_average_bandwidth=None, egress_shaping_burst_size=None, egress_shaping_enabled=None, egress_shaping_peak_bandwidth=None, failback=None, ingress_shaping_average_bandwidth=None, ingress_shaping_burst_size=None, ingress_shaping_enabled=None, ingress_shaping_peak_bandwidth=None, key=None, lacp_enabled=None, lacp_mode=None, live_port_moving_allowed=None, name=None, netflow_enabled=None, netflow_override_allowed=None, network_resource_pool_key=None, network_resource_pool_override_allowed=None, notify_switches=None, number_of_ports=None, port_config_reset_at_disconnect=None, port_name_format=None, port_private_secondary_vlan_id=None, security_policy_override_allowed=None, shaping_override_allowed=None, standby_uplinks=None, tags=None, teaming_policy=None, traffic_filter_override_allowed=None, tx_uplink=None, type=None, uplink_teaming_override_allowed=None, vlan_id=None, vlan_override_allowed=None, vlan_ranges=None)

Get an existing DistributedPortGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] auto_expand: Allows the port group to create additional ports

past the limit specified in number_of_ports if necessary. Default: true.
Parameters:
  • block_override_allowed (pulumi.Input[bool]) – Allow the [port shutdown policy][port-shutdown-policy] to be overridden on an individual port.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value string to set for port group. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • description (pulumi.Input[str]) – An optional description for the port group.
  • distributed_virtual_switch_uuid (pulumi.Input[str]) – The ID of the DVS to add the port group to. Forces a new resource if changed.
  • live_port_moving_allowed (pulumi.Input[bool]) – Allow a port in this port group to be moved to another port group while it is connected.
  • name (pulumi.Input[str]) – The name of the port group.
  • netflow_override_allowed (pulumi.Input[bool]) – Allow the [Netflow policy][netflow-policy] on this port group to be overridden on an individual port.
  • network_resource_pool_key (pulumi.Input[str]) – The key of a network resource pool to associate with this port group. The default is -1, which implies no association.
  • network_resource_pool_override_allowed (pulumi.Input[bool]) – Allow the network resource pool set on this port group to be overridden on an individual port.
  • number_of_ports (pulumi.Input[float]) – The number of ports available on this port group. Cannot be decreased below the amount of used ports on the port group.
  • port_config_reset_at_disconnect (pulumi.Input[bool]) – Reset a port’s settings to the settings defined on this port group policy when the port disconnects.
  • port_name_format (pulumi.Input[str]) – An optional formatting policy for naming of the ports in this port group. See the portNameFormat attribute listed [here][ext-vsphere-portname-format] for details on the format syntax.
  • security_policy_override_allowed (pulumi.Input[bool]) – Allow the [security policy settings][sec-policy-settings] defined in this port group policy to be overridden on an individual port.
  • shaping_override_allowed (pulumi.Input[bool]) – Allow the [traffic shaping options][traffic-shaping-settings] on this port group policy to be overridden on an individual port.
  • traffic_filter_override_allowed (pulumi.Input[bool]) – Allow any traffic filters on this port group to be overridden on an individual port.
  • type (pulumi.Input[str]) – The port group type. Can be one of earlyBinding (static binding) or ephemeral. Default: earlyBinding.
  • uplink_teaming_override_allowed (pulumi.Input[bool]) – Allow the [uplink teaming options][uplink-teaming-settings] on this port group to be overridden on an individual port.
  • vlan_override_allowed (pulumi.Input[bool]) – Allow the [VLAN settings][vlan-settings] on this port group to be overridden on an individual port.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DistributedVirtualSwitch(resource_name, opts=None, active_uplinks=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, block_all_ports=None, check_beacon=None, contact_detail=None, contact_name=None, custom_attributes=None, datacenter_id=None, description=None, directpath_gen2_allowed=None, egress_shaping_average_bandwidth=None, egress_shaping_burst_size=None, egress_shaping_enabled=None, egress_shaping_peak_bandwidth=None, failback=None, faulttolerance_maximum_mbit=None, faulttolerance_reservation_mbit=None, faulttolerance_share_count=None, faulttolerance_share_level=None, folder=None, hbr_maximum_mbit=None, hbr_reservation_mbit=None, hbr_share_count=None, hbr_share_level=None, hosts=None, ingress_shaping_average_bandwidth=None, ingress_shaping_burst_size=None, ingress_shaping_enabled=None, ingress_shaping_peak_bandwidth=None, ipv4_address=None, iscsi_maximum_mbit=None, iscsi_reservation_mbit=None, iscsi_share_count=None, iscsi_share_level=None, lacp_api_version=None, lacp_enabled=None, lacp_mode=None, link_discovery_operation=None, link_discovery_protocol=None, management_maximum_mbit=None, management_reservation_mbit=None, management_share_count=None, management_share_level=None, max_mtu=None, multicast_filtering_mode=None, name=None, netflow_active_flow_timeout=None, netflow_collector_ip_address=None, netflow_collector_port=None, netflow_enabled=None, netflow_idle_flow_timeout=None, netflow_internal_flows_only=None, netflow_observation_domain_id=None, netflow_sampling_rate=None, network_resource_control_enabled=None, network_resource_control_version=None, nfs_maximum_mbit=None, nfs_reservation_mbit=None, nfs_share_count=None, nfs_share_level=None, notify_switches=None, port_private_secondary_vlan_id=None, standby_uplinks=None, tags=None, teaming_policy=None, tx_uplink=None, uplinks=None, vdp_maximum_mbit=None, vdp_reservation_mbit=None, vdp_share_count=None, vdp_share_level=None, version=None, virtualmachine_maximum_mbit=None, virtualmachine_reservation_mbit=None, virtualmachine_share_count=None, virtualmachine_share_level=None, vlan_id=None, vlan_ranges=None, vmotion_maximum_mbit=None, vmotion_reservation_mbit=None, vmotion_share_count=None, vmotion_share_level=None, vsan_maximum_mbit=None, vsan_reservation_mbit=None, vsan_share_count=None, vsan_share_level=None, __props__=None, __name__=None, __opts__=None)

The .DistributedVirtualSwitch resource can be used to manage VMware Distributed Virtual Switches.

An essential component of a distributed, scalable VMware datacenter, the vSphere Distributed Virtual Switch (DVS) provides centralized management and monitoring of the networking configuration of all the hosts that are associated with the switch. In addition to adding port groups (see the `.DistributedPortGroup`` </docs/providers/vsphere/r/distributed_port_group.html>`_ resource) that can be used as networks for virtual machines, a DVS can be configured to perform advanced high availability, traffic shaping, network monitoring, and more.

For an overview on vSphere networking concepts, see this page. For more information on vSphere DVS, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • active_uplinks (pulumi.Input[list]) – 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.
  • allow_forged_transmits (pulumi.Input[bool]) – Controls whether or not a virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
  • allow_mac_changes (pulumi.Input[bool]) – Controls whether or not the Media Access Control (MAC) address can be changed.
  • allow_promiscuous (pulumi.Input[bool]) – Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
  • block_all_ports (pulumi.Input[bool]) – Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.
  • check_beacon (pulumi.Input[bool]) – Enables beacon probing as an additional measure to detect NIC failure.
  • contact_detail (pulumi.Input[str]) – The detailed contact information for the person who is responsible for the DVS.
  • contact_name (pulumi.Input[str]) – The name of the person who is responsible for the DVS.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set for virtual switch. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datacenter_id (pulumi.Input[str]) – The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.
  • description (pulumi.Input[str]) – A detailed description for the DVS.
  • directpath_gen2_allowed (pulumi.Input[bool]) – Allow VMDirectPath Gen2 for the ports for which this policy applies to.
  • egress_shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if egress traffic shaping is enabled on the port.
  • egress_shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.
  • egress_shaping_enabled (pulumi.Input[bool]) – true if the traffic shaper is enabled on the port for egress traffic.
  • egress_shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
  • failback (pulumi.Input[bool]) – If true, the teaming policy will re-activate failed uplinks higher in precedence when they come back up.
  • folder (pulumi.Input[str]) – The folder to create the DVS in. Forces a new resource if changed.
  • hosts (pulumi.Input[list]) – Use the host block to declare a host specification. The options are:
  • ingress_shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.
  • ingress_shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.
  • ingress_shaping_enabled (pulumi.Input[bool]) – true if the traffic shaper is enabled on the port for ingress traffic.
  • ingress_shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
  • ipv4_address (pulumi.Input[str]) – An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.
  • lacp_api_version (pulumi.Input[str]) – The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.
  • lacp_enabled (pulumi.Input[bool]) – Enables LACP for the ports that this policy applies to.
  • lacp_mode (pulumi.Input[str]) – The LACP mode. Can be one of active or passive.
  • link_discovery_operation (pulumi.Input[str]) – Whether to advertise or listen for link discovery traffic.
  • link_discovery_protocol (pulumi.Input[str]) – The discovery protocol type. Valid types are cdp and lldp.
  • max_mtu (pulumi.Input[float]) – The maximum transmission unit (MTU) for the virtual switch.
  • multicast_filtering_mode (pulumi.Input[str]) – The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.
  • name (pulumi.Input[str]) – The name of the distributed virtual switch.
  • netflow_active_flow_timeout (pulumi.Input[float]) – The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.
  • netflow_collector_ip_address (pulumi.Input[str]) – 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.
  • netflow_collector_port (pulumi.Input[float]) – Port for the Netflow collector. This must be set before Netflow can be enabled.
  • netflow_enabled (pulumi.Input[bool]) – Enables Netflow on all ports that this policy applies to.
  • netflow_idle_flow_timeout (pulumi.Input[float]) – The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.
  • netflow_internal_flows_only (pulumi.Input[bool]) – Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.
  • netflow_observation_domain_id (pulumi.Input[float]) – The observation domain ID for the Netflow collector.
  • netflow_sampling_rate (pulumi.Input[float]) – 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%.
  • network_resource_control_enabled (pulumi.Input[bool]) – Set to true to enable network I/O control. Default: false.
  • network_resource_control_version (pulumi.Input[str]) – The version of network I/O control to use. Can be one of version2 or version3. Default: version2.
  • notify_switches (pulumi.Input[bool]) – If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.
  • port_private_secondary_vlan_id (pulumi.Input[float]) – Used to define a secondary VLAN ID when using private VLANs.
  • standby_uplinks (pulumi.Input[list]) – 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.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • teaming_policy (pulumi.Input[str]) – The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.
  • tx_uplink (pulumi.Input[bool]) – Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.
  • uplinks (pulumi.Input[list]) – 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.
  • version (pulumi.Input[str]) –
    • 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.

  • vlan_ranges (pulumi.Input[list]) – 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:

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.

allow_forged_transmits = None

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

allow_mac_changes = None

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

allow_promiscuous = None

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

block_all_ports = None

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

check_beacon = None

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

contact_detail = None

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

contact_name = None

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

custom_attributes = None

Map of custom attribute ids to attribute value strings to set for virtual switch. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenter_id = None

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

description = None

A detailed description for the DVS.

directpath_gen2_allowed = None

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

egress_shaping_average_bandwidth = None

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

egress_shaping_burst_size = None

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

egress_shaping_enabled = None

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

egress_shaping_peak_bandwidth = None

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

failback = None

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

folder = None

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

hosts = None

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

ingress_shaping_average_bandwidth = None

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

ingress_shaping_burst_size = None

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

ingress_shaping_enabled = None

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

ingress_shaping_peak_bandwidth = None

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

ipv4_address = None

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

lacp_api_version = None

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

lacp_enabled = None

Enables LACP for the ports that this policy applies to.

lacp_mode = None

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

Whether to advertise or listen for link discovery traffic.

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

max_mtu = None

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

multicast_filtering_mode = None

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

name = None

The name of the distributed virtual switch.

netflow_active_flow_timeout = None

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

netflow_collector_ip_address = None

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.

netflow_collector_port = None

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

netflow_enabled = None

Enables Netflow on all ports that this policy applies to.

netflow_idle_flow_timeout = None

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

netflow_internal_flows_only = None

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

netflow_observation_domain_id = None

The observation domain ID for the Netflow collector.

netflow_sampling_rate = None

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%.

network_resource_control_enabled = None

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

network_resource_control_version = None

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

notify_switches = None

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

port_private_secondary_vlan_id = None

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

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.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

teaming_policy = None

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

Forward all traffic transmitted by ports for which this policy applies to its DVS 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.

version = None
  • 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.
vlan_ranges = None

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:

static get(resource_name, id, opts=None, active_uplinks=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, block_all_ports=None, check_beacon=None, config_version=None, contact_detail=None, contact_name=None, custom_attributes=None, datacenter_id=None, description=None, directpath_gen2_allowed=None, egress_shaping_average_bandwidth=None, egress_shaping_burst_size=None, egress_shaping_enabled=None, egress_shaping_peak_bandwidth=None, failback=None, faulttolerance_maximum_mbit=None, faulttolerance_reservation_mbit=None, faulttolerance_share_count=None, faulttolerance_share_level=None, folder=None, hbr_maximum_mbit=None, hbr_reservation_mbit=None, hbr_share_count=None, hbr_share_level=None, hosts=None, ingress_shaping_average_bandwidth=None, ingress_shaping_burst_size=None, ingress_shaping_enabled=None, ingress_shaping_peak_bandwidth=None, ipv4_address=None, iscsi_maximum_mbit=None, iscsi_reservation_mbit=None, iscsi_share_count=None, iscsi_share_level=None, lacp_api_version=None, lacp_enabled=None, lacp_mode=None, link_discovery_operation=None, link_discovery_protocol=None, management_maximum_mbit=None, management_reservation_mbit=None, management_share_count=None, management_share_level=None, max_mtu=None, multicast_filtering_mode=None, name=None, netflow_active_flow_timeout=None, netflow_collector_ip_address=None, netflow_collector_port=None, netflow_enabled=None, netflow_idle_flow_timeout=None, netflow_internal_flows_only=None, netflow_observation_domain_id=None, netflow_sampling_rate=None, network_resource_control_enabled=None, network_resource_control_version=None, nfs_maximum_mbit=None, nfs_reservation_mbit=None, nfs_share_count=None, nfs_share_level=None, notify_switches=None, port_private_secondary_vlan_id=None, standby_uplinks=None, tags=None, teaming_policy=None, tx_uplink=None, uplinks=None, vdp_maximum_mbit=None, vdp_reservation_mbit=None, vdp_share_count=None, vdp_share_level=None, version=None, virtualmachine_maximum_mbit=None, virtualmachine_reservation_mbit=None, virtualmachine_share_count=None, virtualmachine_share_level=None, vlan_id=None, vlan_ranges=None, vmotion_maximum_mbit=None, vmotion_reservation_mbit=None, vmotion_share_count=None, vmotion_share_level=None, vsan_maximum_mbit=None, vsan_reservation_mbit=None, vsan_share_count=None, vsan_share_level=None)

Get an existing DistributedVirtualSwitch resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] active_uplinks: 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.
Parameters:
  • allow_forged_transmits (pulumi.Input[bool]) – Controls whether or not a virtual network adapter is allowed to send network traffic with a different MAC address than that of its own.
  • allow_mac_changes (pulumi.Input[bool]) – Controls whether or not the Media Access Control (MAC) address can be changed.
  • allow_promiscuous (pulumi.Input[bool]) – Enable promiscuous mode on the network. This flag indicates whether or not all traffic is seen on a given port.
  • block_all_ports (pulumi.Input[bool]) – Shuts down all ports in the port groups that this policy applies to, effectively blocking all network access to connected virtual devices.
  • check_beacon (pulumi.Input[bool]) – Enables beacon probing as an additional measure to detect NIC failure.
  • contact_detail (pulumi.Input[str]) – The detailed contact information for the person who is responsible for the DVS.
  • contact_name (pulumi.Input[str]) – The name of the person who is responsible for the DVS.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set for virtual switch. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datacenter_id (pulumi.Input[str]) – The ID of the datacenter where the distributed virtual switch will be created. Forces a new resource if changed.
  • description (pulumi.Input[str]) – A detailed description for the DVS.
  • directpath_gen2_allowed (pulumi.Input[bool]) – Allow VMDirectPath Gen2 for the ports for which this policy applies to.
  • egress_shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if egress traffic shaping is enabled on the port.
  • egress_shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if egress traffic shaping is enabled on the port.
  • egress_shaping_enabled (pulumi.Input[bool]) – true if the traffic shaper is enabled on the port for egress traffic.
  • egress_shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if egress traffic shaping is enabled on the port.
  • failback (pulumi.Input[bool]) – If true, the teaming policy will re-activate failed uplinks higher in precedence when they come back up.
  • folder (pulumi.Input[str]) – The folder to create the DVS in. Forces a new resource if changed.
  • hosts (pulumi.Input[list]) – Use the host block to declare a host specification. The options are:
  • ingress_shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if ingress traffic shaping is enabled on the port.
  • ingress_shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if ingress traffic shaping is enabled on the port.
  • ingress_shaping_enabled (pulumi.Input[bool]) – true if the traffic shaper is enabled on the port for ingress traffic.
  • ingress_shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if ingress traffic shaping is enabled on the port.
  • ipv4_address (pulumi.Input[str]) – An IPv4 address to identify the switch. This is mostly useful when used with the Netflow arguments found below.
  • lacp_api_version (pulumi.Input[str]) – The Link Aggregation Control Protocol group version to use with the switch. Possible values are singleLag and multipleLag.
  • lacp_enabled (pulumi.Input[bool]) – Enables LACP for the ports that this policy applies to.
  • lacp_mode (pulumi.Input[str]) – The LACP mode. Can be one of active or passive.
  • link_discovery_operation (pulumi.Input[str]) – Whether to advertise or listen for link discovery traffic.
  • link_discovery_protocol (pulumi.Input[str]) – The discovery protocol type. Valid types are cdp and lldp.
  • max_mtu (pulumi.Input[float]) – The maximum transmission unit (MTU) for the virtual switch.
  • multicast_filtering_mode (pulumi.Input[str]) – The multicast filtering mode to use with the switch. Can be one of legacyFiltering or snooping.
  • name (pulumi.Input[str]) – The name of the distributed virtual switch.
  • netflow_active_flow_timeout (pulumi.Input[float]) – The number of seconds after which active flows are forced to be exported to the collector. Allowed range is 60 to 3600. Default: 60.
  • netflow_collector_ip_address (pulumi.Input[str]) – 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.
  • netflow_collector_port (pulumi.Input[float]) – Port for the Netflow collector. This must be set before Netflow can be enabled.
  • netflow_enabled (pulumi.Input[bool]) – Enables Netflow on all ports that this policy applies to.
  • netflow_idle_flow_timeout (pulumi.Input[float]) – The number of seconds after which idle flows are forced to be exported to the collector. Allowed range is 10 to 600. Default: 15.
  • netflow_internal_flows_only (pulumi.Input[bool]) – Whether to limit analysis to traffic that has both source and destination served by the same host. Default: false.
  • netflow_observation_domain_id (pulumi.Input[float]) – The observation domain ID for the Netflow collector.
  • netflow_sampling_rate (pulumi.Input[float]) – 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%.
  • network_resource_control_enabled (pulumi.Input[bool]) – Set to true to enable network I/O control. Default: false.
  • network_resource_control_version (pulumi.Input[str]) – The version of network I/O control to use. Can be one of version2 or version3. Default: version2.
  • notify_switches (pulumi.Input[bool]) – If true, the teaming policy will notify the broadcast network of an uplink failover, triggering cache updates.
  • port_private_secondary_vlan_id (pulumi.Input[float]) – Used to define a secondary VLAN ID when using private VLANs.
  • standby_uplinks (pulumi.Input[list]) – 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.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • teaming_policy (pulumi.Input[str]) – The uplink teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit.
  • tx_uplink (pulumi.Input[bool]) – Forward all traffic transmitted by ports for which this policy applies to its DVS uplinks.
  • uplinks (pulumi.Input[list]) – 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.
  • version (pulumi.Input[str]) –
    • 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.

  • vlan_ranges (pulumi.Input[list]) – 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:
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DpmHostOverride(resource_name, opts=None, compute_cluster_id=None, dpm_automation_level=None, dpm_enabled=None, host_system_id=None, __props__=None, __name__=None, __opts__=None)

The .DpmHostOverride resource can be used to add a DPM override to a cluster for a particular host. This allows you to control the power management settings for individual hosts in the cluster while leaving any unspecified ones at the default power management settings.

For more information on DPM within vSphere clusters, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
  • dpm_automation_level (pulumi.Input[str]) – The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
  • dpm_enabled (pulumi.Input[bool]) – Enable DPM support for this host. Default: false.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.

dpm_automation_level = None

The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.

dpm_enabled = None

Enable DPM support for this host. Default: false.

static get(resource_name, id, opts=None, compute_cluster_id=None, dpm_automation_level=None, dpm_enabled=None, host_system_id=None)

Get an existing DpmHostOverride resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
Parameters:
  • dpm_automation_level (pulumi.Input[str]) – The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
  • dpm_enabled (pulumi.Input[bool]) – Enable DPM support for this host. Default: false.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.DrsVmOverride(resource_name, opts=None, compute_cluster_id=None, drs_automation_level=None, drs_enabled=None, virtual_machine_id=None, __props__=None, __name__=None, __opts__=None)

The .DrsVmOverride resource can be used to add a DRS override to a cluster for a specific virtual machine. With this resource, one can enable or disable DRS and control the automation level for a single virtual machine without affecting the rest of the cluster.

For more information on vSphere clusters and DRS, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
  • drs_automation_level (pulumi.Input[str]) – Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
  • drs_enabled (pulumi.Input[bool]) – Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.

drs_automation_level = None

Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

drs_enabled = None

Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.

virtual_machine_id = None

The UUID of the virtual machine to create the override for. Forces a new resource if changed.

static get(resource_name, id, opts=None, compute_cluster_id=None, drs_automation_level=None, drs_enabled=None, virtual_machine_id=None)

Get an existing DrsVmOverride resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
Parameters:
  • drs_automation_level (pulumi.Input[str]) – Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.
  • drs_enabled (pulumi.Input[bool]) – Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.File(resource_name, opts=None, create_directories=None, datacenter=None, datastore=None, destination_file=None, source_datacenter=None, source_datastore=None, source_file=None, __props__=None, __name__=None, __opts__=None)

Create a File resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • create_directories (pulumi.Input[bool]) – Create directories in destination_file path parameter if any missing for copy operation.
  • datacenter (pulumi.Input[str]) – The name of a datacenter in which the file will be uploaded to.
  • datastore (pulumi.Input[str]) – The name of the datastore in which to upload the file to.
  • destination_file (pulumi.Input[str]) – The path to where the file should be uploaded or copied to on vSphere.
  • source_datacenter (pulumi.Input[str]) – The name of a datacenter in which the file will be copied from. Forces a new resource if changed.
  • source_datastore (pulumi.Input[str]) – The name of the datastore in which file will be copied from. Forces a new resource if changed.
create_directories = None

Create directories in destination_file path parameter if any missing for copy operation.

datacenter = None

The name of a datacenter in which the file will be uploaded to.

datastore = None

The name of the datastore in which to upload the file to.

destination_file = None

The path to where the file should be uploaded or copied to on vSphere.

source_datacenter = None

The name of a datacenter in which the file will be copied from. Forces a new resource if changed.

source_datastore = None

The name of the datastore in which file will be copied from. Forces a new resource if changed.

static get(resource_name, id, opts=None, create_directories=None, datacenter=None, datastore=None, destination_file=None, source_datacenter=None, source_datastore=None, source_file=None)

Get an existing File resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] create_directories: Create directories in destination_file

path parameter if any missing for copy operation.
Parameters:
  • datacenter (pulumi.Input[str]) – The name of a datacenter in which the file will be uploaded to.
  • datastore (pulumi.Input[str]) – The name of the datastore in which to upload the file to.
  • destination_file (pulumi.Input[str]) – The path to where the file should be uploaded or copied to on vSphere.
  • source_datacenter (pulumi.Input[str]) – The name of a datacenter in which the file will be copied from. Forces a new resource if changed.
  • source_datastore (pulumi.Input[str]) – The name of the datastore in which file will be copied from. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.Folder(resource_name, opts=None, custom_attributes=None, datacenter_id=None, path=None, tags=None, type=None, __props__=None, __name__=None, __opts__=None)

The .Folder resource can be used to manage vSphere inventory folders. The resource supports creating folders of the 5 major types - datacenter folders, host and cluster folders, virtual machine folders, datastore folders, and network folders.

Paths are always relative to the specific type of folder you are creating. Subfolders are discovered by parsing the relative path specified in path, so foo/bar will create a folder named bar in the parent folder foo, as long as that folder exists.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set for folder. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datacenter_id (pulumi.Input[str]) – The ID of the datacenter the folder will be created in. Required for all folder types except for datacenter folders. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • type (pulumi.Input[str]) – The type of folder to create. Allowed options are datacenter for datacenter folders, host for host and cluster folders, vm for virtual machine folders, datastore for datastore folders, and network for network folders. Forces a new resource if changed.
custom_attributes = None

Map of custom attribute ids to attribute value strings to set for folder. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datacenter_id = None

The ID of the datacenter the folder will be created in. Required for all folder types except for datacenter folders. Forces a new resource if changed.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

type = None

The type of folder to create. Allowed options are datacenter for datacenter folders, host for host and cluster folders, vm for virtual machine folders, datastore for datastore folders, and network for network folders. Forces a new resource if changed.

static get(resource_name, id, opts=None, custom_attributes=None, datacenter_id=None, path=None, tags=None, type=None)

Get an existing Folder resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] custom_attributes: Map of custom attribute ids to attribute

value strings to set for folder. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
Parameters:
  • datacenter_id (pulumi.Input[str]) – The ID of the datacenter the folder will be created in. Required for all folder types except for datacenter folders. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • type (pulumi.Input[str]) – The type of folder to create. Allowed options are datacenter for datacenter folders, host for host and cluster folders, vm for virtual machine folders, datastore for datastore folders, and network for network folders. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.GetComputeClusterResult(datacenter_id=None, name=None, resource_pool_id=None, id=None)

A collection of values returned by getComputeCluster.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetCustomAttributeResult(managed_object_type=None, name=None, id=None)

A collection of values returned by getCustomAttribute.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetDatacenterResult(name=None, id=None)

A collection of values returned by getDatacenter.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetDatastoreClusterResult(datacenter_id=None, name=None, id=None)

A collection of values returned by getDatastoreCluster.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetDatastoreResult(datacenter_id=None, name=None, id=None)

A collection of values returned by getDatastore.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetDistributedVirtualSwitchResult(datacenter_id=None, name=None, uplinks=None, id=None)

A collection of values returned by getDistributedVirtualSwitch.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetFolderResult(path=None, id=None)

A collection of values returned by getFolder.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetHostResult(datacenter_id=None, name=None, resource_pool_id=None, id=None)

A collection of values returned by getHost.

resource_pool_id = None

The [managed object ID][docs-about-morefs] of the host’s root resource pool.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetNetworkResult(datacenter_id=None, name=None, type=None, id=None)

A collection of values returned by getNetwork.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetResourcePoolResult(datacenter_id=None, name=None, id=None)

A collection of values returned by getResourcePool.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetTagCategoryResult(associable_types=None, cardinality=None, description=None, name=None, id=None)

A collection of values returned by getTagCategory.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetTagResult(category_id=None, description=None, name=None, id=None)

A collection of values returned by getTag.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetVappContainerResult(datacenter_id=None, name=None, id=None)

A collection of values returned by getVappContainer.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetVirtualMachineResult(alternate_guest_name=None, datacenter_id=None, disks=None, firmware=None, guest_id=None, name=None, network_interface_types=None, scsi_bus_sharing=None, scsi_controller_scan_count=None, scsi_type=None, id=None)

A collection of values returned by getVirtualMachine.

alternate_guest_name = None

The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.

disks = None

Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a .VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:

firmware = None

The firmware type for this virtual machine. Can be bios or efi.

guest_id = None

The guest ID of the virtual machine or template.

network_interface_types = None

The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, or vmxnet3.

scsi_bus_sharing = None

Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.

scsi_type = None

The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.GetVmfsDisksResult(disks=None, filter=None, host_system_id=None, rescan=None, id=None)

A collection of values returned by getVmfsDisks.

disks = None

A lexicographically sorted list of devices discovered by the operation, matching the supplied filter, if provided.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_vsphere.HaVmOverride(resource_name, opts=None, compute_cluster_id=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_host_isolation_response=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_monitoring_use_cluster_defaults=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, virtual_machine_id=None, __props__=None, __name__=None, __opts__=None)

The .HaVmOverride resource can be used to add an override for vSphere HA settings on a cluster for a specific virtual machine. With this resource, one can control specific HA settings so that they are different than the cluster default, accommodating the needs of that specific virtual machine, while not affecting the rest of the cluster.

For more information on vSphere HA, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • compute_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
  • ha_datastore_apd_recovery_action (pulumi.Input[str]) – Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset. Default: useClusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_apd_response (pulumi.Input[str]) – Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_apd_response_delay (pulumi.Input[float]) – Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Use -1 to use the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_pdl_response (pulumi.Input[str]) – Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_host_isolation_response (pulumi.Input[str]) – The action to take on this virtual machine when a host has detected that it has been isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown. Default: clusterIsolationResponse.
  • ha_vm_failure_interval (pulumi.Input[float]) – If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
  • ha_vm_maximum_failure_window (pulumi.Input[float]) – The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
  • ha_vm_maximum_resets (pulumi.Input[float]) – The maximum number of resets that HA will perform to this virtual machine when responding to a failure event. Default: 3
  • ha_vm_minimum_uptime (pulumi.Input[float]) – The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
  • ha_vm_monitoring (pulumi.Input[str]) – The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
  • ha_vm_monitoring_use_cluster_defaults (pulumi.Input[bool]) – Determines whether or not the cluster’s default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
  • ha_vm_restart_priority (pulumi.Input[str]) – The restart priority for the virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest. Default: clusterRestartPriority.
  • ha_vm_restart_timeout (pulumi.Input[float]) – The maximum time, in seconds, that vSphere HA will wait for this virtual machine to be ready. Use -1 to specify the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
compute_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.

ha_datastore_apd_recovery_action = None

Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset. Default: useClusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]

ha_datastore_apd_response = None

Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]

ha_datastore_apd_response_delay = None

Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Use -1 to use the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]

ha_datastore_pdl_response = None

Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]

ha_host_isolation_response = None

The action to take on this virtual machine when a host has detected that it has been isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown. Default: clusterIsolationResponse.

ha_vm_failure_interval = None

If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.

ha_vm_maximum_failure_window = None

The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).

ha_vm_maximum_resets = None

The maximum number of resets that HA will perform to this virtual machine when responding to a failure event. Default: 3

ha_vm_minimum_uptime = None

The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).

ha_vm_monitoring = None

The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.

ha_vm_monitoring_use_cluster_defaults = None

Determines whether or not the cluster’s default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.

ha_vm_restart_priority = None

The restart priority for the virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest. Default: clusterRestartPriority.

ha_vm_restart_timeout = None

The maximum time, in seconds, that vSphere HA will wait for this virtual machine to be ready. Use -1 to specify the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]

virtual_machine_id = None

The UUID of the virtual machine to create the override for. Forces a new resource if changed.

static get(resource_name, id, opts=None, compute_cluster_id=None, ha_datastore_apd_recovery_action=None, ha_datastore_apd_response=None, ha_datastore_apd_response_delay=None, ha_datastore_pdl_response=None, ha_host_isolation_response=None, ha_vm_failure_interval=None, ha_vm_maximum_failure_window=None, ha_vm_maximum_resets=None, ha_vm_minimum_uptime=None, ha_vm_monitoring=None, ha_vm_monitoring_use_cluster_defaults=None, ha_vm_restart_priority=None, ha_vm_restart_timeout=None, virtual_machine_id=None)

Get an existing HaVmOverride resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] compute_cluster_id: The [managed object reference

ID][docs-about-morefs] of the cluster to put the override in. Forces a new resource if changed.
Parameters:
  • ha_datastore_apd_recovery_action (pulumi.Input[str]) – Controls the action to take on this virtual machine if an APD status on an affected datastore clears in the middle of an APD event. Can be one of useClusterDefault, none or reset. Default: useClusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_apd_response (pulumi.Input[str]) – Controls the action to take on this virtual machine when the cluster has detected loss to all paths to a relevant datastore. Can be one of clusterDefault, disabled, warning, restartConservative, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_apd_response_delay (pulumi.Input[float]) – Controls the delay in minutes to wait after an APD timeout event to execute the response action defined in ha_datastore_apd_response. Use -1 to use the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_datastore_pdl_response (pulumi.Input[str]) – Controls the action to take on this virtual machine when the cluster has detected a permanent device loss to a relevant datastore. Can be one of clusterDefault, disabled, warning, or restartAggressive. Default: clusterDefault. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • ha_host_isolation_response (pulumi.Input[str]) – The action to take on this virtual machine when a host has detected that it has been isolated from the rest of the cluster. Can be one of clusterIsolationResponse, none, powerOff, or shutdown. Default: clusterIsolationResponse.
  • ha_vm_failure_interval (pulumi.Input[float]) – If a heartbeat from this virtual machine is not received within this configured interval, the virtual machine is marked as failed. The value is in seconds. Default: 30.
  • ha_vm_maximum_failure_window (pulumi.Input[float]) – The length of the reset window in which ha_vm_maximum_resets can operate. When this window expires, no more resets are attempted regardless of the setting configured in ha_vm_maximum_resets. -1 means no window, meaning an unlimited reset time is allotted. The value is specified in seconds. Default: -1 (no window).
  • ha_vm_maximum_resets (pulumi.Input[float]) – The maximum number of resets that HA will perform to this virtual machine when responding to a failure event. Default: 3
  • ha_vm_minimum_uptime (pulumi.Input[float]) – The time, in seconds, that HA waits after powering on this virtual machine before monitoring for heartbeats. Default: 120 (2 minutes).
  • ha_vm_monitoring (pulumi.Input[str]) – The type of virtual machine monitoring to use when HA is enabled in the cluster. Can be one of vmMonitoringDisabled, vmMonitoringOnly, or vmAndAppMonitoring. Default: vmMonitoringDisabled.
  • ha_vm_monitoring_use_cluster_defaults (pulumi.Input[bool]) – Determines whether or not the cluster’s default settings or the VM override settings specified in this resource are used for virtual machine monitoring. The default is true (use cluster defaults) - set to false to have overrides take effect.
  • ha_vm_restart_priority (pulumi.Input[str]) – The restart priority for the virtual machine when vSphere detects a host failure. Can be one of clusterRestartPriority, lowest, low, medium, high, or highest. Default: clusterRestartPriority.
  • ha_vm_restart_timeout (pulumi.Input[float]) – The maximum time, in seconds, that vSphere HA will wait for this virtual machine to be ready. Use -1 to specify the cluster default. Default: -1. [\*][tf-vsphere-cluster-resource-version-restrictions]
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.HostPortGroup(resource_name, opts=None, active_nics=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, check_beacon=None, failback=None, host_system_id=None, name=None, notify_switches=None, shaping_average_bandwidth=None, shaping_burst_size=None, shaping_enabled=None, shaping_peak_bandwidth=None, standby_nics=None, teaming_policy=None, virtual_switch_name=None, vlan_id=None, __props__=None, __name__=None, __opts__=None)

The .HostPortGroup resource can be used to manage vSphere standard port groups on an ESXi host. These port groups are connected to standard virtual switches, which can be managed by the `.HostVirtualSwitch`` </docs/providers/vsphere/r/host_virtual_switch.html>`_ resource.

For an overview on vSphere networking concepts, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • host_system_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the port group up on. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the port group. Forces a new resource if changed.
  • virtual_switch_name (pulumi.Input[str]) – The name of the virtual switch to bind this port group to. Forces a new resource if changed.
  • vlan_id (pulumi.Input[float]) – The VLAN ID/trunk mode for this port group. An ID of 0 denotes no tagging, an ID of 1-4094 tags with the specific ID, and an ID of 4095 enables trunk mode, allowing the guest to manage its own tagging. Default: 0.
computed_policy = None

A map with a full set of the [policy options][host-vswitch-policy-options] computed from defaults and overrides, explaining the effective policy for this port group.

host_system_id = None

The [managed object ID][docs-about-morefs] of the host to set the port group up on. Forces a new resource if changed.

key = None

The key for this port group as returned from the vSphere API.

name = None

The name of the port group. Forces a new resource if changed.

ports = None

A list of ports that currently exist and are used on this port group.

virtual_switch_name = None

The name of the virtual switch to bind this port group to. Forces a new resource if changed.

vlan_id = None

The VLAN ID/trunk mode for this port group. An ID of 0 denotes no tagging, an ID of 1-4094 tags with the specific ID, and an ID of 4095 enables trunk mode, allowing the guest to manage its own tagging. Default: 0.

static get(resource_name, id, opts=None, active_nics=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, check_beacon=None, computed_policy=None, failback=None, host_system_id=None, key=None, name=None, notify_switches=None, ports=None, shaping_average_bandwidth=None, shaping_burst_size=None, shaping_enabled=None, shaping_peak_bandwidth=None, standby_nics=None, teaming_policy=None, virtual_switch_name=None, vlan_id=None)

Get an existing HostPortGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[dict] computed_policy: A map with a full set of the [policy

options][host-vswitch-policy-options] computed from defaults and overrides, explaining the effective policy for this port group.
Parameters:
  • host_system_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the port group up on. Forces a new resource if changed.
  • key (pulumi.Input[str]) – The key for this port group as returned from the vSphere API.
  • name (pulumi.Input[str]) – The name of the port group. Forces a new resource if changed.
  • ports (pulumi.Input[dict]) – A list of ports that currently exist and are used on this port group.
  • virtual_switch_name (pulumi.Input[str]) – The name of the virtual switch to bind this port group to. Forces a new resource if changed.
  • vlan_id (pulumi.Input[float]) – The VLAN ID/trunk mode for this port group. An ID of 0 denotes no tagging, an ID of 1-4094 tags with the specific ID, and an ID of 4095 enables trunk mode, allowing the guest to manage its own tagging. Default: 0.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.HostVirtualSwitch(resource_name, opts=None, active_nics=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, beacon_interval=None, check_beacon=None, failback=None, host_system_id=None, link_discovery_operation=None, link_discovery_protocol=None, mtu=None, name=None, network_adapters=None, notify_switches=None, number_of_ports=None, shaping_average_bandwidth=None, shaping_burst_size=None, shaping_enabled=None, shaping_peak_bandwidth=None, standby_nics=None, teaming_policy=None, __props__=None, __name__=None, __opts__=None)

The .HostVirtualSwitch resource can be used to manage vSphere standard switches on an ESXi host. These switches can be used as a backing for standard port groups, which can be managed by the `.HostPortGroup`` </docs/providers/vsphere/r/host_port_group.html>`_ resource.

For an overview on vSphere networking concepts, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • active_nics (pulumi.Input[list]) – The list of active network adapters used for load balancing.
  • allow_forged_transmits (pulumi.Input[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 (pulumi.Input[bool]) – Controls whether or not the Media Access Control (MAC) address can be changed. Default: true.
  • allow_promiscuous (pulumi.Input[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 (pulumi.Input[float]) – 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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the virtual switch up on. Forces a new resource if changed.
  • link_discovery_operation (pulumi.Input[str]) – Whether to advertise or listen for link discovery traffic. Default: listen.
  • link_discovery_protocol (pulumi.Input[str]) – The discovery protocol type. Valid types are cpd and lldp. Default: cdp.
  • mtu (pulumi.Input[float]) – The maximum transmission unit (MTU) for the virtual switch. Default: 1500.
  • name (pulumi.Input[str]) – The name of the virtual switch. Forces a new resource if changed.
  • network_adapters (pulumi.Input[list]) – The network interfaces to bind to the bridge.
  • notify_switches (pulumi.Input[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 (pulumi.Input[float]) – The number of ports to create with this virtual switch. Default: 128.
  • shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if traffic shaping is enabled. Default: 0
  • shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if shaping is enabled. Default: 0
  • shaping_enabled (pulumi.Input[bool]) – Set to true to enable the traffic shaper for ports managed by this virtual switch. Default: false.
  • shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if traffic shaping is enabled. Default: 0
  • standby_nics (pulumi.Input[list]) – The list of standby network adapters used for failover.
  • teaming_policy (pulumi.Input[str]) – The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit. Default: loadbalance_srcid.
active_nics = None

The list of active network adapters used for load balancing.

allow_forged_transmits = None

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 = None

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

allow_promiscuous = None

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

beacon_interval = None

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 = None

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 = None

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 = None

The [managed object ID][docs-about-morefs] of the host to set the virtual switch up on. Forces a new resource if changed.

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

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

mtu = None

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

name = None

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

network_adapters = None

The network interfaces to bind to the bridge.

notify_switches = None

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

number_of_ports = None

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

shaping_average_bandwidth = None

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

shaping_burst_size = None

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

shaping_enabled = None

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

shaping_peak_bandwidth = None

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

standby_nics = None

The list of standby network adapters used for failover.

teaming_policy = None

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

static get(resource_name, id, opts=None, active_nics=None, allow_forged_transmits=None, allow_mac_changes=None, allow_promiscuous=None, beacon_interval=None, check_beacon=None, failback=None, host_system_id=None, link_discovery_operation=None, link_discovery_protocol=None, mtu=None, name=None, network_adapters=None, notify_switches=None, number_of_ports=None, shaping_average_bandwidth=None, shaping_burst_size=None, shaping_enabled=None, shaping_peak_bandwidth=None, standby_nics=None, teaming_policy=None)

Get an existing HostVirtualSwitch resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] active_nics: The list of active network adapters used for load

balancing.
Parameters:
  • allow_forged_transmits (pulumi.Input[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 (pulumi.Input[bool]) – Controls whether or not the Media Access Control (MAC) address can be changed. Default: true.
  • allow_promiscuous (pulumi.Input[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 (pulumi.Input[float]) – 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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the virtual switch up on. Forces a new resource if changed.
  • link_discovery_operation (pulumi.Input[str]) – Whether to advertise or listen for link discovery traffic. Default: listen.
  • link_discovery_protocol (pulumi.Input[str]) – The discovery protocol type. Valid types are cpd and lldp. Default: cdp.
  • mtu (pulumi.Input[float]) – The maximum transmission unit (MTU) for the virtual switch. Default: 1500.
  • name (pulumi.Input[str]) – The name of the virtual switch. Forces a new resource if changed.
  • network_adapters (pulumi.Input[list]) – The network interfaces to bind to the bridge.
  • notify_switches (pulumi.Input[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 (pulumi.Input[float]) – The number of ports to create with this virtual switch. Default: 128.
  • shaping_average_bandwidth (pulumi.Input[float]) – The average bandwidth in bits per second if traffic shaping is enabled. Default: 0
  • shaping_burst_size (pulumi.Input[float]) – The maximum burst size allowed in bytes if shaping is enabled. Default: 0
  • shaping_enabled (pulumi.Input[bool]) – Set to true to enable the traffic shaper for ports managed by this virtual switch. Default: false.
  • shaping_peak_bandwidth (pulumi.Input[float]) – The peak bandwidth during bursts in bits per second if traffic shaping is enabled. Default: 0
  • standby_nics (pulumi.Input[list]) – The list of standby network adapters used for failover.
  • teaming_policy (pulumi.Input[str]) – The network adapter teaming policy. Can be one of loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, or failover_explicit. Default: loadbalance_srcid.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.License(resource_name, opts=None, labels=None, license_key=None, __props__=None, __name__=None, __opts__=None)

Provides a VMware vSphere license resource. This can be used to add and remove license keys.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • labels (pulumi.Input[dict]) – A map of key/value pairs to be attached as labels (tags) to the license key.
  • license_key (pulumi.Input[str]) – The license key to add.
edition_key = None

The product edition of the license key.

labels = None

A map of key/value pairs to be attached as labels (tags) to the license key.

license_key = None

The license key to add.

name = None

The display name for the license.

total = None

Total number of units (example: CPUs) contained in the license.

used = None

The number of units (example: CPUs) assigned to this license.

static get(resource_name, id, opts=None, edition_key=None, labels=None, license_key=None, name=None, total=None, used=None)

Get an existing License resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] edition_key: The product edition of the license key. :param pulumi.Input[dict] labels: A map of key/value pairs to be attached as labels (tags) to the license key. :param pulumi.Input[str] license_key: The license key to add. :param pulumi.Input[str] name: The display name for the license. :param pulumi.Input[float] total: Total number of units (example: CPUs) contained in the license. :param pulumi.Input[float] used: The number of units (example: CPUs) assigned to this license.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.NasDatastore(resource_name, opts=None, access_mode=None, custom_attributes=None, datastore_cluster_id=None, folder=None, host_system_ids=None, name=None, remote_hosts=None, remote_path=None, security_type=None, tags=None, type=None, __props__=None, __name__=None, __opts__=None)

The .NasDatastore resource can be used to create and manage NAS datastores on an ESXi host or a set of hosts. The resource supports mounting NFS v3 and v4.1 shares to be used as datastores.

NOTE: Unlike `.VmfsDatastore`` </docs/providers/vsphere/r/vmfs_datastore.html>`_, a NAS datastore is only mounted on the hosts you choose to mount it on. To mount on multiple hosts, you must specify each host that you want to add in the host_system_ids argument.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • access_mode (pulumi.Input[str]) – Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set on datasource resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to mount the datastore on.
  • name (pulumi.Input[str]) – The name of the datastore. Forces a new resource if changed.
  • remote_hosts (pulumi.Input[list]) – The hostnames or IP addresses of the remote server or servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
  • remote_path (pulumi.Input[str]) – The remote path of the mount point. Forces a new resource if changed.
  • security_type (pulumi.Input[str]) – The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • type (pulumi.Input[str]) – The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
access_mode = None

Access mode for the mount point. Can be one of readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.

accessible = None

The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.

capacity = None

Maximum capacity of the datastore, in megabytes.

custom_attributes = None

Map of custom attribute ids to attribute value strings to set on datasource resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datastore_cluster_id = None

The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.

free_space = None

Available space of this datastore, in megabytes.

host_system_ids = None

The [managed object IDs][docs-about-morefs] of the hosts to mount the datastore on.

maintenance_mode = None

The current maintenance mode state of the datastore.

multiple_host_access = None

If true, more than one host in the datacenter has been configured with access to the datastore.

name = None

The name of the datastore. Forces a new resource if changed.

protocol_endpoint = None

Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.

remote_hosts = None

The hostnames or IP addresses of the remote server or servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.

remote_path = None

The remote path of the mount point. Forces a new resource if changed.

security_type = None

The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

type = None

The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.

uncommitted_space = None

Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.

url = None

The unique locator for the datastore.

static get(resource_name, id, opts=None, access_mode=None, accessible=None, capacity=None, custom_attributes=None, datastore_cluster_id=None, folder=None, free_space=None, host_system_ids=None, maintenance_mode=None, multiple_host_access=None, name=None, protocol_endpoint=None, remote_hosts=None, remote_path=None, security_type=None, tags=None, type=None, uncommitted_space=None, url=None)

Get an existing NasDatastore resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] access_mode: Access mode for the mount point. Can be one of

readOnly or readWrite. Note that readWrite does not necessarily mean that the datastore will be read-write depending on the permissions of the actual share. Default: readWrite. Forces a new resource if changed.
Parameters:
  • accessible (pulumi.Input[bool]) – The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.
  • capacity (pulumi.Input[float]) – Maximum capacity of the datastore, in megabytes.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set on datasource resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.
  • free_space (pulumi.Input[float]) – Available space of this datastore, in megabytes.
  • host_system_ids (pulumi.Input[list]) – The [managed object IDs][docs-about-morefs] of the hosts to mount the datastore on.
  • maintenance_mode (pulumi.Input[str]) – The current maintenance mode state of the datastore.
  • multiple_host_access (pulumi.Input[bool]) – If true, more than one host in the datacenter has been configured with access to the datastore.
  • name (pulumi.Input[str]) – The name of the datastore. Forces a new resource if changed.
  • protocol_endpoint (pulumi.Input[str]) – Indicates that this NAS volume is a protocol endpoint. This field is only populated if the host supports virtual datastores.
  • remote_hosts (pulumi.Input[list]) – The hostnames or IP addresses of the remote server or servers. Only one element should be present for NFS v3 but multiple can be present for NFS v4.1. Forces a new resource if changed.
  • remote_path (pulumi.Input[str]) – The remote path of the mount point. Forces a new resource if changed.
  • security_type (pulumi.Input[str]) – The security type to use when using NFS v4.1. Can be one of AUTH_SYS, SEC_KRB5, or SEC_KRB5I. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • type (pulumi.Input[str]) – The type of NAS volume. Can be one of NFS (to denote v3) or NFS41 (to denote NFS v4.1). Default: NFS. Forces a new resource if changed.
  • uncommitted_space (pulumi.Input[float]) – Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
  • url (pulumi.Input[str]) – The unique locator for the datastore.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.Provider(resource_name, opts=None, allow_unverified_ssl=None, client_debug=None, client_debug_path=None, client_debug_path_run=None, password=None, persist_session=None, rest_session_path=None, user=None, vcenter_server=None, vim_keep_alive=None, vim_session_path=None, vsphere_server=None, __props__=None, __name__=None, __opts__=None)

The provider type for the vsphere package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
static get(resource_name, id, opts=None)

Get an existing Provider resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.ResourcePool(resource_name, opts=None, cpu_expandable=None, cpu_limit=None, cpu_reservation=None, cpu_share_level=None, cpu_shares=None, custom_attributes=None, memory_expandable=None, memory_limit=None, memory_reservation=None, memory_share_level=None, memory_shares=None, name=None, parent_resource_pool_id=None, tags=None, __props__=None, __name__=None, __opts__=None)

The .ResourcePool resource can be used to create and manage resource pools in standalone hosts or on compute clusters.

For more information on vSphere resource pools, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • cpu_expandable (pulumi.Input[bool]) – Determines if the reservation on a resource pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • cpu_limit (pulumi.Input[float]) – The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • cpu_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0
  • cpu_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
  • cpu_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
  • memory_expandable (pulumi.Input[bool]) – Determines if the reservation on a resource pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • memory_limit (pulumi.Input[float]) – The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • memory_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0
  • memory_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
  • memory_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
  • name (pulumi.Input[str]) – The name of the resource pool.
  • parent_resource_pool_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a resource pool from one parent resource pool to another, both must share a common root resource pool or the move will fail.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
cpu_expandable = None

Determines if the reservation on a resource pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true

cpu_limit = None

The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1

cpu_reservation = None

Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0

cpu_share_level = None

The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal

cpu_shares = None

The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.

memory_expandable = None

Determines if the reservation on a resource pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true

memory_limit = None

The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1

memory_reservation = None

Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0

memory_share_level = None

The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal

memory_shares = None

The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.

name = None

The name of the resource pool.

parent_resource_pool_id = None

The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a resource pool from one parent resource pool to another, both must share a common root resource pool or the move will fail.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

static get(resource_name, id, opts=None, cpu_expandable=None, cpu_limit=None, cpu_reservation=None, cpu_share_level=None, cpu_shares=None, custom_attributes=None, memory_expandable=None, memory_limit=None, memory_reservation=None, memory_share_level=None, memory_shares=None, name=None, parent_resource_pool_id=None, tags=None)

Get an existing ResourcePool resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] cpu_expandable: Determines if the reservation on a resource

pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
Parameters:
  • cpu_limit (pulumi.Input[float]) – The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • cpu_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0
  • cpu_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
  • cpu_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
  • memory_expandable (pulumi.Input[bool]) – Determines if the reservation on a resource pool can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • memory_limit (pulumi.Input[float]) – The CPU utilization of a resource pool will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • memory_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the resource pool. Default: 0
  • memory_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
  • memory_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
  • name (pulumi.Input[str]) – The name of the resource pool.
  • parent_resource_pool_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a resource pool from one parent resource pool to another, both must share a common root resource pool or the move will fail.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.StorageDrsVmOverride(resource_name, opts=None, datastore_cluster_id=None, sdrs_automation_level=None, sdrs_enabled=None, sdrs_intra_vm_affinity=None, virtual_machine_id=None, __props__=None, __name__=None, __opts__=None)

The .StorageDrsVmOverride resource can be used to add a Storage DRS override to a datastore cluster for a specific virtual machine. With this resource, one can enable or disable Storage DRS, and control the automation level and disk affinity for a single virtual machine without affecting the rest of the datastore cluster.

For more information on vSphere datastore clusters and Storage DRS, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the datastore cluster to put the override in. Forces a new resource if changed.
  • sdrs_automation_level (pulumi.Input[str]) – Overrides any Storage DRS automation levels for this virtual machine. Can be one of automated or manual. When not specified, the datastore cluster’s settings are used according to the [specific SDRS subsystem][tf-vsphere-datastore-cluster-sdrs-levels].
  • sdrs_enabled (pulumi.Input[str]) – Overrides the default Storage DRS setting for this virtual machine. When not specified, the datastore cluster setting is used.
  • sdrs_intra_vm_affinity (pulumi.Input[str]) – Overrides the intra-VM affinity setting for this virtual machine. When true, all disks for this virtual machine will be kept on the same datastore. When false, Storage DRS may locate individual disks on different datastores if it helps satisfy cluster requirements. When not specified, the datastore cluster’s settings are used.
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
datastore_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the datastore cluster to put the override in. Forces a new resource if changed.

sdrs_automation_level = None

Overrides any Storage DRS automation levels for this virtual machine. Can be one of automated or manual. When not specified, the datastore cluster’s settings are used according to the [specific SDRS subsystem][tf-vsphere-datastore-cluster-sdrs-levels].

sdrs_enabled = None

Overrides the default Storage DRS setting for this virtual machine. When not specified, the datastore cluster setting is used.

sdrs_intra_vm_affinity = None

Overrides the intra-VM affinity setting for this virtual machine. When true, all disks for this virtual machine will be kept on the same datastore. When false, Storage DRS may locate individual disks on different datastores if it helps satisfy cluster requirements. When not specified, the datastore cluster’s settings are used.

virtual_machine_id = None

The UUID of the virtual machine to create the override for. Forces a new resource if changed.

static get(resource_name, id, opts=None, datastore_cluster_id=None, sdrs_automation_level=None, sdrs_enabled=None, sdrs_intra_vm_affinity=None, virtual_machine_id=None)

Get an existing StorageDrsVmOverride resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] datastore_cluster_id: The [managed object reference

ID][docs-about-morefs] of the datastore cluster to put the override in. Forces a new resource if changed.
Parameters:
  • sdrs_automation_level (pulumi.Input[str]) – Overrides any Storage DRS automation levels for this virtual machine. Can be one of automated or manual. When not specified, the datastore cluster’s settings are used according to the [specific SDRS subsystem][tf-vsphere-datastore-cluster-sdrs-levels].
  • sdrs_enabled (pulumi.Input[str]) – Overrides the default Storage DRS setting for this virtual machine. When not specified, the datastore cluster setting is used.
  • sdrs_intra_vm_affinity (pulumi.Input[str]) – Overrides the intra-VM affinity setting for this virtual machine. When true, all disks for this virtual machine will be kept on the same datastore. When false, Storage DRS may locate individual disks on different datastores if it helps satisfy cluster requirements. When not specified, the datastore cluster’s settings are used.
  • virtual_machine_id (pulumi.Input[str]) – The UUID of the virtual machine to create the override for. Forces a new resource if changed.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.Tag(resource_name, opts=None, category_id=None, description=None, name=None, __props__=None, __name__=None, __opts__=None)

The .Tag resource can be used to create and manage tags, which allow you to attach metadata to objects in the vSphere inventory to make these objects more sortable and searchable.

For more information about tags, click here.

NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • category_id (pulumi.Input[str]) – The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.
  • description (pulumi.Input[str]) – A description for the tag.
  • name (pulumi.Input[str]) – The display name of the tag. The name must be unique within its category.
category_id = None

The unique identifier of the parent category in which this tag will be created. Forces a new resource if changed.

description = None

A description for the tag.

name = None

The display name of the tag. The name must be unique within its category.

static get(resource_name, id, opts=None, category_id=None, description=None, name=None)

Get an existing Tag resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] category_id: The unique identifier of the parent category in

which this tag will be created. Forces a new resource if changed.
Parameters:
  • description (pulumi.Input[str]) – A description for the tag.
  • name (pulumi.Input[str]) – The display name of the tag. The name must be unique within its category.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.TagCategory(resource_name, opts=None, associable_types=None, cardinality=None, description=None, name=None, __props__=None, __name__=None, __opts__=None)

The .TagCategory resource can be used to create and manage tag categories, which determine how tags are grouped together and applied to specific objects.

For more information about tags, click here. For more information about tag categories specifically, click here.

NOTE: Tagging support is unsupported on direct ESXi connections and requires vCenter 6.0 or higher.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • associable_types (pulumi.Input[list]) – A list object types that this category is valid to be assigned to. For a full list, click here.
  • cardinality (pulumi.Input[str]) – The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
  • description (pulumi.Input[str]) – A description for the category.
  • name (pulumi.Input[str]) – The name of the category.
associable_types = None

A list object types that this category is valid to be assigned to. For a full list, click here.

cardinality = None

The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.

description = None

A description for the category.

name = None

The name of the category.

static get(resource_name, id, opts=None, associable_types=None, cardinality=None, description=None, name=None)

Get an existing TagCategory resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[list] associable_types: A list object types that this category is

valid to be assigned to. For a full list, click here.
Parameters:
  • cardinality (pulumi.Input[str]) – The number of tags that can be assigned from this category to a single object at once. Can be one of SINGLE (object can only be assigned one tag in this category), to MULTIPLE (object can be assigned multiple tags in this category). Forces a new resource if changed.
  • description (pulumi.Input[str]) – A description for the category.
  • name (pulumi.Input[str]) – The name of the category.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VappContainer(resource_name, opts=None, cpu_expandable=None, cpu_limit=None, cpu_reservation=None, cpu_share_level=None, cpu_shares=None, custom_attributes=None, memory_expandable=None, memory_limit=None, memory_reservation=None, memory_share_level=None, memory_shares=None, name=None, parent_folder_id=None, parent_resource_pool_id=None, tags=None, __props__=None, __name__=None, __opts__=None)

The .VappContainer resource can be used to create and manage vApps.

For more information on vSphere vApps, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • cpu_expandable (pulumi.Input[bool]) – Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • cpu_limit (pulumi.Input[float]) – The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • cpu_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
  • cpu_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
  • cpu_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
  • memory_expandable (pulumi.Input[bool]) – Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • memory_limit (pulumi.Input[float]) – The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • memory_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
  • memory_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
  • memory_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
  • name (pulumi.Input[str]) – The name of the vApp container.
  • parent_folder_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the vApp container’s parent folder.
  • parent_resource_pool_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
cpu_expandable = None

Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true

cpu_limit = None

The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1

cpu_reservation = None

Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0

cpu_share_level = None

The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal

cpu_shares = None

The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.

memory_expandable = None

Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true

memory_limit = None

The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1

memory_reservation = None

Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0

memory_share_level = None

The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal

memory_shares = None

The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.

name = None

The name of the vApp container.

parent_folder_id = None

The [managed object ID][docs-about-morefs] of the vApp container’s parent folder.

parent_resource_pool_id = None

The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

static get(resource_name, id, opts=None, cpu_expandable=None, cpu_limit=None, cpu_reservation=None, cpu_share_level=None, cpu_shares=None, custom_attributes=None, memory_expandable=None, memory_limit=None, memory_reservation=None, memory_share_level=None, memory_shares=None, name=None, parent_folder_id=None, parent_resource_pool_id=None, tags=None)

Get an existing VappContainer resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] cpu_expandable: Determines if the reservation on a vApp

container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
Parameters:
  • cpu_limit (pulumi.Input[float]) – The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • cpu_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
  • cpu_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in cpu_shares will be ignored. Default: normal
  • cpu_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, cpu_share_level must be custom.
  • memory_expandable (pulumi.Input[bool]) – Determines if the reservation on a vApp container can grow beyond the specified value if the parent resource pool has unreserved resources. Default: true
  • memory_limit (pulumi.Input[float]) – The CPU utilization of a vApp container will not exceed this limit, even if there are available resources. Set to -1 for unlimited. Default: -1
  • memory_reservation (pulumi.Input[float]) – Amount of CPU (MHz) that is guaranteed available to the vApp container. Default: 0
  • memory_share_level (pulumi.Input[str]) – The CPU allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. Can be one of low, normal, high, or custom. When low, normal, or high are specified values in memory_shares will be ignored. Default: normal
  • memory_shares (pulumi.Input[float]) – The number of shares allocated for CPU. Used to determine resource allocation in case of resource contention. If this is set, memory_share_level must be custom.
  • name (pulumi.Input[str]) – The name of the vApp container.
  • parent_folder_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the vApp container’s parent folder.
  • parent_resource_pool_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the parent resource pool. This can be the root resource pool for a cluster or standalone host, or a resource pool itself. When moving a vApp container from one parent resource pool to another, both must share a common root resource pool or the move will fail.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VappEntity(resource_name, opts=None, container_id=None, custom_attributes=None, start_action=None, start_delay=None, start_order=None, stop_action=None, stop_delay=None, tags=None, target_id=None, wait_for_guest=None, __props__=None, __name__=None, __opts__=None)

The .VappEntity resource can be used to describe the behavior of an entity (virtual machine or sub-vApp container) in a vApp container.

For more information on vSphere vApps, see this page.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • container_id (pulumi.Input[str]) – [Managed object ID|docs-about-morefs] of the vApp container the entity is a member of.
  • start_action (pulumi.Input[str]) – How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
  • start_delay (pulumi.Input[float]) – Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
  • start_order (pulumi.Input[float]) – Order to start and stop target in vApp. Default: 1
  • stop_action (pulumi.Input[str]) – Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
  • stop_delay (pulumi.Input[float]) – Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
  • target_id (pulumi.Input[str]) – [Managed object ID|docs-about-morefs] of the entity to power on or power off. This can be a virtual machine or a vApp.
  • wait_for_guest (pulumi.Input[bool]) – Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
container_id = None

[Managed object ID|docs-about-morefs] of the vApp container the entity is a member of.

start_action = None

How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn

start_delay = None

Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120

start_order = None

Order to start and stop target in vApp. Default: 1

stop_action = None

Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff

stop_delay = None

Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120

target_id = None

[Managed object ID|docs-about-morefs] of the entity to power on or power off. This can be a virtual machine or a vApp.

wait_for_guest = None

Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false

static get(resource_name, id, opts=None, container_id=None, custom_attributes=None, start_action=None, start_delay=None, start_order=None, stop_action=None, stop_delay=None, tags=None, target_id=None, wait_for_guest=None)

Get an existing VappEntity resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] container_id: [Managed object ID|docs-about-morefs] of the vApp

container the entity is a member of.
Parameters:
  • start_action (pulumi.Input[str]) – How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn
  • start_delay (pulumi.Input[float]) – Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120
  • start_order (pulumi.Input[float]) – Order to start and stop target in vApp. Default: 1
  • stop_action (pulumi.Input[str]) – Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff
  • stop_delay (pulumi.Input[float]) – Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120
  • target_id (pulumi.Input[str]) – [Managed object ID|docs-about-morefs] of the entity to power on or power off. This can be a virtual machine or a vApp.
  • wait_for_guest (pulumi.Input[bool]) – Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VirtualDisk(resource_name, opts=None, adapter_type=None, create_directories=None, datacenter=None, datastore=None, size=None, type=None, vmdk_path=None, __props__=None, __name__=None, __opts__=None)

The .VirtualDisk resource can be used to create virtual disks outside of any given `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource. These disks can be attached to a virtual machine by creating a disk block with the ``attach` </docs/providers/vsphere/r/virtual_machine.html#attach>`_ parameter.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • adapter_type (pulumi.Input[str]) – The adapter type for this virtual disk. Can be one of ide, lsiLogic, or busLogic. Default: lsiLogic.
  • create_directories (pulumi.Input[bool]) – Tells the resource to create any directories that are a part of the vmdk_path parameter if they are missing. Default: false.
  • datacenter (pulumi.Input[str]) – The name of the datacenter in which to create the disk. Can be omitted when when ESXi or if there is only one datacenter in your infrastructure.
  • datastore (pulumi.Input[str]) – The name of the datastore in which to create the disk.
  • size (pulumi.Input[float]) – Size of the disk (in GB).
  • type (pulumi.Input[str]) – The type of disk to create. Can be one of eagerZeroedThick, lazy, or thin. Default: eagerZeroedThick. For information on what each kind of disk provisioning policy means, click [here][docs-vmware-vm-disk-provisioning].
  • vmdk_path (pulumi.Input[str]) – The path, including filename, of the virtual disk to be created. This needs to end in .vmdk.
adapter_type = None

The adapter type for this virtual disk. Can be one of ide, lsiLogic, or busLogic. Default: lsiLogic.

create_directories = None

Tells the resource to create any directories that are a part of the vmdk_path parameter if they are missing. Default: false.

datacenter = None

The name of the datacenter in which to create the disk. Can be omitted when when ESXi or if there is only one datacenter in your infrastructure.

datastore = None

The name of the datastore in which to create the disk.

size = None

Size of the disk (in GB).

type = None

The type of disk to create. Can be one of eagerZeroedThick, lazy, or thin. Default: eagerZeroedThick. For information on what each kind of disk provisioning policy means, click [here][docs-vmware-vm-disk-provisioning].

vmdk_path = None

The path, including filename, of the virtual disk to be created. This needs to end in .vmdk.

static get(resource_name, id, opts=None, adapter_type=None, create_directories=None, datacenter=None, datastore=None, size=None, type=None, vmdk_path=None)

Get an existing VirtualDisk resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] adapter_type: The adapter type for this virtual disk. Can be

one of ide, lsiLogic, or busLogic. Default: lsiLogic.
Parameters:
  • create_directories (pulumi.Input[bool]) – Tells the resource to create any directories that are a part of the vmdk_path parameter if they are missing. Default: false.
  • datacenter (pulumi.Input[str]) – The name of the datacenter in which to create the disk. Can be omitted when when ESXi or if there is only one datacenter in your infrastructure.
  • datastore (pulumi.Input[str]) – The name of the datastore in which to create the disk.
  • size (pulumi.Input[float]) – Size of the disk (in GB).
  • type (pulumi.Input[str]) – The type of disk to create. Can be one of eagerZeroedThick, lazy, or thin. Default: eagerZeroedThick. For information on what each kind of disk provisioning policy means, click [here][docs-vmware-vm-disk-provisioning].
  • vmdk_path (pulumi.Input[str]) – The path, including filename, of the virtual disk to be created. This needs to end in .vmdk.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VirtualMachine(resource_name, opts=None, alternate_guest_name=None, annotation=None, boot_delay=None, boot_retry_delay=None, boot_retry_enabled=None, cdrom=None, clone=None, cpu_hot_add_enabled=None, cpu_hot_remove_enabled=None, cpu_limit=None, cpu_performance_counters_enabled=None, cpu_reservation=None, cpu_share_count=None, cpu_share_level=None, custom_attributes=None, datastore_cluster_id=None, datastore_id=None, disks=None, efi_secure_boot_enabled=None, enable_disk_uuid=None, enable_logging=None, ept_rvi_mode=None, extra_config=None, firmware=None, folder=None, force_power_off=None, guest_id=None, host_system_id=None, hv_mode=None, ignored_guest_ips=None, latency_sensitivity=None, memory=None, memory_hot_add_enabled=None, memory_limit=None, memory_reservation=None, memory_share_count=None, memory_share_level=None, migrate_wait_timeout=None, name=None, nested_hv_enabled=None, network_interfaces=None, num_cores_per_socket=None, num_cpus=None, resource_pool_id=None, run_tools_scripts_after_power_on=None, run_tools_scripts_after_resume=None, run_tools_scripts_before_guest_reboot=None, run_tools_scripts_before_guest_shutdown=None, run_tools_scripts_before_guest_standby=None, scsi_bus_sharing=None, scsi_controller_count=None, scsi_type=None, shutdown_wait_timeout=None, swap_placement_policy=None, sync_time_with_host=None, tags=None, vapp=None, wait_for_guest_ip_timeout=None, wait_for_guest_net_routable=None, wait_for_guest_net_timeout=None, __props__=None, __name__=None, __opts__=None)

Create a VirtualMachine resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • alternate_guest_name (pulumi.Input[str]) – The guest name for the operating system when guest_id is other or other-64.
  • annotation (pulumi.Input[str]) – A user-provided description of the virtual machine. The default is no annotation.
  • boot_delay (pulumi.Input[float]) – The number of milliseconds to wait before starting the boot sequence. The default is no delay.
  • boot_retry_delay (pulumi.Input[float]) – The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true. Default: 10000 (10 seconds).
  • boot_retry_enabled (pulumi.Input[bool]) – If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay. Default: false.
  • cdrom (pulumi.Input[dict]) – A specification for a CDROM device on this virtual machine. See CDROM options below.
  • clone (pulumi.Input[dict]) – When specified, the VM will be created as a clone of a specified template. Optional customization options can be submitted as well. See creating a virtual machine from a template for more details.
  • cpu_hot_add_enabled (pulumi.Input[bool]) – Allow CPUs to be added to this virtual machine while it is running.
  • cpu_hot_remove_enabled (pulumi.Input[bool]) – Allow CPUs to be removed to this virtual machine while it is running.
  • cpu_limit (pulumi.Input[float]) – The maximum amount of CPU (in MHz) that this virtual machine can consume, regardless of available resources. The default is no limit.
  • cpu_performance_counters_enabled (pulumi.Input[bool]) – Enable CPU performance counters on this virtual machine. Default: false.
  • cpu_reservation (pulumi.Input[float]) – The amount of CPU (in MHz) that this virtual machine is guaranteed. The default is no reservation.
  • cpu_share_count (pulumi.Input[float]) – The number of CPU shares allocated to the virtual machine when the cpu_share_level is custom.
  • cpu_share_level (pulumi.Input[str]) – The allocation level for CPU resources. Can be one of high, low, normal, or custom. Default: custom.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set for virtual machine. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the datastore cluster ID to use. This setting applies to entire virtual machine and implies that you wish to use Storage DRS with this virtual machine. See the section on virtual machine migration for details on changing this value.
  • datastore_id (pulumi.Input[str]) – The datastore ID that the ISO is located in. Requried for using a datastore ISO. Conflicts with client_device.
  • disks (pulumi.Input[list]) – A specification for a virtual disk device on this virtual machine. See disk options below.
  • efi_secure_boot_enabled (pulumi.Input[bool]) – When the firmware type is set to is efi, this enables EFI secure boot. Default: false.
  • enable_disk_uuid (pulumi.Input[bool]) – Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: false.
  • enable_logging (pulumi.Input[bool]) – Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: false.
  • ept_rvi_mode (pulumi.Input[str]) – The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off. Default: automatic.
  • extra_config (pulumi.Input[dict]) – Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata.
  • firmware (pulumi.Input[str]) – The firmware interface to use on the virtual machine. Can be one of bios or EFI. Default: bios.
  • folder (pulumi.Input[str]) – The path to the folder to put this virtual machine in, relative to the datacenter that the resource pool is in.
  • force_power_off (pulumi.Input[bool]) – If a guest shutdown failed or timed out while updating or destroying (see shutdown_wait_timeout), force the power-off of the virtual machine. Default: true.
  • guest_id (pulumi.Input[str]) – The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: other-64.
  • host_system_id (pulumi.Input[str]) – An optional [managed object reference ID][docs-about-morefs] of a host to put this virtual machine on. See the section on virtual machine migration for details on changing this value. If a host_system_id is not supplied, vSphere will select a host in the resource pool to place the virtual machine, according to any defaults or DRS policies in place.
  • hv_mode (pulumi.Input[str]) – The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff. Default: hvAuto.
  • ignored_guest_ips (pulumi.Input[list]) – List of IP addresses to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored if they show up so that the waiter will continue to wait for a real IP address. Default: [].
  • latency_sensitivity (pulumi.Input[str]) – Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. Can be one of low, normal, medium, or high.
  • memory (pulumi.Input[float]) – The size of the virtual machine’s memory, in MB. Default: 1024 (1 GB).
  • memory_hot_add_enabled (pulumi.Input[bool]) – Allow memory to be added to this virtual machine while it is running.
  • memory_limit (pulumi.Input[float]) – The maximum amount of memory (in MB) that this virtual machine can consume, regardless of available resources. The default is no limit.
  • memory_reservation (pulumi.Input[float]) – The amount of memory (in MB) that this virtual machine is guaranteed. The default is no reservation.
  • memory_share_count (pulumi.Input[float]) – The number of memory shares allocated to the virtual machine when the memory_share_level is custom.
  • memory_share_level (pulumi.Input[str]) – The allocation level for memory resources. Can be one of high, low, normal, or custom. Default: custom.
  • migrate_wait_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: 10 minutes. Also see the section on virtual machine migration.
  • name (pulumi.Input[str]) – An alias for both label and path, the latter when using attach. Required if not using label.
  • nested_hv_enabled (pulumi.Input[bool]) – Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest. Default: false.
  • network_interfaces (pulumi.Input[list]) – A specification for a virtual NIC on this virtual machine. See network interface options below.
  • num_cores_per_socket (pulumi.Input[float]) – The number of cores to distribute among the CPUs in this virtual machine. If specified, the value supplied to num_cpus must be evenly divisible by this value. Default: 1.
  • num_cpus (pulumi.Input[float]) – The number of virtual processors to assign to this virtual machine. Default: 1.
  • resource_pool_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the resource pool to put this virtual machine in. See the section on virtual machine migration for details on changing this value.
  • run_tools_scripts_after_power_on (pulumi.Input[bool]) – Enable the execution of post-power-on scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_after_resume (pulumi.Input[bool]) – Enable the execution of post-resume scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_before_guest_reboot (pulumi.Input[bool]) – Enable the execution of pre-reboot scripts when VMware tools is installed. Default: false.
  • run_tools_scripts_before_guest_shutdown (pulumi.Input[bool]) – Enable the execution of pre-shutdown scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_before_guest_standby (pulumi.Input[bool]) – Enable the execution of pre-standby scripts when VMware tools is installed. Default: true.
  • scsi_bus_sharing (pulumi.Input[str]) – Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Default: noSharing.
  • scsi_type (pulumi.Input[str]) – The type of SCSI bus this virtual machine will have. Can be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS) or pvscsi (VMware Paravirtual). Defualt: pvscsi.
  • shutdown_wait_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If force_power_off is set to true, the VM will be force powered-off after this timeout, otherwise an error is returned. Default: 3 minutes.
  • swap_placement_policy (pulumi.Input[str]) – The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory. Default: inherit.
  • sync_time_with_host (pulumi.Input[bool]) – Enable guest clock synchronization with the host. Requires VMware tools to be installed. Default: false.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • vapp (pulumi.Input[dict]) – Optional vApp configuration. The only sub-key available is properties, which is a key/value map of properties for virtual machines imported from OVF or OVA files. See Using vApp properties to supply OVF/OVA configuration for more details.
  • wait_for_guest_ip_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for an available guest IP address on this virtual machine. This should only be used if your version of VMware Tools does not allow the wait_for_guest_net_timeout waiter to be used. A value less than 1 disables the waiter. Default: 0.
  • wait_for_guest_net_routable (pulumi.Input[bool]) – Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the wait_for_guest_ip_timeout waiter is used. Default: true.
  • wait_for_guest_net_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for an available IP address on this virtual machine’s NICs. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the wait_for_guest_ip_timeout waiter can be used instead. A value less than 1 disables the waiter. Default: 5 minutes.
alternate_guest_name = None

The guest name for the operating system when guest_id is other or other-64.

annotation = None

A user-provided description of the virtual machine. The default is no annotation.

boot_delay = None

The number of milliseconds to wait before starting the boot sequence. The default is no delay.

boot_retry_delay = None

The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true. Default: 10000 (10 seconds).

boot_retry_enabled = None

If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay. Default: false.

cdrom = None

A specification for a CDROM device on this virtual machine. See CDROM options below.

change_version = None

A unique identifier for a given version of the last configuration applied, such the timestamp of the last update to the configuration.

clone = None

When specified, the VM will be created as a clone of a specified template. Optional customization options can be submitted as well. See creating a virtual machine from a template for more details.

cpu_hot_add_enabled = None

Allow CPUs to be added to this virtual machine while it is running.

cpu_hot_remove_enabled = None

Allow CPUs to be removed to this virtual machine while it is running.

cpu_limit = None

The maximum amount of CPU (in MHz) that this virtual machine can consume, regardless of available resources. The default is no limit.

cpu_performance_counters_enabled = None

Enable CPU performance counters on this virtual machine. Default: false.

cpu_reservation = None

The amount of CPU (in MHz) that this virtual machine is guaranteed. The default is no reservation.

cpu_share_count = None

The number of CPU shares allocated to the virtual machine when the cpu_share_level is custom.

cpu_share_level = None

The allocation level for CPU resources. Can be one of high, low, normal, or custom. Default: custom.

custom_attributes = None

Map of custom attribute ids to attribute value strings to set for virtual machine. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datastore_cluster_id = None

The [managed object reference ID][docs-about-morefs] of the datastore cluster ID to use. This setting applies to entire virtual machine and implies that you wish to use Storage DRS with this virtual machine. See the section on virtual machine migration for details on changing this value.

datastore_id = None

The datastore ID that the ISO is located in. Requried for using a datastore ISO. Conflicts with client_device.

disks = None

A specification for a virtual disk device on this virtual machine. See disk options below.

efi_secure_boot_enabled = None

When the firmware type is set to is efi, this enables EFI secure boot. Default: false.

enable_disk_uuid = None

Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: false.

enable_logging = None

Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: false.

ept_rvi_mode = None

The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off. Default: automatic.

extra_config = None

Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata.

firmware = None

The firmware interface to use on the virtual machine. Can be one of bios or EFI. Default: bios.

folder = None

The path to the folder to put this virtual machine in, relative to the datacenter that the resource pool is in.

force_power_off = None

If a guest shutdown failed or timed out while updating or destroying (see shutdown_wait_timeout), force the power-off of the virtual machine. Default: true.

guest_id = None

The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: other-64.

guest_ip_addresses = None

The current list of IP addresses on this machine, including the value of default_ip_address. If VMware tools is not running on the virtual machine, or if the VM is powered off, this list will be empty.

  • moid: The [managed object reference ID][docs-about-morefs] of the created virtual machine.
host_system_id = None

An optional [managed object reference ID][docs-about-morefs] of a host to put this virtual machine on. See the section on virtual machine migration for details on changing this value. If a host_system_id is not supplied, vSphere will select a host in the resource pool to place the virtual machine, according to any defaults or DRS policies in place.

hv_mode = None

The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff. Default: hvAuto.

ignored_guest_ips = None

List of IP addresses to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored if they show up so that the waiter will continue to wait for a real IP address. Default: [].

imported = None

This is flagged if the virtual machine has been imported, or the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.

latency_sensitivity = None

Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. Can be one of low, normal, medium, or high.

memory = None

The size of the virtual machine’s memory, in MB. Default: 1024 (1 GB).

memory_hot_add_enabled = None

Allow memory to be added to this virtual machine while it is running.

memory_limit = None

The maximum amount of memory (in MB) that this virtual machine can consume, regardless of available resources. The default is no limit.

memory_reservation = None

The amount of memory (in MB) that this virtual machine is guaranteed. The default is no reservation.

memory_share_count = None

The number of memory shares allocated to the virtual machine when the memory_share_level is custom.

memory_share_level = None

The allocation level for memory resources. Can be one of high, low, normal, or custom. Default: custom.

migrate_wait_timeout = None

The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: 10 minutes. Also see the section on virtual machine migration.

name = None

An alias for both label and path, the latter when using attach. Required if not using label.

nested_hv_enabled = None

Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest. Default: false.

network_interfaces = None

A specification for a virtual NIC on this virtual machine. See network interface options below.

num_cores_per_socket = None

The number of cores to distribute among the CPUs in this virtual machine. If specified, the value supplied to num_cpus must be evenly divisible by this value. Default: 1.

num_cpus = None

The number of virtual processors to assign to this virtual machine. Default: 1.

resource_pool_id = None

The [managed object reference ID][docs-about-morefs] of the resource pool to put this virtual machine in. See the section on virtual machine migration for details on changing this value.

run_tools_scripts_after_power_on = None

Enable the execution of post-power-on scripts when VMware tools is installed. Default: true.

run_tools_scripts_after_resume = None

Enable the execution of post-resume scripts when VMware tools is installed. Default: true.

run_tools_scripts_before_guest_reboot = None

Enable the execution of pre-reboot scripts when VMware tools is installed. Default: false.

run_tools_scripts_before_guest_shutdown = None

Enable the execution of pre-shutdown scripts when VMware tools is installed. Default: true.

run_tools_scripts_before_guest_standby = None

Enable the execution of pre-standby scripts when VMware tools is installed. Default: true.

scsi_bus_sharing = None

Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Default: noSharing.

scsi_type = None

The type of SCSI bus this virtual machine will have. Can be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS) or pvscsi (VMware Paravirtual). Defualt: pvscsi.

shutdown_wait_timeout = None

The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If force_power_off is set to true, the VM will be force powered-off after this timeout, otherwise an error is returned. Default: 3 minutes.

swap_placement_policy = None

The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory. Default: inherit.

sync_time_with_host = None

Enable guest clock synchronization with the host. Requires VMware tools to be installed. Default: false.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

uuid = None

The UUID of the virtual disk’s VMDK file. This is used to track the virtual disk on the virtual machine.

vapp = None

Optional vApp configuration. The only sub-key available is properties, which is a key/value map of properties for virtual machines imported from OVF or OVA files. See Using vApp properties to supply OVF/OVA configuration for more details.

vapp_transports = None

Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.

vmware_tools_status = None

The state of VMware tools in the guest. This will determine the proper course of action for some device operations.

vmx_path = None

The path of the virtual machine’s configuration file in the VM’s datastore.

wait_for_guest_ip_timeout = None

The amount of time, in minutes, to wait for an available guest IP address on this virtual machine. This should only be used if your version of VMware Tools does not allow the wait_for_guest_net_timeout waiter to be used. A value less than 1 disables the waiter. Default: 0.

wait_for_guest_net_routable = None

Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the wait_for_guest_ip_timeout waiter is used. Default: true.

wait_for_guest_net_timeout = None

The amount of time, in minutes, to wait for an available IP address on this virtual machine’s NICs. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the wait_for_guest_ip_timeout waiter can be used instead. A value less than 1 disables the waiter. Default: 5 minutes.

static get(resource_name, id, opts=None, alternate_guest_name=None, annotation=None, boot_delay=None, boot_retry_delay=None, boot_retry_enabled=None, cdrom=None, change_version=None, clone=None, cpu_hot_add_enabled=None, cpu_hot_remove_enabled=None, cpu_limit=None, cpu_performance_counters_enabled=None, cpu_reservation=None, cpu_share_count=None, cpu_share_level=None, custom_attributes=None, datastore_cluster_id=None, datastore_id=None, default_ip_address=None, disks=None, efi_secure_boot_enabled=None, enable_disk_uuid=None, enable_logging=None, ept_rvi_mode=None, extra_config=None, firmware=None, folder=None, force_power_off=None, guest_id=None, guest_ip_addresses=None, host_system_id=None, hv_mode=None, ignored_guest_ips=None, imported=None, latency_sensitivity=None, memory=None, memory_hot_add_enabled=None, memory_limit=None, memory_reservation=None, memory_share_count=None, memory_share_level=None, migrate_wait_timeout=None, moid=None, name=None, nested_hv_enabled=None, network_interfaces=None, num_cores_per_socket=None, num_cpus=None, reboot_required=None, resource_pool_id=None, run_tools_scripts_after_power_on=None, run_tools_scripts_after_resume=None, run_tools_scripts_before_guest_reboot=None, run_tools_scripts_before_guest_shutdown=None, run_tools_scripts_before_guest_standby=None, scsi_bus_sharing=None, scsi_controller_count=None, scsi_type=None, shutdown_wait_timeout=None, swap_placement_policy=None, sync_time_with_host=None, tags=None, uuid=None, vapp=None, vapp_transports=None, vmware_tools_status=None, vmx_path=None, wait_for_guest_ip_timeout=None, wait_for_guest_net_routable=None, wait_for_guest_net_timeout=None)

Get an existing VirtualMachine resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] alternate_guest_name: The guest name for the operating system

when guest_id is other or other-64.
Parameters:
  • annotation (pulumi.Input[str]) – A user-provided description of the virtual machine. The default is no annotation.
  • boot_delay (pulumi.Input[float]) – The number of milliseconds to wait before starting the boot sequence. The default is no delay.
  • boot_retry_delay (pulumi.Input[float]) – The number of milliseconds to wait before retrying the boot sequence. This only valid if boot_retry_enabled is true. Default: 10000 (10 seconds).
  • boot_retry_enabled (pulumi.Input[bool]) – If set to true, a virtual machine that fails to boot will try again after the delay defined in boot_retry_delay. Default: false.
  • cdrom (pulumi.Input[dict]) – A specification for a CDROM device on this virtual machine. See CDROM options below.
  • change_version (pulumi.Input[str]) – A unique identifier for a given version of the last configuration applied, such the timestamp of the last update to the configuration.
  • clone (pulumi.Input[dict]) – When specified, the VM will be created as a clone of a specified template. Optional customization options can be submitted as well. See creating a virtual machine from a template for more details.
  • cpu_hot_add_enabled (pulumi.Input[bool]) – Allow CPUs to be added to this virtual machine while it is running.
  • cpu_hot_remove_enabled (pulumi.Input[bool]) – Allow CPUs to be removed to this virtual machine while it is running.
  • cpu_limit (pulumi.Input[float]) – The maximum amount of CPU (in MHz) that this virtual machine can consume, regardless of available resources. The default is no limit.
  • cpu_performance_counters_enabled (pulumi.Input[bool]) – Enable CPU performance counters on this virtual machine. Default: false.
  • cpu_reservation (pulumi.Input[float]) – The amount of CPU (in MHz) that this virtual machine is guaranteed. The default is no reservation.
  • cpu_share_count (pulumi.Input[float]) – The number of CPU shares allocated to the virtual machine when the cpu_share_level is custom.
  • cpu_share_level (pulumi.Input[str]) – The allocation level for CPU resources. Can be one of high, low, normal, or custom. Default: custom.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value strings to set for virtual machine. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the datastore cluster ID to use. This setting applies to entire virtual machine and implies that you wish to use Storage DRS with this virtual machine. See the section on virtual machine migration for details on changing this value.
  • datastore_id (pulumi.Input[str]) – The datastore ID that the ISO is located in. Requried for using a datastore ISO. Conflicts with client_device.
  • disks (pulumi.Input[list]) – A specification for a virtual disk device on this virtual machine. See disk options below.
  • efi_secure_boot_enabled (pulumi.Input[bool]) – When the firmware type is set to is efi, this enables EFI secure boot. Default: false.
  • enable_disk_uuid (pulumi.Input[bool]) – Expose the UUIDs of attached virtual disks to the virtual machine, allowing access to them in the guest. Default: false.
  • enable_logging (pulumi.Input[bool]) – Enable logging of virtual machine events to a log file stored in the virtual machine directory. Default: false.
  • ept_rvi_mode (pulumi.Input[str]) – The EPT/RVI (hardware memory virtualization) setting for this virtual machine. Can be one of automatic, on, or off. Default: automatic.
  • extra_config (pulumi.Input[dict]) – Extra configuration data for this virtual machine. Can be used to supply advanced parameters not normally in configuration, such as instance metadata.
  • firmware (pulumi.Input[str]) – The firmware interface to use on the virtual machine. Can be one of bios or EFI. Default: bios.
  • folder (pulumi.Input[str]) – The path to the folder to put this virtual machine in, relative to the datacenter that the resource pool is in.
  • force_power_off (pulumi.Input[bool]) – If a guest shutdown failed or timed out while updating or destroying (see shutdown_wait_timeout), force the power-off of the virtual machine. Default: true.
  • guest_id (pulumi.Input[str]) – The guest ID for the operating system type. For a full list of possible values, see [here][vmware-docs-guest-ids]. Default: other-64.
  • guest_ip_addresses (pulumi.Input[list]) – The current list of IP addresses on this machine, including the value of default_ip_address. If VMware tools is not running on the virtual machine, or if the VM is powered off, this list will be empty.
Parameters:
  • host_system_id (pulumi.Input[str]) – An optional [managed object reference ID][docs-about-morefs] of a host to put this virtual machine on. See the section on virtual machine migration for details on changing this value. If a host_system_id is not supplied, vSphere will select a host in the resource pool to place the virtual machine, according to any defaults or DRS policies in place.
  • hv_mode (pulumi.Input[str]) – The (non-nested) hardware virtualization setting for this virtual machine. Can be one of hvAuto, hvOn, or hvOff. Default: hvAuto.
  • ignored_guest_ips (pulumi.Input[list]) – List of IP addresses to ignore while waiting for an available IP address using either of the waiters. Any IP addresses in this list will be ignored if they show up so that the waiter will continue to wait for a real IP address. Default: [].
  • imported (pulumi.Input[bool]) – This is flagged if the virtual machine has been imported, or the state has been migrated from a previous version of the resource. It influences the behavior of the first post-import apply operation. See the section on importing below.
  • latency_sensitivity (pulumi.Input[str]) – Controls the scheduling delay of the virtual machine. Use a higher sensitivity for applications that require lower latency, such as VOIP, media player applications, or applications that require frequent access to mouse or keyboard devices. Can be one of low, normal, medium, or high.
  • memory (pulumi.Input[float]) – The size of the virtual machine’s memory, in MB. Default: 1024 (1 GB).
  • memory_hot_add_enabled (pulumi.Input[bool]) – Allow memory to be added to this virtual machine while it is running.
  • memory_limit (pulumi.Input[float]) – The maximum amount of memory (in MB) that this virtual machine can consume, regardless of available resources. The default is no limit.
  • memory_reservation (pulumi.Input[float]) – The amount of memory (in MB) that this virtual machine is guaranteed. The default is no reservation.
  • memory_share_count (pulumi.Input[float]) – The number of memory shares allocated to the virtual machine when the memory_share_level is custom.
  • memory_share_level (pulumi.Input[str]) – The allocation level for memory resources. Can be one of high, low, normal, or custom. Default: custom.
  • migrate_wait_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for a virtual machine migration to complete before failing. Default: 10 minutes. Also see the section on virtual machine migration.
  • name (pulumi.Input[str]) – An alias for both label and path, the latter when using attach. Required if not using label.
  • nested_hv_enabled (pulumi.Input[bool]) – Enable nested hardware virtualization on this virtual machine, facilitating nested virtualization in the guest. Default: false.
  • network_interfaces (pulumi.Input[list]) – A specification for a virtual NIC on this virtual machine. See network interface options below.
  • num_cores_per_socket (pulumi.Input[float]) – The number of cores to distribute among the CPUs in this virtual machine. If specified, the value supplied to num_cpus must be evenly divisible by this value. Default: 1.
  • num_cpus (pulumi.Input[float]) – The number of virtual processors to assign to this virtual machine. Default: 1.
  • resource_pool_id (pulumi.Input[str]) – The [managed object reference ID][docs-about-morefs] of the resource pool to put this virtual machine in. See the section on virtual machine migration for details on changing this value.
  • run_tools_scripts_after_power_on (pulumi.Input[bool]) – Enable the execution of post-power-on scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_after_resume (pulumi.Input[bool]) – Enable the execution of post-resume scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_before_guest_reboot (pulumi.Input[bool]) – Enable the execution of pre-reboot scripts when VMware tools is installed. Default: false.
  • run_tools_scripts_before_guest_shutdown (pulumi.Input[bool]) – Enable the execution of pre-shutdown scripts when VMware tools is installed. Default: true.
  • run_tools_scripts_before_guest_standby (pulumi.Input[bool]) – Enable the execution of pre-standby scripts when VMware tools is installed. Default: true.
  • scsi_bus_sharing (pulumi.Input[str]) – Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Default: noSharing.
  • scsi_type (pulumi.Input[str]) – The type of SCSI bus this virtual machine will have. Can be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS) or pvscsi (VMware Paravirtual). Defualt: pvscsi.
  • shutdown_wait_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for a graceful guest shutdown when making necessary updates to the virtual machine. If force_power_off is set to true, the VM will be force powered-off after this timeout, otherwise an error is returned. Default: 3 minutes.
  • swap_placement_policy (pulumi.Input[str]) – The swap file placement policy for this virtual machine. Can be one of inherit, hostLocal, or vmDirectory. Default: inherit.
  • sync_time_with_host (pulumi.Input[bool]) – Enable guest clock synchronization with the host. Requires VMware tools to be installed. Default: false.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • uuid (pulumi.Input[str]) – The UUID of the virtual disk’s VMDK file. This is used to track the virtual disk on the virtual machine.
  • vapp (pulumi.Input[dict]) – Optional vApp configuration. The only sub-key available is properties, which is a key/value map of properties for virtual machines imported from OVF or OVA files. See Using vApp properties to supply OVF/OVA configuration for more details.
  • vapp_transports (pulumi.Input[list]) – Computed value which is only valid for cloned virtual machines. A list of vApp transport methods supported by the source virtual machine or template.
  • vmware_tools_status (pulumi.Input[str]) – The state of VMware tools in the guest. This will determine the proper course of action for some device operations.
  • vmx_path (pulumi.Input[str]) – The path of the virtual machine’s configuration file in the VM’s datastore.
  • wait_for_guest_ip_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for an available guest IP address on this virtual machine. This should only be used if your version of VMware Tools does not allow the wait_for_guest_net_timeout waiter to be used. A value less than 1 disables the waiter. Default: 0.
  • wait_for_guest_net_routable (pulumi.Input[bool]) – Controls whether or not the guest network waiter waits for a routable address. When false, the waiter does not wait for a default gateway, nor are IP addresses checked against any discovered default gateways as part of its success criteria. This property is ignored if the wait_for_guest_ip_timeout waiter is used. Default: true.
  • wait_for_guest_net_timeout (pulumi.Input[float]) – The amount of time, in minutes, to wait for an available IP address on this virtual machine’s NICs. Older versions of VMware Tools do not populate this property. In those cases, this waiter can be disabled and the wait_for_guest_ip_timeout waiter can be used instead. A value less than 1 disables the waiter. Default: 5 minutes.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VirtualMachineSnapshot(resource_name, opts=None, consolidate=None, description=None, memory=None, quiesce=None, remove_children=None, snapshot_name=None, virtual_machine_uuid=None, __props__=None, __name__=None, __opts__=None)

The .VirtualMachineSnapshot resource can be used to manage snapshots for a virtual machine.

For more information on managing snapshots and how they work in VMware, see here.

NOTE: A snapshot in VMware differs from traditional disk snapshots, and can contain the actual running state of the virtual machine, data for all disks that have not been set to be independent from the snapshot (including ones that have been attached via the attach parameter to the .VirtualMachine disk block), and even the configuration of the virtual machine at the time of the snapshot. Virtual machine, disk activity, and configuration changes post-snapshot are not included in the original state. Use this resource with care! Neither VMware nor HashiCorp recommends retaining snapshots for a extended period of time and does NOT recommend using them as as backup feature. For more information on the limitation of virtual machine snapshots, see here.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • consolidate (pulumi.Input[bool]) – If set to true, the delta disks involved in this snapshot will be consolidated into the parent when this resource is destroyed.
  • description (pulumi.Input[str]) – A description for the snapshot.
  • memory (pulumi.Input[bool]) – If set to true, a dump of the internal state of the virtual machine is included in the snapshot.
  • quiesce (pulumi.Input[bool]) – If set to true, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine.
  • remove_children (pulumi.Input[bool]) – If set to true, the entire snapshot subtree is removed when this resource is destroyed.
  • snapshot_name (pulumi.Input[str]) – The name of the snapshot.
  • virtual_machine_uuid (pulumi.Input[str]) – The virtual machine UUID.
consolidate = None

If set to true, the delta disks involved in this snapshot will be consolidated into the parent when this resource is destroyed.

description = None

A description for the snapshot.

memory = None

If set to true, a dump of the internal state of the virtual machine is included in the snapshot.

quiesce = None

If set to true, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine.

remove_children = None

If set to true, the entire snapshot subtree is removed when this resource is destroyed.

snapshot_name = None

The name of the snapshot.

virtual_machine_uuid = None

The virtual machine UUID.

static get(resource_name, id, opts=None, consolidate=None, description=None, memory=None, quiesce=None, remove_children=None, snapshot_name=None, virtual_machine_uuid=None)

Get an existing VirtualMachineSnapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] consolidate: If set to true, the delta disks involved in this

snapshot will be consolidated into the parent when this resource is destroyed.
Parameters:
  • description (pulumi.Input[str]) – A description for the snapshot.
  • memory (pulumi.Input[bool]) – If set to true, a dump of the internal state of the virtual machine is included in the snapshot.
  • quiesce (pulumi.Input[bool]) – If set to true, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine.
  • remove_children (pulumi.Input[bool]) – If set to true, the entire snapshot subtree is removed when this resource is destroyed.
  • snapshot_name (pulumi.Input[str]) – The name of the snapshot.
  • virtual_machine_uuid (pulumi.Input[str]) – The virtual machine UUID.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_vsphere.VmfsDatastore(resource_name, opts=None, custom_attributes=None, datastore_cluster_id=None, disks=None, folder=None, host_system_id=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Create a VmfsDatastore resource with the given unique name, props, and options.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value string to set on datastore resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.
  • disks (pulumi.Input[list]) – The disks to use with the datastore.
  • host_system_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
  • name (pulumi.Input[str]) – The name of the datastore. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
accessible = None

The connectivity status of the datastore. If this is false, some other computed attributes may be out of date.

capacity = None

Maximum capacity of the datastore, in megabytes.

custom_attributes = None

Map of custom attribute ids to attribute value string to set on datastore resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.

datastore_cluster_id = None

The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.

disks = None

The disks to use with the datastore.

free_space = None

Available space of this datastore, in megabytes.

host_system_id = None

The [managed object ID][docs-about-morefs] of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.

maintenance_mode = None

The current maintenance mode state of the datastore.

multiple_host_access = None

If true, more than one host in the datacenter has been configured with access to the datastore.

name = None

The name of the datastore. Forces a new resource if changed.

tags = None

The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.

uncommitted_space = None

Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.

url = None

The unique locator for the datastore.

static get(resource_name, id, opts=None, accessible=None, capacity=None, custom_attributes=None, datastore_cluster_id=None, disks=None, folder=None, free_space=None, host_system_id=None, maintenance_mode=None, multiple_host_access=None, name=None, tags=None, uncommitted_space=None, url=None)

Get an existing VmfsDatastore resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] accessible: The connectivity status of the datastore. If this is false,

some other computed attributes may be out of date.
Parameters:
  • capacity (pulumi.Input[float]) – Maximum capacity of the datastore, in megabytes.
  • custom_attributes (pulumi.Input[dict]) – Map of custom attribute ids to attribute value string to set on datastore resource. See [here][docs-setting-custom-attributes] for a reference on how to set values for custom attributes.
  • datastore_cluster_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of a datastore cluster to put this datastore in. Conflicts with folder.
  • disks (pulumi.Input[list]) – The disks to use with the datastore.
  • free_space (pulumi.Input[float]) – Available space of this datastore, in megabytes.
  • host_system_id (pulumi.Input[str]) – The [managed object ID][docs-about-morefs] of the host to set the datastore up on. Note that this is not necessarily the only host that the datastore will be set up on - see here for more info. Forces a new resource if changed.
  • maintenance_mode (pulumi.Input[str]) – The current maintenance mode state of the datastore.
  • multiple_host_access (pulumi.Input[bool]) – If true, more than one host in the datacenter has been configured with access to the datastore.
  • name (pulumi.Input[str]) – The name of the datastore. Forces a new resource if changed.
  • tags (pulumi.Input[list]) – The IDs of any tags to attach to this resource. See [here][docs-applying-tags] for a reference on how to apply tags.
  • uncommitted_space (pulumi.Input[float]) – Total additional storage space, in megabytes, potentially used by all virtual machines on this datastore.
  • url (pulumi.Input[str]) – The unique locator for the datastore.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_vsphere.get_compute_cluster(datacenter_id=None, name=None, opts=None)
pulumi_vsphere.get_custom_attribute(name=None, opts=None)
pulumi_vsphere.get_datacenter(name=None, opts=None)

The .Datacenter data source can be used to discover the ID of a vSphere datacenter. This can then be used with resources or data sources that require a datacenter, such as the `.getHost`` </docs/providers/vsphere/d/host.html>`_ data source.

pulumi_vsphere.get_datastore(datacenter_id=None, name=None, opts=None)

The .getDatastore data source can be used to discover the ID of a datastore in vSphere. This is useful to fetch the ID of a datastore that you want to use to create virtual machines in using the `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource.

pulumi_vsphere.get_datastore_cluster(datacenter_id=None, name=None, opts=None)

The .DatastoreCluster data source can be used to discover the ID of a datastore cluster in vSphere. This is useful to fetch the ID of a datastore cluster that you want to use to assign datastores to using the `.NasDatastore`` </docs/providers/vsphere/r/nas_datastore.html>`_ or `.VmfsDatastore`` </docs/providers/vsphere/r/vmfs_datastore.html>`_ resources, or create virtual machines in using the `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource.

pulumi_vsphere.get_distributed_virtual_switch(datacenter_id=None, name=None, opts=None)

The .DistributedVirtualSwitch data source can be used to discover the ID and uplink data of a of a vSphere distributed virtual switch (DVS). This can then be used with resources or data sources that require a DVS, such as the `.DistributedPortGroup`` </docs/providers/vsphere/r/distributed_port_group.html>`_ resource, for which an example is shown below.

NOTE: This data source requires vCenter and is not available on direct ESXi connections.

This content is derived from https://github.com/terraform-providers/terraform-provider-vsphere/blob/master/website/docs/d/distributed_virtual_switch.html.markdown.

pulumi_vsphere.get_folder(path=None, opts=None)

The .Folder data source can be used to get the general attributes of a vSphere inventory folder. Paths are absolute and include must include the datacenter.

pulumi_vsphere.get_host(datacenter_id=None, name=None, opts=None)

The .getHost data source can be used to discover the ID of a vSphere host. This can then be used with resources or data sources that require a host managed object reference ID.

pulumi_vsphere.get_network(datacenter_id=None, name=None, opts=None)

The .getNetwork data source can be used to discover the ID of a network in vSphere. This can be any network that can be used as the backing for a network interface for .VirtualMachine or any other vSphere resource that requires a network. This includes standard (host-based) port groups, DVS port groups, or opaque networks such as those managed by NSX.

pulumi_vsphere.get_resource_pool(datacenter_id=None, name=None, opts=None)

The .ResourcePool data source can be used to discover the ID of a resource pool in vSphere. This is useful to fetch the ID of a resource pool that you want to use to create virtual machines in using the `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource.

pulumi_vsphere.get_tag(category_id=None, name=None, opts=None)
pulumi_vsphere.get_tag_category(name=None, opts=None)
pulumi_vsphere.get_vapp_container(datacenter_id=None, name=None, opts=None)

The .VappContainer data source can be used to discover the ID of a vApp container in vSphere. This is useful to fetch the ID of a vApp container that you want to use to create virtual machines in using the `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource.

pulumi_vsphere.get_virtual_machine(datacenter_id=None, name=None, scsi_controller_scan_count=None, opts=None)

The .VirtualMachine data source can be used to find the UUID of an existing virtual machine or template. Its most relevant purpose is for finding the UUID of a template to be used as the source for cloning into a new `.VirtualMachine`` </docs/providers/vsphere/r/virtual_machine.html>`_ resource. It also reads the guest ID so that can be supplied as well.

pulumi_vsphere.get_vmfs_disks(filter=None, host_system_id=None, rescan=None, opts=None)

The .getVmfsDisks data source can be used to discover the storage devices available on an ESXi host. This data source can be combined with the `.VmfsDatastore`` </docs/providers/vsphere/r/vmfs_datastore.html>`_ resource to create VMFS datastores based off a set of discovered disks.