pulumi-vsphere 4.12.0a1727221820__py3-none-any.whl → 4.12.0a1727889180__py3-none-any.whl

pulumi_vsphere/ha_vm_override.py

@@ -575,7 +575,85 @@ class HaVmOverride(pulumi.CustomResource):
                  virtual_machine_id: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a HaVmOverride resource with the given unique name, props, and options.
+        The `HaVmOverride` resource can be used to add an override for
+        vSphere HA settings on a cluster for a specific virtual machine. With this
+        resource, one can control specific HA settings so that they are different than
+        the cluster default, accommodating the needs of that specific virtual machine,
+        while not affecting the rest of the cluster.
+
+        For more information on vSphere HA, see [this page][ref-vsphere-ha-clusters].
+
+        [ref-vsphere-ha-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-availability/GUID-5432CA24-14F1-44E3-87FB-61D937831CF6.html
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The example below creates a virtual machine in a cluster using the
+        `VirtualMachine` resource, creating the
+        virtual machine in the cluster looked up by the
+        `ComputeCluster` data source.
+
+        Considering a scenario where this virtual machine is of high value to the
+        application or organization for which it does its work, it's been determined in
+        the event of a host failure, that this should be one of the first virtual
+        machines to be started by vSphere HA during recovery. Hence, it
+        `ha_vm_restart_priority` has been set to `highest`,
+        which, assuming that the default restart priority is `medium` and no other
+        virtual machine has been assigned the `highest` priority, will mean that this
+        VM will be started before any other virtual machine in the event of host
+        failure.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datastore(name="datastore1",
+            datacenter_id=datacenter.id)
+        cluster = vsphere.get_compute_cluster(name="cluster-01",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="network1",
+            datacenter_id=datacenter.id)
+        vm = vsphere.VirtualMachine("vm",
+            name="test",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        ha_vm_override = vsphere.HaVmOverride("ha_vm_override",
+            compute_cluster_id=cluster.id,
+            virtual_machine_id=vm.id,
+            ha_vm_restart_priority="highest")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the cluster, and the path to the virtual machine, to
+
+        `pulumi import`. If no override exists, an error will be given.  An example
+
+        is below:
+
+        ```sh
+        $ pulumi import vsphere:index/haVmOverride:HaVmOverride ha_vm_override \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "virtual_machine_path": "/dc1/vm/srv1"}'
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] compute_cluster_id: The managed object ID of the cluster.
@@ -613,7 +691,85 @@ class HaVmOverride(pulumi.CustomResource):
                  args: HaVmOverrideArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a HaVmOverride resource with the given unique name, props, and options.
+        The `HaVmOverride` resource can be used to add an override for
+        vSphere HA settings on a cluster for a specific virtual machine. With this
+        resource, one can control specific HA settings so that they are different than
+        the cluster default, accommodating the needs of that specific virtual machine,
+        while not affecting the rest of the cluster.
+
+        For more information on vSphere HA, see [this page][ref-vsphere-ha-clusters].
+
+        [ref-vsphere-ha-clusters]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-availability/GUID-5432CA24-14F1-44E3-87FB-61D937831CF6.html
+
+        > **NOTE:** This resource requires vCenter and is not available on direct ESXi
+        connections.
+
+        ## Example Usage
+
+        The example below creates a virtual machine in a cluster using the
+        `VirtualMachine` resource, creating the
+        virtual machine in the cluster looked up by the
+        `ComputeCluster` data source.
+
+        Considering a scenario where this virtual machine is of high value to the
+        application or organization for which it does its work, it's been determined in
+        the event of a host failure, that this should be one of the first virtual
+        machines to be started by vSphere HA during recovery. Hence, it
+        `ha_vm_restart_priority` has been set to `highest`,
+        which, assuming that the default restart priority is `medium` and no other
+        virtual machine has been assigned the `highest` priority, will mean that this
+        VM will be started before any other virtual machine in the event of host
+        failure.
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datastore(name="datastore1",
+            datacenter_id=datacenter.id)
+        cluster = vsphere.get_compute_cluster(name="cluster-01",
+            datacenter_id=datacenter.id)
+        network = vsphere.get_network(name="network1",
+            datacenter_id=datacenter.id)
+        vm = vsphere.VirtualMachine("vm",
+            name="test",
+            resource_pool_id=cluster.resource_pool_id,
+            datastore_id=datastore.id,
+            num_cpus=2,
+            memory=2048,
+            guest_id="otherLinux64Guest",
+            network_interfaces=[{
+                "network_id": network.id,
+            }],
+            disks=[{
+                "label": "disk0",
+                "size": 20,
+            }])
+        ha_vm_override = vsphere.HaVmOverride("ha_vm_override",
+            compute_cluster_id=cluster.id,
+            virtual_machine_id=vm.id,
+            ha_vm_restart_priority="highest")
+        ```
+
+        ## Import
+
+        An existing override can be imported into this resource by
+
+        supplying both the path to the cluster, and the path to the virtual machine, to
+
+        `pulumi import`. If no override exists, an error will be given.  An example
+
+        is below:
+
+        ```sh
+        $ pulumi import vsphere:index/haVmOverride:HaVmOverride ha_vm_override \\
+        ```
+
+          '{"compute_cluster_path": "/dc1/host/cluster1", \\
+
+          "virtual_machine_path": "/dc1/vm/srv1"}'
+
         :param str resource_name: The name of the resource.
         :param HaVmOverrideArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/host.py

@@ -644,7 +644,131 @@ class Host(pulumi.CustomResource):
                  username: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a Host resource with the given unique name, props, and options.
+        Provides a VMware vSphere host resource. This represents an ESXi host that
+        can be used either as a member of a cluster or as a standalone host.
+
+        ## Example Usage
+
+        ### Create a standalone host
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        thumbprint = vsphere.get_host_thumbprint(address="esx-01.example.com",
+            insecure=True)
+        esx_01 = vsphere.Host("esx-01",
+            hostname="esx-01.example.com",
+            username="root",
+            password="password",
+            license="00000-00000-00000-00000-00000",
+            thumbprint=thumbprint.id,
+            datacenter=datacenter.id)
+        ```
+
+        ## Import
+
+        An existing host can be imported into this resource by supplying
+
+        the host's ID.
+
+        [docs-import]: /docs/import/index.html
+
+        Obtain the host's ID using the data source. For example:
+
+        hcl
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = "dc-01"
+
+        }
+
+        data "vsphere_host" "host" {
+
+          name          = "esx-01.example.com"
+
+          datacenter_id = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        output "host_id" {
+
+          value = data.vsphere_host.host.id
+
+        }
+
+        Next, create a resource configuration, For example:
+
+        hcl
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = "dc-01"
+
+        }
+
+        data "vsphere_host_thumbprint" "thumbprint" {
+
+          address = "esx-01.example.com"
+
+          insecure = true
+
+        }
+
+        resource "vsphere_host" "esx-01" {
+
+          hostname   = "esx-01.example.com"
+
+          username   = "root"
+
+          password   = "password"
+
+          thumbprint = data.vsphere_host_thumbprint.thumbprint.id
+
+          datacenter = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        hcl
+
+        resource "vsphere_host" "esx-01" {
+
+          hostname   = "esx-01.example.com"
+
+          username   = "root"
+
+          password   = "password"
+
+          license    = "00000-00000-00000-00000-00000"
+
+          thumbprint = data.vsphere_host_thumbprint.thumbprint.id
+
+          cluster    = data.vsphere_compute_cluster.cluster.id
+
+          services {
+
+            ntpd {
+            
+              enabled     = true
+            
+              policy      = "on"
+            
+              ntp_servers = ["pool.ntp.org"]
+            
+            }
+
+        }
+
+        console
+
+        ```sh
+        $ pulumi import vsphere:index/host:Host esx-01 host-123
+        ```
+
+        The above would import the host `esx-01.example.com` with the host ID `host-123`.
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] cluster: The ID of the Compute Cluster this host should
@@ -699,7 +823,131 @@ class Host(pulumi.CustomResource):
                  args: HostArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a Host resource with the given unique name, props, and options.
+        Provides a VMware vSphere host resource. This represents an ESXi host that
+        can be used either as a member of a cluster or as a standalone host.
+
+        ## Example Usage
+
+        ### Create a standalone host
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        thumbprint = vsphere.get_host_thumbprint(address="esx-01.example.com",
+            insecure=True)
+        esx_01 = vsphere.Host("esx-01",
+            hostname="esx-01.example.com",
+            username="root",
+            password="password",
+            license="00000-00000-00000-00000-00000",
+            thumbprint=thumbprint.id,
+            datacenter=datacenter.id)
+        ```
+
+        ## Import
+
+        An existing host can be imported into this resource by supplying
+
+        the host's ID.
+
+        [docs-import]: /docs/import/index.html
+
+        Obtain the host's ID using the data source. For example:
+
+        hcl
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = "dc-01"
+
+        }
+
+        data "vsphere_host" "host" {
+
+          name          = "esx-01.example.com"
+
+          datacenter_id = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        output "host_id" {
+
+          value = data.vsphere_host.host.id
+
+        }
+
+        Next, create a resource configuration, For example:
+
+        hcl
+
+        data "vsphere_datacenter" "datacenter" {
+
+          name = "dc-01"
+
+        }
+
+        data "vsphere_host_thumbprint" "thumbprint" {
+
+          address = "esx-01.example.com"
+
+          insecure = true
+
+        }
+
+        resource "vsphere_host" "esx-01" {
+
+          hostname   = "esx-01.example.com"
+
+          username   = "root"
+
+          password   = "password"
+
+          thumbprint = data.vsphere_host_thumbprint.thumbprint.id
+
+          datacenter = data.vsphere_datacenter.datacenter.id
+
+        }
+
+        hcl
+
+        resource "vsphere_host" "esx-01" {
+
+          hostname   = "esx-01.example.com"
+
+          username   = "root"
+
+          password   = "password"
+
+          license    = "00000-00000-00000-00000-00000"
+
+          thumbprint = data.vsphere_host_thumbprint.thumbprint.id
+
+          cluster    = data.vsphere_compute_cluster.cluster.id
+
+          services {
+
+            ntpd {
+            
+              enabled     = true
+            
+              policy      = "on"
+            
+              ntp_servers = ["pool.ntp.org"]
+            
+            }
+
+        }
+
+        console
+
+        ```sh
+        $ pulumi import vsphere:index/host:Host esx-01 host-123
+        ```
+
+        The above would import the host `esx-01.example.com` with the host ID `host-123`.
+
         :param str resource_name: The name of the resource.
         :param HostArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/host_port_group.py

@@ -750,11 +750,16 @@ class HostPortGroup(pulumi.CustomResource):
             allow_promiscuous=True)
         ```
 
-        ## Importing
+        ## Import
 
         An existing host port group can be imported into this resource
+
         using the host port group's ID. An example is below:
 
+        ```sh
+        $ pulumi import vsphere:index/hostPortGroup:HostPortGroup management tf-HostPortGroup:host-123:management
+        ```
+
         The above would import the `management` host port group from host with ID `host-123`.
 
         :param str resource_name: The name of the resource.
@@ -860,11 +865,16 @@ class HostPortGroup(pulumi.CustomResource):
             allow_promiscuous=True)
         ```
 
-        ## Importing
+        ## Import
 
         An existing host port group can be imported into this resource
+
         using the host port group's ID. An example is below:
 
+        ```sh
+        $ pulumi import vsphere:index/hostPortGroup:HostPortGroup management tf-HostPortGroup:host-123:management
+        ```
+
         The above would import the `management` host port group from host with ID `host-123`.
 
         :param str resource_name: The name of the resource.

pulumi_vsphere/host_virtual_switch.py

@@ -764,7 +764,38 @@ class HostVirtualSwitch(pulumi.CustomResource):
                  teaming_policy: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a HostVirtualSwitch resource with the given unique name, props, and options.
+        The `HostVirtualSwitch` resource can be used to manage vSphere
+        standard switches on an ESXi host. These switches can be used as a backing for
+        standard port groups, which can be managed by the
+        `HostPortGroup` resource.
+
+        For an overview on vSphere networking concepts, see [this
+        page][ref-vsphere-net-concepts].
+
+        [ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
+
+        ## Example Usage
+
+        ## Import
+
+        An existing vSwitch can be imported into this resource by its ID.
+
+        The convention of the id is a prefix, the host system [managed objectID][docs-about-morefs], and the virtual switch
+
+        name. An example would be `tf-HostVirtualSwitch:host-10:vSwitchTerraformTest`.
+
+        Import can the be done via the following command:
+
+        [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
+
+        ```sh
+        $ pulumi import vsphere:index/hostVirtualSwitch:HostVirtualSwitch switch tf-HostVirtualSwitch:host-10:vSwitchTerraformTest
+        ```
+
+        The above would import the vSwitch named `vSwitchTerraformTest` that is located in the `host-10`
+
+        vSphere host.
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[Sequence[pulumi.Input[str]]] active_nics: List of active network adapters used for load balancing.
@@ -806,7 +837,38 @@ class HostVirtualSwitch(pulumi.CustomResource):
                  args: HostVirtualSwitchArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a HostVirtualSwitch resource with the given unique name, props, and options.
+        The `HostVirtualSwitch` resource can be used to manage vSphere
+        standard switches on an ESXi host. These switches can be used as a backing for
+        standard port groups, which can be managed by the
+        `HostPortGroup` resource.
+
+        For an overview on vSphere networking concepts, see [this
+        page][ref-vsphere-net-concepts].
+
+        [ref-vsphere-net-concepts]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.networking.doc/GUID-2B11DBB8-CB3C-4AFF-8885-EFEA0FC562F4.html
+
+        ## Example Usage
+
+        ## Import
+
+        An existing vSwitch can be imported into this resource by its ID.
+
+        The convention of the id is a prefix, the host system [managed objectID][docs-about-morefs], and the virtual switch
+
+        name. An example would be `tf-HostVirtualSwitch:host-10:vSwitchTerraformTest`.
+
+        Import can the be done via the following command:
+
+        [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
+
+        ```sh
+        $ pulumi import vsphere:index/hostVirtualSwitch:HostVirtualSwitch switch tf-HostVirtualSwitch:host-10:vSwitchTerraformTest
+        ```
+
+        The above would import the vSwitch named `vSwitchTerraformTest` that is located in the `host-10`
+
+        vSphere host.
+
         :param str resource_name: The name of the resource.
         :param HostVirtualSwitchArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/nas_datastore.py

@@ -638,7 +638,37 @@ class NasDatastore(pulumi.CustomResource):
                  type: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a NasDatastore resource with the given unique name, props, and options.
+        The `NasDatastore` resource can be used to create and manage NAS
+        datastores on an ESXi host or a set of hosts. The resource supports mounting
+        NFS v3 and v4.1 shares to be used as datastores.
+
+        > **NOTE:** Unlike `VmfsDatastore`, a NAS
+        datastore is only mounted on the hosts you choose to mount it on. To mount on
+        multiple hosts, you must specify each host that you want to add in the
+        `host_system_ids` argument.
+
+        ## Import
+
+        An existing NAS datastore can be imported into this resource via
+
+        its managed object ID, via the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/nasDatastore:NasDatastore datastore datastore-123
+        ```
+
+        You need a tool like [`govc`][ext-govc] that can display managed object IDs.
+
+        [ext-govc]: https://github.com/vmware/govmomi/tree/master/govc
+
+        In the case of govc, you can locate a managed object ID from an inventory path
+
+        by doing the following:
+
+        $ govc ls -i /dc/datastore/terraform-test
+
+        Datastore:datastore-123
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] access_mode: Access mode for the mount point. Can be one of
@@ -687,7 +717,37 @@ class NasDatastore(pulumi.CustomResource):
                  args: NasDatastoreArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a NasDatastore resource with the given unique name, props, and options.
+        The `NasDatastore` resource can be used to create and manage NAS
+        datastores on an ESXi host or a set of hosts. The resource supports mounting
+        NFS v3 and v4.1 shares to be used as datastores.
+
+        > **NOTE:** Unlike `VmfsDatastore`, a NAS
+        datastore is only mounted on the hosts you choose to mount it on. To mount on
+        multiple hosts, you must specify each host that you want to add in the
+        `host_system_ids` argument.
+
+        ## Import
+
+        An existing NAS datastore can be imported into this resource via
+
+        its managed object ID, via the following command:
+
+        ```sh
+        $ pulumi import vsphere:index/nasDatastore:NasDatastore datastore datastore-123
+        ```
+
+        You need a tool like [`govc`][ext-govc] that can display managed object IDs.
+
+        [ext-govc]: https://github.com/vmware/govmomi/tree/master/govc
+
+        In the case of govc, you can locate a managed object ID from an inventory path
+
+        by doing the following:
+
+        $ govc ls -i /dc/datastore/terraform-test
+
+        Datastore:datastore-123
+
         :param str resource_name: The name of the resource.
         :param NasDatastoreArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_vsphere/pulumi-plugin.json

@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "vsphere",
-  "version": "4.12.0-alpha.1727221820"
+  "version": "4.12.0-alpha.1727889180"
 }

pulumi_vsphere/resource_pool.py

@@ -698,19 +698,13 @@ class ResourcePool(pulumi.CustomResource):
             parent_resource_pool_id=resource_pool_parent.id)
         ```
 
-        ## Importing
-
-        An existing resource pool can be imported into this resource via
-        the path to the resource pool, using the following command:
-
-        The above would import the resource pool named `resource-pool-01` that is located
-        in the compute cluster `cluster-01` in the `dc-01` datacenter.
+        ## Import
 
         ### Settings that Require vSphere 7.0 or higher
 
         These settings require vSphere 7.0 or higher:
 
-        * `scale_descendants_shares`
+        * [`scale_descendants_shares`](#scale_descendants_shares)
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -820,19 +814,13 @@ class ResourcePool(pulumi.CustomResource):
             parent_resource_pool_id=resource_pool_parent.id)
         ```
 
-        ## Importing
-
-        An existing resource pool can be imported into this resource via
-        the path to the resource pool, using the following command:
-
-        The above would import the resource pool named `resource-pool-01` that is located
-        in the compute cluster `cluster-01` in the `dc-01` datacenter.
+        ## Import
 
         ### Settings that Require vSphere 7.0 or higher
 
         These settings require vSphere 7.0 or higher:
 
-        * `scale_descendants_shares`
+        * [`scale_descendants_shares`](#scale_descendants_shares)
 
         :param str resource_name: The name of the resource.
         :param ResourcePoolArgs args: The arguments to use to populate this resource's properties.