pulumi-vsphere 4.11.5__py3-none-any.whl → 4.12.0a1725603256__py3-none-any.whl

pulumi_vsphere/content_library_item.py

@@ -4,14 +4,9 @@
 
 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__ = ['ContentLibraryItemArgs', 'ContentLibraryItem']
@@ -240,75 +235,7 @@ class ContentLibraryItem(pulumi.CustomResource):
                  type: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        The `ContentLibraryItem` resource can be used to create items in a
-        vSphere content library. The `file_url` must be accessible from the vSphere
-        environment as it will be downloaded from the specified location and stored
-        on the content library's storage backing.
-
-        ## Example Usage
-
-        The first example below imports an OVF Template to a content
-        library.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="ovf-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS OVF Template",
-            file_url="https://releases.example.com/ubuntu/ubuntu/ubuntu-live-server-amd64.ovf",
-            library_id=content_library.id)
-        ```
-
-        The next example imports an .iso image to a content library.
-
-        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="iso-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS .iso",
-            type="iso",
-            file_url="https://releases.example.com/ubuntu/ubuntu-live-server-amd64.iso",
-            library_id=content_library.id)
-        ```
-
-        The last example imports a virtual machine image to a content library from an
-        existing virtual machine.
-
-        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="tpl-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS",
-            source_uuid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
-            library_id=content_library.id)
-        ```
-
-        ## Import
-
-        An existing content library item can be imported into this resource by
-
-        supplying the content library ID. An example is below:
-
-        ```sh
-        $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-        ```
-
+        Create a ContentLibraryItem resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] description: A description for the content library item.
@@ -326,75 +253,7 @@ class ContentLibraryItem(pulumi.CustomResource):
                  args: ContentLibraryItemArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `ContentLibraryItem` resource can be used to create items in a
-        vSphere content library. The `file_url` must be accessible from the vSphere
-        environment as it will be downloaded from the specified location and stored
-        on the content library's storage backing.
-
-        ## Example Usage
-
-        The first example below imports an OVF Template to a content
-        library.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="ovf-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS OVF Template",
-            file_url="https://releases.example.com/ubuntu/ubuntu/ubuntu-live-server-amd64.ovf",
-            library_id=content_library.id)
-        ```
-
-        The next example imports an .iso image to a content library.
-
-        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="iso-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS .iso",
-            type="iso",
-            file_url="https://releases.example.com/ubuntu/ubuntu-live-server-amd64.iso",
-            library_id=content_library.id)
-        ```
-
-        The last example imports a virtual machine image to a content library from an
-        existing virtual machine.
-
-        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        content_library = vsphere.get_content_library(name="clb-01")
-        content_library_item = vsphere.ContentLibraryItem("content_library_item",
-            name="tpl-linux-ubuntu-server-lts",
-            description="Ubuntu Server LTS",
-            source_uuid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
-            library_id=content_library.id)
-        ```
-
-        ## Import
-
-        An existing content library item can be imported into this resource by
-
-        supplying the content library ID. An example is below:
-
-        ```sh
-        $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-        ```
-
+        Create a ContentLibraryItem resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param ContentLibraryItemArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/custom_attribute.py

@@ -4,14 +4,9 @@
 
 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__ = ['CustomAttributeArgs', 'CustomAttribute']
@@ -113,42 +108,7 @@ class CustomAttribute(pulumi.CustomResource):
                  name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        The `CustomAttribute` resource can be used to create and manage custom
-        attributes, which allow users to associate user-specific meta-information with
-        vSphere managed objects. Custom attribute values must be strings and are stored
-        on the vCenter Server and not the managed object.
-
-        For more information about custom attributes, click [here][ext-custom-attributes].
-
-        [ext-custom-attributes]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html
-
-        > **NOTE:** Custom attributes are unsupported on direct ESXi host connections
-        and require vCenter Server.
-
-        ## Example Usage
-
-        This example creates a custom attribute named `test-attribute`. The
-        resulting custom attribute can be assigned to VMs only.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        attribute = vsphere.CustomAttribute("attribute",
-            name="test-attribute",
-            managed_object_type="VirtualMachine")
-        ```
-
-        ## Import
-
-        An existing custom attribute can be imported into this resource
-
-        via its name, using the following command:
-
-        ```sh
-        $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
-        ```
-
+        Create a CustomAttribute resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] managed_object_type: The object type that this attribute may be
@@ -163,42 +123,7 @@ class CustomAttribute(pulumi.CustomResource):
                  args: Optional[CustomAttributeArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `CustomAttribute` resource can be used to create and manage custom
-        attributes, which allow users to associate user-specific meta-information with
-        vSphere managed objects. Custom attribute values must be strings and are stored
-        on the vCenter Server and not the managed object.
-
-        For more information about custom attributes, click [here][ext-custom-attributes].
-
-        [ext-custom-attributes]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html
-
-        > **NOTE:** Custom attributes are unsupported on direct ESXi host connections
-        and require vCenter Server.
-
-        ## Example Usage
-
-        This example creates a custom attribute named `test-attribute`. The
-        resulting custom attribute can be assigned to VMs only.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        attribute = vsphere.CustomAttribute("attribute",
-            name="test-attribute",
-            managed_object_type="VirtualMachine")
-        ```
-
-        ## Import
-
-        An existing custom attribute can be imported into this resource
-
-        via its name, using the following command:
-
-        ```sh
-        $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
-        ```
-
+        Create a CustomAttribute resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param CustomAttributeArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/datacenter.py

@@ -4,14 +4,9 @@
 
 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__ = ['DatacenterArgs', 'Datacenter']
@@ -252,18 +247,13 @@ class Datacenter(pulumi.CustomResource):
             folder="/research/")
         ```
 
-        ## Import
-
-        An existing datacenter can be imported into this resource
+        ## Importing
 
+        An existing datacenter can be [imported][docs-import] into this resource
         via supplying the full path to the datacenter. An example is below:
 
         [docs-import]: /docs/import/index.html
 
-        ```sh
-        $ pulumi import vsphere:index/datacenter:Datacenter dc /dc1
-        ```
-
         The above would import the datacenter named `dc1`.
 
         :param str resource_name: The name of the resource.
@@ -315,18 +305,13 @@ class Datacenter(pulumi.CustomResource):
             folder="/research/")
         ```
 
-        ## Import
-
-        An existing datacenter can be imported into this resource
+        ## Importing
 
+        An existing datacenter can be [imported][docs-import] into this resource
         via supplying the full path to the datacenter. An example is below:
 
         [docs-import]: /docs/import/index.html
 
-        ```sh
-        $ pulumi import vsphere:index/datacenter:Datacenter dc /dc1
-        ```
-
         The above would import the datacenter named `dc1`.
 
         :param str resource_name: The name of the resource.

pulumi_vsphere/datastore_cluster.py

@@ -4,14 +4,9 @@
 
 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__ = ['DatastoreClusterArgs', 'DatastoreCluster']
@@ -951,35 +946,7 @@ class DatastoreCluster(pulumi.CustomResource):
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        The `DatastoreCluster` resource can be used to create and manage
-        datastore clusters. This can be used to create groups of datastores with a
-        shared management interface, allowing for resource control and load balancing
-        through Storage DRS.
-
-        For more information on vSphere datastore clusters and Storage DRS, see [this
-        page][ref-vsphere-datastore-clusters].
-
-        [ref-vsphere-datastore-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-598DF695-107E-406B-9C95-0AF961FC227A.html
-
-        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
-        connections.
-
-        > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
-
-        ## Import
-
-        An existing datastore cluster can be imported into this resource
-
-        via the path to the cluster, via the following command:
-
-        ```sh
-        $ pulumi import vsphere:index/datastoreCluster:DatastoreCluster datastore_cluster /dc1/datastore/ds-cluster
-        ```
-
-        The above would import the datastore cluster named `ds-cluster` that is located
-
-        in the `dc1` datacenter.
-
+        Create a DatastoreCluster resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: A map of custom attribute ids to attribute
@@ -1037,35 +1004,7 @@ class DatastoreCluster(pulumi.CustomResource):
                  args: DatastoreClusterArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `DatastoreCluster` resource can be used to create and manage
-        datastore clusters. This can be used to create groups of datastores with a
-        shared management interface, allowing for resource control and load balancing
-        through Storage DRS.
-
-        For more information on vSphere datastore clusters and Storage DRS, see [this
-        page][ref-vsphere-datastore-clusters].
-
-        [ref-vsphere-datastore-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-598DF695-107E-406B-9C95-0AF961FC227A.html
-
-        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
-        connections.
-
-        > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
-
-        ## Import
-
-        An existing datastore cluster can be imported into this resource
-
-        via the path to the cluster, via the following command:
-
-        ```sh
-        $ pulumi import vsphere:index/datastoreCluster:DatastoreCluster datastore_cluster /dc1/datastore/ds-cluster
-        ```
-
-        The above would import the datastore cluster named `ds-cluster` that is located
-
-        in the `dc1` datacenter.
-
+        Create a DatastoreCluster resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param DatastoreClusterArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/datastore_cluster_vm_anti_affinity_rule.py

@@ -4,14 +4,9 @@
 
 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__ = ['DatastoreClusterVmAntiAffinityRuleArgs', 'DatastoreClusterVmAntiAffinityRule']
@@ -226,83 +221,7 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
                  virtual_machine_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        The `DatastoreClusterVmAntiAffinityRule` resource can be used to
-        manage VM anti-affinity rules in a datastore cluster, either created by the
-        `DatastoreCluster` resource or looked up
-        by the `DatastoreCluster` data source.
-
-        This rule can be used to tell a set to virtual machines to run on different
-        datastores within a cluster, useful for preventing single points of failure in
-        application cluster scenarios. When configured, Storage DRS will make a best effort to
-        ensure that the virtual machines run on different datastores, or prevent any
-        operation that would keep that from happening, depending on the value of the
-        `mandatory` flag.
-
-        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
-        connections.
-
-        > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
-
-        ## Example Usage
-
-        The example below creates two virtual machines in a cluster using the
-        `VirtualMachine` resource, creating the
-        virtual machines in the datastore cluster looked up by the
-        `DatastoreCluster` data
-        source. It then creates an anti-affinity rule for these two virtual machines,
-        ensuring they will run on different datastores whenever possible.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        datastore_cluster = vsphere.get_datastore_cluster(name="datastore-cluster1",
-            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)
-        vm = []
-        for range in [{"value": i} for i in range(0, 2)]:
-            vm.append(vsphere.VirtualMachine(f"vm-{range['value']}",
-                name=f"test-{range['value']}",
-                resource_pool_id=cluster.resource_pool_id,
-                datastore_cluster_id=datastore_cluster.id,
-                num_cpus=2,
-                memory=2048,
-                guest_id="otherLinux64Guest",
-                network_interfaces=[{
-                    "network_id": network.id,
-                }],
-                disks=[{
-                    "label": "disk0",
-                    "size": 20,
-                }]))
-        cluster_vm_anti_affinity_rule = vsphere.DatastoreClusterVmAntiAffinityRule("cluster_vm_anti_affinity_rule",
-            name="test-datastore-cluster-vm-anti-affinity-rule",
-            datastore_cluster_id=datastore_cluster.id,
-            virtual_machine_ids=[[__item.id for __item in vm]])
-        ```
-
-        ## 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/datastoreClusterVmAntiAffinityRule:DatastoreClusterVmAntiAffinityRule cluster_vm_anti_affinity_rule \\
-        ```
-
-          '{"compute_cluster_path": "/dc1/datastore/cluster1", \\
-
-          "name": "pulumi-test-datastore-cluster-vm-anti-affinity-rule"}'
-
+        Create a DatastoreClusterVmAntiAffinityRule resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] datastore_cluster_id: The managed object reference
@@ -324,83 +243,7 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
                  args: DatastoreClusterVmAntiAffinityRuleArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `DatastoreClusterVmAntiAffinityRule` resource can be used to
-        manage VM anti-affinity rules in a datastore cluster, either created by the
-        `DatastoreCluster` resource or looked up
-        by the `DatastoreCluster` data source.
-
-        This rule can be used to tell a set to virtual machines to run on different
-        datastores within a cluster, useful for preventing single points of failure in
-        application cluster scenarios. When configured, Storage DRS will make a best effort to
-        ensure that the virtual machines run on different datastores, or prevent any
-        operation that would keep that from happening, depending on the value of the
-        `mandatory` flag.
-
-        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
-        connections.
-
-        > **NOTE:** Storage DRS requires a vSphere Enterprise Plus license.
-
-        ## Example Usage
-
-        The example below creates two virtual machines in a cluster using the
-        `VirtualMachine` resource, creating the
-        virtual machines in the datastore cluster looked up by the
-        `DatastoreCluster` data
-        source. It then creates an anti-affinity rule for these two virtual machines,
-        ensuring they will run on different datastores whenever possible.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        datastore_cluster = vsphere.get_datastore_cluster(name="datastore-cluster1",
-            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)
-        vm = []
-        for range in [{"value": i} for i in range(0, 2)]:
-            vm.append(vsphere.VirtualMachine(f"vm-{range['value']}",
-                name=f"test-{range['value']}",
-                resource_pool_id=cluster.resource_pool_id,
-                datastore_cluster_id=datastore_cluster.id,
-                num_cpus=2,
-                memory=2048,
-                guest_id="otherLinux64Guest",
-                network_interfaces=[{
-                    "network_id": network.id,
-                }],
-                disks=[{
-                    "label": "disk0",
-                    "size": 20,
-                }]))
-        cluster_vm_anti_affinity_rule = vsphere.DatastoreClusterVmAntiAffinityRule("cluster_vm_anti_affinity_rule",
-            name="test-datastore-cluster-vm-anti-affinity-rule",
-            datastore_cluster_id=datastore_cluster.id,
-            virtual_machine_ids=[[__item.id for __item in vm]])
-        ```
-
-        ## 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/datastoreClusterVmAntiAffinityRule:DatastoreClusterVmAntiAffinityRule cluster_vm_anti_affinity_rule \\
-        ```
-
-          '{"compute_cluster_path": "/dc1/datastore/cluster1", \\
-
-          "name": "pulumi-test-datastore-cluster-vm-anti-affinity-rule"}'
-
+        Create a DatastoreClusterVmAntiAffinityRule resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param DatastoreClusterVmAntiAffinityRuleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.