pulumi-vsphere 4.11.0__py3-none-any.whl → 4.11.0a1710920591__py3-none-any.whl

pulumi_vsphere/get_host_pci_device.py

@@ -106,6 +106,7 @@ def get_host_pci_device(class_id: Optional[str] = None,
 
     ### With Vendor ID And Class ID
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -117,19 +118,22 @@ 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)
+        datacenter_id=datacenter.id)
     dev = vsphere.get_host_pci_device(host_id=host.id,
-       name_regex="MMC")
+        name_regex="MMC")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str class_id: The hexadecimal PCI device class ID
@@ -137,8 +141,7 @@ def get_host_pci_device(class_id: Optional[str] = None,
            [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
            
            > **NOTE:** `name_regex`, `vendor_id`, and `class_id` can all be used together.
-    :param str host_id: The [managed object reference ID][docs-about-morefs] of
-           a host.
+    :param str host_id: The [managed object reference ID][docs-about-morefs] of a host.
     :param str name_regex: A regular expression that will be used to match the
            host PCI device name.
     :param str vendor_id: The hexadecimal PCI device vendor ID.
@@ -175,6 +178,7 @@ def get_host_pci_device_output(class_id: Optional[pulumi.Input[Optional[str]]] =
 
     ### With Vendor ID And Class ID
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -186,19 +190,22 @@ 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)
+        datacenter_id=datacenter.id)
     dev = vsphere.get_host_pci_device(host_id=host.id,
-       name_regex="MMC")
+        name_regex="MMC")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str class_id: The hexadecimal PCI device class ID
@@ -206,8 +213,7 @@ def get_host_pci_device_output(class_id: Optional[pulumi.Input[Optional[str]]] =
            [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
            
            > **NOTE:** `name_regex`, `vendor_id`, and `class_id` can all be used together.
-    :param str host_id: The [managed object reference ID][docs-about-morefs] of
-           a host.
+    :param str host_id: The [managed object reference ID][docs-about-morefs] of a host.
     :param str name_regex: A regular expression that will be used to match the
            host PCI device name.
     :param str vendor_id: The hexadecimal PCI device vendor ID.

pulumi_vsphere/get_host_thumbprint.py

@@ -76,23 +76,25 @@ def get_host_thumbprint(address: Optional[str] = None,
                         port: Optional[str] = None,
                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetHostThumbprintResult:
     """
-    The `vsphere_thumbprint` data source can be used to discover the host thumbprint
-    of an ESXi host. This can be used when adding the `Host` resource. If
-    the ESXi host is using a certificate chain, the first one returned will be used
-    to generate the thumbprint.
+    The `vsphere_thumbprint` data source can be used to discover the host
+    thumbprint of an ESXi host. This can be used when adding the `Host`
+    resource. If the ESXi host is using a certificate chain, the first one returned
+    will be used to generate the thumbprint.
 
     ## 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 thumbprint
-           from.
+    :param str address: The address of the ESXi host to retrieve the
+           thumbprint from.
     :param bool insecure: Disables SSL certificate verification.
            Default: `false`
     :param str port: The port to use connecting to the ESXi host. Default: 443
@@ -117,23 +119,25 @@ def get_host_thumbprint_output(address: Optional[pulumi.Input[str]] = None,
                                port: Optional[pulumi.Input[Optional[str]]] = None,
                                opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetHostThumbprintResult]:
     """
-    The `vsphere_thumbprint` data source can be used to discover the host thumbprint
-    of an ESXi host. This can be used when adding the `Host` resource. If
-    the ESXi host is using a certificate chain, the first one returned will be used
-    to generate the thumbprint.
+    The `vsphere_thumbprint` data source can be used to discover the host
+    thumbprint of an ESXi host. This can be used when adding the `Host`
+    resource. If the ESXi host is using a certificate chain, the first one returned
+    will be used to generate the thumbprint.
 
     ## 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 thumbprint
-           from.
+    :param str address: The address of the ESXi host to retrieve the
+           thumbprint from.
     :param bool insecure: Disables SSL certificate verification.
            Default: `false`
     :param str port: The port to use connecting to the ESXi host. Default: 443

pulumi_vsphere/get_host_vgpu_profile.py

@@ -94,6 +94,7 @@ def get_host_vgpu_profile(host_id: Optional[str] = None,
 
     ### To Return All VGPU Profiles
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -103,9 +104,11 @@ def get_host_vgpu_profile(host_id: Optional[str] = None,
         datacenter_id=datacenter.id)
     vgpu_profile = vsphere.get_host_vgpu_profile(host_id=host.id)
     ```
+    <!--End PulumiCodeChooser -->
 
     ### With VGPU Profile Name_regex
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -116,10 +119,10 @@ def get_host_vgpu_profile(host_id: Optional[str] = None,
     vgpu_profile = vsphere.get_host_vgpu_profile(host_id=host.id,
         name_regex="a100")
     ```
+    <!--End PulumiCodeChooser -->
 
 
-    :param str host_id: The [managed object reference ID][docs-about-morefs] of
-           a host.
+    :param str host_id: The [managed object reference ID][docs-about-morefs] of a host.
     :param str name_regex: A regular expression that will be used to match the
            host vGPU profile name.
            
@@ -150,6 +153,7 @@ def get_host_vgpu_profile_output(host_id: Optional[pulumi.Input[str]] = None,
 
     ### To Return All VGPU Profiles
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -159,9 +163,11 @@ def get_host_vgpu_profile_output(host_id: Optional[pulumi.Input[str]] = None,
         datacenter_id=datacenter.id)
     vgpu_profile = vsphere.get_host_vgpu_profile(host_id=host.id)
     ```
+    <!--End PulumiCodeChooser -->
 
     ### With VGPU Profile Name_regex
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -172,10 +178,10 @@ def get_host_vgpu_profile_output(host_id: Optional[pulumi.Input[str]] = None,
     vgpu_profile = vsphere.get_host_vgpu_profile(host_id=host.id,
         name_regex="a100")
     ```
+    <!--End PulumiCodeChooser -->
 
 
-    :param str host_id: The [managed object reference ID][docs-about-morefs] of
-           a host.
+    :param str host_id: The [managed object reference ID][docs-about-morefs] of a host.
     :param str name_regex: A regular expression that will be used to match the
            host vGPU profile name.
            

pulumi_vsphere/get_license.py

@@ -61,8 +61,7 @@ class GetLicenseResult:
     @pulumi.getter
     def labels(self) -> Mapping[str, str]:
         """
-        A map of key/value pairs attached as labels (tags) to the license
-        key.
+        A map of key/value pairs attached as labels (tags) to the license key.
         """
         return pulumi.get(self, "labels")
 
@@ -119,12 +118,14 @@ def get_license(license_key: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     license = vsphere.get_license(license_key="00000-00000-00000-00000-00000")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str license_key: The license key.
@@ -153,12 +154,14 @@ def get_license_output(license_key: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     license = vsphere.get_license(license_key="00000-00000-00000-00000-00000")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str license_key: The license key.

pulumi_vsphere/get_network.py

@@ -91,14 +91,15 @@ def get_network(datacenter_id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNetworkResult:
     """
-    The `get_network` data source can be used to discover the ID of a network in
-    vSphere. This can be any network that can be used as the backing for a network
-    interface for `VirtualMachine` or any other vSphere resource that
-    requires a network. This includes standard (host-based) port groups, distributed
-    port groups, or opaque networks such as those managed by NSX.
+    The `get_network` data source can be used to discover the ID of a network
+    in vSphere. This can be any network that can be used as the backing for a
+    network interface for `VirtualMachine` or any other vSphere resource
+    that requires a network. This includes standard (host-based) port groups,
+    distributed port groups, or opaque networks such as those managed by NSX.
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -107,6 +108,7 @@ def get_network(datacenter_id: Optional[str] = None,
     network = vsphere.get_network(name="VM Network",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -115,8 +117,8 @@ def get_network(datacenter_id: Optional[str] = None,
            use the `id` attribute from an empty `Datacenter` data source.
     :param str distributed_virtual_switch_uuid: For distributed port group type
            network objects, the ID of the distributed virtual switch for which the port
-           group belongs. It is useful to differentiate port groups with same name using
-           the distributed virtual switch ID.
+           group belongs. It is useful to differentiate port groups with same name
+           using the distributed virtual switch ID.
     :param str name: The name of the network. This can be a name or path.
     """
     __args__ = dict()
@@ -140,14 +142,15 @@ def get_network_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] = No
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetNetworkResult]:
     """
-    The `get_network` data source can be used to discover the ID of a network in
-    vSphere. This can be any network that can be used as the backing for a network
-    interface for `VirtualMachine` or any other vSphere resource that
-    requires a network. This includes standard (host-based) port groups, distributed
-    port groups, or opaque networks such as those managed by NSX.
+    The `get_network` data source can be used to discover the ID of a network
+    in vSphere. This can be any network that can be used as the backing for a
+    network interface for `VirtualMachine` or any other vSphere resource
+    that requires a network. This includes standard (host-based) port groups,
+    distributed port groups, or opaque networks such as those managed by NSX.
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -156,6 +159,7 @@ def get_network_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] = No
     network = vsphere.get_network(name="VM Network",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -164,8 +168,8 @@ def get_network_output(datacenter_id: Optional[pulumi.Input[Optional[str]]] = No
            use the `id` attribute from an empty `Datacenter` data source.
     :param str distributed_virtual_switch_uuid: For distributed port group type
            network objects, the ID of the distributed virtual switch for which the port
-           group belongs. It is useful to differentiate port groups with same name using
-           the distributed virtual switch ID.
+           group belongs. It is useful to differentiate port groups with same name
+           using the distributed virtual switch ID.
     :param str name: The name of the network. This can be a name or path.
     """
     ...

pulumi_vsphere/get_policy.py

@@ -65,6 +65,7 @@ def get_policy(name: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -72,6 +73,7 @@ def get_policy(name: Optional[str] = None,
     prod_platinum_replicated = vsphere.get_policy(name="prod_platinum_replicated")
     dev_silver_nonreplicated = vsphere.get_policy(name="dev_silver_nonreplicated")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the storage policy.
@@ -99,6 +101,7 @@ def get_policy_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -106,6 +109,7 @@ def get_policy_output(name: Optional[pulumi.Input[str]] = None,
     prod_platinum_replicated = vsphere.get_policy(name="prod_platinum_replicated")
     dev_silver_nonreplicated = vsphere.get_policy(name="dev_silver_nonreplicated")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the storage policy.

pulumi_vsphere/get_resource_pool.py

@@ -73,6 +73,7 @@ def get_resource_pool(datacenter_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -81,6 +82,7 @@ def get_resource_pool(datacenter_id: Optional[str] = None,
     pool = vsphere.get_resource_pool(name="resource-pool-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
     ### Specifying the Root Resource Pool for a Standalone ESXi Host
 
@@ -89,22 +91,22 @@ def get_resource_pool(datacenter_id: Optional[str] = None,
     data source.
 
     All compute resources in vSphere have a resource pool, even if one has not been
-    explicitly created. This resource pool is referred to as the _root resource
-    pool_ and can be looked up by specifying the path.
+    explicitly created. This resource pool is referred to as the
+    _root resource pool_ and can be looked up by specifying the path.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     pool = vsphere.get_resource_pool(name="esxi-01.example.com/Resources",
-        datacenter_id=datacenter["id"])
+        datacenter_id=data["vsphere_datacenter"]["datacenter"]["id"])
     ```
+    <!--End PulumiCodeChooser -->
 
-    For more information on the root resource pool, see
-    [Managing Resource Pools][vmware-docs-resource-pools] in the vSphere
-    documentation.
+    For more information on the root resource pool, see [Managing Resource Pools][vmware-docs-resource-pools] in the vSphere documentation.
 
-    [vmware-docs-resource-pools]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-60077B40-66FF-4625-934A-641703ED7601.html
+    [vmware-docs-resource-pools]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html
 
 
     :param str datacenter_id: The managed object reference ID
@@ -143,6 +145,7 @@ def get_resource_pool_output(datacenter_id: Optional[pulumi.Input[Optional[str]]
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -151,6 +154,7 @@ def get_resource_pool_output(datacenter_id: Optional[pulumi.Input[Optional[str]]
     pool = vsphere.get_resource_pool(name="resource-pool-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
     ### Specifying the Root Resource Pool for a Standalone ESXi Host
 
@@ -159,22 +163,22 @@ def get_resource_pool_output(datacenter_id: Optional[pulumi.Input[Optional[str]]
     data source.
 
     All compute resources in vSphere have a resource pool, even if one has not been
-    explicitly created. This resource pool is referred to as the _root resource
-    pool_ and can be looked up by specifying the path.
+    explicitly created. This resource pool is referred to as the
+    _root resource pool_ and can be looked up by specifying the path.
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     pool = vsphere.get_resource_pool(name="esxi-01.example.com/Resources",
-        datacenter_id=datacenter["id"])
+        datacenter_id=data["vsphere_datacenter"]["datacenter"]["id"])
     ```
+    <!--End PulumiCodeChooser -->
 
-    For more information on the root resource pool, see
-    [Managing Resource Pools][vmware-docs-resource-pools] in the vSphere
-    documentation.
+    For more information on the root resource pool, see [Managing Resource Pools][vmware-docs-resource-pools] in the vSphere documentation.
 
-    [vmware-docs-resource-pools]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-resource-management/GUID-60077B40-66FF-4625-934A-641703ED7601.html
+    [vmware-docs-resource-pools]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.resmgmt.doc/GUID-60077B40-66FF-4625-934A-641703ED7601.html
 
 
     :param str datacenter_id: The managed object reference ID

pulumi_vsphere/get_role.py

@@ -95,17 +95,19 @@ def get_role(description: Optional[str] = None,
              role_privileges: Optional[Sequence[str]] = None,
              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetRoleResult:
     """
-    The `Role` data source can be used to discover the `id` and privileges
-    associated with a role given its name or display label.
+    The `Role` data source can be used to discover the `id` and privileges associated
+    with a role given its name or display label.
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     terraform_role = vsphere.get_role(label="Terraform to vSphere Integration Role")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str description: The description of the role.
@@ -135,17 +137,19 @@ def get_role_output(description: Optional[pulumi.Input[Optional[str]]] = None,
                     role_privileges: Optional[pulumi.Input[Optional[Sequence[str]]]] = None,
                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetRoleResult]:
     """
-    The `Role` data source can be used to discover the `id` and privileges
-    associated with a role given its name or display label.
+    The `Role` data source can be used to discover the `id` and privileges associated
+    with a role given its name or display label.
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     terraform_role = vsphere.get_role(label="Terraform to vSphere Integration Role")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str description: The description of the role.

pulumi_vsphere/get_tag.py

@@ -86,6 +86,7 @@ def get_tag(category_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -94,6 +95,7 @@ def get_tag(category_id: Optional[str] = None,
     tag = vsphere.get_tag(name="example-tag",
         category_id=category.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str category_id: The ID of the tag category in which the tag is
@@ -129,6 +131,7 @@ def get_tag_output(category_id: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -137,6 +140,7 @@ def get_tag_output(category_id: Optional[pulumi.Input[str]] = None,
     tag = vsphere.get_tag(name="example-tag",
         category_id=category.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str category_id: The ID of the tag category in which the tag is

pulumi_vsphere/get_tag_category.py

@@ -94,12 +94,14 @@ def get_tag_category(name: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     category = vsphere.get_tag_category(name="example-category")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the tag category.
@@ -132,12 +134,14 @@ def get_tag_category_output(name: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
 
     category = vsphere.get_tag_category(name="example-category")
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str name: The name of the tag category.

pulumi_vsphere/get_vapp_container.py

@@ -73,6 +73,7 @@ def get_vapp_container(datacenter_id: Optional[str] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -81,6 +82,7 @@ def get_vapp_container(datacenter_id: Optional[str] = None,
     pool = vsphere.get_vapp_container(name="vapp-container-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID
@@ -112,6 +114,7 @@ def get_vapp_container_output(datacenter_id: Optional[pulumi.Input[str]] = None,
 
     ## Example Usage
 
+    <!--Start PulumiCodeChooser -->
     ```python
     import pulumi
     import pulumi_vsphere as vsphere
@@ -120,6 +123,7 @@ def get_vapp_container_output(datacenter_id: Optional[pulumi.Input[str]] = None,
     pool = vsphere.get_vapp_container(name="vapp-container-01",
         datacenter_id=datacenter.id)
     ```
+    <!--End PulumiCodeChooser -->
 
 
     :param str datacenter_id: The managed object reference ID