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

pulumi_vsphere/dpm_host_override.py

@@ -195,6 +195,7 @@ class _DpmHostOverrideState:
         pulumi.set(self, "host_system_id", value)
 
 
+@pulumi.type_token("vsphere:index/dpmHostOverride:DpmHostOverride")
 class DpmHostOverride(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -219,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
@@ -227,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 \\
         ```
@@ -271,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
@@ -279,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

@@ -199,6 +199,7 @@ class _DrsVmOverrideState:
         pulumi.set(self, "virtual_machine_id", value)
 
 
+@pulumi.type_token("vsphere:index/drsVmOverride:DrsVmOverride")
 class DrsVmOverride(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -280,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 \\
         ```
@@ -382,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 \\
         ```

pulumi_vsphere/entity_permissions.py

@@ -148,6 +148,7 @@ class _EntityPermissionsState:
         pulumi.set(self, "permissions", value)
 
 
+@pulumi.type_token("vsphere:index/entityPermissions:EntityPermissions")
 class EntityPermissions(pulumi.CustomResource):
     @overload
     def __init__(__self__,

pulumi_vsphere/file.py

@@ -32,13 +32,10 @@ class FileArgs:
         :param pulumi.Input[builtins.str] datastore: The name of the datastore to which to upload the
                file.
         :param pulumi.Input[builtins.str] destination_file: The path to where the file should be uploaded
-               or copied to on the destination `datastore` in vSphere.
-        :param pulumi.Input[builtins.bool] create_directories: Create directories in `destination_file`
-               path parameter on first apply if any are missing for copy operation.
-               
-               > **NOTE:** Any directory created as part of the `create_directories` argument
-               will not be deleted when the resource is destroyed. New directories are not
-               created if the `destination_file` path is changed in subsequent applies.
+               or copied to on the destination datastore.
+        :param pulumi.Input[builtins.str] source_file: The path to the file being uploaded from or copied.
+               Forces a new resource if changed.
+        :param pulumi.Input[builtins.bool] create_directories: Specifies whether to create the parent directories of the destination file if they do not exist.
         :param pulumi.Input[builtins.str] datacenter: The name of a datacenter to which the file will be
                uploaded.
         :param pulumi.Input[builtins.str] source_datacenter: The name of a datacenter from which the file
@@ -76,7 +73,7 @@ class FileArgs:
     def destination_file(self) -> pulumi.Input[builtins.str]:
         """
         The path to where the file should be uploaded
-        or copied to on the destination `datastore` in vSphere.
+        or copied to on the destination datastore.
         """
         return pulumi.get(self, "destination_file")
 
@@ -87,6 +84,10 @@ class FileArgs:
     @property
     @pulumi.getter(name="sourceFile")
     def source_file(self) -> pulumi.Input[builtins.str]:
+        """
+        The path to the file being uploaded from or copied.
+        Forces a new resource if changed.
+        """
         return pulumi.get(self, "source_file")
 
     @source_file.setter
@@ -97,12 +98,7 @@ class FileArgs:
     @pulumi.getter(name="createDirectories")
     def create_directories(self) -> Optional[pulumi.Input[builtins.bool]]:
         """
-        Create directories in `destination_file`
-        path parameter on first apply if any are missing for copy operation.
-
-        > **NOTE:** Any directory created as part of the `create_directories` argument
-        will not be deleted when the resource is destroyed. New directories are not
-        created if the `destination_file` path is changed in subsequent applies.
+        Specifies whether to create the parent directories of the destination file if they do not exist.
         """
         return pulumi.get(self, "create_directories")
 
@@ -162,22 +158,19 @@ class _FileState:
                  source_file: Optional[pulumi.Input[builtins.str]] = None):
         """
         Input properties used for looking up and filtering File resources.
-        :param pulumi.Input[builtins.bool] create_directories: Create directories in `destination_file`
-               path parameter on first apply if any are missing for copy operation.
-               
-               > **NOTE:** Any directory created as part of the `create_directories` argument
-               will not be deleted when the resource is destroyed. New directories are not
-               created if the `destination_file` path is changed in subsequent applies.
+        :param pulumi.Input[builtins.bool] create_directories: Specifies whether to create the parent directories of the destination file if they do not exist.
         :param pulumi.Input[builtins.str] datacenter: The name of a datacenter to which the file will be
                uploaded.
         :param pulumi.Input[builtins.str] datastore: The name of the datastore to which to upload the
                file.
         :param pulumi.Input[builtins.str] destination_file: The path to where the file should be uploaded
-               or copied to on the destination `datastore` in vSphere.
+               or copied to on the destination datastore.
         :param pulumi.Input[builtins.str] source_datacenter: The name of a datacenter from which the file
                will be copied. Forces a new resource if changed.
         :param pulumi.Input[builtins.str] source_datastore: The name of the datastore from which file will
                be copied. Forces a new resource if changed.
+        :param pulumi.Input[builtins.str] source_file: The path to the file being uploaded from or copied.
+               Forces a new resource if changed.
         """
         if create_directories is not None:
             pulumi.set(__self__, "create_directories", create_directories)
@@ -198,12 +191,7 @@ class _FileState:
     @pulumi.getter(name="createDirectories")
     def create_directories(self) -> Optional[pulumi.Input[builtins.bool]]:
         """
-        Create directories in `destination_file`
-        path parameter on first apply if any are missing for copy operation.
-
-        > **NOTE:** Any directory created as part of the `create_directories` argument
-        will not be deleted when the resource is destroyed. New directories are not
-        created if the `destination_file` path is changed in subsequent applies.
+        Specifies whether to create the parent directories of the destination file if they do not exist.
         """
         return pulumi.get(self, "create_directories")
 
@@ -242,7 +230,7 @@ class _FileState:
     def destination_file(self) -> Optional[pulumi.Input[builtins.str]]:
         """
         The path to where the file should be uploaded
-        or copied to on the destination `datastore` in vSphere.
+        or copied to on the destination datastore.
         """
         return pulumi.get(self, "destination_file")
 
@@ -279,6 +267,10 @@ class _FileState:
     @property
     @pulumi.getter(name="sourceFile")
     def source_file(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The path to the file being uploaded from or copied.
+        Forces a new resource if changed.
+        """
         return pulumi.get(self, "source_file")
 
     @source_file.setter
@@ -286,6 +278,7 @@ class _FileState:
         pulumi.set(self, "source_file", value)
 
 
+@pulumi.type_token("vsphere:index/file:File")
 class File(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -334,22 +327,19 @@ class File(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[builtins.bool] create_directories: Create directories in `destination_file`
-               path parameter on first apply if any are missing for copy operation.
-               
-               > **NOTE:** Any directory created as part of the `create_directories` argument
-               will not be deleted when the resource is destroyed. New directories are not
-               created if the `destination_file` path is changed in subsequent applies.
+        :param pulumi.Input[builtins.bool] create_directories: Specifies whether to create the parent directories of the destination file if they do not exist.
         :param pulumi.Input[builtins.str] datacenter: The name of a datacenter to which the file will be
                uploaded.
         :param pulumi.Input[builtins.str] datastore: The name of the datastore to which to upload the
                file.
         :param pulumi.Input[builtins.str] destination_file: The path to where the file should be uploaded
-               or copied to on the destination `datastore` in vSphere.
+               or copied to on the destination datastore.
         :param pulumi.Input[builtins.str] source_datacenter: The name of a datacenter from which the file
                will be copied. Forces a new resource if changed.
         :param pulumi.Input[builtins.str] source_datastore: The name of the datastore from which file will
                be copied. Forces a new resource if changed.
+        :param pulumi.Input[builtins.str] source_file: The path to the file being uploaded from or copied.
+               Forces a new resource if changed.
         """
         ...
     @overload
@@ -458,22 +448,19 @@ class File(pulumi.CustomResource):
         :param str resource_name: The unique name of the resulting resource.
         :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[builtins.bool] create_directories: Create directories in `destination_file`
-               path parameter on first apply if any are missing for copy operation.
-               
-               > **NOTE:** Any directory created as part of the `create_directories` argument
-               will not be deleted when the resource is destroyed. New directories are not
-               created if the `destination_file` path is changed in subsequent applies.
+        :param pulumi.Input[builtins.bool] create_directories: Specifies whether to create the parent directories of the destination file if they do not exist.
         :param pulumi.Input[builtins.str] datacenter: The name of a datacenter to which the file will be
                uploaded.
         :param pulumi.Input[builtins.str] datastore: The name of the datastore to which to upload the
                file.
         :param pulumi.Input[builtins.str] destination_file: The path to where the file should be uploaded
-               or copied to on the destination `datastore` in vSphere.
+               or copied to on the destination datastore.
         :param pulumi.Input[builtins.str] source_datacenter: The name of a datacenter from which the file
                will be copied. Forces a new resource if changed.
         :param pulumi.Input[builtins.str] source_datastore: The name of the datastore from which file will
                be copied. Forces a new resource if changed.
+        :param pulumi.Input[builtins.str] source_file: The path to the file being uploaded from or copied.
+               Forces a new resource if changed.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -492,12 +479,7 @@ class File(pulumi.CustomResource):
     @pulumi.getter(name="createDirectories")
     def create_directories(self) -> pulumi.Output[Optional[builtins.bool]]:
         """
-        Create directories in `destination_file`
-        path parameter on first apply if any are missing for copy operation.
-
-        > **NOTE:** Any directory created as part of the `create_directories` argument
-        will not be deleted when the resource is destroyed. New directories are not
-        created if the `destination_file` path is changed in subsequent applies.
+        Specifies whether to create the parent directories of the destination file if they do not exist.
         """
         return pulumi.get(self, "create_directories")
 
@@ -524,7 +506,7 @@ class File(pulumi.CustomResource):
     def destination_file(self) -> pulumi.Output[builtins.str]:
         """
         The path to where the file should be uploaded
-        or copied to on the destination `datastore` in vSphere.
+        or copied to on the destination datastore.
         """
         return pulumi.get(self, "destination_file")
 
@@ -549,5 +531,9 @@ class File(pulumi.CustomResource):
     @property
     @pulumi.getter(name="sourceFile")
     def source_file(self) -> pulumi.Output[builtins.str]:
+        """
+        The path to the file being uploaded from or copied.
+        Forces a new resource if changed.
+        """
         return pulumi.get(self, "source_file")
 

pulumi_vsphere/folder.py

@@ -279,6 +279,7 @@ class _FolderState:
         pulumi.set(self, "type", value)
 
 
+@pulumi.type_token("vsphere:index/folder:Folder")
 class Folder(pulumi.CustomResource):
     @overload
     def __init__(__self__,
@@ -299,7 +300,7 @@ class Folder(pulumi.CustomResource):
         Paths are always relative to the specific type of folder you are creating.
         A subfolder is discovered by parsing the relative path specified in `path`, so
         `foo/bar` will create a folder named `bar` in the parent folder `foo`, as long
-        as that folder exists.
+        as the folder `foo` exists.
 
         ## Example Usage
 
@@ -310,14 +311,14 @@ class Folder(pulumi.CustomResource):
         import pulumi
         import pulumi_vsphere as vsphere
 
-        datacenter = vsphere.get_datacenter()
+        datacenter = vsphere.get_datacenter(name=vsphere_datacenter)
         folder = vsphere.Folder("folder",
             path="test-folder",
             type="vm",
             datacenter_id=datacenter.id)
         ```
 
-        ### Example with subfolders
+        ### Example with Sub-folders
 
         The below example builds off of the above by first creating a folder named
         `test-parent`, and then locating `test-folder` in that
@@ -332,7 +333,7 @@ class Folder(pulumi.CustomResource):
         import pulumi
         import pulumi_vsphere as vsphere
 
-        datacenter = vsphere.get_datacenter()
+        datacenter = vsphere.get_datacenter(name=vsphere_datacenter)
         parent = vsphere.Folder("parent",
             path="test-parent",
             type="vm",
@@ -349,13 +350,15 @@ class Folder(pulumi.CustomResource):
 
         its full path, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
-        $ pulumi import vsphere:index/folder:Folder folder /default-dc/vm/terraform-test-folder
+        $ pulumi import vsphere:index/folder:Folder folder /default-dc/vm/example-vm-folder
         ```
 
         The above command would import the folder from our examples above, the VM
 
-        folder named `terraform-test-folder` located in the datacenter named
+        folder named `example-vm-folder` located in the datacenter named
 
         `default-dc`.
 
@@ -404,7 +407,7 @@ class Folder(pulumi.CustomResource):
         Paths are always relative to the specific type of folder you are creating.
         A subfolder is discovered by parsing the relative path specified in `path`, so
         `foo/bar` will create a folder named `bar` in the parent folder `foo`, as long
-        as that folder exists.
+        as the folder `foo` exists.
 
         ## Example Usage
 
@@ -415,14 +418,14 @@ class Folder(pulumi.CustomResource):
         import pulumi
         import pulumi_vsphere as vsphere
 
-        datacenter = vsphere.get_datacenter()
+        datacenter = vsphere.get_datacenter(name=vsphere_datacenter)
         folder = vsphere.Folder("folder",
             path="test-folder",
             type="vm",
             datacenter_id=datacenter.id)
         ```
 
-        ### Example with subfolders
+        ### Example with Sub-folders
 
         The below example builds off of the above by first creating a folder named
         `test-parent`, and then locating `test-folder` in that
@@ -437,7 +440,7 @@ class Folder(pulumi.CustomResource):
         import pulumi
         import pulumi_vsphere as vsphere
 
-        datacenter = vsphere.get_datacenter()
+        datacenter = vsphere.get_datacenter(name=vsphere_datacenter)
         parent = vsphere.Folder("parent",
             path="test-parent",
             type="vm",
@@ -454,13 +457,15 @@ class Folder(pulumi.CustomResource):
 
         its full path, via the following command:
 
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
         ```sh
-        $ pulumi import vsphere:index/folder:Folder folder /default-dc/vm/terraform-test-folder
+        $ pulumi import vsphere:index/folder:Folder folder /default-dc/vm/example-vm-folder
         ```
 
         The above command would import the folder from our examples above, the VM
 
-        folder named `terraform-test-folder` located in the datacenter named
+        folder named `example-vm-folder` located in the datacenter named
 
         `default-dc`.
 

pulumi_vsphere/get_compute_cluster_host_group.py

@@ -111,8 +111,6 @@ def get_compute_cluster_host_group(compute_cluster_id: Optional[builtins.str] =
     :param builtins.str compute_cluster_id: The
            [managed object reference ID][docs-about-morefs] of the compute cluster for
            the host group.
-           
-           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
     :param builtins.str name: The name of the host group.
     """
     __args__ = dict()
@@ -156,8 +154,6 @@ def get_compute_cluster_host_group_output(compute_cluster_id: Optional[pulumi.In
     :param builtins.str compute_cluster_id: The
            [managed object reference ID][docs-about-morefs] of the compute cluster for
            the host group.
-           
-           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
     :param builtins.str name: The name of the host group.
     """
     __args__ = dict()

pulumi_vsphere/get_datastore_cluster.py

@@ -50,7 +50,7 @@ class GetDatastoreClusterResult:
     @pulumi.getter
     def datastores(self) -> Sequence[builtins.str]:
         """
-        (Optional) The names of the datastores included in the specific 
+        (Optional) The names of the datastores included in the specific
         cluster.
         """
         return pulumi.get(self, "datastores")

pulumi_vsphere/get_datastore_stats.py

@@ -131,8 +131,6 @@ def get_datastore_stats(capacity: Optional[Mapping[str, builtins.str]] = None,
            [managed object reference ID][docs-about-morefs] of the datacenter the
            datastores are located in. For default datacenters, use the `id` attribute
            from an empty `Datacenter` data source.
-           
-           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
     :param Mapping[str, builtins.str] free_space: A mapping of the free space for each datastore in the
            datacenter, where the name of the datastore is used as key and the free space
            as value.
@@ -190,8 +188,6 @@ def get_datastore_stats_output(capacity: Optional[pulumi.Input[Optional[Mapping[
            [managed object reference ID][docs-about-morefs] of the datacenter the
            datastores are located in. For default datacenters, use the `id` attribute
            from an empty `Datacenter` data source.
-           
-           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
     :param Mapping[str, builtins.str] free_space: A mapping of the free space for each datastore in the
            datacenter, where the name of the datastore is used as key and the free space
            as value.

pulumi_vsphere/get_dynamic.py

@@ -82,8 +82,6 @@ def get_dynamic(filters: Optional[Sequence[builtins.str]] = None,
                 type: Optional[builtins.str] = None,
                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDynamicResult:
     """
-    [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
-
     The `get_dynamic` data source can be used to get the
     [managed object reference ID][docs-about-morefs] of any tagged managed object in
     vCenter Server by providing a list of tag IDs and an optional regular expression
@@ -134,8 +132,6 @@ def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[builtins.str]]] =
                        type: Optional[pulumi.Input[Optional[builtins.str]]] = None,
                        opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDynamicResult]:
     """
-    [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
-
     The `get_dynamic` data source can be used to get the
     [managed object reference ID][docs-about-morefs] of any tagged managed object in
     vCenter Server by providing a list of tag IDs and an optional regular expression