ComputeClusterVmDependencyRule

The vsphere..ComputeClusterVmDependencyRule resource can be used to manage VM dependency rules in a cluster, either created by the vsphere..ComputeCluster resource or looked up by the vsphere..ComputeCluster data source.

A virtual machine dependency rule applies to vSphere HA, and allows user-defined startup orders for virtual machines in the case of host failure. Virtual machines are supplied via groups, which can be managed via the vsphere..ComputeClusterVmGroup resource.

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

Example Usage

using Pulumi;
using VSphere = Pulumi.VSphere;

class MyStack : Stack
{
    public MyStack()
    {
        var dc = Output.Create(VSphere.GetDatacenter.InvokeAsync(new VSphere.GetDatacenterArgs
        {
            Name = "dc1",
        }));
        var datastore = dc.Apply(dc => Output.Create(VSphere.GetDatastore.InvokeAsync(new VSphere.GetDatastoreArgs
        {
            DatacenterId = dc.Id,
            Name = "datastore1",
        })));
        var cluster = dc.Apply(dc => Output.Create(VSphere.GetComputeCluster.InvokeAsync(new VSphere.GetComputeClusterArgs
        {
            DatacenterId = dc.Id,
            Name = "cluster1",
        })));
        var network = dc.Apply(dc => Output.Create(VSphere.GetNetwork.InvokeAsync(new VSphere.GetNetworkArgs
        {
            DatacenterId = dc.Id,
            Name = "network1",
        })));
        var vm1 = new VSphere.VirtualMachine("vm1", new VSphere.VirtualMachineArgs
        {
            DatastoreId = datastore.Apply(datastore => datastore.Id),
            Disks = 
            {
                new VSphere.Inputs.VirtualMachineDiskArgs
                {
                    Label = "disk0",
                    Size = 20,
                },
            },
            GuestId = "other3xLinux64Guest",
            Memory = 2048,
            NetworkInterfaces = 
            {
                new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
                {
                    NetworkId = network.Apply(network => network.Id),
                },
            },
            NumCpus = 2,
            ResourcePoolId = cluster.Apply(cluster => cluster.ResourcePoolId),
        });
        var vm2 = new VSphere.VirtualMachine("vm2", new VSphere.VirtualMachineArgs
        {
            DatastoreId = datastore.Apply(datastore => datastore.Id),
            Disks = 
            {
                new VSphere.Inputs.VirtualMachineDiskArgs
                {
                    Label = "disk0",
                    Size = 20,
                },
            },
            GuestId = "other3xLinux64Guest",
            Memory = 2048,
            NetworkInterfaces = 
            {
                new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
                {
                    NetworkId = network.Apply(network => network.Id),
                },
            },
            NumCpus = 2,
            ResourcePoolId = cluster.Apply(cluster => cluster.ResourcePoolId),
        });
        var clusterVmGroup1 = new VSphere.ComputeClusterVmGroup("clusterVmGroup1", new VSphere.ComputeClusterVmGroupArgs
        {
            ComputeClusterId = cluster.Apply(cluster => cluster.Id),
            VirtualMachineIds = 
            {
                vm1.Id,
            },
        });
        var clusterVmGroup2 = new VSphere.ComputeClusterVmGroup("clusterVmGroup2", new VSphere.ComputeClusterVmGroupArgs
        {
            ComputeClusterId = cluster.Apply(cluster => cluster.Id),
            VirtualMachineIds = 
            {
                vm2.Id,
            },
        });
        var clusterVmDependencyRule = new VSphere.ComputeClusterVmDependencyRule("clusterVmDependencyRule", new VSphere.ComputeClusterVmDependencyRuleArgs
        {
            ComputeClusterId = cluster.Apply(cluster => cluster.Id),
            DependencyVmGroupName = clusterVmGroup1.Name,
            VmGroupName = clusterVmGroup2.Name,
        });
    }

}

Coming soon!

import pulumi
import pulumi_vsphere as vsphere

dc = vsphere.get_datacenter(name="dc1")
datastore = vsphere.get_datastore(datacenter_id=dc.id,
    name="datastore1")
cluster = vsphere.get_compute_cluster(datacenter_id=dc.id,
    name="cluster1")
network = vsphere.get_network(datacenter_id=dc.id,
    name="network1")
vm1 = vsphere.VirtualMachine("vm1",
    datastore_id=datastore.id,
    disks=[{
        "label": "disk0",
        "size": 20,
    }],
    guest_id="other3xLinux64Guest",
    memory=2048,
    network_interfaces=[{
        "networkId": network.id,
    }],
    num_cpus=2,
    resource_pool_id=cluster.resource_pool_id)
vm2 = vsphere.VirtualMachine("vm2",
    datastore_id=datastore.id,
    disks=[{
        "label": "disk0",
        "size": 20,
    }],
    guest_id="other3xLinux64Guest",
    memory=2048,
    network_interfaces=[{
        "networkId": network.id,
    }],
    num_cpus=2,
    resource_pool_id=cluster.resource_pool_id)
cluster_vm_group1 = vsphere.ComputeClusterVmGroup("clusterVmGroup1",
    compute_cluster_id=cluster.id,
    virtual_machine_ids=[vm1.id])
cluster_vm_group2 = vsphere.ComputeClusterVmGroup("clusterVmGroup2",
    compute_cluster_id=cluster.id,
    virtual_machine_ids=[vm2.id])
cluster_vm_dependency_rule = vsphere.ComputeClusterVmDependencyRule("clusterVmDependencyRule",
    compute_cluster_id=cluster.id,
    dependency_vm_group_name=cluster_vm_group1.name,
    vm_group_name=cluster_vm_group2.name)

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

const dc = pulumi.output(vsphere.getDatacenter({
    name: "dc1",
}, { async: true }));
const datastore = dc.apply(dc => vsphere.getDatastore({
    datacenterId: dc.id,
    name: "datastore1",
}, { async: true }));
const cluster = dc.apply(dc => vsphere.getComputeCluster({
    datacenterId: dc.id,
    name: "cluster1",
}, { async: true }));
const network = dc.apply(dc => vsphere.getNetwork({
    datacenterId: dc.id,
    name: "network1",
}, { async: true }));
const vm1 = new vsphere.VirtualMachine("vm1", {
    datastoreId: datastore.id,
    disks: [{
        label: "disk0",
        size: 20,
    }],
    guestId: "other3xLinux64Guest",
    memory: 2048,
    networkInterfaces: [{
        networkId: network.id,
    }],
    numCpus: 2,
    resourcePoolId: cluster.resourcePoolId,
});
const vm2 = new vsphere.VirtualMachine("vm2", {
    datastoreId: datastore.id,
    disks: [{
        label: "disk0",
        size: 20,
    }],
    guestId: "other3xLinux64Guest",
    memory: 2048,
    networkInterfaces: [{
        networkId: network.id,
    }],
    numCpus: 2,
    resourcePoolId: cluster.resourcePoolId,
});
const clusterVmGroup1 = new vsphere.ComputeClusterVmGroup("cluster_vm_group1", {
    computeClusterId: cluster.id,
    virtualMachineIds: [vm1.id],
});
const clusterVmGroup2 = new vsphere.ComputeClusterVmGroup("cluster_vm_group2", {
    computeClusterId: cluster.id,
    virtualMachineIds: [vm2.id],
});
const clusterVmDependencyRule = new vsphere.ComputeClusterVmDependencyRule("cluster_vm_dependency_rule", {
    computeClusterId: cluster.id,
    dependencyVmGroupName: clusterVmGroup1.name,
    vmGroupName: clusterVmGroup2.name,
});

Create a ComputeClusterVmDependencyRule Resource

new ComputeClusterVmDependencyRule(name: string, args: ComputeClusterVmDependencyRuleArgs, opts?: CustomResourceOptions);

def ComputeClusterVmDependencyRule(resource_name, opts=None, compute_cluster_id=None, dependency_vm_group_name=None, enabled=None, mandatory=None, name=None, vm_group_name=None, __props__=None);

func NewComputeClusterVmDependencyRule(ctx *Context, name string, args ComputeClusterVmDependencyRuleArgs, opts ...ResourceOption) (*ComputeClusterVmDependencyRule, error)

public ComputeClusterVmDependencyRule(string name, ComputeClusterVmDependencyRuleArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

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

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

ComputeClusterVmDependencyRule Resource Properties

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

Inputs

The ComputeClusterVmDependencyRule resource accepts the following input properties:

ComputeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
DependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
VmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
Enabled bool: Enable this rule in the cluster. Default: true.
Mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
Name string: The name of the rule. This must be unique in the cluster.

ComputeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
DependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
VmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
Enabled bool: Enable this rule in the cluster. Default: true.
Mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
Name string: The name of the rule. This must be unique in the cluster.

computeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
dependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
vmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
enabled boolean: Enable this rule in the cluster. Default: true.
mandatory boolean: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
name string: The name of the rule. This must be unique in the cluster.

compute_cluster_id str: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
dependency_vm_group_name str: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
vm_group_name str: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
enabled bool: Enable this rule in the cluster. Default: true.
mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
name str: The name of the rule. This must be unique in the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the ComputeClusterVmDependencyRule 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing ComputeClusterVmDependencyRule Resource

Get an existing ComputeClusterVmDependencyRule 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?: ComputeClusterVmDependencyRuleState, opts?: CustomResourceOptions): ComputeClusterVmDependencyRule

static get(resource_name, id, opts=None, compute_cluster_id=None, dependency_vm_group_name=None, enabled=None, mandatory=None, name=None, vm_group_name=None, __props__=None);

func GetComputeClusterVmDependencyRule(ctx *Context, name string, id IDInput, state *ComputeClusterVmDependencyRuleState, opts ...ResourceOption) (*ComputeClusterVmDependencyRule, error)

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

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.

The following state arguments are supported:

ComputeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
DependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
Enabled bool: Enable this rule in the cluster. Default: true.
Mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
Name string: The name of the rule. This must be unique in the cluster.
VmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

ComputeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
DependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
Enabled bool: Enable this rule in the cluster. Default: true.
Mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
Name string: The name of the rule. This must be unique in the cluster.
VmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

computeClusterId string: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
dependencyVmGroupName string: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
enabled boolean: Enable this rule in the cluster. Default: true.
mandatory boolean: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
name string: The name of the rule. This must be unique in the cluster.
vmGroupName string: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

compute_cluster_id str: The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
dependency_vm_group_name str: The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
enabled bool: Enable this rule in the cluster. Default: true.
mandatory bool: When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.
name str: The name of the rule. This must be unique in the cluster.
vm_group_name str: The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud