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

pulumi_vsphere/get_datastore_stats.py

@@ -0,0 +1,204 @@
+# coding=utf-8
+# *** 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 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__ = [
+    'GetDatastoreStatsResult',
+    'AwaitableGetDatastoreStatsResult',
+    'get_datastore_stats',
+    'get_datastore_stats_output',
+]
+
+@pulumi.output_type
+class GetDatastoreStatsResult:
+    """
+    A collection of values returned by getDatastoreStats.
+    """
+    def __init__(__self__, capacity=None, datacenter_id=None, free_space=None, id=None):
+        if capacity and not isinstance(capacity, dict):
+            raise TypeError("Expected argument 'capacity' to be a dict")
+        pulumi.set(__self__, "capacity", capacity)
+        if datacenter_id and not isinstance(datacenter_id, str):
+            raise TypeError("Expected argument 'datacenter_id' to be a str")
+        pulumi.set(__self__, "datacenter_id", datacenter_id)
+        if free_space and not isinstance(free_space, dict):
+            raise TypeError("Expected argument 'free_space' to be a dict")
+        pulumi.set(__self__, "free_space", free_space)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+
+    @_builtins.property
+    @pulumi.getter
+    def capacity(self) -> Optional[Mapping[str, _builtins.str]]:
+        """
+        A mapping of the capacity for all datastore in the datacenter,
+        where the name of the datastore is used as key and the capacity as value.
+        """
+        return pulumi.get(self, "capacity")
+
+    @_builtins.property
+    @pulumi.getter(name="datacenterId")
+    def datacenter_id(self) -> _builtins.str:
+        """
+        The [managed object reference ID][docs-about-morefs] of the
+        datacenter the datastores are located in.
+        """
+        return pulumi.get(self, "datacenter_id")
+
+    @_builtins.property
+    @pulumi.getter(name="freeSpace")
+    def free_space(self) -> Optional[Mapping[str, _builtins.str]]:
+        """
+        A mapping of the free space for each datastore in the
+        datacenter, where the name of the datastore is used as key and the free space
+        as value.
+        """
+        return pulumi.get(self, "free_space")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+
+class AwaitableGetDatastoreStatsResult(GetDatastoreStatsResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDatastoreStatsResult(
+            capacity=self.capacity,
+            datacenter_id=self.datacenter_id,
+            free_space=self.free_space,
+            id=self.id)
+
+
+def get_datastore_stats(capacity: Optional[Mapping[str, _builtins.str]] = None,
+                        datacenter_id: Optional[_builtins.str] = None,
+                        free_space: Optional[Mapping[str, _builtins.str]] = None,
+                        opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDatastoreStatsResult:
+    """
+    The `get_datastore_stats` data source can be used to retrieve the usage
+    stats of all vSphere datastore objects in a datacenter. This can then be used as
+    a standalone data source to get information required as input to other data
+    sources.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vsphere as vsphere
+
+    datacenter = vsphere.get_datacenter(name="dc-01")
+    datastore_stats = vsphere.get_datastore_stats(datacenter_id=datacenter.id)
+    ```
+
+    A useful example of this data source would be to determine the datastore with
+    the most free space. For example, in addition to the above:
+
+    Create an `outputs.tf` like that:
+
+    ```python
+    import pulumi
+
+    pulumi.export("maxFreeSpaceName", their_max_free_space_name)
+    pulumi.export("maxFreeSpace", their_max_free_space)
+    ```
+
+    and a `locals.tf` like that:
+
+
+    :param Mapping[str, _builtins.str] capacity: A mapping of the capacity for all datastore in the datacenter,
+           where the name of the datastore is used as key and the capacity as value.
+    :param _builtins.str datacenter_id: The
+           [managed object reference ID][docs-about-morefs] of the datacenter the
+           datastores are located in. For default datacenters, use the `id` attribute
+           from an empty `Datacenter` data source.
+    :param Mapping[str, _builtins.str] free_space: A mapping of the free space for each datastore in the
+           datacenter, where the name of the datastore is used as key and the free space
+           as value.
+    """
+    __args__ = dict()
+    __args__['capacity'] = capacity
+    __args__['datacenterId'] = datacenter_id
+    __args__['freeSpace'] = free_space
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('vsphere:index/getDatastoreStats:getDatastoreStats', __args__, opts=opts, typ=GetDatastoreStatsResult).value
+
+    return AwaitableGetDatastoreStatsResult(
+        capacity=pulumi.get(__ret__, 'capacity'),
+        datacenter_id=pulumi.get(__ret__, 'datacenter_id'),
+        free_space=pulumi.get(__ret__, 'free_space'),
+        id=pulumi.get(__ret__, 'id'))
+def get_datastore_stats_output(capacity: Optional[pulumi.Input[Optional[Mapping[str, _builtins.str]]]] = None,
+                               datacenter_id: Optional[pulumi.Input[_builtins.str]] = None,
+                               free_space: Optional[pulumi.Input[Optional[Mapping[str, _builtins.str]]]] = None,
+                               opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDatastoreStatsResult]:
+    """
+    The `get_datastore_stats` data source can be used to retrieve the usage
+    stats of all vSphere datastore objects in a datacenter. This can then be used as
+    a standalone data source to get information required as input to other data
+    sources.
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_vsphere as vsphere
+
+    datacenter = vsphere.get_datacenter(name="dc-01")
+    datastore_stats = vsphere.get_datastore_stats(datacenter_id=datacenter.id)
+    ```
+
+    A useful example of this data source would be to determine the datastore with
+    the most free space. For example, in addition to the above:
+
+    Create an `outputs.tf` like that:
+
+    ```python
+    import pulumi
+
+    pulumi.export("maxFreeSpaceName", their_max_free_space_name)
+    pulumi.export("maxFreeSpace", their_max_free_space)
+    ```
+
+    and a `locals.tf` like that:
+
+
+    :param Mapping[str, _builtins.str] capacity: A mapping of the capacity for all datastore in the datacenter,
+           where the name of the datastore is used as key and the capacity as value.
+    :param _builtins.str datacenter_id: The
+           [managed object reference ID][docs-about-morefs] of the datacenter the
+           datastores are located in. For default datacenters, use the `id` attribute
+           from an empty `Datacenter` data source.
+    :param Mapping[str, _builtins.str] free_space: A mapping of the free space for each datastore in the
+           datacenter, where the name of the datastore is used as key and the free space
+           as value.
+    """
+    __args__ = dict()
+    __args__['capacity'] = capacity
+    __args__['datacenterId'] = datacenter_id
+    __args__['freeSpace'] = free_space
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vsphere:index/getDatastoreStats:getDatastoreStats', __args__, opts=opts, typ=GetDatastoreStatsResult)
+    return __ret__.apply(lambda __response__: GetDatastoreStatsResult(
+        capacity=pulumi.get(__response__, 'capacity'),
+        datacenter_id=pulumi.get(__response__, 'datacenter_id'),
+        free_space=pulumi.get(__response__, 'free_space'),
+        id=pulumi.get(__response__, 'id')))

pulumi_vsphere/get_distributed_virtual_switch.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__ = [
@@ -35,27 +40,27 @@ class GetDistributedVirtualSwitchResult:
             raise TypeError("Expected argument 'uplinks' to be a list")
         pulumi.set(__self__, "uplinks", uplinks)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="datacenterId")
-    def datacenter_id(self) -> Optional[str]:
+    def datacenter_id(self) -> Optional[_builtins.str]:
         return pulumi.get(self, "datacenter_id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def name(self) -> str:
+    def name(self) -> _builtins.str:
         return pulumi.get(self, "name")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def uplinks(self) -> Sequence[str]:
+    def uplinks(self) -> Sequence[_builtins.str]:
         """
         The list of the uplinks on this vSphere distributed switch, as per the
         `uplinks` argument to the
@@ -77,8 +82,8 @@ class AwaitableGetDistributedVirtualSwitchResult(GetDistributedVirtualSwitchResu
             uplinks=self.uplinks)
 
 
-def get_distributed_virtual_switch(datacenter_id: Optional[str] = None,
-                                   name: Optional[str] = None,
+def get_distributed_virtual_switch(datacenter_id: Optional[_builtins.str] = None,
+                                   name: Optional[_builtins.str] = None,
                                    opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDistributedVirtualSwitchResult:
     """
     The `DistributedVirtualSwitch` data source can be used to discover
@@ -105,17 +110,18 @@ def get_distributed_virtual_switch(datacenter_id: Optional[str] = None,
     vds = vsphere.get_distributed_virtual_switch(name="vds-01",
         datacenter_id=datacenter.id)
     dvpg = vsphere.DistributedPortGroup("dvpg",
+        name="dvpg-01",
         distributed_virtual_switch_uuid=vds.id,
         active_uplinks=[vds.uplinks[0]],
         standby_uplinks=[vds.uplinks[1]])
     ```
 
 
-    :param str datacenter_id: The managed object reference ID
+    :param _builtins.str datacenter_id: The managed object reference ID
            of the datacenter the VDS is located in. This can be omitted if the search
            path used in `name` is an absolute path. For default datacenters, use the `id`
            attribute from an empty `Datacenter` data source.
-    :param str name: The name of the VDS. This can be a name or path.
+    :param _builtins.str name: The name of the VDS. This can be a name or path.
     """
     __args__ = dict()
     __args__['datacenterId'] = datacenter_id
@@ -128,12 +134,9 @@ def get_distributed_virtual_switch(datacenter_id: Optional[str] = None,
         id=pulumi.get(__ret__, 'id'),
         name=pulumi.get(__ret__, 'name'),
         uplinks=pulumi.get(__ret__, 'uplinks'))
-
-
-@_utilities.lift_output_func(get_distributed_virtual_switch)
-def get_distributed_virtual_switch_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] = None,
-                                          name: Optional[pulumi.Input[str]] = None,
-                                          opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDistributedVirtualSwitchResult]:
+def get_distributed_virtual_switch_output(datacenter_id: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                          name: Optional[pulumi.Input[_builtins.str]] = None,
+                                          opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDistributedVirtualSwitchResult]:
     """
     The `DistributedVirtualSwitch` data source can be used to discover
     the ID and uplink data of a of a vSphere distributed switch (VDS). This
@@ -159,16 +162,26 @@ def get_distributed_virtual_switch_output(datacenter_id: Optional[pulumi.Input[O
     vds = vsphere.get_distributed_virtual_switch(name="vds-01",
         datacenter_id=datacenter.id)
     dvpg = vsphere.DistributedPortGroup("dvpg",
+        name="dvpg-01",
         distributed_virtual_switch_uuid=vds.id,
         active_uplinks=[vds.uplinks[0]],
         standby_uplinks=[vds.uplinks[1]])
     ```
 
 
-    :param str datacenter_id: The managed object reference ID
+    :param _builtins.str datacenter_id: The managed object reference ID
            of the datacenter the VDS is located in. This can be omitted if the search
            path used in `name` is an absolute path. For default datacenters, use the `id`
            attribute from an empty `Datacenter` data source.
-    :param str name: The name of the VDS. This can be a name or path.
+    :param _builtins.str name: The name of the VDS. This can be a name or path.
     """
-    ...
+    __args__ = dict()
+    __args__['datacenterId'] = datacenter_id
+    __args__['name'] = name
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vsphere:index/getDistributedVirtualSwitch:getDistributedVirtualSwitch', __args__, opts=opts, typ=GetDistributedVirtualSwitchResult)
+    return __ret__.apply(lambda __response__: GetDistributedVirtualSwitchResult(
+        datacenter_id=pulumi.get(__response__, 'datacenter_id'),
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name'),
+        uplinks=pulumi.get(__response__, 'uplinks')))

pulumi_vsphere/get_dynamic.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__ = [
@@ -35,27 +40,27 @@ class GetDynamicResult:
             raise TypeError("Expected argument 'type' to be a str")
         pulumi.set(__self__, "type", type)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def filters(self) -> Sequence[str]:
+    def filters(self) -> Sequence[_builtins.str]:
         return pulumi.get(self, "filters")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def id(self) -> str:
+    def id(self) -> _builtins.str:
         """
         The provider-assigned unique ID for this managed resource.
         """
         return pulumi.get(self, "id")
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="nameRegex")
-    def name_regex(self) -> Optional[str]:
+    def name_regex(self) -> Optional[_builtins.str]:
         return pulumi.get(self, "name_regex")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def type(self) -> Optional[str]:
+    def type(self) -> Optional[_builtins.str]:
         return pulumi.get(self, "type")
 
 
@@ -71,16 +76,15 @@ class AwaitableGetDynamicResult(GetDynamicResult):
             type=self.type)
 
 
-def get_dynamic(filters: Optional[Sequence[str]] = None,
-                name_regex: Optional[str] = None,
-                type: Optional[str] = None,
+def get_dynamic(filters: Optional[Sequence[_builtins.str]] = None,
+                name_regex: Optional[_builtins.str] = None,
+                type: Optional[_builtins.str] = None,
                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDynamicResult:
     """
-    [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
-
-    The `get_dynamic` data source can be used to get the [managed object reference ID][docs-about-morefs]
-    of any tagged managed object in vCenter Server by providing a list of tag IDs
-    and an optional regular expression to filter objects by name.
+    The `get_dynamic` data source can be used to get the
+    [managed object reference ID][docs-about-morefs] of any tagged managed object in
+    vCenter Server by providing a list of tag IDs and an optional regular expression
+    to filter objects by name.
 
     ## Example Usage
 
@@ -90,9 +94,9 @@ def get_dynamic(filters: Optional[Sequence[str]] = None,
 
     category = vsphere.get_tag_category(name="SomeCategory")
     tag1 = vsphere.get_tag(name="FirstTag",
-        category_id=data["vsphere_tag_category"]["cat"]["id"])
+        category_id=cat["id"])
     tag2 = vsphere.get_tag(name="SecondTag",
-        category_id=data["vsphere_tag_category"]["cat"]["id"])
+        category_id=cat["id"])
     dyn = vsphere.get_dynamic(filters=[
             tag1.id,
             tag1.id,
@@ -102,13 +106,13 @@ def get_dynamic(filters: Optional[Sequence[str]] = None,
     ```
 
 
-    :param Sequence[str] filters: A list of tag IDs that must be present on an object to
+    :param Sequence[_builtins.str] filters: A list of tag IDs that must be present on an object to
            be a match.
-    :param str name_regex: A regular expression that will be used to match
-           the object's name.
-    :param str type: The managed object type the returned object must match.
+    :param _builtins.str name_regex: A regular expression that will be used to match the
+           object's name.
+    :param _builtins.str type: The managed object type the returned object must match.
            The managed object types can be found in the managed object type section
-           [here](https://developer.vmware.com/apis/968/vsphere).
+           [here](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/).
     """
     __args__ = dict()
     __args__['filters'] = filters
@@ -122,19 +126,15 @@ def get_dynamic(filters: Optional[Sequence[str]] = None,
         id=pulumi.get(__ret__, 'id'),
         name_regex=pulumi.get(__ret__, 'name_regex'),
         type=pulumi.get(__ret__, 'type'))
-
-
-@_utilities.lift_output_func(get_dynamic)
-def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[str]]] = None,
-                       name_regex: Optional[pulumi.Input[Optional[str]]] = None,
-                       type: Optional[pulumi.Input[Optional[str]]] = None,
-                       opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDynamicResult]:
+def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[_builtins.str]]] = None,
+                       name_regex: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                       type: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                       opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDynamicResult]:
     """
-    [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
-
-    The `get_dynamic` data source can be used to get the [managed object reference ID][docs-about-morefs]
-    of any tagged managed object in vCenter Server by providing a list of tag IDs
-    and an optional regular expression to filter objects by name.
+    The `get_dynamic` data source can be used to get the
+    [managed object reference ID][docs-about-morefs] of any tagged managed object in
+    vCenter Server by providing a list of tag IDs and an optional regular expression
+    to filter objects by name.
 
     ## Example Usage
 
@@ -144,9 +144,9 @@ def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[str]]] = None,
 
     category = vsphere.get_tag_category(name="SomeCategory")
     tag1 = vsphere.get_tag(name="FirstTag",
-        category_id=data["vsphere_tag_category"]["cat"]["id"])
+        category_id=cat["id"])
     tag2 = vsphere.get_tag(name="SecondTag",
-        category_id=data["vsphere_tag_category"]["cat"]["id"])
+        category_id=cat["id"])
     dyn = vsphere.get_dynamic(filters=[
             tag1.id,
             tag1.id,
@@ -156,12 +156,22 @@ def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[str]]] = None,
     ```
 
 
-    :param Sequence[str] filters: A list of tag IDs that must be present on an object to
+    :param Sequence[_builtins.str] filters: A list of tag IDs that must be present on an object to
            be a match.
-    :param str name_regex: A regular expression that will be used to match
-           the object's name.
-    :param str type: The managed object type the returned object must match.
+    :param _builtins.str name_regex: A regular expression that will be used to match the
+           object's name.
+    :param _builtins.str type: The managed object type the returned object must match.
            The managed object types can be found in the managed object type section
-           [here](https://developer.vmware.com/apis/968/vsphere).
+           [here](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/).
     """
-    ...
+    __args__ = dict()
+    __args__['filters'] = filters
+    __args__['nameRegex'] = name_regex
+    __args__['type'] = type
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('vsphere:index/getDynamic:getDynamic', __args__, opts=opts, typ=GetDynamicResult)
+    return __ret__.apply(lambda __response__: GetDynamicResult(
+        filters=pulumi.get(__response__, 'filters'),
+        id=pulumi.get(__response__, 'id'),
+        name_regex=pulumi.get(__response__, 'name_regex'),
+        type=pulumi.get(__response__, 'type')))