pulumi-vsphere 4.13.2__py3-none-any.whl → 4.14.0__py3-none-any.whl

pulumi_vsphere/compute_cluster.py

@@ -2454,6 +2454,7 @@ class _ComputeClusterState:
         pulumi.set(self, "vsan_verbose_mode_enabled", value)
 
 
+@pulumi.type_token("vsphere:index/computeCluster:ComputeCluster")
 class ComputeCluster(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -2560,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" {
@@ -2576,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
 
         }
 
@@ -2606,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
@@ -2774,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" {
@@ -2790,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
 
         }
 
@@ -2820,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

@@ -164,6 +164,7 @@ class _ComputeClusterHostGroupState:
         pulumi.set(self, "name", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup")
 class ComputeClusterHostGroup(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -187,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
@@ -197,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 \\
         ```
@@ -240,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
@@ -250,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_affinity_rule.py

@@ -223,6 +223,7 @@ class _ComputeClusterVmAffinityRuleState:
         pulumi.set(self, "virtual_machine_ids", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterVmAffinityRule:ComputeClusterVmAffinityRule")
 class ComputeClusterVmAffinityRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,

pulumi_vsphere/compute_cluster_vm_anti_affinity_rule.py

@@ -223,6 +223,7 @@ class _ComputeClusterVmAntiAffinityRuleState:
         pulumi.set(self, "virtual_machine_ids", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule")
 class ComputeClusterVmAntiAffinityRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -245,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 \\
         ```
@@ -286,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

@@ -278,6 +278,7 @@ class _ComputeClusterVmDependencyRuleState:
         pulumi.set(self, "vm_group_name", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterVmDependencyRule:ComputeClusterVmDependencyRule")
 class ComputeClusterVmDependencyRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -383,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 \\
         ```
@@ -513,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

@@ -184,6 +184,7 @@ class _ComputeClusterVmGroupState:
         pulumi.set(self, "virtual_machine_ids", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterVmGroup:ComputeClusterVmGroup")
 class ComputeClusterVmGroup(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -265,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 \\
         ```
@@ -371,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

@@ -323,6 +323,7 @@ class _ComputeClusterVmHostRuleState:
         pulumi.set(self, "vm_group_name", value)
 
 
+@pulumi.type_token("vsphere:index/computeClusterVmHostRule:ComputeClusterVmHostRule")
 class ComputeClusterVmHostRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -425,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 \\
         ```
@@ -555,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

@@ -194,6 +194,7 @@ class _ContentLibraryState:
         pulumi.set(self, "subscription", value)
 
 
+@pulumi.type_token("vsphere:index/contentLibrary:ContentLibrary")
 class ContentLibrary(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -251,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
         ```
@@ -315,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

@@ -228,6 +228,7 @@ class _ContentLibraryItemState:
         pulumi.set(self, "type", value)
 
 
+@pulumi.type_token("vsphere:index/contentLibraryItem:ContentLibraryItem")
 class ContentLibraryItem(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -306,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
         ```
@@ -392,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

@@ -105,6 +105,7 @@ class _CustomAttributeState:
         pulumi.set(self, "name", value)
 
 
+@pulumi.type_token("vsphere:index/customAttribute:CustomAttribute")
 class CustomAttribute(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -146,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
         ```
@@ -196,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/datacenter.py

@@ -217,6 +217,7 @@ class _DatacenterState:
         pulumi.set(self, "tags", value)
 
 
+@pulumi.type_token("vsphere:index/datacenter:Datacenter")
 class Datacenter(pulumi.CustomResource):
     @overload
     def __init__(__self__,

pulumi_vsphere/datastore_cluster.py

@@ -920,6 +920,7 @@ class _DatastoreClusterState:
         pulumi.set(self, "tags", value)
 
 
+@pulumi.type_token("vsphere:index/datastoreCluster:DatastoreCluster")
 class DatastoreCluster(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -967,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
         ```
@@ -1053,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

@@ -215,6 +215,7 @@ class _DatastoreClusterVmAntiAffinityRuleState:
         pulumi.set(self, "virtual_machine_ids", value)
 
 
+@pulumi.type_token("vsphere:index/datastoreClusterVmAntiAffinityRule:DatastoreClusterVmAntiAffinityRule")
 class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -296,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 \\
         ```
@@ -394,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

@@ -1624,6 +1624,7 @@ class _DistributedPortGroupState:
         pulumi.set(self, "vlan_ranges", value)
 
 
+@pulumi.type_token("vsphere:index/distributedPortGroup:DistributedPortGroup")
 class DistributedPortGroup(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -1809,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
         ```
@@ -2026,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

@@ -3144,6 +3144,7 @@ class _DistributedVirtualSwitchState:
         pulumi.set(self, "vsan_share_level", value)
 
 
+@pulumi.type_token("vsphere:index/distributedVirtualSwitch:DistributedVirtualSwitch")
 class DistributedVirtualSwitch(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -3365,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
         ```
@@ -3618,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/distributed_virtual_switch_pvlan_mapping.py

@@ -157,6 +157,7 @@ class _DistributedVirtualSwitchPvlanMappingState:
         pulumi.set(self, "secondary_vlan_id", value)
 
 
+@pulumi.type_token("vsphere:index/distributedVirtualSwitchPvlanMapping:DistributedVirtualSwitchPvlanMapping")
 class DistributedVirtualSwitchPvlanMapping(pulumi.CustomResource):
     @overload
     def __init__(__self__,