@pulumi/vsphere

import * as pulumi from "@pulumi/pulumi"; /** * The `vsphere.ComputeClusterVmHostRule` resource can be used to manage * VM-to-host rules in a cluster, either created by the * `vsphere.ComputeCluster` resource or looked up * by the `vsphere.ComputeCluster` data source. * * This resource can create both _affinity rules_, where virtual machines run on * specified hosts, or _anti-affinity_ rules, where virtual machines run on hosts * outside of the ones specified in the rule. Virtual machines and hosts are * supplied via groups, which can be managed via the * `vsphere.ComputeClusterVmGroup` and * `vsphere.ComputeClusterHostGroup` * resources. * * > **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 * `vsphere.VirtualMachine` resource in a cluster * looked up by the `vsphere.ComputeCluster` * data source. It then creates a group with this virtual machine. It also creates * a host group off of the host looked up via the * `vsphere.Host` data source. Finally, this * virtual machine is configured to run specifically on that host via a * `vsphere.ComputeClusterVmHostRule` resource. * * > Note how `vmGroupName` and * `affinityHostGroupName` are sourced off of the * `name` attributes from the * `vsphere.ComputeClusterVmGroup` and * `vsphere.ComputeClusterHostGroup` * resources. This is to ensure that the rule is not created before the groups * exist, which may not possibly happen in the event that the names came from a * "static" source such as a variable. * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as vsphere from "@pulumi/vsphere"; * * const datacenter = vsphere.getDatacenter({ * name: "dc-01", * }); * const datastore = datacenter.then(datacenter => vsphere.getDatastore({ * name: "datastore1", * datacenterId: datacenter.id, * })); * const cluster = datacenter.then(datacenter => vsphere.getComputeCluster({ * name: "cluster-01", * datacenterId: datacenter.id, * })); * const host = datacenter.then(datacenter => vsphere.getHost({ * name: "esxi-01.example.com", * datacenterId: datacenter.id, * })); * const network = datacenter.then(datacenter => vsphere.getNetwork({ * name: "network1", * datacenterId: datacenter.id, * })); * const vm = new vsphere.VirtualMachine("vm", { * name: "test", * resourcePoolId: cluster.then(cluster => cluster.resourcePoolId), * datastoreId: datastore.then(datastore => datastore.id), * numCpus: 2, * memory: 2048, * guestId: "otherLinux64Guest", * networkInterfaces: [{ * networkId: network.then(network => network.id), * }], * disks: [{ * label: "disk0", * size: 20, * }], * }); * const clusterVmGroup = new vsphere.ComputeClusterVmGroup("cluster_vm_group", { * name: "test-cluster-vm-group", * computeClusterId: cluster.then(cluster => cluster.id), * virtualMachineIds: [vm.id], * }); * const clusterHostGroup = new vsphere.ComputeClusterHostGroup("cluster_host_group", { * name: "test-cluster-vm-group", * computeClusterId: cluster.then(cluster => cluster.id), * hostSystemIds: [host.then(host => host.id)], * }); * const clusterVmHostRule = new vsphere.ComputeClusterVmHostRule("cluster_vm_host_rule", { * computeClusterId: cluster.then(cluster => cluster.id), * name: "test-cluster-vm-host-rule", * vmGroupName: clusterVmGroup.name, * affinityHostGroupName: clusterHostGroup.name, * }); * ``` * * ## Import * * An existing rule can be imported into this resource by supplying * * both the path to the cluster, and the name the rule. If the name or cluster is * * not found, or if the rule is of a different type, an error will be returned. An * * example is below: * * [docs-import]: https://developer.hashicorp.com/terraform/cli/import * * ```sh * $ pulumi import vsphere:index/computeClusterVmHostRule:ComputeClusterVmHostRule cluster_vm_host_rule \ * ``` * * '{"compute_cluster_path": "/dc1/host/cluster1", \ * * "name": "pulumi-test-cluster-vm-host-rule"}' */ export declare class ComputeClusterVmHostRule extends pulumi.CustomResource { /** * Get an existing ComputeClusterVmHostRule resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ComputeClusterVmHostRuleState, opts?: pulumi.CustomResourceOptions): ComputeClusterVmHostRule; /** * Returns true if the given object is an instance of ComputeClusterVmHostRule. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ComputeClusterVmHostRule; /** * When this field is used, the virtual * machines defined in `vmGroupName` will be run on the * hosts defined in this host group. */ readonly affinityHostGroupName: pulumi.Output<string | undefined>; /** * When this field is used, the * virtual machines defined in `vmGroupName` will _not_ be * run on the hosts defined in this host group. */ readonly antiAffinityHostGroupName: pulumi.Output<string | undefined>; /** * The managed object reference * ID of the cluster to put the group in. Forces a new * resource if changed. */ readonly computeClusterId: pulumi.Output<string>; /** * Enable this rule in the cluster. Default: `true`. */ readonly enabled: pulumi.Output<boolean | undefined>; /** * When this value is `true`, prevents any virtual * machine operations that may violate this rule. Default: `false`. * * > **NOTE:** One of `affinityHostGroupName` or * `antiAffinityHostGroupName` must be * defined, but not both. * * > **NOTE:** The namespace for rule names on this resource (defined by the * `name` argument) is shared with all rules in the cluster - consider * this when naming your rules. */ readonly mandatory: pulumi.Output<boolean | undefined>; /** * The name of the rule. This must be unique in the * cluster. */ readonly name: pulumi.Output<string>; /** * The name of the virtual machine group to use * with this rule. */ readonly vmGroupName: pulumi.Output<string>; /** * Create a ComputeClusterVmHostRule resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ComputeClusterVmHostRuleArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ComputeClusterVmHostRule resources. */ export interface ComputeClusterVmHostRuleState { /** * When this field is used, the virtual * machines defined in `vmGroupName` will be run on the * hosts defined in this host group. */ affinityHostGroupName?: pulumi.Input<string>; /** * When this field is used, the * virtual machines defined in `vmGroupName` will _not_ be * run on the hosts defined in this host group. */ antiAffinityHostGroupName?: pulumi.Input<string>; /** * The managed object reference * ID of the cluster to put the group in. Forces a new * resource if changed. */ computeClusterId?: pulumi.Input<string>; /** * Enable this rule in the cluster. Default: `true`. */ enabled?: pulumi.Input<boolean>; /** * When this value is `true`, prevents any virtual * machine operations that may violate this rule. Default: `false`. * * > **NOTE:** One of `affinityHostGroupName` or * `antiAffinityHostGroupName` must be * defined, but not both. * * > **NOTE:** The namespace for rule names on this resource (defined by the * `name` argument) is shared with all rules in the cluster - consider * this when naming your rules. */ mandatory?: pulumi.Input<boolean>; /** * The name of the rule. This must be unique in the * cluster. */ name?: pulumi.Input<string>; /** * The name of the virtual machine group to use * with this rule. */ vmGroupName?: pulumi.Input<string>; } /** * The set of arguments for constructing a ComputeClusterVmHostRule resource. */ export interface ComputeClusterVmHostRuleArgs { /** * When this field is used, the virtual * machines defined in `vmGroupName` will be run on the * hosts defined in this host group. */ affinityHostGroupName?: pulumi.Input<string>; /** * When this field is used, the * virtual machines defined in `vmGroupName` will _not_ be * run on the hosts defined in this host group. */ antiAffinityHostGroupName?: pulumi.Input<string>; /** * The managed object reference * ID of the cluster to put the group in. Forces a new * resource if changed. */ computeClusterId: pulumi.Input<string>; /** * Enable this rule in the cluster. Default: `true`. */ enabled?: pulumi.Input<boolean>; /** * When this value is `true`, prevents any virtual * machine operations that may violate this rule. Default: `false`. * * > **NOTE:** One of `affinityHostGroupName` or * `antiAffinityHostGroupName` must be * defined, but not both. * * > **NOTE:** The namespace for rule names on this resource (defined by the * `name` argument) is shared with all rules in the cluster - consider * this when naming your rules. */ mandatory?: pulumi.Input<boolean>; /** * The name of the rule. This must be unique in the * cluster. */ name?: pulumi.Input<string>; /** * The name of the virtual machine group to use * with this rule. */ vmGroupName: pulumi.Input<string>; }