pulumi-vsphere 4.10.0a1710160860__py3-none-any.whl → 4.13.0a1736836157__py3-none-any.whl

pulumi_vsphere/content_library_item.py

@@ -4,9 +4,14 @@
 
 import copy
 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__ = ['ContentLibraryItemArgs', 'ContentLibraryItem']
@@ -235,7 +240,75 @@ class ContentLibraryItem(pulumi.CustomResource):
                  type: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a ContentLibraryItem resource with the given unique name, props, and options.
+        The `ContentLibraryItem` resource can be used to create items in a
+        vSphere content library. The `file_url` must be accessible from the vSphere
+        environment as it will be downloaded from the specified location and stored
+        on the content library's storage backing.
+
+        ## Example Usage
+
+        The first example below imports an OVF Template to a content
+        library.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="ovf-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS OVF Template",
+            file_url="https://releases.example.com/ubuntu/ubuntu/ubuntu-live-server-amd64.ovf",
+            library_id=content_library.id)
+        ```
+
+        The next example imports an .iso image to a content library.
+
+        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="iso-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS .iso",
+            type="iso",
+            file_url="https://releases.example.com/ubuntu/ubuntu-live-server-amd64.iso",
+            library_id=content_library.id)
+        ```
+
+        The last example imports a virtual machine image to a content library from an
+        existing virtual machine.
+
+        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="tpl-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS",
+            source_uuid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+            library_id=content_library.id)
+        ```
+
+        ## Import
+
+        An existing content library item can be imported into this resource by
+
+        supplying the content library ID. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] description: A description for the content library item.
@@ -253,7 +326,75 @@ class ContentLibraryItem(pulumi.CustomResource):
                  args: ContentLibraryItemArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a ContentLibraryItem resource with the given unique name, props, and options.
+        The `ContentLibraryItem` resource can be used to create items in a
+        vSphere content library. The `file_url` must be accessible from the vSphere
+        environment as it will be downloaded from the specified location and stored
+        on the content library's storage backing.
+
+        ## Example Usage
+
+        The first example below imports an OVF Template to a content
+        library.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="ovf-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS OVF Template",
+            file_url="https://releases.example.com/ubuntu/ubuntu/ubuntu-live-server-amd64.ovf",
+            library_id=content_library.id)
+        ```
+
+        The next example imports an .iso image to a content library.
+
+        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="iso-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS .iso",
+            type="iso",
+            file_url="https://releases.example.com/ubuntu/ubuntu-live-server-amd64.iso",
+            library_id=content_library.id)
+        ```
+
+        The last example imports a virtual machine image to a content library from an
+        existing virtual machine.
+
+        [tf-vsphere-vm-resource]: /docs/providers/vsphere/r/virtual_machine.html
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        content_library = vsphere.get_content_library(name="clb-01")
+        content_library_item = vsphere.ContentLibraryItem("content_library_item",
+            name="tpl-linux-ubuntu-server-lts",
+            description="Ubuntu Server LTS",
+            source_uuid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+            library_id=content_library.id)
+        ```
+
+        ## Import
+
+        An existing content library item can be imported into this resource by
+
+        supplying the content library ID. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/contentLibraryItem:ContentLibraryItem vsphere_content_library_item iso-linux-ubuntu-server-lts xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+        ```
+
         :param str resource_name: The name of the resource.
         :param ContentLibraryItemArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/custom_attribute.py

@@ -4,9 +4,14 @@
 
 import copy
 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__ = ['CustomAttributeArgs', 'CustomAttribute']
@@ -108,7 +113,42 @@ class CustomAttribute(pulumi.CustomResource):
                  name: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a CustomAttribute resource with the given unique name, props, and options.
+        The `CustomAttribute` resource can be used to create and manage custom
+        attributes, which allow users to associate user-specific meta-information with
+        vSphere managed objects. Custom attribute values must be strings and are stored
+        on the vCenter Server and not the managed object.
+
+        For more information about custom attributes, click [here][ext-custom-attributes].
+
+        [ext-custom-attributes]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html
+
+        > **NOTE:** Custom attributes are unsupported on direct ESXi host connections
+        and require vCenter Server.
+
+        ## Example Usage
+
+        This example creates a custom attribute named `test-attribute`. The
+        resulting custom attribute can be assigned to VMs only.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        attribute = vsphere.CustomAttribute("attribute",
+            name="test-attribute",
+            managed_object_type="VirtualMachine")
+        ```
+
+        ## Import
+
+        An existing custom attribute can be imported into this resource
+
+        via its name, using the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] managed_object_type: The object type that this attribute may be
@@ -123,7 +163,42 @@ class CustomAttribute(pulumi.CustomResource):
                  args: Optional[CustomAttributeArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a CustomAttribute resource with the given unique name, props, and options.
+        The `CustomAttribute` resource can be used to create and manage custom
+        attributes, which allow users to associate user-specific meta-information with
+        vSphere managed objects. Custom attribute values must be strings and are stored
+        on the vCenter Server and not the managed object.
+
+        For more information about custom attributes, click [here][ext-custom-attributes].
+
+        [ext-custom-attributes]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-73606C4C-763C-4E27-A1DA-032E4C46219D.html
+
+        > **NOTE:** Custom attributes are unsupported on direct ESXi host connections
+        and require vCenter Server.
+
+        ## Example Usage
+
+        This example creates a custom attribute named `test-attribute`. The
+        resulting custom attribute can be assigned to VMs only.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        attribute = vsphere.CustomAttribute("attribute",
+            name="test-attribute",
+            managed_object_type="VirtualMachine")
+        ```
+
+        ## Import
+
+        An existing custom attribute can be imported into this resource
+
+        via its name, using the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute
+        ```
+
         :param str resource_name: The name of the resource.
         :param CustomAttributeArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/datacenter.py

@@ -4,9 +4,14 @@
 
 import copy
 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__ = ['DatacenterArgs', 'Datacenter']
@@ -20,7 +25,7 @@ class DatacenterArgs:
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
         """
         The set of arguments for constructing a Datacenter resource.
-        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value 
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value
                strings to set for datacenter resource. See
                [here][docs-setting-custom-attributes] for a reference on how to set values
                for custom attributes.
@@ -34,9 +39,6 @@ class DatacenterArgs:
         :param pulumi.Input[str] name: The name of the datacenter. This name needs to be unique
                within the folder. Forces a new resource if changed.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource.
-               
-               > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-               requires vCenter 6.0 or higher.
         """
         if custom_attributes is not None:
             pulumi.set(__self__, "custom_attributes", custom_attributes)
@@ -51,7 +53,7 @@ class DatacenterArgs:
     @pulumi.getter(name="customAttributes")
     def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
         """
-        Map of custom attribute ids to value 
+        Map of custom attribute ids to value
         strings to set for datacenter resource. See
         [here][docs-setting-custom-attributes] for a reference on how to set values
         for custom attributes.
@@ -98,9 +100,6 @@ class DatacenterArgs:
     def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
         """
         The IDs of any tags to attach to this resource.
-
-        > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-        requires vCenter 6.0 or higher.
         """
         return pulumi.get(self, "tags")
 
@@ -119,7 +118,7 @@ class _DatacenterState:
                  tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None):
         """
         Input properties used for looking up and filtering Datacenter resources.
-        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value 
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value
                strings to set for datacenter resource. See
                [here][docs-setting-custom-attributes] for a reference on how to set values
                for custom attributes.
@@ -134,9 +133,6 @@ class _DatacenterState:
         :param pulumi.Input[str] name: The name of the datacenter. This name needs to be unique
                within the folder. Forces a new resource if changed.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource.
-               
-               > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-               requires vCenter 6.0 or higher.
         """
         if custom_attributes is not None:
             pulumi.set(__self__, "custom_attributes", custom_attributes)
@@ -153,7 +149,7 @@ class _DatacenterState:
     @pulumi.getter(name="customAttributes")
     def custom_attributes(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]:
         """
-        Map of custom attribute ids to value 
+        Map of custom attribute ids to value
         strings to set for datacenter resource. See
         [here][docs-setting-custom-attributes] for a reference on how to set values
         for custom attributes.
@@ -212,9 +208,6 @@ class _DatacenterState:
     def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
         """
         The IDs of any tags to attach to this resource.
-
-        > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-        requires vCenter 6.0 or higher.
         """
         return pulumi.get(self, "tags")
 
@@ -241,29 +234,41 @@ class Datacenter(pulumi.CustomResource):
 
         ### Create datacenter on the root folder
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
 
-        prod_datacenter = vsphere.Datacenter("prodDatacenter")
+        prod_datacenter = vsphere.Datacenter("prod_datacenter", name="my_prod_datacenter")
         ```
-        <!--End PulumiCodeChooser -->
 
         ### Create datacenter on a subfolder
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
 
-        research_datacenter = vsphere.Datacenter("researchDatacenter", folder="/research/")
+        research_datacenter = vsphere.Datacenter("research_datacenter",
+            name="my_research_datacenter",
+            folder="/research/")
         ```
-        <!--End PulumiCodeChooser -->
+
+        ## Import
+
+        An existing datacenter can be imported into this resource
+
+        via supplying the full path to the datacenter. An example is below:
+
+        [docs-import]: /docs/import/index.html
+
+        ```sh
+        $ pulumi import vsphere:index/datacenter:Datacenter dc /dc1
+        ```
+
+        The above would import the datacenter named `dc1`.
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value 
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value
                strings to set for datacenter resource. See
                [here][docs-setting-custom-attributes] for a reference on how to set values
                for custom attributes.
@@ -277,9 +282,6 @@ class Datacenter(pulumi.CustomResource):
         :param pulumi.Input[str] name: The name of the datacenter. This name needs to be unique
                within the folder. Forces a new resource if changed.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource.
-               
-               > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-               requires vCenter 6.0 or higher.
         """
         ...
     @overload
@@ -295,25 +297,37 @@ class Datacenter(pulumi.CustomResource):
 
         ### Create datacenter on the root folder
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
 
-        prod_datacenter = vsphere.Datacenter("prodDatacenter")
+        prod_datacenter = vsphere.Datacenter("prod_datacenter", name="my_prod_datacenter")
         ```
-        <!--End PulumiCodeChooser -->
 
         ### Create datacenter on a subfolder
 
-        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_vsphere as vsphere
 
-        research_datacenter = vsphere.Datacenter("researchDatacenter", folder="/research/")
+        research_datacenter = vsphere.Datacenter("research_datacenter",
+            name="my_research_datacenter",
+            folder="/research/")
+        ```
+
+        ## Import
+
+        An existing datacenter can be imported into this resource
+
+        via supplying the full path to the datacenter. An example is below:
+
+        [docs-import]: /docs/import/index.html
+
+        ```sh
+        $ pulumi import vsphere:index/datacenter:Datacenter dc /dc1
         ```
-        <!--End PulumiCodeChooser -->
+
+        The above would import the datacenter named `dc1`.
 
         :param str resource_name: The name of the resource.
         :param DatacenterArgs args: The arguments to use to populate this resource's properties.
@@ -370,7 +384,7 @@ class Datacenter(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[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value 
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] custom_attributes: Map of custom attribute ids to value
                strings to set for datacenter resource. See
                [here][docs-setting-custom-attributes] for a reference on how to set values
                for custom attributes.
@@ -385,9 +399,6 @@ class Datacenter(pulumi.CustomResource):
         :param pulumi.Input[str] name: The name of the datacenter. This name needs to be unique
                within the folder. Forces a new resource if changed.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] tags: The IDs of any tags to attach to this resource.
-               
-               > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-               requires vCenter 6.0 or higher.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -404,7 +415,7 @@ class Datacenter(pulumi.CustomResource):
     @pulumi.getter(name="customAttributes")
     def custom_attributes(self) -> pulumi.Output[Optional[Mapping[str, str]]]:
         """
-        Map of custom attribute ids to value 
+        Map of custom attribute ids to value
         strings to set for datacenter resource. See
         [here][docs-setting-custom-attributes] for a reference on how to set values
         for custom attributes.
@@ -447,9 +458,6 @@ class Datacenter(pulumi.CustomResource):
     def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
         """
         The IDs of any tags to attach to this resource.
-
-        > **NOTE:** Tagging support is unsupported on direct ESXi connections and
-        requires vCenter 6.0 or higher.
         """
         return pulumi.get(self, "tags")