Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. DrsVmOverride
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.DrsVmOverride

Explore with Pulumi AI

vsphere logo
vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
pulumi/pulumi-vsphere

    The vsphere.DrsVmOverride resource can be used to add a DRS override to a cluster for a specific virtual machine. With this resource, one can enable or disable DRS and control the automation level for a single virtual machine without affecting the rest of the cluster.

    For more information on vSphere clusters and DRS, see this page.

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

    Create DrsVmOverride Resource

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

    Constructor syntax

    new DrsVmOverride(name: string, args: DrsVmOverrideArgs, opts?: CustomResourceOptions);
    @overload
def DrsVmOverride(resource_name: str,
                  args: DrsVmOverrideArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DrsVmOverride(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  compute_cluster_id: Optional[str] = None,
                  virtual_machine_id: Optional[str] = None,
                  drs_automation_level: Optional[str] = None,
                  drs_enabled: Optional[bool] = None)
    func NewDrsVmOverride(ctx *Context, name string, args DrsVmOverrideArgs, opts ...ResourceOption) (*DrsVmOverride, error)
    public DrsVmOverride(string name, DrsVmOverrideArgs args, CustomResourceOptions? opts = null)
    public DrsVmOverride(String name, DrsVmOverrideArgs args)
public DrsVmOverride(String name, DrsVmOverrideArgs args, CustomResourceOptions options)

    type: vsphere:DrsVmOverride
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 DrsVmOverrideArgs
    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 DrsVmOverrideArgs
    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 DrsVmOverrideArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DrsVmOverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DrsVmOverrideArgs
    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 drsVmOverrideResource = new VSphere.DrsVmOverride("drsVmOverrideResource", new()
{
    ComputeClusterId = "string",
    VirtualMachineId = "string",
    DrsAutomationLevel = "string",
    DrsEnabled = false,
});

    example, err := vsphere.NewDrsVmOverride(ctx, "drsVmOverrideResource", &vsphere.DrsVmOverrideArgs{
	ComputeClusterId:   pulumi.String("string"),
	VirtualMachineId:   pulumi.String("string"),
	DrsAutomationLevel: pulumi.String("string"),
	DrsEnabled:         pulumi.Bool(false),
})

    var drsVmOverrideResource = new DrsVmOverride("drsVmOverrideResource", DrsVmOverrideArgs.builder()
    .computeClusterId("string")
    .virtualMachineId("string")
    .drsAutomationLevel("string")
    .drsEnabled(false)
    .build());

    drs_vm_override_resource = vsphere.DrsVmOverride("drsVmOverrideResource",
    compute_cluster_id="string",
    virtual_machine_id="string",
    drs_automation_level="string",
    drs_enabled=False)

    const drsVmOverrideResource = new vsphere.DrsVmOverride("drsVmOverrideResource", {
    computeClusterId: "string",
    virtualMachineId: "string",
    drsAutomationLevel: "string",
    drsEnabled: false,
});

    type: vsphere:DrsVmOverride
properties:
    computeClusterId: string
    drsAutomationLevel: string
    drsEnabled: false
    virtualMachineId: string

    DrsVmOverride 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 DrsVmOverride 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.
    VirtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    DrsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    DrsEnabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    VirtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    DrsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    DrsEnabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    computeClusterId String
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    virtualMachineId String
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    drsAutomationLevel String

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled Boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    computeClusterId string
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    virtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    drsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. 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.
    virtual_machine_id str
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    drs_automation_level str

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drs_enabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    computeClusterId String
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    virtualMachineId String
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    drsAutomationLevel String

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled Boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DrsVmOverride 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 DrsVmOverride Resource

    Get an existing DrsVmOverride 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?: DrsVmOverrideState, opts?: CustomResourceOptions): DrsVmOverride
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute_cluster_id: Optional[str] = None,
        drs_automation_level: Optional[str] = None,
        drs_enabled: Optional[bool] = None,
        virtual_machine_id: Optional[str] = None) -> DrsVmOverride
    func GetDrsVmOverride(ctx *Context, name string, id IDInput, state *DrsVmOverrideState, opts ...ResourceOption) (*DrsVmOverride, error)
    public static DrsVmOverride Get(string name, Input<string> id, DrsVmOverrideState? state, CustomResourceOptions? opts = null)
    public static DrsVmOverride get(String name, Output<String> id, DrsVmOverrideState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    DrsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    DrsEnabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    VirtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    DrsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    DrsEnabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    VirtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    drsAutomationLevel String

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled Boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    virtualMachineId String
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    computeClusterId string
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    drsAutomationLevel string

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    virtualMachineId string
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    drs_automation_level str

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drs_enabled bool
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    virtual_machine_id str
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the override in. Forces a new resource if changed.
    drsAutomationLevel String

    Overrides the automation level for this virtual machine in the cluster. Can be one of manual, partiallyAutomated, or fullyAutomated. Default: manual.

    NOTE: Using this resource always implies an override, even if one of drs_enabled or drs_automation_level is omitted. Take note of the defaults for both options.

    drsEnabled Boolean
    Overrides the default DRS setting for this virtual machine. Can be either true or false. Default: false.
    virtualMachineId String
    The UUID of the virtual machine to create the override for. Forces a new resource if changed.

    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:

    $ pulumi import vsphere:index/drsVmOverride:DrsVmOverride drs_vm_override \

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

    “virtual_machine_path”: “/dc1/vm/srv1”}’

    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 logo
    vSphere v4.12.1 published on Tuesday, Oct 22, 2024 by Pulumi
    pulumi/pulumi-vsphere