pulumi-vsphere 4.11.2__tar.gz → 4.11.3__tar.gz

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pulumi_vsphere
-Version: 4.11.2
+Version: 4.11.3
 Summary: A Pulumi package for creating vsphere resources
 License: Apache-2.0
 Project-URL: Homepage, https://pulumi.io

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/pulumi_vsphere/compute_cluster.py

@@ -2524,7 +2524,94 @@ class ComputeCluster(pulumi.CustomResource):
                  vsan_verbose_mode_enabled: Optional[pulumi.Input[bool]] = None,
                  __props__=None):
         """
-        Create a ComputeCluster resource with the given unique name, props, and options.
+        > **A note on the naming of this resource:** VMware refers to clusters of
+        hosts in the UI and documentation as _clusters_, _HA clusters_, or _DRS
+        clusters_. All of these refer to the same kind of resource (with the latter two
+        referring to specific features of clustering). We use
+        `ComputeCluster` to differentiate host clusters from _datastore
+        clusters_, which are clusters of datastores that can be used to distribute load
+        and ensure fault tolerance via distribution of virtual machines. Datastore
+        clusters can also be managed through the provider, via the
+        `DatastoreCluster` resource.
+
+        The `ComputeCluster` resource can be used to create and manage
+        clusters of hosts allowing for resource control of compute resources, load
+        balancing through DRS, and high availability through vSphere HA.
+
+        For more information on vSphere clusters and DRS, see [this
+        page][ref-vsphere-drs-clusters]. For more information on vSphere HA, see [this
+        page][ref-vsphere-ha-clusters].
+
+        [ref-vsphere-drs-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-8ACF3502-5314-469F-8CC9-4A9BD5925BC2.html
+        [ref-vsphere-ha-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-availability/GUID-5432CA24-14F1-44E3-87FB-61D937831CF6.html
+
+        > **NOTE:** This resource requires vCenter and is not available on
+        direct ESXi connections.
+
+        ## Import
+
+        An existing cluster can be imported into this resource via the
+
+        path to the cluster, via the following command:
+
+        hcl
+
+        variable "datacenter" {
+
+          default = "dc-01"
+
+        }
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = var.datacenter
+
+        }
+
+        resource "vsphere_compute_cluster" "compute_cluster" {
+
+          name            = "cluster-01"
+
+          datacenter_id   = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        hcl
+
+        resource "vsphere_compute_cluster" "compute_cluster" {
+
+          name                      = "cluster-01"
+
+          datacenter_id             = data.vsphere_datacenter.datacenter.id
+
+          vsan_enabled              = true
+
+          vsan_performance_enabled  = true
+
+          host_system_ids           = [for host in data.vsphere_host.host : host.id]
+
+          dpm_automation_level      = "automated"
+
+          drs_automation_level      = "fullyAutomated"
+
+          drs_enabled               = true
+
+          ha_datastore_apd_response = "restartConservative"
+
+          ha_datastore_pdl_response = "restartAggressive"
+
+          ... etc.
+
+        console
+
+        ```sh
+        $ pulumi import vsphere:index/computeCluster:ComputeCluster compute_cluster /dc-01/host/cluster-01
+        ```
+
+        The above would import the cluster named `cluster-01` that is located in
+
+        the `dc-01` datacenter.
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A map of custom attribute ids to attribute
@@ -2651,7 +2738,94 @@ class ComputeCluster(pulumi.CustomResource):
                  args: ComputeClusterArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a ComputeCluster resource with the given unique name, props, and options.
+        > **A note on the naming of this resource:** VMware refers to clusters of
+        hosts in the UI and documentation as _clusters_, _HA clusters_, or _DRS
+        clusters_. All of these refer to the same kind of resource (with the latter two
+        referring to specific features of clustering). We use
+        `ComputeCluster` to differentiate host clusters from _datastore
+        clusters_, which are clusters of datastores that can be used to distribute load
+        and ensure fault tolerance via distribution of virtual machines. Datastore
+        clusters can also be managed through the provider, via the
+        `DatastoreCluster` resource.
+
+        The `ComputeCluster` resource can be used to create and manage
+        clusters of hosts allowing for resource control of compute resources, load
+        balancing through DRS, and high availability through vSphere HA.
+
+        For more information on vSphere clusters and DRS, see [this
+        page][ref-vsphere-drs-clusters]. For more information on vSphere HA, see [this
+        page][ref-vsphere-ha-clusters].
+
+        [ref-vsphere-drs-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-8ACF3502-5314-469F-8CC9-4A9BD5925BC2.html
+        [ref-vsphere-ha-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-availability/GUID-5432CA24-14F1-44E3-87FB-61D937831CF6.html
+
+        > **NOTE:** This resource requires vCenter and is not available on
+        direct ESXi connections.
+
+        ## Import
+
+        An existing cluster can be imported into this resource via the
+
+        path to the cluster, via the following command:
+
+        hcl
+
+        variable "datacenter" {
+
+          default = "dc-01"
+
+        }
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = var.datacenter
+
+        }
+
+        resource "vsphere_compute_cluster" "compute_cluster" {
+
+          name            = "cluster-01"
+
+          datacenter_id   = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        hcl
+
+        resource "vsphere_compute_cluster" "compute_cluster" {
+
+          name                      = "cluster-01"
+
+          datacenter_id             = data.vsphere_datacenter.datacenter.id
+
+          vsan_enabled              = true
+
+          vsan_performance_enabled  = true
+
+          host_system_ids           = [for host in data.vsphere_host.host : host.id]
+
+          dpm_automation_level      = "automated"
+
+          drs_automation_level      = "fullyAutomated"
+
+          drs_enabled               = true
+
+          ha_datastore_apd_response = "restartConservative"
+
+          ha_datastore_pdl_response = "restartAggressive"
+
+          ... etc.
+
+        console
+
+        ```sh
+        $ pulumi import vsphere:index/computeCluster:ComputeCluster compute_cluster /dc-01/host/cluster-01
+        ```
+
+        The above would import the cluster named `cluster-01` that is located in
+
+        the `dc-01` datacenter.
+
         :param str resource_name: The name of the resource.
         :param ComputeClusterArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/pulumi_vsphere/compute_cluster_host_group.py

@@ -168,7 +168,37 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
                  name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a ComputeClusterHostGroup resource with the given unique name, props, and options.
+        The `ComputeClusterHostGroup` resource can be used to manage groups
+        of hosts in a cluster, either created by the
+        `ComputeCluster` resource or looked up
+        by the `ComputeCluster` data source.
+
+        This resource mainly serves as an input to the
+        `ComputeClusterVmHostRule`
+        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.
+
+        ## Import
+
+        An existing group can be imported into this resource by
+
+        supplying both the path to the cluster, and the name of the host group. If the
+
+        name or cluster is not found, or if the group is of a different type, an error
+
+        will be returned. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup cluster_host_group \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "name": "pulumi-test-cluster-host-group"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] compute_cluster_id: The managed object reference
@@ -191,7 +221,37 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
                  args: ComputeClusterHostGroupArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a ComputeClusterHostGroup resource with the given unique name, props, and options.
+        The `ComputeClusterHostGroup` resource can be used to manage groups
+        of hosts in a cluster, either created by the
+        `ComputeCluster` resource or looked up
+        by the `ComputeCluster` data source.
+
+        This resource mainly serves as an input to the
+        `ComputeClusterVmHostRule`
+        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.
+
+        ## Import
+
+        An existing group can be imported into this resource by
+
+        supplying both the path to the cluster, and the name of the host group. If the
+
+        name or cluster is not found, or if the group is of a different type, an error
+
+        will be returned. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup cluster_host_group \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "name": "pulumi-test-cluster-host-group"}'
+
         :param str resource_name: The name of the resource.
         :param ComputeClusterHostGroupArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/pulumi_vsphere/compute_cluster_vm_affinity_rule.py

@@ -315,13 +315,24 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
             virtual_machine_ids=[__item.id for __item in vms_get_virtual_machine])
         ```
 
-        ## Importing
+        ## Import
 
         An existing rule can be imported into this resource by supplying
+
         both the path to the cluster, and the name the rule. If the name or cluster is
+
         not found, or if the rule is of a different type, an error will be returned. An
+
         example is below:
 
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmAffinityRule:ComputeClusterVmAffinityRule vm_affinity_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc-01/host/cluster-01", \\
+
+          "name": "vm-affinity-rule"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] compute_cluster_id: The managed object reference
@@ -431,13 +442,24 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
             virtual_machine_ids=[__item.id for __item in vms_get_virtual_machine])
         ```
 
-        ## Importing
+        ## Import
 
         An existing rule can be imported into this resource by supplying
+
         both the path to the cluster, and the name the rule. If the name or cluster is
+
         not found, or if the rule is of a different type, an error will be returned. An
+
         example is below:
 
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmAffinityRule:ComputeClusterVmAffinityRule vm_affinity_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc-01/host/cluster-01", \\
+
+          "name": "vm-affinity-rule"}'
+
         :param str resource_name: The name of the resource.
         :param ComputeClusterVmAffinityRuleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py

@@ -229,7 +229,24 @@ class ComputeClusterVmAntiAffinityRule(pulumi.CustomResource):
                  virtual_machine_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        Create a ComputeClusterVmAntiAffinityRule resource with the given unique name, props, and options.
+        ## Import
+
+        An existing rule can be imported into this resource by supplying
+
+        both the path to the cluster, and the name the rule. If the name or cluster is
+
+        not found, or if the rule is of a different type, an error will be returned. An
+
+        example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule vm_anti_affinity_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc-01/host/cluster-01", \\
+
+          "name": "vm-anti-affinity-rule"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] compute_cluster_id: The managed object reference
@@ -253,7 +270,24 @@ class ComputeClusterVmAntiAffinityRule(pulumi.CustomResource):
                  args: ComputeClusterVmAntiAffinityRuleArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a ComputeClusterVmAntiAffinityRule resource with the given unique name, props, and options.
+        ## Import
+
+        An existing rule can be imported into this resource by supplying
+
+        both the path to the cluster, and the name the rule. If the name or cluster is
+
+        not found, or if the rule is of a different type, an error will be returned. An
+
+        example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule vm_anti_affinity_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc-01/host/cluster-01", \\
+
+          "name": "vm-anti-affinity-rule"}'
+
         :param str resource_name: The name of the resource.
         :param ComputeClusterVmAntiAffinityRuleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

{pulumi_vsphere-4.11.2 → pulumi_vsphere-4.11.3}/pulumi_vsphere/compute_cluster_vm_dependency_rule.py

@@ -285,7 +285,106 @@ class ComputeClusterVmDependencyRule(pulumi.CustomResource):
                  vm_group_name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a ComputeClusterVmDependencyRule resource with the given unique name, props, and options.
+        The `ComputeClusterVmDependencyRule` resource can be used to manage
+        VM dependency rules in a cluster, either created by the
+        `ComputeCluster` resource or looked up
+        by the `ComputeCluster` 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`
+        resource.
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The example below creates two virtual machine in a cluster using the
+        `VirtualMachine` resource in a cluster
+        looked up by the `ComputeCluster`
+        data source. It then creates a group with this virtual machine. Two groups are created, each with one of the created VMs. Finally, a rule is created to ensure that `vm1` starts before `vm2`.
+
+        > Note how `dependency_vm_group_name` and
+        `vm_group_name` are sourced off of the `name` attributes from
+        the `ComputeClusterVmGroup`
+        resource. This is to ensure that the rule is not created before the groups
+        exist, which may not possibly happen in the event that the names came from a
+        "static" source such as a variable.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datastore(name="datastore1",
+            datacenter_id=datacenter.id)
+        cluster = vsphere.get_compute_cluster(name="cluster-01",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="network1",
+            datacenter_id=datacenter.id)
+        vm1 = vsphere.VirtualMachine("vm1",
+            name="test1",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        vm2 = vsphere.VirtualMachine("vm2",
+            name="test2",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        cluster_vm_group1 = vsphere.ComputeClusterVmGroup("cluster_vm_group1",
+            name="test-cluster-vm-group1",
+            compute_cluster_id=cluster.id,
+            virtual_machine_ids=[vm1.id])
+        cluster_vm_group2 = vsphere.ComputeClusterVmGroup("cluster_vm_group2",
+            name="test-cluster-vm-group2",
+            compute_cluster_id=cluster.id,
+            virtual_machine_ids=[vm2.id])
+        cluster_vm_dependency_rule = vsphere.ComputeClusterVmDependencyRule("cluster_vm_dependency_rule",
+            compute_cluster_id=cluster.id,
+            name="test-cluster-vm-dependency-rule",
+            dependency_vm_group_name=cluster_vm_group1.name,
+            vm_group_name=cluster_vm_group2.name)
+        ```
+
+        ## Import
+
+        An existing rule can be imported into this resource by supplying
+
+        both the path to the cluster, and the name the rule. If the name or cluster is
+
+        not found, or if the rule is of a different type, an error will be returned. An
+
+        example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmDependencyRule:ComputeClusterVmDependencyRule cluster_vm_dependency_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "name": "pulumi-test-cluster-vm-dependency-rule"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] compute_cluster_id: The managed object reference
@@ -316,7 +415,106 @@ class ComputeClusterVmDependencyRule(pulumi.CustomResource):
                  args: ComputeClusterVmDependencyRuleArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a ComputeClusterVmDependencyRule resource with the given unique name, props, and options.
+        The `ComputeClusterVmDependencyRule` resource can be used to manage
+        VM dependency rules in a cluster, either created by the
+        `ComputeCluster` resource or looked up
+        by the `ComputeCluster` 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`
+        resource.
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The example below creates two virtual machine in a cluster using the
+        `VirtualMachine` resource in a cluster
+        looked up by the `ComputeCluster`
+        data source. It then creates a group with this virtual machine. Two groups are created, each with one of the created VMs. Finally, a rule is created to ensure that `vm1` starts before `vm2`.
+
+        > Note how `dependency_vm_group_name` and
+        `vm_group_name` are sourced off of the `name` attributes from
+        the `ComputeClusterVmGroup`
+        resource. This is to ensure that the rule is not created before the groups
+        exist, which may not possibly happen in the event that the names came from a
+        "static" source such as a variable.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datastore(name="datastore1",
+            datacenter_id=datacenter.id)
+        cluster = vsphere.get_compute_cluster(name="cluster-01",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="network1",
+            datacenter_id=datacenter.id)
+        vm1 = vsphere.VirtualMachine("vm1",
+            name="test1",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        vm2 = vsphere.VirtualMachine("vm2",
+            name="test2",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        cluster_vm_group1 = vsphere.ComputeClusterVmGroup("cluster_vm_group1",
+            name="test-cluster-vm-group1",
+            compute_cluster_id=cluster.id,
+            virtual_machine_ids=[vm1.id])
+        cluster_vm_group2 = vsphere.ComputeClusterVmGroup("cluster_vm_group2",
+            name="test-cluster-vm-group2",
+            compute_cluster_id=cluster.id,
+            virtual_machine_ids=[vm2.id])
+        cluster_vm_dependency_rule = vsphere.ComputeClusterVmDependencyRule("cluster_vm_dependency_rule",
+            compute_cluster_id=cluster.id,
+            name="test-cluster-vm-dependency-rule",
+            dependency_vm_group_name=cluster_vm_group1.name,
+            vm_group_name=cluster_vm_group2.name)
+        ```
+
+        ## Import
+
+        An existing rule can be imported into this resource by supplying
+
+        both the path to the cluster, and the name the rule. If the name or cluster is
+
+        not found, or if the rule is of a different type, an error will be returned. An
+
+        example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/computeClusterVmDependencyRule:ComputeClusterVmDependencyRule cluster_vm_dependency_rule \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "name": "pulumi-test-cluster-vm-dependency-rule"}'
+
         :param str resource_name: The name of the resource.
         :param ComputeClusterVmDependencyRuleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.