pulumi-vsphere 4.10.0a1709017641__py3-none-any.whl → 4.17.0a1763710194__py3-none-any.whl

pulumi_vsphere/dpm_host_override.py

@@ -1,12 +1,17 @@
 # coding=utf-8
-# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** WARNING: this file was generated by pulumi-language-python. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 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__ = ['DpmHostOverrideArgs', 'DpmHostOverride']
@@ -14,24 +19,24 @@ __all__ = ['DpmHostOverrideArgs', 'DpmHostOverride']
 @pulumi.input_type
 class DpmHostOverrideArgs:
     def __init__(__self__, *,
-                 compute_cluster_id: pulumi.Input[str],
-                 host_system_id: pulumi.Input[str],
-                 dpm_automation_level: Optional[pulumi.Input[str]] = None,
-                 dpm_enabled: Optional[pulumi.Input[bool]] = None):
+                 compute_cluster_id: pulumi.Input[_builtins.str],
+                 host_system_id: pulumi.Input[_builtins.str],
+                 dpm_automation_level: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_enabled: Optional[pulumi.Input[_builtins.bool]] = None):
         """
         The set of arguments for constructing a DpmHostOverride resource.
-        :param pulumi.Input[str] compute_cluster_id: The managed object reference
+        :param pulumi.Input[_builtins.str] compute_cluster_id: The managed object reference
                ID of the cluster to put the override in.  Forces a new
                resource if changed.
-        :param pulumi.Input[str] host_system_id: The managed object ID of the host.
-        :param pulumi.Input[str] dpm_automation_level: The automation level for host power
+        :param pulumi.Input[_builtins.str] host_system_id: The managed object ID of the host.
+        :param pulumi.Input[_builtins.str] dpm_automation_level: The automation level for host power
                operations on this host. Can be one of `manual` or `automated`. Default:
                `manual`.
                
                > **NOTE:** Using this resource _always_ implies an override, even if one of
                `dpm_enabled` or `dpm_automation_level` is omitted. Take note of the defaults
                for both options.
-        :param pulumi.Input[bool] dpm_enabled: Enable DPM support for this host. Default:
+        :param pulumi.Input[_builtins.bool] dpm_enabled: Enable DPM support for this host. Default:
                `false`.
         """
         pulumi.set(__self__, "compute_cluster_id", compute_cluster_id)
@@ -41,9 +46,9 @@ class DpmHostOverrideArgs:
         if dpm_enabled is not None:
             pulumi.set(__self__, "dpm_enabled", dpm_enabled)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="computeClusterId")
-    def compute_cluster_id(self) -> pulumi.Input[str]:
+    def compute_cluster_id(self) -> pulumi.Input[_builtins.str]:
         """
         The managed object reference
         ID of the cluster to put the override in.  Forces a new
@@ -52,24 +57,24 @@ class DpmHostOverrideArgs:
         return pulumi.get(self, "compute_cluster_id")
 
     @compute_cluster_id.setter
-    def compute_cluster_id(self, value: pulumi.Input[str]):
+    def compute_cluster_id(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "compute_cluster_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="hostSystemId")
-    def host_system_id(self) -> pulumi.Input[str]:
+    def host_system_id(self) -> pulumi.Input[_builtins.str]:
         """
         The managed object ID of the host.
         """
         return pulumi.get(self, "host_system_id")
 
     @host_system_id.setter
-    def host_system_id(self, value: pulumi.Input[str]):
+    def host_system_id(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "host_system_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmAutomationLevel")
-    def dpm_automation_level(self) -> Optional[pulumi.Input[str]]:
+    def dpm_automation_level(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The automation level for host power
         operations on this host. Can be one of `manual` or `automated`. Default:
@@ -82,12 +87,12 @@ class DpmHostOverrideArgs:
         return pulumi.get(self, "dpm_automation_level")
 
     @dpm_automation_level.setter
-    def dpm_automation_level(self, value: Optional[pulumi.Input[str]]):
+    def dpm_automation_level(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "dpm_automation_level", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmEnabled")
-    def dpm_enabled(self) -> Optional[pulumi.Input[bool]]:
+    def dpm_enabled(self) -> Optional[pulumi.Input[_builtins.bool]]:
         """
         Enable DPM support for this host. Default:
         `false`.
@@ -95,32 +100,32 @@ class DpmHostOverrideArgs:
         return pulumi.get(self, "dpm_enabled")
 
     @dpm_enabled.setter
-    def dpm_enabled(self, value: Optional[pulumi.Input[bool]]):
+    def dpm_enabled(self, value: Optional[pulumi.Input[_builtins.bool]]):
         pulumi.set(self, "dpm_enabled", value)
 
 
 @pulumi.input_type
 class _DpmHostOverrideState:
     def __init__(__self__, *,
-                 compute_cluster_id: Optional[pulumi.Input[str]] = None,
-                 dpm_automation_level: Optional[pulumi.Input[str]] = None,
-                 dpm_enabled: Optional[pulumi.Input[bool]] = None,
-                 host_system_id: Optional[pulumi.Input[str]] = None):
+                 compute_cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_automation_level: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_enabled: Optional[pulumi.Input[_builtins.bool]] = None,
+                 host_system_id: Optional[pulumi.Input[_builtins.str]] = None):
         """
         Input properties used for looking up and filtering DpmHostOverride resources.
-        :param pulumi.Input[str] compute_cluster_id: The managed object reference
+        :param pulumi.Input[_builtins.str] compute_cluster_id: The managed object reference
                ID of the cluster to put the override in.  Forces a new
                resource if changed.
-        :param pulumi.Input[str] dpm_automation_level: The automation level for host power
+        :param pulumi.Input[_builtins.str] dpm_automation_level: The automation level for host power
                operations on this host. Can be one of `manual` or `automated`. Default:
                `manual`.
                
                > **NOTE:** Using this resource _always_ implies an override, even if one of
                `dpm_enabled` or `dpm_automation_level` is omitted. Take note of the defaults
                for both options.
-        :param pulumi.Input[bool] dpm_enabled: Enable DPM support for this host. Default:
+        :param pulumi.Input[_builtins.bool] dpm_enabled: Enable DPM support for this host. Default:
                `false`.
-        :param pulumi.Input[str] host_system_id: The managed object ID of the host.
+        :param pulumi.Input[_builtins.str] host_system_id: The managed object ID of the host.
         """
         if compute_cluster_id is not None:
             pulumi.set(__self__, "compute_cluster_id", compute_cluster_id)
@@ -131,9 +136,9 @@ class _DpmHostOverrideState:
         if host_system_id is not None:
             pulumi.set(__self__, "host_system_id", host_system_id)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="computeClusterId")
-    def compute_cluster_id(self) -> Optional[pulumi.Input[str]]:
+    def compute_cluster_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The managed object reference
         ID of the cluster to put the override in.  Forces a new
@@ -142,12 +147,12 @@ class _DpmHostOverrideState:
         return pulumi.get(self, "compute_cluster_id")
 
     @compute_cluster_id.setter
-    def compute_cluster_id(self, value: Optional[pulumi.Input[str]]):
+    def compute_cluster_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "compute_cluster_id", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmAutomationLevel")
-    def dpm_automation_level(self) -> Optional[pulumi.Input[str]]:
+    def dpm_automation_level(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The automation level for host power
         operations on this host. Can be one of `manual` or `automated`. Default:
@@ -160,12 +165,12 @@ class _DpmHostOverrideState:
         return pulumi.get(self, "dpm_automation_level")
 
     @dpm_automation_level.setter
-    def dpm_automation_level(self, value: Optional[pulumi.Input[str]]):
+    def dpm_automation_level(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "dpm_automation_level", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmEnabled")
-    def dpm_enabled(self) -> Optional[pulumi.Input[bool]]:
+    def dpm_enabled(self) -> Optional[pulumi.Input[_builtins.bool]]:
         """
         Enable DPM support for this host. Default:
         `false`.
@@ -173,49 +178,122 @@ class _DpmHostOverrideState:
         return pulumi.get(self, "dpm_enabled")
 
     @dpm_enabled.setter
-    def dpm_enabled(self, value: Optional[pulumi.Input[bool]]):
+    def dpm_enabled(self, value: Optional[pulumi.Input[_builtins.bool]]):
         pulumi.set(self, "dpm_enabled", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="hostSystemId")
-    def host_system_id(self) -> Optional[pulumi.Input[str]]:
+    def host_system_id(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The managed object ID of the host.
         """
         return pulumi.get(self, "host_system_id")
 
     @host_system_id.setter
-    def host_system_id(self, value: Optional[pulumi.Input[str]]):
+    def host_system_id(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "host_system_id", value)
 
 
+@pulumi.type_token("vsphere:index/dpmHostOverride:DpmHostOverride")
 class DpmHostOverride(pulumi.CustomResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 compute_cluster_id: Optional[pulumi.Input[str]] = None,
-                 dpm_automation_level: Optional[pulumi.Input[str]] = None,
-                 dpm_enabled: Optional[pulumi.Input[bool]] = None,
-                 host_system_id: Optional[pulumi.Input[str]] = None,
+                 compute_cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_automation_level: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_enabled: Optional[pulumi.Input[_builtins.bool]] = None,
+                 host_system_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
-        Create a DpmHostOverride resource with the given unique name, props, and options.
+        The `DpmHostOverride` resource can be used to add a DPM override to a
+        cluster for a particular host. This allows you to control the power management
+        settings for individual hosts in the cluster while leaving any unspecified ones
+        at the default power management settings.
+
+        For more information on DPM within vSphere clusters, see [this
+        page][ref-vsphere-cluster-dpm].
+
+        [ref-vsphere-cluster-dpm]: https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-resource-management-8-0/using-drs-clusters-to-manage-resources/managing-power-resources.html
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The following example creates a compute cluster comprised of three hosts,
+        making use of the
+        `ComputeCluster` resource. DPM
+        will be disabled in the cluster as it is the default setting, but we override
+        the setting of the first host referenced by the
+        `Host` data source (`esxi1`) by using
+        the `DpmHostOverride` resource so it will be powered off when the
+        cluster does not need it to service virtual machines.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated")
+        dpm_host_override = vsphere.DpmHostOverride("dpm_host_override",
+            compute_cluster_id=compute_cluster.id,
+            host_system_id=hosts_get_host[0].id,
+            dpm_enabled=True,
+            dpm_automation_level="automated")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the cluster, and the path to the host, to `terraform
+
+        import`. If no override exists, an error will be given.  An example is below:
+
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
+        ```sh
+        $ pulumi import vsphere:index/dpmHostOverride:DpmHostOverride dpm_host_override \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "host_path": "/dc1/host/esxi1"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] compute_cluster_id: The managed object reference
+        :param pulumi.Input[_builtins.str] compute_cluster_id: The managed object reference
                ID of the cluster to put the override in.  Forces a new
                resource if changed.
-        :param pulumi.Input[str] dpm_automation_level: The automation level for host power
+        :param pulumi.Input[_builtins.str] dpm_automation_level: The automation level for host power
                operations on this host. Can be one of `manual` or `automated`. Default:
                `manual`.
                
                > **NOTE:** Using this resource _always_ implies an override, even if one of
                `dpm_enabled` or `dpm_automation_level` is omitted. Take note of the defaults
                for both options.
-        :param pulumi.Input[bool] dpm_enabled: Enable DPM support for this host. Default:
+        :param pulumi.Input[_builtins.bool] dpm_enabled: Enable DPM support for this host. Default:
                `false`.
-        :param pulumi.Input[str] host_system_id: The managed object ID of the host.
+        :param pulumi.Input[_builtins.str] host_system_id: The managed object ID of the host.
         """
         ...
     @overload
@@ -224,7 +302,79 @@ class DpmHostOverride(pulumi.CustomResource):
                  args: DpmHostOverrideArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a DpmHostOverride resource with the given unique name, props, and options.
+        The `DpmHostOverride` resource can be used to add a DPM override to a
+        cluster for a particular host. This allows you to control the power management
+        settings for individual hosts in the cluster while leaving any unspecified ones
+        at the default power management settings.
+
+        For more information on DPM within vSphere clusters, see [this
+        page][ref-vsphere-cluster-dpm].
+
+        [ref-vsphere-cluster-dpm]: https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-resource-management-8-0/using-drs-clusters-to-manage-resources/managing-power-resources.html
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The following example creates a compute cluster comprised of three hosts,
+        making use of the
+        `ComputeCluster` resource. DPM
+        will be disabled in the cluster as it is the default setting, but we override
+        the setting of the first host referenced by the
+        `Host` data source (`esxi1`) by using
+        the `DpmHostOverride` resource so it will be powered off when the
+        cluster does not need it to service virtual machines.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        config = pulumi.Config()
+        datacenter = config.get("datacenter")
+        if datacenter is None:
+            datacenter = "dc-01"
+        hosts = config.get_object("hosts")
+        if hosts is None:
+            hosts = [
+                "esxi-01.example.com",
+                "esxi-02.example.com",
+                "esxi-03.example.com",
+            ]
+        datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
+        hosts_get_host = [vsphere.get_host(name=hosts[__index],
+            datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
+        compute_cluster = vsphere.ComputeCluster("compute_cluster",
+            name="compute-cluster-test",
+            datacenter_id=dc["id"],
+            host_system_ids=[[__item.id for __item in hosts_get_host]],
+            drs_enabled=True,
+            drs_automation_level="fullyAutomated")
+        dpm_host_override = vsphere.DpmHostOverride("dpm_host_override",
+            compute_cluster_id=compute_cluster.id,
+            host_system_id=hosts_get_host[0].id,
+            dpm_enabled=True,
+            dpm_automation_level="automated")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the cluster, and the path to the host, to `terraform
+
+        import`. If no override exists, an error will be given.  An example is below:
+
+        [docs-import]: https://developer.hashicorp.com/terraform/cli/import
+
+        ```sh
+        $ pulumi import vsphere:index/dpmHostOverride:DpmHostOverride dpm_host_override \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "host_path": "/dc1/host/esxi1"}'
+
         :param str resource_name: The name of the resource.
         :param DpmHostOverrideArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -240,10 +390,10 @@ class DpmHostOverride(pulumi.CustomResource):
     def _internal_init(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 compute_cluster_id: Optional[pulumi.Input[str]] = None,
-                 dpm_automation_level: Optional[pulumi.Input[str]] = None,
-                 dpm_enabled: Optional[pulumi.Input[bool]] = None,
-                 host_system_id: Optional[pulumi.Input[str]] = None,
+                 compute_cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_automation_level: Optional[pulumi.Input[_builtins.str]] = None,
+                 dpm_enabled: Optional[pulumi.Input[_builtins.bool]] = None,
+                 host_system_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -271,10 +421,10 @@ class DpmHostOverride(pulumi.CustomResource):
     def get(resource_name: str,
             id: pulumi.Input[str],
             opts: Optional[pulumi.ResourceOptions] = None,
-            compute_cluster_id: Optional[pulumi.Input[str]] = None,
-            dpm_automation_level: Optional[pulumi.Input[str]] = None,
-            dpm_enabled: Optional[pulumi.Input[bool]] = None,
-            host_system_id: Optional[pulumi.Input[str]] = None) -> 'DpmHostOverride':
+            compute_cluster_id: Optional[pulumi.Input[_builtins.str]] = None,
+            dpm_automation_level: Optional[pulumi.Input[_builtins.str]] = None,
+            dpm_enabled: Optional[pulumi.Input[_builtins.bool]] = None,
+            host_system_id: Optional[pulumi.Input[_builtins.str]] = None) -> 'DpmHostOverride':
         """
         Get an existing DpmHostOverride resource's state with the given name, id, and optional extra
         properties used to qualify the lookup.
@@ -282,19 +432,19 @@ class DpmHostOverride(pulumi.CustomResource):
         :param str resource_name: The unique name of the resulting resource.
         :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] compute_cluster_id: The managed object reference
+        :param pulumi.Input[_builtins.str] compute_cluster_id: The managed object reference
                ID of the cluster to put the override in.  Forces a new
                resource if changed.
-        :param pulumi.Input[str] dpm_automation_level: The automation level for host power
+        :param pulumi.Input[_builtins.str] dpm_automation_level: The automation level for host power
                operations on this host. Can be one of `manual` or `automated`. Default:
                `manual`.
                
                > **NOTE:** Using this resource _always_ implies an override, even if one of
                `dpm_enabled` or `dpm_automation_level` is omitted. Take note of the defaults
                for both options.
-        :param pulumi.Input[bool] dpm_enabled: Enable DPM support for this host. Default:
+        :param pulumi.Input[_builtins.bool] dpm_enabled: Enable DPM support for this host. Default:
                `false`.
-        :param pulumi.Input[str] host_system_id: The managed object ID of the host.
+        :param pulumi.Input[_builtins.str] host_system_id: The managed object ID of the host.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -306,9 +456,9 @@ class DpmHostOverride(pulumi.CustomResource):
         __props__.__dict__["host_system_id"] = host_system_id
         return DpmHostOverride(resource_name, opts=opts, __props__=__props__)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="computeClusterId")
-    def compute_cluster_id(self) -> pulumi.Output[str]:
+    def compute_cluster_id(self) -> pulumi.Output[_builtins.str]:
         """
         The managed object reference
         ID of the cluster to put the override in.  Forces a new
@@ -316,9 +466,9 @@ class DpmHostOverride(pulumi.CustomResource):
         """
         return pulumi.get(self, "compute_cluster_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmAutomationLevel")
-    def dpm_automation_level(self) -> pulumi.Output[Optional[str]]:
+    def dpm_automation_level(self) -> pulumi.Output[Optional[_builtins.str]]:
         """
         The automation level for host power
         operations on this host. Can be one of `manual` or `automated`. Default:
@@ -330,18 +480,18 @@ class DpmHostOverride(pulumi.CustomResource):
         """
         return pulumi.get(self, "dpm_automation_level")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="dpmEnabled")
-    def dpm_enabled(self) -> pulumi.Output[Optional[bool]]:
+    def dpm_enabled(self) -> pulumi.Output[Optional[_builtins.bool]]:
         """
         Enable DPM support for this host. Default:
         `false`.
         """
         return pulumi.get(self, "dpm_enabled")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="hostSystemId")
-    def host_system_id(self) -> pulumi.Output[str]:
+    def host_system_id(self) -> pulumi.Output[_builtins.str]:
         """
         The managed object ID of the host.
         """