vSphere v4.14.0, May 20 25

vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi

vsphere.DpmHostOverride

Explore with Pulumi AI

vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi

Example Usage

The following example creates a compute cluster comprised of three hosts, making use of the vsphere.ComputeCluster resource. DPM will be disabled in the cluster as it is the default setting, but we override the setting of the first host referenced by the vsphere.Host data source (esxi1) by using the vsphere.DpmHostOverride resource so it will be powered off when the cluster does not need it to service virtual machines.

import * as pulumi from "@pulumi/pulumi";
import * as vsphere from "@pulumi/vsphere";

const config = new pulumi.Config();
const datacenter = config.get("datacenter") || "dc-01";
const hosts = config.getObject<any>("hosts") || [
    "esxi-01.example.com",
    "esxi-02.example.com",
    "esxi-03.example.com",
];
const datacenterGetDatacenter = vsphere.getDatacenter({
    name: datacenter,
});
const hostsGetHost = (new Array(hosts.length)).map((_, i) => i).map(__index => (vsphere.getHost({
    name: hosts[__index],
    datacenterId: _arg0_.id,
})));
const computeCluster = new vsphere.ComputeCluster("compute_cluster", {
    name: "compute-cluster-test",
    datacenterId: dc.id,
    hostSystemIds: [hostsGetHost.map(__item => __item.id)],
    drsEnabled: true,
    drsAutomationLevel: "fullyAutomated",
});
const dpmHostOverride = new vsphere.DpmHostOverride("dpm_host_override", {
    computeClusterId: computeCluster.id,
    hostSystemId: hostsGetHost[0].then(hostsGetHost => hostsGetHost.id),
    dpmEnabled: true,
    dpmAutomationLevel: "automated",
});

import pulumi
import pulumi_vsphere as vsphere

config = pulumi.Config()
datacenter = config.get("datacenter")
if datacenter is None:
    datacenter = "dc-01"
hosts = config.get_object("hosts")
if hosts is None:
    hosts = [
        "esxi-01.example.com",
        "esxi-02.example.com",
        "esxi-03.example.com",
    ]
datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
hosts_get_host = [vsphere.get_host(name=hosts[__index],
    datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
compute_cluster = vsphere.ComputeCluster("compute_cluster",
    name="compute-cluster-test",
    datacenter_id=dc["id"],
    host_system_ids=[[__item.id for __item in hosts_get_host]],
    drs_enabled=True,
    drs_automation_level="fullyAutomated")
dpm_host_override = vsphere.DpmHostOverride("dpm_host_override",
    compute_cluster_id=compute_cluster.id,
    host_system_id=hosts_get_host[0].id,
    dpm_enabled=True,
    dpm_automation_level="automated")

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Create DpmHostOverride Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DpmHostOverride(name: string, args: DpmHostOverrideArgs, opts?: CustomResourceOptions);

@overload
def DpmHostOverride(resource_name: str,
                    args: DpmHostOverrideArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def DpmHostOverride(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    compute_cluster_id: Optional[str] = None,
                    host_system_id: Optional[str] = None,
                    dpm_automation_level: Optional[str] = None,
                    dpm_enabled: Optional[bool] = None)

func NewDpmHostOverride(ctx *Context, name string, args DpmHostOverrideArgs, opts ...ResourceOption) (*DpmHostOverride, error)

public DpmHostOverride(string name, DpmHostOverrideArgs args, CustomResourceOptions? opts = null)

public DpmHostOverride(String name, DpmHostOverrideArgs args)
public DpmHostOverride(String name, DpmHostOverrideArgs args, CustomResourceOptions options)

type: vsphere:DpmHostOverride
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DpmHostOverrideArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DpmHostOverrideArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DpmHostOverrideArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DpmHostOverrideArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DpmHostOverrideArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dpmHostOverrideResource = new VSphere.DpmHostOverride("dpmHostOverrideResource", new()
{
    ComputeClusterId = "string",
    HostSystemId = "string",
    DpmAutomationLevel = "string",
    DpmEnabled = false,
});

example, err := vsphere.NewDpmHostOverride(ctx, "dpmHostOverrideResource", &vsphere.DpmHostOverrideArgs{
	ComputeClusterId:   pulumi.String("string"),
	HostSystemId:       pulumi.String("string"),
	DpmAutomationLevel: pulumi.String("string"),
	DpmEnabled:         pulumi.Bool(false),
})

var dpmHostOverrideResource = new DpmHostOverride("dpmHostOverrideResource", DpmHostOverrideArgs.builder()
    .computeClusterId("string")
    .hostSystemId("string")
    .dpmAutomationLevel("string")
    .dpmEnabled(false)
    .build());

dpm_host_override_resource = vsphere.DpmHostOverride("dpmHostOverrideResource",
    compute_cluster_id="string",
    host_system_id="string",
    dpm_automation_level="string",
    dpm_enabled=False)

const dpmHostOverrideResource = new vsphere.DpmHostOverride("dpmHostOverrideResource", {
    computeClusterId: "string",
    hostSystemId: "string",
    dpmAutomationLevel: "string",
    dpmEnabled: false,
});

type: vsphere:DpmHostOverride
properties:
    computeClusterId: string
    dpmAutomationLevel: string
    dpmEnabled: false
    hostSystemId: string

DpmHostOverride Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DpmHostOverride resource accepts the following input properties:

ComputeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
HostSystemId string: The managed object ID of the host.
DpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
DpmEnabled bool: Enable DPM support for this host. Default: false.

ComputeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
HostSystemId string: The managed object ID of the host.
DpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
DpmEnabled bool: Enable DPM support for this host. Default: false.

computeClusterId String: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
hostSystemId String: The managed object ID of the host.
dpmAutomationLevel String: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled Boolean: Enable DPM support for this host. Default: false.

computeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
hostSystemId string: The managed object ID of the host.
dpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled boolean: Enable DPM support for this host. Default: false.

compute_cluster_id str: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
host_system_id str: The managed object ID of the host.
dpm_automation_level str: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpm_enabled bool: Enable DPM support for this host. Default: false.

computeClusterId String: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
hostSystemId String: The managed object ID of the host.
dpmAutomationLevel String: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled Boolean: Enable DPM support for this host. Default: false.

Outputs

All input properties are implicitly available as output properties. Additionally, the DpmHostOverride resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing DpmHostOverride Resource

Get an existing DpmHostOverride resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DpmHostOverrideState, opts?: CustomResourceOptions): DpmHostOverride

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute_cluster_id: Optional[str] = None,
        dpm_automation_level: Optional[str] = None,
        dpm_enabled: Optional[bool] = None,
        host_system_id: Optional[str] = None) -> DpmHostOverride

func GetDpmHostOverride(ctx *Context, name string, id IDInput, state *DpmHostOverrideState, opts ...ResourceOption) (*DpmHostOverride, error)

public static DpmHostOverride Get(string name, Input<string> id, DpmHostOverrideState? state, CustomResourceOptions? opts = null)

public static DpmHostOverride get(String name, Output<String> id, DpmHostOverrideState state, CustomResourceOptions options)

resources:  _:    type: vsphere:DpmHostOverride    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ComputeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
DpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
DpmEnabled bool: Enable DPM support for this host. Default: false.
HostSystemId string: The managed object ID of the host.

ComputeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
DpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
DpmEnabled bool: Enable DPM support for this host. Default: false.
HostSystemId string: The managed object ID of the host.

computeClusterId String: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
dpmAutomationLevel String: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled Boolean: Enable DPM support for this host. Default: false.
hostSystemId String: The managed object ID of the host.

computeClusterId string: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
dpmAutomationLevel string: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled boolean: Enable DPM support for this host. Default: false.
hostSystemId string: The managed object ID of the host.

compute_cluster_id str: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
dpm_automation_level str: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpm_enabled bool: Enable DPM support for this host. Default: false.
host_system_id str: The managed object ID of the host.

computeClusterId String: The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
dpmAutomationLevel String: The automation level for host power operations on this host. Can be one of manual or automated. Default: manual.
NOTE: Using this resource always implies an override, even if one of dpm_enabled or dpm_automation_level is omitted. Take note of the defaults for both options.
dpmEnabled Boolean: Enable DPM support for this host. Default: false.
hostSystemId String: The managed object ID of the host.

Import

An existing override can be imported into this resource by

supplying both the path to the cluster, and the path to the host, to `terraform

import`. If no override exists, an error will be given. An example is below:

$ pulumi import vsphere:index/dpmHostOverride:DpmHostOverride dpm_host_override \

‘{“compute_cluster_path”: “/dc1/host/cluster1”, \

“host_path”: “/dc1/host/esxi1”}’

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: vSphere pulumi/pulumi-vsphere
License: Apache-2.0
Notes: This Pulumi package is based on the vsphere Terraform Provider.

vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi

pulumi/pulumi-vsphere

vsphere.DpmHostOverride

On this page

On this page

Example Usage

Create DpmHostOverride Resource

Constructor syntax

Parameters

Constructor example

DpmHostOverride Resource Properties

Inputs

Outputs

Look up Existing DpmHostOverride Resource

Import

Package Details

On this page

On this page