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

pulumi_vsphere/vapp_container.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__ = ['VappContainerArgs', 'VappContainer']
@@ -645,85 +640,7 @@ class VappContainer(pulumi.CustomResource):
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        The `VappContainer` resource can be used to create and manage
-        vApps.
-
-        For more information on vSphere vApps, see the VMware vSphere [product documentation][ref-vsphere-vapp].
-
-        [ref-vsphere-vapp]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html
-
-        ## Basic Example
-
-        The example below sets up a vSphere vApp container in a compute cluster which uses
-        the default settings for CPU and memory reservations, shares, and limits. The compute cluster
-        needs to already exist in vSphere.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
-            datacenter_id=datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-01",
-            parent_resource_pool_id=compute_cluster.resource_pool_id)
-        ```
-
-        ### Example with a Virtual Machine
-
-        The example below builds off the basic example, but includes a virtual machine
-        in the new vApp container. To accomplish this, the `resource_pool_id` of the
-        virtual machine is set to the `id` of the vApp container.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
-            datacenter_id=datacenter.id)
-        datastore = vsphere.get_datastore(name="datastore-01",
-            datacenter_id=datacenter.id)
-        network = vsphere.get_network(name="VM Network",
-            datacenter_id=datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-01",
-            parent_resource_pool_id=compute_cluster.resource_pool_id)
-        vm = vsphere.VirtualMachine("vm",
-            name="foo",
-            resource_pool_id=vapp_container_vsphere_vapp_container["id"],
-            datastore_id=datastore.id,
-            num_cpus=1,
-            memory=1024,
-            guest_id="ubuntu64Guest",
-            network_interfaces=[{
-                "network_id": network.id,
-            }],
-            disks=[{
-                "label": "disk0",
-                "size": 20,
-            }])
-        ```
-
-        ## Import
-
-        An existing vApp container can be imported into this resource via
-
-        the path to the vApp container, using the following command:
-
-        Example:
-
-        ```sh
-        $ pulumi import vsphere:index/vappContainer:VappContainer vapp_container /dc-01/host/cluster-01/Resources/resource-pool-01/vapp-01
-        ```
-
-        The example above would import the vApp container named `vapp-01` that is
-
-        located in the resource pool `resource-pool-01` that is part of the host cluster
-
-        `cluster-01` in the `dc-01` datacenter.
-
+        Create a VappContainer 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[bool] cpu_expandable: Determines if the reservation on a vApp
@@ -777,85 +694,7 @@ class VappContainer(pulumi.CustomResource):
                  args: VappContainerArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `VappContainer` resource can be used to create and manage
-        vApps.
-
-        For more information on vSphere vApps, see the VMware vSphere [product documentation][ref-vsphere-vapp].
-
-        [ref-vsphere-vapp]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-E6E9D2A9-D358-4996-9BC7-F8D9D9645290.html
-
-        ## Basic Example
-
-        The example below sets up a vSphere vApp container in a compute cluster which uses
-        the default settings for CPU and memory reservations, shares, and limits. The compute cluster
-        needs to already exist in vSphere.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
-            datacenter_id=datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-01",
-            parent_resource_pool_id=compute_cluster.resource_pool_id)
-        ```
-
-        ### Example with a Virtual Machine
-
-        The example below builds off the basic example, but includes a virtual machine
-        in the new vApp container. To accomplish this, the `resource_pool_id` of the
-        virtual machine is set to the `id` of the vApp container.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        compute_cluster = vsphere.get_compute_cluster(name="cluster-01",
-            datacenter_id=datacenter.id)
-        datastore = vsphere.get_datastore(name="datastore-01",
-            datacenter_id=datacenter.id)
-        network = vsphere.get_network(name="VM Network",
-            datacenter_id=datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-01",
-            parent_resource_pool_id=compute_cluster.resource_pool_id)
-        vm = vsphere.VirtualMachine("vm",
-            name="foo",
-            resource_pool_id=vapp_container_vsphere_vapp_container["id"],
-            datastore_id=datastore.id,
-            num_cpus=1,
-            memory=1024,
-            guest_id="ubuntu64Guest",
-            network_interfaces=[{
-                "network_id": network.id,
-            }],
-            disks=[{
-                "label": "disk0",
-                "size": 20,
-            }])
-        ```
-
-        ## Import
-
-        An existing vApp container can be imported into this resource via
-
-        the path to the vApp container, using the following command:
-
-        Example:
-
-        ```sh
-        $ pulumi import vsphere:index/vappContainer:VappContainer vapp_container /dc-01/host/cluster-01/Resources/resource-pool-01/vapp-01
-        ```
-
-        The example above would import the vApp container named `vapp-01` that is
-
-        located in the resource pool `resource-pool-01` that is part of the host cluster
-
-        `cluster-01` in the `dc-01` datacenter.
-
+        Create a VappContainer resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param VappContainerArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/vapp_entity.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__ = ['VappEntityArgs', 'VappEntity']
@@ -411,77 +406,7 @@ class VappEntity(pulumi.CustomResource):
                  wait_for_guest: Optional[pulumi.Input[bool]] = None,
                  __props__=None):
         """
-        The `VappEntity` resource can be used to describe the behavior of an
-        entity (virtual machine or sub-vApp container) in a vApp container.
-
-        For more information on vSphere vApps, see [this
-        page][ref-vsphere-vapp].
-
-        [ref-vsphere-vapp]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-2A95EBB8-1779-40FA-B4FB-4D0845750879.html
-
-        ## Example Usage
-
-        The basic example below sets up a vApp container and a virtual machine in a
-        compute cluster and then creates a vApp entity to change the virtual machine's
-        power on behavior in the vApp container.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        config = pulumi.Config()
-        datacenter = config.get("datacenter")
-        if datacenter is None:
-            datacenter = "dc-01"
-        cluster = config.get("cluster")
-        if cluster is None:
-            cluster = "cluster-01"
-        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
-        compute_cluster = vsphere.get_compute_cluster(name=cluster,
-            datacenter_id=datacenter_get_datacenter.id)
-        network = vsphere.get_network(name="network1",
-            datacenter_id=datacenter_get_datacenter.id)
-        datastore = vsphere.get_datastore(name="datastore1",
-            datacenter_id=datacenter_get_datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-container-test",
-            parent_resource_pool_id=compute_cluster.id)
-        vm = vsphere.VirtualMachine("vm",
-            name="virtual-machine-test",
-            resource_pool_id=vapp_container.id,
-            datastore_id=datastore.id,
-            num_cpus=2,
-            memory=1024,
-            guest_id="ubuntu64Guest",
-            disks=[{
-                "label": "disk0",
-                "size": 1,
-            }],
-            network_interfaces=[{
-                "network_id": network.id,
-            }])
-        vapp_entity = vsphere.VappEntity("vapp_entity",
-            target_id=vm.moid,
-            container_id=vapp_container.id,
-            start_action="none")
-        ```
-
-        ## Import
-
-        An existing vApp entity can be imported into this resource via
-
-        the ID of the vApp Entity.
-
-        ```sh
-        $ pulumi import vsphere:index/vappEntity:VappEntity vapp_entity vm-123:res-456
-        ```
-
-        The above would import the vApp entity that governs the behavior of the virtual
-
-        machine with a [managed object ID][docs-about-morefs] of vm-123 in the vApp
-
-        container with the [managed object ID][docs-about-morefs] res-456.
-
+        Create a VappEntity 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] container_id: Managed object ID of the vApp
@@ -513,77 +438,7 @@ class VappEntity(pulumi.CustomResource):
                  args: VappEntityArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `VappEntity` resource can be used to describe the behavior of an
-        entity (virtual machine or sub-vApp container) in a vApp container.
-
-        For more information on vSphere vApps, see [this
-        page][ref-vsphere-vapp].
-
-        [ref-vsphere-vapp]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-2A95EBB8-1779-40FA-B4FB-4D0845750879.html
-
-        ## Example Usage
-
-        The basic example below sets up a vApp container and a virtual machine in a
-        compute cluster and then creates a vApp entity to change the virtual machine's
-        power on behavior in the vApp container.
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        config = pulumi.Config()
-        datacenter = config.get("datacenter")
-        if datacenter is None:
-            datacenter = "dc-01"
-        cluster = config.get("cluster")
-        if cluster is None:
-            cluster = "cluster-01"
-        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
-        compute_cluster = vsphere.get_compute_cluster(name=cluster,
-            datacenter_id=datacenter_get_datacenter.id)
-        network = vsphere.get_network(name="network1",
-            datacenter_id=datacenter_get_datacenter.id)
-        datastore = vsphere.get_datastore(name="datastore1",
-            datacenter_id=datacenter_get_datacenter.id)
-        vapp_container = vsphere.VappContainer("vapp_container",
-            name="vapp-container-test",
-            parent_resource_pool_id=compute_cluster.id)
-        vm = vsphere.VirtualMachine("vm",
-            name="virtual-machine-test",
-            resource_pool_id=vapp_container.id,
-            datastore_id=datastore.id,
-            num_cpus=2,
-            memory=1024,
-            guest_id="ubuntu64Guest",
-            disks=[{
-                "label": "disk0",
-                "size": 1,
-            }],
-            network_interfaces=[{
-                "network_id": network.id,
-            }])
-        vapp_entity = vsphere.VappEntity("vapp_entity",
-            target_id=vm.moid,
-            container_id=vapp_container.id,
-            start_action="none")
-        ```
-
-        ## Import
-
-        An existing vApp entity can be imported into this resource via
-
-        the ID of the vApp Entity.
-
-        ```sh
-        $ pulumi import vsphere:index/vappEntity:VappEntity vapp_entity vm-123:res-456
-        ```
-
-        The above would import the vApp entity that governs the behavior of the virtual
-
-        machine with a [managed object ID][docs-about-morefs] of vm-123 in the vApp
-
-        container with the [managed object ID][docs-about-morefs] res-456.
-
+        Create a VappEntity resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param VappEntityArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/virtual_disk.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__ = ['VirtualDiskArgs', 'VirtualDisk']
@@ -375,44 +370,7 @@ class VirtualDisk(pulumi.CustomResource):
                  vmdk_path: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        The `VirtualDisk` resource can be used to create virtual disks outside
-        of any given `VirtualMachine`
-        resource. These disks can be attached to a virtual machine by creating a disk
-        block with the `attach` parameter.
-
-        ## Example Usage
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        datastore = vsphere.get_datacenter(name="datastore-01")
-        virtual_disk = vsphere.VirtualDisk("virtual_disk",
-            size=40,
-            type="thin",
-            vmdk_path="/foo/foo.vmdk",
-            create_directories=True,
-            datacenter=datacenter.name,
-            datastore=datastore_vsphere_datastore["name"])
-        ```
-
-        ## Import
-
-        An existing virtual disk can be imported into this resource
-
-        via supplying the full datastore path to the virtual disk. An example is below:
-
-        ```sh
-        $ pulumi import vsphere:index/virtualDisk:VirtualDisk virtual_disk \\
-        ```
-
-          '{"virtual_disk_path": "/dc-01/[datastore-01]foo/bar.vmdk", \\ "create_directories": "true"}'
-
-        The above would import the virtual disk located at `foo/bar.vmdk` in the `datastore-01`
-
-        datastore of the `dc-01` datacenter with `create_directories` set as `true`.
-
+        Create a VirtualDisk 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] adapter_type: The adapter type for this virtual disk. Can be
@@ -455,44 +413,7 @@ class VirtualDisk(pulumi.CustomResource):
                  args: VirtualDiskArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        The `VirtualDisk` resource can be used to create virtual disks outside
-        of any given `VirtualMachine`
-        resource. These disks can be attached to a virtual machine by creating a disk
-        block with the `attach` parameter.
-
-        ## Example Usage
-
-        ```python
-        import pulumi
-        import pulumi_vsphere as vsphere
-
-        datacenter = vsphere.get_datacenter(name="dc-01")
-        datastore = vsphere.get_datacenter(name="datastore-01")
-        virtual_disk = vsphere.VirtualDisk("virtual_disk",
-            size=40,
-            type="thin",
-            vmdk_path="/foo/foo.vmdk",
-            create_directories=True,
-            datacenter=datacenter.name,
-            datastore=datastore_vsphere_datastore["name"])
-        ```
-
-        ## Import
-
-        An existing virtual disk can be imported into this resource
-
-        via supplying the full datastore path to the virtual disk. An example is below:
-
-        ```sh
-        $ pulumi import vsphere:index/virtualDisk:VirtualDisk virtual_disk \\
-        ```
-
-          '{"virtual_disk_path": "/dc-01/[datastore-01]foo/bar.vmdk", \\ "create_directories": "true"}'
-
-        The above would import the virtual disk located at `foo/bar.vmdk` in the `datastore-01`
-
-        datastore of the `dc-01` datacenter with `create_directories` set as `true`.
-
+        Create a VirtualDisk resource with the given unique name, props, and options.
         :param str resource_name: The name of the resource.
         :param VirtualDiskArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.