pulumi-vsphere 4.12.0a1727221820__py3-none-any.whl → 4.12.0a1727848995__py3-none-any.whl

pulumi_vsphere/role.py

@@ -116,7 +116,20 @@ class Role(pulumi.CustomResource):
                  role_privileges: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        Create a Role resource with the given unique name, props, and options.
+        ## Import
+
+        An existing role can be imported into this resource by supplying the role id. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/role:Role role1 -709298051
+        ```
+
+        Use [`vsphere_role` data source][ref-vsphere-role-data-source]
+
+        to read information about system roles.
+
+        [ref-vsphere-role-data-source]: /docs/providers/vsphere/d/vsphere_role.html
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] name: The name of the role.
@@ -129,7 +142,20 @@ class Role(pulumi.CustomResource):
                  args: Optional[RoleArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a Role resource with the given unique name, props, and options.
+        ## Import
+
+        An existing role can be imported into this resource by supplying the role id. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/role:Role role1 -709298051
+        ```
+
+        Use [`vsphere_role` data source][ref-vsphere-role-data-source]
+
+        to read information about system roles.
+
+        [ref-vsphere-role-data-source]: /docs/providers/vsphere/d/vsphere_role.html
+
         :param str resource_name: The name of the resource.
         :param RoleArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/storage_drs_vm_override.py

@@ -245,7 +245,70 @@ class StorageDrsVmOverride(pulumi.CustomResource):
                  virtual_machine_id: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a StorageDrsVmOverride resource with the given unique name, props, and options.
+        The `StorageDrsVmOverride` resource can be used to add a Storage DRS
+        override to a datastore cluster for a specific virtual machine. With this
+        resource, one can enable or disable Storage DRS, and control the automation
+        level and disk affinity for a single virtual machine without affecting the rest
+        of the datastore cluster.
+
+        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
+
+        ## Example Usage
+
+        ```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)
+        member_datastore = vsphere.get_datastore(name="datastore-cluster1-member1",
+            datacenter_id=datacenter.id)
+        pool = vsphere.get_resource_pool(name="cluster1/Resources",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="public",
+            datacenter_id=datacenter.id)
+        vm = vsphere.VirtualMachine("vm",
+            name="test",
+            resource_pool_id=pool.id,
+            datastore_id=member_datastore.id,
+            num_cpus=2,
+            memory=1024,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        drs_vm_override = vsphere.StorageDrsVmOverride("drs_vm_override",
+            datastore_cluster_id=datastore_cluster.id,
+            virtual_machine_id=vm.id,
+            sdrs_enabled="false")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the datastore cluster and the path to the virtual
+
+        machine to `pulumi import`. If no override exists, an error will be given.
+
+        An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/storageDrsVmOverride:StorageDrsVmOverride drs_vm_override \\
+        ```
+
+          '{"datastore_cluster_path": "/dc1/datastore/ds-cluster", \\
+
+          "virtual_machine_path": "/dc1/vm/srv1"}'
+
         :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
@@ -273,7 +336,70 @@ class StorageDrsVmOverride(pulumi.CustomResource):
                  args: StorageDrsVmOverrideArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a StorageDrsVmOverride resource with the given unique name, props, and options.
+        The `StorageDrsVmOverride` resource can be used to add a Storage DRS
+        override to a datastore cluster for a specific virtual machine. With this
+        resource, one can enable or disable Storage DRS, and control the automation
+        level and disk affinity for a single virtual machine without affecting the rest
+        of the datastore cluster.
+
+        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
+
+        ## Example Usage
+
+        ```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)
+        member_datastore = vsphere.get_datastore(name="datastore-cluster1-member1",
+            datacenter_id=datacenter.id)
+        pool = vsphere.get_resource_pool(name="cluster1/Resources",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="public",
+            datacenter_id=datacenter.id)
+        vm = vsphere.VirtualMachine("vm",
+            name="test",
+            resource_pool_id=pool.id,
+            datastore_id=member_datastore.id,
+            num_cpus=2,
+            memory=1024,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        drs_vm_override = vsphere.StorageDrsVmOverride("drs_vm_override",
+            datastore_cluster_id=datastore_cluster.id,
+            virtual_machine_id=vm.id,
+            sdrs_enabled="false")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the datastore cluster and the path to the virtual
+
+        machine to `pulumi import`. If no override exists, an error will be given.
+
+        An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/storageDrsVmOverride:StorageDrsVmOverride drs_vm_override \\
+        ```
+
+          '{"datastore_cluster_path": "/dc1/datastore/ds-cluster", \\
+
+          "virtual_machine_path": "/dc1/vm/srv1"}'
+
         :param str resource_name: The name of the resource.
         :param StorageDrsVmOverrideArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/tag.py

@@ -140,7 +140,83 @@ class Tag(pulumi.CustomResource):
                  name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a Tag resource with the given unique name, props, and options.
+        The `Tag` resource can be used to create and manage tags, which allow
+        you to attach metadata to objects in the vSphere inventory to make these
+        objects more sortable and searchable.
+
+        For more information about tags, click [here][ext-tags-general].
+
+        [ext-tags-general]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html
+
+        ## Example Usage
+
+        This example creates a tag named `test-tag`. This tag is assigned the
+        `test-category` category, which was created by the
+        `TagCategory` resource. The resulting
+        tag can be assigned to VMs and datastores only, and can be the only value in
+        the category that can be assigned, as per the restrictions defined by the
+        category.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            cardinality="SINGLE",
+            description="Managed by Pulumi",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        tag = vsphere.Tag("tag",
+            name="test-tag",
+            category_id=category.id,
+            description="Managed by Pulumi")
+        ```
+
+        ### Using Tags in a Supported Resource
+
+        Tags can be applied to vSphere resources via the `tags` argument
+        in any supported resource.
+
+        The following example builds on the above example by creating a
+        `VirtualMachine` and applying the
+        created tag to it:
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            cardinality="SINGLE",
+            description="Managed by Pulumi",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        tag = vsphere.Tag("tag",
+            name="test-tag",
+            category_id=category.id,
+            description="Managed by Pulumi")
+        web = vsphere.VirtualMachine("web", tags=[tag.id])
+        ```
+
+        ## Import
+
+        An existing tag can be imported into this resource by supplying
+
+        both the tag's category name and the name of the tag as a JSON string to
+
+        `pulumi import`, as per the example below:
+
+        ```sh
+        $ pulumi import vsphere:index/tag:Tag tag \\
+        ```
+
+          '{"category_name": "pulumi-test-category", "tag_name": "pulumi-test-tag"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] category_id: The unique identifier of the parent category in
@@ -156,7 +232,83 @@ class Tag(pulumi.CustomResource):
                  args: TagArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a Tag resource with the given unique name, props, and options.
+        The `Tag` resource can be used to create and manage tags, which allow
+        you to attach metadata to objects in the vSphere inventory to make these
+        objects more sortable and searchable.
+
+        For more information about tags, click [here][ext-tags-general].
+
+        [ext-tags-general]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html
+
+        ## Example Usage
+
+        This example creates a tag named `test-tag`. This tag is assigned the
+        `test-category` category, which was created by the
+        `TagCategory` resource. The resulting
+        tag can be assigned to VMs and datastores only, and can be the only value in
+        the category that can be assigned, as per the restrictions defined by the
+        category.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            cardinality="SINGLE",
+            description="Managed by Pulumi",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        tag = vsphere.Tag("tag",
+            name="test-tag",
+            category_id=category.id,
+            description="Managed by Pulumi")
+        ```
+
+        ### Using Tags in a Supported Resource
+
+        Tags can be applied to vSphere resources via the `tags` argument
+        in any supported resource.
+
+        The following example builds on the above example by creating a
+        `VirtualMachine` and applying the
+        created tag to it:
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            cardinality="SINGLE",
+            description="Managed by Pulumi",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        tag = vsphere.Tag("tag",
+            name="test-tag",
+            category_id=category.id,
+            description="Managed by Pulumi")
+        web = vsphere.VirtualMachine("web", tags=[tag.id])
+        ```
+
+        ## Import
+
+        An existing tag can be imported into this resource by supplying
+
+        both the tag's category name and the name of the tag as a JSON string to
+
+        `pulumi import`, as per the example below:
+
+        ```sh
+        $ pulumi import vsphere:index/tag:Tag tag \\
+        ```
+
+          '{"category_name": "pulumi-test-category", "tag_name": "pulumi-test-tag"}'
+
         :param str resource_name: The name of the resource.
         :param TagArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/tag_category.py

@@ -196,7 +196,45 @@ class TagCategory(pulumi.CustomResource):
                  name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a TagCategory resource with the given unique name, props, and options.
+        The `TagCategory` resource can be used to create and manage tag
+        categories, which determine how tags are grouped together and applied to
+        specific objects.
+
+        For more information about tags, click [here][ext-tags-general].
+
+        [ext-tags-general]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html
+
+        ## Example Usage
+
+        This example creates a tag category named `test-category`, with
+        single cardinality (meaning that only one tag in this category can be assigned
+        to an object at any given time). Tags in this category can only be assigned to
+        VMs and datastores.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            description="Managed by Pulumi",
+            cardinality="SINGLE",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        ```
+
+        ## Import
+
+        An existing tag category can be imported into this resource via
+
+        its name, using the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/tagCategory:TagCategory category terraform-test-category
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] associable_types: A list object types that this category is
@@ -219,7 +257,45 @@ class TagCategory(pulumi.CustomResource):
                  args: TagCategoryArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a TagCategory resource with the given unique name, props, and options.
+        The `TagCategory` resource can be used to create and manage tag
+        categories, which determine how tags are grouped together and applied to
+        specific objects.
+
+        For more information about tags, click [here][ext-tags-general].
+
+        [ext-tags-general]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html
+
+        ## Example Usage
+
+        This example creates a tag category named `test-category`, with
+        single cardinality (meaning that only one tag in this category can be assigned
+        to an object at any given time). Tags in this category can only be assigned to
+        VMs and datastores.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        category = vsphere.TagCategory("category",
+            name="test-category",
+            description="Managed by Pulumi",
+            cardinality="SINGLE",
+            associable_types=[
+                "VirtualMachine",
+                "Datastore",
+            ])
+        ```
+
+        ## Import
+
+        An existing tag category can be imported into this resource via
+
+        its name, using the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/tagCategory:TagCategory category terraform-test-category
+        ```
+
         :param str resource_name: The name of the resource.
         :param TagCategoryArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/vapp_container.py

@@ -640,7 +640,85 @@ class VappContainer(pulumi.CustomResource):
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        Create a VappContainer resource with the given unique name, props, and options.
+        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.
+
         :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
@@ -694,7 +772,85 @@ class VappContainer(pulumi.CustomResource):
                  args: VappContainerArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a VappContainer resource with the given unique name, props, and options.
+        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.
+
         :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.