vsphere.DpmHostOverride

The vsphere.DpmHostOverride resource can be used to add a DPM override to a cluster for a particular host. This allows you to control the power management settings for individual hosts in the cluster while leaving any unspecified ones at the default power management settings.

For more information on DPM within vSphere clusters, see this page.

NOTE: This resource requires vCenter and is not available on direct ESXi connections.

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

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

The DpmHostOverride resource accepts the following input properties:

Outputs

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

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)

Resource lookup is not supported in YAML

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.