pulumi-vsphere 4.14.0a1746734806__py3-none-any.whl → 4.14.0a1747752163__py3-none-any.whl

pulumi_vsphere/compute_cluster.py

@@ -2561,6 +2561,8 @@ class ComputeCluster(pulumi.CustomResource):
 
         path to the cluster, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         hcl
 
         variable "datacenter" {
@@ -2577,9 +2579,9 @@ class ComputeCluster(pulumi.CustomResource):
 
         resource "vsphere_compute_cluster" "compute_cluster" {
 
-          name            = "cluster-01"
+          name          = "cluster-01"
 
-          datacenter_id   = data.vsphere_datacenter.datacenter.id
+          datacenter_id = data.vsphere_datacenter.datacenter.id
 
         }
 
@@ -2607,9 +2609,7 @@ class ComputeCluster(pulumi.CustomResource):
 
           ha_datastore_pdl_response = "restartAggressive"
 
-          ... etc.
-
-        console
+        }
 
         ```sh
         $ pulumi import vsphere:index/computeCluster:ComputeCluster compute_cluster /dc-01/host/cluster-01
@@ -2775,6 +2775,8 @@ class ComputeCluster(pulumi.CustomResource):
 
         path to the cluster, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         hcl
 
         variable "datacenter" {
@@ -2791,9 +2793,9 @@ class ComputeCluster(pulumi.CustomResource):
 
         resource "vsphere_compute_cluster" "compute_cluster" {
 
-          name            = "cluster-01"
+          name          = "cluster-01"
 
-          datacenter_id   = data.vsphere_datacenter.datacenter.id
+          datacenter_id = data.vsphere_datacenter.datacenter.id
 
         }
 
@@ -2821,9 +2823,7 @@ class ComputeCluster(pulumi.CustomResource):
 
           ha_datastore_pdl_response = "restartAggressive"
 
-          ... etc.
-
-        console
+        }
 
         ```sh
         $ pulumi import vsphere:index/computeCluster:ComputeCluster compute_cluster /dc-01/host/cluster-01

pulumi_vsphere/compute_cluster_host_group.py

@@ -188,6 +188,39 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter and is not available on direct ESXi
         connections.
 
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated",
+            ha_enabled=True)
+        cluster_host_group = vsphere.ComputeClusterHostGroup("cluster_host_group",
+            name="test-cluster-host-group",
+            compute_cluster_id=compute_cluster.id,
+            host_system_ids=[[__item.id for __item in hosts_get_host]])
+        ```
+
         ## Import
 
         An existing group can be imported into this resource by
@@ -198,6 +231,8 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
 
         will be returned. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup cluster_host_group \\
         ```
@@ -241,6 +276,39 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter and is not available on direct ESXi
         connections.
 
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated",
+            ha_enabled=True)
+        cluster_host_group = vsphere.ComputeClusterHostGroup("cluster_host_group",
+            name="test-cluster-host-group",
+            compute_cluster_id=compute_cluster.id,
+            host_system_ids=[[__item.id for __item in hosts_get_host]])
+        ```
+
         ## Import
 
         An existing group can be imported into this resource by
@@ -251,6 +319,8 @@ class ComputeClusterHostGroup(pulumi.CustomResource):
 
         will be returned. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup cluster_host_group \\
         ```

pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py

@@ -246,6 +246,8 @@ class ComputeClusterVmAntiAffinityRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule vm_anti_affinity_rule \\
         ```
@@ -287,6 +289,8 @@ class ComputeClusterVmAntiAffinityRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule vm_anti_affinity_rule \\
         ```

pulumi_vsphere/compute_cluster_vm_dependency_rule.py

@@ -384,6 +384,8 @@ class ComputeClusterVmDependencyRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmDependencyRule:ComputeClusterVmDependencyRule cluster_vm_dependency_rule \\
         ```
@@ -514,6 +516,8 @@ class ComputeClusterVmDependencyRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmDependencyRule:ComputeClusterVmDependencyRule cluster_vm_dependency_rule \\
         ```

pulumi_vsphere/compute_cluster_vm_group.py

@@ -266,6 +266,8 @@ class ComputeClusterVmGroup(pulumi.CustomResource):
 
         will be returned. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmGroup:ComputeClusterVmGroup cluster_vm_group \\
         ```
@@ -372,6 +374,8 @@ class ComputeClusterVmGroup(pulumi.CustomResource):
 
         will be returned. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmGroup:ComputeClusterVmGroup cluster_vm_group \\
         ```

pulumi_vsphere/compute_cluster_vm_host_rule.py

@@ -426,6 +426,8 @@ class ComputeClusterVmHostRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmHostRule:ComputeClusterVmHostRule cluster_vm_host_rule \\
         ```
@@ -556,6 +558,8 @@ class ComputeClusterVmHostRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/computeClusterVmHostRule:ComputeClusterVmHostRule cluster_vm_host_rule \\
         ```

pulumi_vsphere/content_library.py

@@ -252,6 +252,8 @@ class ContentLibrary(pulumi.CustomResource):
 
         An existing content library can be imported into this resource by supplying the content library ID. For example:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/contentLibrary:ContentLibrary vsphere_content_library publisher_content_library f42a4b25-844a-44ec-9063-a3a5e9cc88c7
         ```
@@ -316,6 +318,8 @@ class ContentLibrary(pulumi.CustomResource):
 
         An existing content library can be imported into this resource by supplying the content library ID. For example:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/contentLibrary:ContentLibrary vsphere_content_library publisher_content_library f42a4b25-844a-44ec-9063-a3a5e9cc88c7
         ```

pulumi_vsphere/content_library_item.py

@@ -307,6 +307,8 @@ class ContentLibraryItem(pulumi.CustomResource):
 
         supplying the content library ID. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
         ```
@@ -393,6 +395,8 @@ class ContentLibraryItem(pulumi.CustomResource):
 
         supplying the content library ID. An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
         ```

pulumi_vsphere/custom_attribute.py

@@ -147,6 +147,8 @@ class CustomAttribute(pulumi.CustomResource):
 
         via its name, using the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
         ```
@@ -197,6 +199,8 @@ class CustomAttribute(pulumi.CustomResource):
 
         via its name, using the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
         ```

pulumi_vsphere/datastore_cluster.py

@@ -968,12 +968,56 @@ class DatastoreCluster(pulumi.CustomResource):
 
         > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
 
+        ## Example Usage
+
+        The following example sets up a datastore cluster and enables Storage DRS with
+        the default settings. It then creates two NAS datastores using the
+        `NasDatastore` resource and assigns them to
+        the datastore cluster.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter = vsphere.get_datacenter()
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter.id) for __index in range(len(hosts))]
+        datastore_cluster = vsphere.DatastoreCluster("datastore_cluster",
+            name="datastore-cluster-test",
+            datacenter_id=datacenter.id,
+            sdrs_enabled=True)
+        datastore1 = vsphere.NasDatastore("datastore1",
+            name="datastore-test1",
+            host_system_ids=[[__item["id"] for __item in esxi_hosts]],
+            datastore_cluster_id=datastore_cluster.id,
+            type="NFS",
+            remote_hosts=["nfs"],
+            remote_path="/export/test1")
+        datastore2 = vsphere.NasDatastore("datastore2",
+            name="datastore-test2",
+            host_system_ids=[[__item["id"] for __item in esxi_hosts]],
+            datastore_cluster_id=datastore_cluster.id,
+            type="NFS",
+            remote_hosts=["nfs"],
+            remote_path="/export/test2")
+        ```
+
         ## Import
 
         An existing datastore cluster can be imported into this resource
 
         via the path to the cluster, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/datastoreCluster:DatastoreCluster datastore_cluster /dc1/datastore/ds-cluster
         ```
@@ -1054,12 +1098,56 @@ class DatastoreCluster(pulumi.CustomResource):
 
         > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
 
+        ## Example Usage
+
+        The following example sets up a datastore cluster and enables Storage DRS with
+        the default settings. It then creates two NAS datastores using the
+        `NasDatastore` resource and assigns them to
+        the datastore cluster.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter = vsphere.get_datacenter()
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter.id) for __index in range(len(hosts))]
+        datastore_cluster = vsphere.DatastoreCluster("datastore_cluster",
+            name="datastore-cluster-test",
+            datacenter_id=datacenter.id,
+            sdrs_enabled=True)
+        datastore1 = vsphere.NasDatastore("datastore1",
+            name="datastore-test1",
+            host_system_ids=[[__item["id"] for __item in esxi_hosts]],
+            datastore_cluster_id=datastore_cluster.id,
+            type="NFS",
+            remote_hosts=["nfs"],
+            remote_path="/export/test1")
+        datastore2 = vsphere.NasDatastore("datastore2",
+            name="datastore-test2",
+            host_system_ids=[[__item["id"] for __item in esxi_hosts]],
+            datastore_cluster_id=datastore_cluster.id,
+            type="NFS",
+            remote_hosts=["nfs"],
+            remote_path="/export/test2")
+        ```
+
         ## Import
 
         An existing datastore cluster can be imported into this resource
 
         via the path to the cluster, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/datastoreCluster:DatastoreCluster datastore_cluster /dc1/datastore/ds-cluster
         ```

pulumi_vsphere/datastore_cluster_vm_anti_affinity_rule.py

@@ -297,6 +297,8 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/datastoreClusterVmAntiAffinityRule:DatastoreClusterVmAntiAffinityRule cluster_vm_anti_affinity_rule \\
         ```
@@ -395,6 +397,8 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
 
         example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/datastoreClusterVmAntiAffinityRule:DatastoreClusterVmAntiAffinityRule cluster_vm_anti_affinity_rule \\
         ```

pulumi_vsphere/distributed_port_group.py

@@ -1810,6 +1810,8 @@ class DistributedPortGroup(pulumi.CustomResource):
 
         the managed object id of the port group, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/distributedPortGroup:DistributedPortGroup pg /dc-01/network/pg-01
         ```
@@ -2027,6 +2029,8 @@ class DistributedPortGroup(pulumi.CustomResource):
 
         the managed object id of the port group, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/distributedPortGroup:DistributedPortGroup pg /dc-01/network/pg-01
         ```

pulumi_vsphere/distributed_virtual_switch.py

@@ -3366,6 +3366,8 @@ class DistributedVirtualSwitch(pulumi.CustomResource):
 
         to the VDS, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/distributedVirtualSwitch:DistributedVirtualSwitch vds /dc-01/network/vds-01
         ```
@@ -3619,6 +3621,8 @@ class DistributedVirtualSwitch(pulumi.CustomResource):
 
         to the VDS, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/distributedVirtualSwitch:DistributedVirtualSwitch vds /dc-01/network/vds-01
         ```

pulumi_vsphere/dpm_host_override.py

@@ -220,6 +220,48 @@ class DpmHostOverride(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter and is not available on direct ESXi
         connections.
 
+        ## Example Usage
+
+        The following example creates a compute cluster comprised of three hosts,
+        making use of the
+        `ComputeCluster` resource. DPM
+        will be disabled in the cluster as it is the default setting, but we override
+        the setting of the first host referenced by the
+        `Host` data source (`esxi1`) by using
+        the `DpmHostOverride` resource so it will be powered off when the
+        cluster does not need it to service virtual machines.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated")
+        dpm_host_override = vsphere.DpmHostOverride("dpm_host_override",
+            compute_cluster_id=compute_cluster.id,
+            host_system_id=hosts_get_host[0].id,
+            dpm_enabled=True,
+            dpm_automation_level="automated")
+        ```
+
         ## Import
 
         An existing override can be imported into this resource by
@@ -228,6 +270,8 @@ class DpmHostOverride(pulumi.CustomResource):
 
         import`. If no override exists, an error will be given.  An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/dpmHostOverride:DpmHostOverride dpm_host_override \\
         ```
@@ -272,6 +316,48 @@ class DpmHostOverride(pulumi.CustomResource):
         > **NOTE:** This resource requires vCenter and is not available on direct ESXi
         connections.
 
+        ## Example Usage
+
+        The following example creates a compute cluster comprised of three hosts,
+        making use of the
+        `ComputeCluster` resource. DPM
+        will be disabled in the cluster as it is the default setting, but we override
+        the setting of the first host referenced by the
+        `Host` data source (`esxi1`) by using
+        the `DpmHostOverride` resource so it will be powered off when the
+        cluster does not need it to service virtual machines.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated")
+        dpm_host_override = vsphere.DpmHostOverride("dpm_host_override",
+            compute_cluster_id=compute_cluster.id,
+            host_system_id=hosts_get_host[0].id,
+            dpm_enabled=True,
+            dpm_automation_level="automated")
+        ```
+
         ## Import
 
         An existing override can be imported into this resource by
@@ -280,6 +366,8 @@ class DpmHostOverride(pulumi.CustomResource):
 
         import`. If no override exists, an error will be given.  An example is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/dpmHostOverride:DpmHostOverride dpm_host_override \\
         ```

pulumi_vsphere/drs_vm_override.py

@@ -281,6 +281,8 @@ class DrsVmOverride(pulumi.CustomResource):
 
         is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/drsVmOverride:DrsVmOverride drs_vm_override \\
         ```
@@ -383,6 +385,8 @@ class DrsVmOverride(pulumi.CustomResource):
 
         is below:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
         $ pulumi import vsphere:index/drsVmOverride:DrsVmOverride drs_vm_override \\
         ```