pulumi-vsphere 4.10.0a1709368772__py3-none-any.whl → 4.10.0a1710245029__py3-none-any.whl

pulumi_vsphere/get_datastore.py

@@ -21,7 +21,7 @@ class GetDatastoreResult:
     """
     A collection of values returned by getDatastore.
     """
-    def __init__(__self__, datacenter_id=None, id=None, name=None):
+    def __init__(__self__, datacenter_id=None, id=None, name=None, stats=None):
         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)
@@ -31,6 +31,9 @@ class GetDatastoreResult:
         if name and not isinstance(name, str):
             raise TypeError("Expected argument 'name' to be a str")
         pulumi.set(__self__, "name", name)
+        if stats and not isinstance(stats, dict):
+            raise TypeError("Expected argument 'stats' to be a dict")
+        pulumi.set(__self__, "stats", stats)
 
     @property
     @pulumi.getter(name="datacenterId")
@@ -50,6 +53,16 @@ class GetDatastoreResult:
     def name(self) -> str:
         return pulumi.get(self, "name")
 
+    @property
+    @pulumi.getter
+    def stats(self) -> Optional[Mapping[str, Any]]:
+        """
+        The disk space usage statistics for the specific datastore. The total
+        datastore capacity is represented as `capacity` and the free remaining disk is
+        represented as `free`.
+        """
+        return pulumi.get(self, "stats")
+
 
 class AwaitableGetDatastoreResult(GetDatastoreResult):
     # pylint: disable=using-constant-test
@@ -59,11 +72,13 @@ class AwaitableGetDatastoreResult(GetDatastoreResult):
         return GetDatastoreResult(
             datacenter_id=self.datacenter_id,
             id=self.id,
-            name=self.name)
+            name=self.name,
+            stats=self.stats)
 
 
 def get_datastore(datacenter_id: Optional[str] = None,
                   name: Optional[str] = None,
+                  stats: Optional[Mapping[str, Any]] = None,
                   opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDatastoreResult:
     """
     The `get_datastore` data source can be used to discover the ID of a
@@ -73,6 +88,7 @@ def get_datastore(datacenter_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -81,6 +97,7 @@ def get_datastore(datacenter_id: Optional[str] = None,
     datastore = vsphere.get_datastore(name="datastore-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -88,22 +105,28 @@ def get_datastore(datacenter_id: Optional[str] = None,
            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 datastore. This can be a name or path.
+    :param Mapping[str, Any] stats: The disk space usage statistics for the specific datastore. The total
+           datastore capacity is represented as `capacity` and the free remaining disk is
+           represented as `free`.
     """
     __args__ = dict()
     __args__['datacenterId'] = datacenter_id
     __args__['name'] = name
+    __args__['stats'] = stats
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('vsphere:index/getDatastore:getDatastore', __args__, opts=opts, typ=GetDatastoreResult).value
 
     return AwaitableGetDatastoreResult(
         datacenter_id=pulumi.get(__ret__, 'datacenter_id'),
         id=pulumi.get(__ret__, 'id'),
-        name=pulumi.get(__ret__, 'name'))
+        name=pulumi.get(__ret__, 'name'),
+        stats=pulumi.get(__ret__, 'stats'))
 
 
 @_utilities.lift_output_func(get_datastore)
 def get_datastore_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] = None,
                          name: Optional[pulumi.Input[str]] = None,
+                         stats: Optional[pulumi.Input[Optional[Mapping[str, Any]]]] = None,
                          opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetDatastoreResult]:
     """
     The `get_datastore` data source can be used to discover the ID of a
@@ -113,6 +136,7 @@ def get_datastore_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] =
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -121,6 +145,7 @@ def get_datastore_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] =
     datastore = vsphere.get_datastore(name="datastore-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -128,5 +153,8 @@ def get_datastore_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] =
            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 datastore. This can be a name or path.
+    :param Mapping[str, Any] stats: The disk space usage statistics for the specific datastore. The total
+           datastore capacity is represented as `capacity` and the free remaining disk is
+           represented as `free`.
     """
     ...

pulumi_vsphere/get_datastore_cluster.py

@@ -73,6 +73,7 @@ def get_datastore_cluster(datacenter_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -81,6 +82,7 @@ def get_datastore_cluster(datacenter_id: Optional[str] = None,
     datastore_cluster = vsphere.get_datastore_cluster(name="datastore-cluster-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference
@@ -114,6 +116,7 @@ def get_datastore_cluster_output(datacenter_id: Optional[pulumi.Input[Optional[s
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -122,6 +125,7 @@ def get_datastore_cluster_output(datacenter_id: Optional[pulumi.Input[Optional[s
     datastore_cluster = vsphere.get_datastore_cluster(name="datastore-cluster-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference

pulumi_vsphere/get_datastore_stats.py

@@ -0,0 +1,202 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+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)
+
+    @property
+    @pulumi.getter
+    def capacity(self) -> Optional[Mapping[str, Any]]:
+        """
+        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")
+
+    @property
+    @pulumi.getter(name="datacenterId")
+    def datacenter_id(self) -> str:
+        """
+        The [managed object reference ID][docs-about-morefs]
+        of the datacenter the datastores are located in.
+        """
+        return pulumi.get(self, "datacenter_id")
+
+    @property
+    @pulumi.getter(name="freeSpace")
+    def free_space(self) -> Optional[Mapping[str, Any]]:
+        """
+        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")
+
+    @property
+    @pulumi.getter
+    def id(self) -> 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, Any]] = None,
+                        datacenter_id: Optional[str] = None,
+                        free_space: Optional[Mapping[str, Any]] = 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 datasource to get information required as input to other data sources.
+
+    ## Example Usage
+
+    <!--Start PulumiCodeChooser -->
+    ```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)
+    ```
+    <!--End PulumiCodeChooser -->
+
+    A usefull example of this datasource would be to determine the
+    datastore with the most free space. For example, in addition to
+    the above:
+
+    Create an `outputs.tf` like that:
+
+    <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+
+    pulumi.export("maxFreeSpaceName", local["max_free_space_name"])
+    pulumi.export("maxFreeSpace", local["max_free_space"])
+    ```
+    <!--End PulumiCodeChooser -->
+
+    and a `locals.tf` like that:
+
+
+    :param Mapping[str, Any] 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 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.
+           
+           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
+    :param Mapping[str, Any] 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'))
+
+
+@_utilities.lift_output_func(get_datastore_stats)
+def get_datastore_stats_output(capacity: Optional[pulumi.Input[Optional[Mapping[str, Any]]]] = None,
+                               datacenter_id: Optional[pulumi.Input[str]] = None,
+                               free_space: Optional[pulumi.Input[Optional[Mapping[str, Any]]]] = None,
+                               opts: Optional[pulumi.InvokeOptions] = 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 datasource to get information required as input to other data sources.
+
+    ## Example Usage
+
+    <!--Start PulumiCodeChooser -->
+    ```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)
+    ```
+    <!--End PulumiCodeChooser -->
+
+    A usefull example of this datasource would be to determine the
+    datastore with the most free space. For example, in addition to
+    the above:
+
+    Create an `outputs.tf` like that:
+
+    <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+
+    pulumi.export("maxFreeSpaceName", local["max_free_space_name"])
+    pulumi.export("maxFreeSpace", local["max_free_space"])
+    ```
+    <!--End PulumiCodeChooser -->
+
+    and a `locals.tf` like that:
+
+
+    :param Mapping[str, Any] 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 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.
+           
+           [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
+    :param Mapping[str, Any] 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.
+    """
+    ...

pulumi_vsphere/get_distributed_virtual_switch.py

@@ -97,6 +97,7 @@ def get_distributed_virtual_switch(datacenter_id: Optional[str] = None,
     `DistributedPortGroup` resource that uses the first uplink as a
     primary uplink and the second uplink as a secondary.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -109,6 +110,7 @@ def get_distributed_virtual_switch(datacenter_id: Optional[str] = None,
         active_uplinks=[vds.uplinks[0]],
         standby_uplinks=[vds.uplinks[1]])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -151,6 +153,7 @@ def get_distributed_virtual_switch_output(datacenter_id: Optional[pulumi.Input[O
     `DistributedPortGroup` resource that uses the first uplink as a
     primary uplink and the second uplink as a secondary.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -163,6 +166,7 @@ def get_distributed_virtual_switch_output(datacenter_id: Optional[pulumi.Input[O
         active_uplinks=[vds.uplinks[0]],
         standby_uplinks=[vds.uplinks[1]])
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID

pulumi_vsphere/get_dynamic.py

@@ -84,6 +84,7 @@ def get_dynamic(filters: Optional[Sequence[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -100,6 +101,7 @@ def get_dynamic(filters: Optional[Sequence[str]] = None,
         name_regex="ubuntu",
         type="Datacenter")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param Sequence[str] filters: A list of tag IDs that must be present on an object to
@@ -138,6 +140,7 @@ def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[str]]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -154,6 +157,7 @@ def get_dynamic_output(filters: Optional[pulumi.Input[Sequence[str]]] = None,
         name_regex="ubuntu",
         type="Datacenter")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param Sequence[str] filters: A list of tag IDs that must be present on an object to

pulumi_vsphere/get_folder.py

@@ -61,12 +61,14 @@ def get_folder(path: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     folder = vsphere.get_folder(path="/dc-01/datastore-01/folder-01")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str path: The absolute path of the folder. For example, given a
@@ -94,12 +96,14 @@ def get_folder_output(path: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     folder = vsphere.get_folder(path="/dc-01/datastore-01/folder-01")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str path: The absolute path of the folder. For example, given a

pulumi_vsphere/get_guest_os_customization.py

@@ -124,12 +124,14 @@ def get_guest_os_customization(name: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     gosc1 = vsphere.get_guest_os_customization(name="linux-spec")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the customization specification is the unique identifier per vCenter Server instance.
@@ -160,12 +162,14 @@ def get_guest_os_customization_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     gosc1 = vsphere.get_guest_os_customization(name="linux-spec")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the customization specification is the unique identifier per vCenter Server instance.

pulumi_vsphere/get_host.py

@@ -85,6 +85,7 @@ def get_host(datacenter_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -93,6 +94,7 @@ def get_host(datacenter_id: Optional[str] = None,
     host = vsphere.get_host(name="esxi-01.example.com",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -127,6 +129,7 @@ def get_host_output(datacenter_id: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -135,6 +138,7 @@ def get_host_output(datacenter_id: Optional[pulumi.Input[str]] = None,
     host = vsphere.get_host(name="esxi-01.example.com",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID

pulumi_vsphere/get_host_pci_device.py

@@ -103,8 +103,10 @@ def get_host_pci_device(class_id: Optional[str] = None,
     `VirtualMachine`'s `pci_device_id`.
 
     ## Example Usage
+
     ### With Vendor ID And Class ID
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -116,8 +118,23 @@ def get_host_pci_device(class_id: Optional[str] = None,
         class_id="123",
         vendor_id="456")
     ```
+    <!--End PulumiCodeChooser -->
+
     ### With Name Regular Expression
 
+     <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+    import pulumi_vsphere as vsphere
+
+    datacenter = vsphere.get_datacenter(name="dc-01")
+    host = vsphere.get_host(name="esxi-01.example.com",
+        datacenter_id=datacenter.id)
+    dev = vsphere.get_host_pci_device(host_id=host.id,
+        name_regex="MMC")
+    ```
+    <!--End PulumiCodeChooser -->
+
 
     :param str class_id: The hexadecimal PCI device class ID
            
@@ -158,8 +175,10 @@ def get_host_pci_device_output(class_id: Optional[pulumi.Input[Optional[str]]] =
     `VirtualMachine`'s `pci_device_id`.
 
     ## Example Usage
+
     ### With Vendor ID And Class ID
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -171,8 +190,23 @@ def get_host_pci_device_output(class_id: Optional[pulumi.Input[Optional[str]]] =
         class_id="123",
         vendor_id="456")
     ```
+    <!--End PulumiCodeChooser -->
+
     ### With Name Regular Expression
 
+     <!--Start PulumiCodeChooser -->
+    ```python
+    import pulumi
+    import pulumi_vsphere as vsphere
+
+    datacenter = vsphere.get_datacenter(name="dc-01")
+    host = vsphere.get_host(name="esxi-01.example.com",
+        datacenter_id=datacenter.id)
+    dev = vsphere.get_host_pci_device(host_id=host.id,
+        name_regex="MMC")
+    ```
+    <!--End PulumiCodeChooser -->
+
 
     :param str class_id: The hexadecimal PCI device class ID
            

pulumi_vsphere/get_host_thumbprint.py

@@ -83,12 +83,14 @@ def get_host_thumbprint(address: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     thumbprint = vsphere.get_host_thumbprint(address="esxi-01.example.com")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str address: The address of the ESXi host to retrieve the
@@ -124,12 +126,14 @@ def get_host_thumbprint_output(address: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     thumbprint = vsphere.get_host_thumbprint(address="esxi-01.example.com")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str address: The address of the ESXi host to retrieve the