pulumi-vsphere 4.10.0a1710245029__py3-none-any.whl → 4.13.0a1736849827__py3-none-any.whl

pulumi_vsphere/compute_cluster_host_group.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['ComputeClusterHostGroupArgs', 'ComputeClusterHostGroup']
@@ -168,7 +173,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 +226,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/compute_cluster_vm_affinity_rule.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['ComputeClusterVmAffinityRuleArgs', 'ComputeClusterVmAffinityRule']
@@ -249,8 +254,6 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter Server and is not available on
         direct ESXi host connections.
 
-        > **NOTE:** vSphere DRS requires a vSphere Enterprise Plus license.
-
         ## Example Usage
 
         The following example creates two virtual machines in a cluster using the
@@ -260,7 +263,6 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         then creates an affinity rule for these two virtual machines, ensuring they
         will run on the same host whenever possible.
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
@@ -275,29 +277,29 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         vm = []
         for range in [{"value": i} for i in range(0, 2)]:
             vm.append(vsphere.VirtualMachine(f"vm-{range['value']}",
+                name=f"foo-{range['value']}",
                 resource_pool_id=cluster.resource_pool_id,
                 datastore_id=datastore.id,
                 num_cpus=1,
                 memory=1024,
                 guest_id="otherLinux64Guest",
-                network_interfaces=[vsphere.VirtualMachineNetworkInterfaceArgs(
-                    network_id=network.id,
-                )],
-                disks=[vsphere.VirtualMachineDiskArgs(
-                    label="disk0",
-                    size=20,
-                )]))
-        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vmAffinityRule",
+                network_interfaces=[{
+                    "network_id": network.id,
+                }],
+                disks=[{
+                    "label": "disk0",
+                    "size": 20,
+                }]))
+        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
+            name="vm-affinity-rule",
             compute_cluster_id=cluster.id,
             virtual_machine_ids=[v.id for k, v in vm])
         ```
-        <!--End PulumiCodeChooser -->
 
         The following example creates an affinity rule for a set of virtual machines
         in the cluster by looking up the virtual machine UUIDs from the
         `VirtualMachine` data source.
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
@@ -309,14 +311,32 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         datacenter = vsphere.get_datacenter(name="dc-01")
         cluster = vsphere.get_compute_cluster(name="cluster-01",
             datacenter_id=datacenter.id)
-        vms_virtual_machine = [vsphere.get_virtual_machine(name=vms[__index],
+        vms_get_virtual_machine = [vsphere.get_virtual_machine(name=vms[__index],
             datacenter_id=datacenter.id) for __index in range(len(vms))]
-        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vmAffinityRule",
+        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
+            name="vm-affinity-rule",
             enabled=True,
             compute_cluster_id=cluster.id,
-            virtual_machine_ids=[__item.id for __item in vms_virtual_machine])
+            virtual_machine_ids=[__item.id for __item in vms_get_virtual_machine])
+        ```
+
+        ## 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 \\
         ```
-        <!--End PulumiCodeChooser -->
+
+          '{"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.
@@ -361,8 +381,6 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter Server and is not available on
         direct ESXi host connections.
 
-        > **NOTE:** vSphere DRS requires a vSphere Enterprise Plus license.
-
         ## Example Usage
 
         The following example creates two virtual machines in a cluster using the
@@ -372,7 +390,6 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         then creates an affinity rule for these two virtual machines, ensuring they
         will run on the same host whenever possible.
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
@@ -387,29 +404,29 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         vm = []
         for range in [{"value": i} for i in range(0, 2)]:
             vm.append(vsphere.VirtualMachine(f"vm-{range['value']}",
+                name=f"foo-{range['value']}",
                 resource_pool_id=cluster.resource_pool_id,
                 datastore_id=datastore.id,
                 num_cpus=1,
                 memory=1024,
                 guest_id="otherLinux64Guest",
-                network_interfaces=[vsphere.VirtualMachineNetworkInterfaceArgs(
-                    network_id=network.id,
-                )],
-                disks=[vsphere.VirtualMachineDiskArgs(
-                    label="disk0",
-                    size=20,
-                )]))
-        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vmAffinityRule",
+                network_interfaces=[{
+                    "network_id": network.id,
+                }],
+                disks=[{
+                    "label": "disk0",
+                    "size": 20,
+                }]))
+        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
+            name="vm-affinity-rule",
             compute_cluster_id=cluster.id,
             virtual_machine_ids=[v.id for k, v in vm])
         ```
-        <!--End PulumiCodeChooser -->
 
         The following example creates an affinity rule for a set of virtual machines
         in the cluster by looking up the virtual machine UUIDs from the
         `VirtualMachine` data source.
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
@@ -421,14 +438,32 @@ class ComputeClusterVmAffinityRule(pulumi.CustomResource):
         datacenter = vsphere.get_datacenter(name="dc-01")
         cluster = vsphere.get_compute_cluster(name="cluster-01",
             datacenter_id=datacenter.id)
-        vms_virtual_machine = [vsphere.get_virtual_machine(name=vms[__index],
+        vms_get_virtual_machine = [vsphere.get_virtual_machine(name=vms[__index],
             datacenter_id=datacenter.id) for __index in range(len(vms))]
-        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vmAffinityRule",
+        vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
+            name="vm-affinity-rule",
             enabled=True,
             compute_cluster_id=cluster.id,
-            virtual_machine_ids=[__item.id for __item in vms_virtual_machine])
+            virtual_machine_ids=[__item.id for __item in vms_get_virtual_machine])
+        ```
+
+        ## 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 \\
         ```
-        <!--End PulumiCodeChooser -->
+
+          '{"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.

pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['ComputeClusterVmAntiAffinityRuleArgs', 'ComputeClusterVmAntiAffinityRule']
@@ -229,7 +234,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 +275,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/compute_cluster_vm_dependency_rule.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['ComputeClusterVmDependencyRuleArgs', 'ComputeClusterVmDependencyRule']
@@ -285,7 +290,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 +420,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.