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

pulumi_vsphere/datastore_cluster.py

@@ -946,7 +946,35 @@ class DatastoreCluster(pulumi.CustomResource):
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        Create a DatastoreCluster resource with the given unique name, props, and options.
+        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.
+
         :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
@@ -1004,7 +1032,35 @@ class DatastoreCluster(pulumi.CustomResource):
                  args: DatastoreClusterArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a DatastoreCluster resource with the given unique name, props, and options.
+        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.
+
         :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

@@ -221,7 +221,83 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
                  virtual_machine_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  __props__=None):
         """
-        Create a DatastoreClusterVmAntiAffinityRule resource with the given unique name, props, and options.
+        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"}'
+
         :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
@@ -243,7 +319,83 @@ class DatastoreClusterVmAntiAffinityRule(pulumi.CustomResource):
                  args: DatastoreClusterVmAntiAffinityRuleArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a DatastoreClusterVmAntiAffinityRule resource with the given unique name, props, and options.
+        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"}'
+
         :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.

pulumi_vsphere/distributed_port_group.py

@@ -1699,7 +1699,146 @@ class DistributedPortGroup(pulumi.CustomResource):
                  vlan_ranges: Optional[pulumi.Input[Sequence[pulumi.Input[Union['DistributedPortGroupVlanRangeArgs', 'DistributedPortGroupVlanRangeArgsDict']]]]] = None,
                  __props__=None):
         """
-        Create a DistributedPortGroup resource with the given unique name, props, and options.
+        The `DistributedPortGroup` resource can be used to manage
+        distributed port groups connected to vSphere Distributed Switches (VDS).
+        A vSphere Distributed Switch can be managed by the
+        `DistributedVirtualSwitch` resource.
+
+        Distributed port groups can be used as networks for virtual machines, allowing
+        the virtual machines to use the networking supplied by a vSphere Distributed
+        Switch, with a set of policies that apply to that individual network, if
+        desired.
+
+        * For an overview on vSphere networking concepts, refer to the vSphere
+        [product documentation][ref-vsphere-net-concepts].
+
+        * For more information on distributed port groups, refer to the vSphere
+        [product documentation][ref-vsphere-dvportgroup].
+
+        [ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
+        [ref-vsphere-dvportgroup]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-69933F6E-2442-46CF-AA17-1196CB9A0A09.html
+
+        > **NOTE:** This resource requires vCenter and is not available on
+        direct ESXi host connections.
+
+        ## Example Usage
+
+        The configuration below builds on the example given in the
+        `DistributedVirtualSwitch` resource by
+        adding the `DistributedPortGroup` resource, attaching itself to the
+        vSphere Distributed Switch and assigning VLAN ID 1000.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        network_interfaces = config.get_object("networkInterfaces")
+        if network_interfaces is None:
+            network_interfaces = [
+                "vmnic0",
+                "vmnic1",
+                "vmnic2",
+                "vmnic3",
+            ]
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter.id) for __index in range(len(hosts))]
+        vds = vsphere.DistributedVirtualSwitch("vds",
+            name="vds-01",
+            datacenter_id=datacenter.id,
+            uplinks=[
+                "uplink1",
+                "uplink2",
+                "uplink3",
+                "uplink4",
+            ],
+            active_uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            standby_uplinks=[
+                "uplink3",
+                "uplink4",
+            ],
+            hosts=[
+                {
+                    "host_system_id": host[0].id,
+                    "devices": [network_interfaces],
+                },
+                {
+                    "host_system_id": host[1].id,
+                    "devices": [network_interfaces],
+                },
+                {
+                    "host_system_id": host[2].id,
+                    "devices": [network_interfaces],
+                },
+            ])
+        pg = vsphere.DistributedPortGroup("pg",
+            name="pg-01",
+            distributed_virtual_switch_uuid=vds.id,
+            vlan_id=1000)
+        ```
+
+        ### Overriding VDS policies
+
+        All of the default port policies available in the
+        `DistributedVirtualSwitch` resource can be overridden on the port
+        group level by specifying new settings for them.
+
+        As an example, we also take this example from the
+        `DistributedVirtualSwitch` resource where we manually specify our
+        uplink count and uplink order. While the vSphere Distributed Switch has a
+        default policy of using the first uplink as an active uplink and the second
+        one as a standby, the overridden port group policy means that both uplinks
+        will be used as active uplinks in this specific port group.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        vds = vsphere.DistributedVirtualSwitch("vds",
+            name="vds-01",
+            datacenter_id=datacenter["id"],
+            uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            active_uplinks=["uplink1"],
+            standby_uplinks=["uplink2"])
+        pg = vsphere.DistributedPortGroup("pg",
+            name="pg-01",
+            distributed_virtual_switch_uuid=vds.id,
+            vlan_id=1000,
+            active_uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            standby_uplinks=[])
+        ```
+
+        ## Import
+
+        An existing port group can be imported into this resource using
+
+        the managed object id of the port group, via the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/distributedPortGroup:DistributedPortGroup pg /dc-01/network/pg-01
+        ```
+
+        The above would import the port group named `pg-01` that is located 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[Sequence[pulumi.Input[str]]] active_uplinks: List of active uplinks used for load balancing, matching the names of the uplinks assigned in the DVS.
@@ -1784,7 +1923,146 @@ class DistributedPortGroup(pulumi.CustomResource):
                  args: DistributedPortGroupArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a DistributedPortGroup resource with the given unique name, props, and options.
+        The `DistributedPortGroup` resource can be used to manage
+        distributed port groups connected to vSphere Distributed Switches (VDS).
+        A vSphere Distributed Switch can be managed by the
+        `DistributedVirtualSwitch` resource.
+
+        Distributed port groups can be used as networks for virtual machines, allowing
+        the virtual machines to use the networking supplied by a vSphere Distributed
+        Switch, with a set of policies that apply to that individual network, if
+        desired.
+
+        * For an overview on vSphere networking concepts, refer to the vSphere
+        [product documentation][ref-vsphere-net-concepts].
+
+        * For more information on distributed port groups, refer to the vSphere
+        [product documentation][ref-vsphere-dvportgroup].
+
+        [ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
+        [ref-vsphere-dvportgroup]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-69933F6E-2442-46CF-AA17-1196CB9A0A09.html
+
+        > **NOTE:** This resource requires vCenter and is not available on
+        direct ESXi host connections.
+
+        ## Example Usage
+
+        The configuration below builds on the example given in the
+        `DistributedVirtualSwitch` resource by
+        adding the `DistributedPortGroup` resource, attaching itself to the
+        vSphere Distributed Switch and assigning VLAN ID 1000.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        network_interfaces = config.get_object("networkInterfaces")
+        if network_interfaces is None:
+            network_interfaces = [
+                "vmnic0",
+                "vmnic1",
+                "vmnic2",
+                "vmnic3",
+            ]
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter.id) for __index in range(len(hosts))]
+        vds = vsphere.DistributedVirtualSwitch("vds",
+            name="vds-01",
+            datacenter_id=datacenter.id,
+            uplinks=[
+                "uplink1",
+                "uplink2",
+                "uplink3",
+                "uplink4",
+            ],
+            active_uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            standby_uplinks=[
+                "uplink3",
+                "uplink4",
+            ],
+            hosts=[
+                {
+                    "host_system_id": host[0].id,
+                    "devices": [network_interfaces],
+                },
+                {
+                    "host_system_id": host[1].id,
+                    "devices": [network_interfaces],
+                },
+                {
+                    "host_system_id": host[2].id,
+                    "devices": [network_interfaces],
+                },
+            ])
+        pg = vsphere.DistributedPortGroup("pg",
+            name="pg-01",
+            distributed_virtual_switch_uuid=vds.id,
+            vlan_id=1000)
+        ```
+
+        ### Overriding VDS policies
+
+        All of the default port policies available in the
+        `DistributedVirtualSwitch` resource can be overridden on the port
+        group level by specifying new settings for them.
+
+        As an example, we also take this example from the
+        `DistributedVirtualSwitch` resource where we manually specify our
+        uplink count and uplink order. While the vSphere Distributed Switch has a
+        default policy of using the first uplink as an active uplink and the second
+        one as a standby, the overridden port group policy means that both uplinks
+        will be used as active uplinks in this specific port group.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        vds = vsphere.DistributedVirtualSwitch("vds",
+            name="vds-01",
+            datacenter_id=datacenter["id"],
+            uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            active_uplinks=["uplink1"],
+            standby_uplinks=["uplink2"])
+        pg = vsphere.DistributedPortGroup("pg",
+            name="pg-01",
+            distributed_virtual_switch_uuid=vds.id,
+            vlan_id=1000,
+            active_uplinks=[
+                "uplink1",
+                "uplink2",
+            ],
+            standby_uplinks=[])
+        ```
+
+        ## Import
+
+        An existing port group can be imported into this resource using
+
+        the managed object id of the port group, via the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/distributedPortGroup:DistributedPortGroup pg /dc-01/network/pg-01
+        ```
+
+        The above would import the port group named `pg-01` that is located in the `dc-01`
+
+        datacenter.
+
         :param str resource_name: The name of the resource.
         :param DistributedPortGroupArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.