Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. GuestOsCustomization
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.GuestOsCustomization

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

The vsphere.GuestOsCustomization resource can be used to a customization specification for a guest operating system.

NOTE: The name attribute is unique identifier for the guest OS spec per VC.

Example Usage

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

const windows = new vsphere.GuestOsCustomization("windows", {
    name: "windows",
    type: "Windows",
    spec: {
        windowsOptions: {
            runOnceCommandLists: [
                "command-1",
                "command-2",
            ],
            computerName: "windows",
            autoLogon: false,
            autoLogonCount: 0,
            adminPassword: "VMware1!",
            timeZone: 4,
            workgroup: "workgroup",
        },
    },
});
Copy
import pulumi
import pulumi_vsphere as vsphere

windows = vsphere.GuestOsCustomization("windows",
    name="windows",
    type="Windows",
    spec={
        "windows_options": {
            "run_once_command_lists": [
                "command-1",
                "command-2",
            ],
            "computer_name": "windows",
            "auto_logon": False,
            "auto_logon_count": 0,
            "admin_password": "VMware1!",
            "time_zone": 4,
            "workgroup": "workgroup",
        },
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.NewGuestOsCustomization(ctx, "windows", &vsphere.GuestOsCustomizationArgs{
			Name: pulumi.String("windows"),
			Type: pulumi.String("Windows"),
			Spec: &vsphere.GuestOsCustomizationSpecArgs{
				WindowsOptions: &vsphere.GuestOsCustomizationSpecWindowsOptionsArgs{
					RunOnceCommandLists: pulumi.StringArray{
						pulumi.String("command-1"),
						pulumi.String("command-2"),
					},
					ComputerName:   pulumi.String("windows"),
					AutoLogon:      pulumi.Bool(false),
					AutoLogonCount: pulumi.Int(0),
					AdminPassword:  pulumi.String("VMware1!"),
					TimeZone:       pulumi.Int(4),
					Workgroup:      pulumi.String("workgroup"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using VSphere = Pulumi.VSphere;

return await Deployment.RunAsync(() => 
{
    var windows = new VSphere.GuestOsCustomization("windows", new()
    {
        Name = "windows",
        Type = "Windows",
        Spec = new VSphere.Inputs.GuestOsCustomizationSpecArgs
        {
            WindowsOptions = new VSphere.Inputs.GuestOsCustomizationSpecWindowsOptionsArgs
            {
                RunOnceCommandLists = new[]
                {
                    "command-1",
                    "command-2",
                },
                ComputerName = "windows",
                AutoLogon = false,
                AutoLogonCount = 0,
                AdminPassword = "VMware1!",
                TimeZone = 4,
                Workgroup = "workgroup",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.GuestOsCustomization;
import com.pulumi.vsphere.GuestOsCustomizationArgs;
import com.pulumi.vsphere.inputs.GuestOsCustomizationSpecArgs;
import com.pulumi.vsphere.inputs.GuestOsCustomizationSpecWindowsOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var windows = new GuestOsCustomization("windows", GuestOsCustomizationArgs.builder()
            .name("windows")
            .type("Windows")
            .spec(GuestOsCustomizationSpecArgs.builder()
                .windowsOptions(GuestOsCustomizationSpecWindowsOptionsArgs.builder()
                    .runOnceCommandLists(                    
                        "command-1",
                        "command-2")
                    .computerName("windows")
                    .autoLogon(false)
                    .autoLogonCount(0)
                    .adminPassword("VMware1!")
                    .timeZone(4)
                    .workgroup("workgroup")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  windows:
    type: vsphere:GuestOsCustomization
    properties:
      name: windows
      type: Windows
      spec:
        windowsOptions:
          runOnceCommandLists:
            - command-1
            - command-2
          computerName: windows
          autoLogon: false
          autoLogonCount: 0
          adminPassword: VMware1!
          timeZone: 4
          workgroup: workgroup
Copy

Create GuestOsCustomization Resource

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

Constructor syntax

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

@overload
def GuestOsCustomization(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         spec: Optional[GuestOsCustomizationSpecArgs] = None,
                         type: Optional[str] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None)
func NewGuestOsCustomization(ctx *Context, name string, args GuestOsCustomizationArgs, opts ...ResourceOption) (*GuestOsCustomization, error)
public GuestOsCustomization(string name, GuestOsCustomizationArgs args, CustomResourceOptions? opts = null)
public GuestOsCustomization(String name, GuestOsCustomizationArgs args)
public GuestOsCustomization(String name, GuestOsCustomizationArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GuestOsCustomizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GuestOsCustomizationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GuestOsCustomizationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GuestOsCustomizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GuestOsCustomizationArgs
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 guestOsCustomizationResource = new VSphere.GuestOsCustomization("guestOsCustomizationResource", new()
{
    Spec = new VSphere.Inputs.GuestOsCustomizationSpecArgs
    {
        DnsServerLists = new[]
        {
            "string",
        },
        DnsSuffixLists = new[]
        {
            "string",
        },
        Ipv4Gateway = "string",
        Ipv6Gateway = "string",
        LinuxOptions = new VSphere.Inputs.GuestOsCustomizationSpecLinuxOptionsArgs
        {
            Domain = "string",
            HostName = "string",
            HwClockUtc = false,
            ScriptText = "string",
            TimeZone = "string",
        },
        NetworkInterfaces = new[]
        {
            new VSphere.Inputs.GuestOsCustomizationSpecNetworkInterfaceArgs
            {
                DnsDomain = "string",
                DnsServerLists = new[]
                {
                    "string",
                },
                Ipv4Address = "string",
                Ipv4Netmask = 0,
                Ipv6Address = "string",
                Ipv6Netmask = 0,
            },
        },
        WindowsOptions = new VSphere.Inputs.GuestOsCustomizationSpecWindowsOptionsArgs
        {
            ComputerName = "string",
            DomainOu = "string",
            AutoLogonCount = 0,
            AutoLogon = false,
            DomainAdminPassword = "string",
            DomainAdminUser = "string",
            AdminPassword = "string",
            FullName = "string",
            JoinDomain = "string",
            OrganizationName = "string",
            ProductKey = "string",
            RunOnceCommandLists = new[]
            {
                "string",
            },
            TimeZone = 0,
            Workgroup = "string",
        },
        WindowsSysprepText = "string",
    },
    Type = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := vsphere.NewGuestOsCustomization(ctx, "guestOsCustomizationResource", &vsphere.GuestOsCustomizationArgs{
	Spec: &vsphere.GuestOsCustomizationSpecArgs{
		DnsServerLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		DnsSuffixLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		Ipv4Gateway: pulumi.String("string"),
		Ipv6Gateway: pulumi.String("string"),
		LinuxOptions: &vsphere.GuestOsCustomizationSpecLinuxOptionsArgs{
			Domain:     pulumi.String("string"),
			HostName:   pulumi.String("string"),
			HwClockUtc: pulumi.Bool(false),
			ScriptText: pulumi.String("string"),
			TimeZone:   pulumi.String("string"),
		},
		NetworkInterfaces: vsphere.GuestOsCustomizationSpecNetworkInterfaceArray{
			&vsphere.GuestOsCustomizationSpecNetworkInterfaceArgs{
				DnsDomain: pulumi.String("string"),
				DnsServerLists: pulumi.StringArray{
					pulumi.String("string"),
				},
				Ipv4Address: pulumi.String("string"),
				Ipv4Netmask: pulumi.Int(0),
				Ipv6Address: pulumi.String("string"),
				Ipv6Netmask: pulumi.Int(0),
			},
		},
		WindowsOptions: &vsphere.GuestOsCustomizationSpecWindowsOptionsArgs{
			ComputerName:        pulumi.String("string"),
			DomainOu:            pulumi.String("string"),
			AutoLogonCount:      pulumi.Int(0),
			AutoLogon:           pulumi.Bool(false),
			DomainAdminPassword: pulumi.String("string"),
			DomainAdminUser:     pulumi.String("string"),
			AdminPassword:       pulumi.String("string"),
			FullName:            pulumi.String("string"),
			JoinDomain:          pulumi.String("string"),
			OrganizationName:    pulumi.String("string"),
			ProductKey:          pulumi.String("string"),
			RunOnceCommandLists: pulumi.StringArray{
				pulumi.String("string"),
			},
			TimeZone:  pulumi.Int(0),
			Workgroup: pulumi.String("string"),
		},
		WindowsSysprepText: pulumi.String("string"),
	},
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})
Copy
var guestOsCustomizationResource = new GuestOsCustomization("guestOsCustomizationResource", GuestOsCustomizationArgs.builder()
    .spec(GuestOsCustomizationSpecArgs.builder()
        .dnsServerLists("string")
        .dnsSuffixLists("string")
        .ipv4Gateway("string")
        .ipv6Gateway("string")
        .linuxOptions(GuestOsCustomizationSpecLinuxOptionsArgs.builder()
            .domain("string")
            .hostName("string")
            .hwClockUtc(false)
            .scriptText("string")
            .timeZone("string")
            .build())
        .networkInterfaces(GuestOsCustomizationSpecNetworkInterfaceArgs.builder()
            .dnsDomain("string")
            .dnsServerLists("string")
            .ipv4Address("string")
            .ipv4Netmask(0)
            .ipv6Address("string")
            .ipv6Netmask(0)
            .build())
        .windowsOptions(GuestOsCustomizationSpecWindowsOptionsArgs.builder()
            .computerName("string")
            .domainOu("string")
            .autoLogonCount(0)
            .autoLogon(false)
            .domainAdminPassword("string")
            .domainAdminUser("string")
            .adminPassword("string")
            .fullName("string")
            .joinDomain("string")
            .organizationName("string")
            .productKey("string")
            .runOnceCommandLists("string")
            .timeZone(0)
            .workgroup("string")
            .build())
        .windowsSysprepText("string")
        .build())
    .type("string")
    .description("string")
    .name("string")
    .build());
Copy
guest_os_customization_resource = vsphere.GuestOsCustomization("guestOsCustomizationResource",
    spec={
        "dns_server_lists": ["string"],
        "dns_suffix_lists": ["string"],
        "ipv4_gateway": "string",
        "ipv6_gateway": "string",
        "linux_options": {
            "domain": "string",
            "host_name": "string",
            "hw_clock_utc": False,
            "script_text": "string",
            "time_zone": "string",
        },
        "network_interfaces": [{
            "dns_domain": "string",
            "dns_server_lists": ["string"],
            "ipv4_address": "string",
            "ipv4_netmask": 0,
            "ipv6_address": "string",
            "ipv6_netmask": 0,
        }],
        "windows_options": {
            "computer_name": "string",
            "domain_ou": "string",
            "auto_logon_count": 0,
            "auto_logon": False,
            "domain_admin_password": "string",
            "domain_admin_user": "string",
            "admin_password": "string",
            "full_name": "string",
            "join_domain": "string",
            "organization_name": "string",
            "product_key": "string",
            "run_once_command_lists": ["string"],
            "time_zone": 0,
            "workgroup": "string",
        },
        "windows_sysprep_text": "string",
    },
    type="string",
    description="string",
    name="string")
Copy
const guestOsCustomizationResource = new vsphere.GuestOsCustomization("guestOsCustomizationResource", {
    spec: {
        dnsServerLists: ["string"],
        dnsSuffixLists: ["string"],
        ipv4Gateway: "string",
        ipv6Gateway: "string",
        linuxOptions: {
            domain: "string",
            hostName: "string",
            hwClockUtc: false,
            scriptText: "string",
            timeZone: "string",
        },
        networkInterfaces: [{
            dnsDomain: "string",
            dnsServerLists: ["string"],
            ipv4Address: "string",
            ipv4Netmask: 0,
            ipv6Address: "string",
            ipv6Netmask: 0,
        }],
        windowsOptions: {
            computerName: "string",
            domainOu: "string",
            autoLogonCount: 0,
            autoLogon: false,
            domainAdminPassword: "string",
            domainAdminUser: "string",
            adminPassword: "string",
            fullName: "string",
            joinDomain: "string",
            organizationName: "string",
            productKey: "string",
            runOnceCommandLists: ["string"],
            timeZone: 0,
            workgroup: "string",
        },
        windowsSysprepText: "string",
    },
    type: "string",
    description: "string",
    name: "string",
});
Copy
type: vsphere:GuestOsCustomization
properties:
    description: string
    name: string
    spec:
        dnsServerLists:
            - string
        dnsSuffixLists:
            - string
        ipv4Gateway: string
        ipv6Gateway: string
        linuxOptions:
            domain: string
            hostName: string
            hwClockUtc: false
            scriptText: string
            timeZone: string
        networkInterfaces:
            - dnsDomain: string
              dnsServerLists:
                - string
              ipv4Address: string
              ipv4Netmask: 0
              ipv6Address: string
              ipv6Netmask: 0
        windowsOptions:
            adminPassword: string
            autoLogon: false
            autoLogonCount: 0
            computerName: string
            domainAdminPassword: string
            domainAdminUser: string
            domainOu: string
            fullName: string
            joinDomain: string
            organizationName: string
            productKey: string
            runOnceCommandLists:
                - string
            timeZone: 0
            workgroup: string
        windowsSysprepText: string
    type: string
Copy

GuestOsCustomization 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 GuestOsCustomization resource accepts the following input properties:

Spec This property is required. Pulumi.VSphere.Inputs.GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
Type This property is required. string
The type of customization specification: One among: Windows, Linux.
Description string
The description for the customization specification.
Name string
The name of the customization specification is the unique identifier per vCenter Server instance.
Spec This property is required. GuestOsCustomizationSpecArgs
Container object for the Guest OS properties about to be customized . See virtual machine customizations
Type This property is required. string
The type of customization specification: One among: Windows, Linux.
Description string
The description for the customization specification.
Name string
The name of the customization specification is the unique identifier per vCenter Server instance.
spec This property is required. GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type This property is required. String
The type of customization specification: One among: Windows, Linux.
description String
The description for the customization specification.
name String
The name of the customization specification is the unique identifier per vCenter Server instance.
spec This property is required. GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type This property is required. string
The type of customization specification: One among: Windows, Linux.
description string
The description for the customization specification.
name string
The name of the customization specification is the unique identifier per vCenter Server instance.
spec This property is required. GuestOsCustomizationSpecArgs
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type This property is required. str
The type of customization specification: One among: Windows, Linux.
description str
The description for the customization specification.
name str
The name of the customization specification is the unique identifier per vCenter Server instance.
spec This property is required. Property Map
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type This property is required. String
The type of customization specification: One among: Windows, Linux.
description String
The description for the customization specification.
name String
The name of the customization specification is the unique identifier per vCenter Server instance.

Outputs

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

ChangeVersion string
The number of last changed version to the customization specification.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdateTime string
The time of last modification to the customization specification.
ChangeVersion string
The number of last changed version to the customization specification.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdateTime string
The time of last modification to the customization specification.
changeVersion String
The number of last changed version to the customization specification.
id String
The provider-assigned unique ID for this managed resource.
lastUpdateTime String
The time of last modification to the customization specification.
changeVersion string
The number of last changed version to the customization specification.
id string
The provider-assigned unique ID for this managed resource.
lastUpdateTime string
The time of last modification to the customization specification.
change_version str
The number of last changed version to the customization specification.
id str
The provider-assigned unique ID for this managed resource.
last_update_time str
The time of last modification to the customization specification.
changeVersion String
The number of last changed version to the customization specification.
id String
The provider-assigned unique ID for this managed resource.
lastUpdateTime String
The time of last modification to the customization specification.

Look up Existing GuestOsCustomization Resource

Get an existing GuestOsCustomization 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?: GuestOsCustomizationState, opts?: CustomResourceOptions): GuestOsCustomization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        change_version: Optional[str] = None,
        description: Optional[str] = None,
        last_update_time: Optional[str] = None,
        name: Optional[str] = None,
        spec: Optional[GuestOsCustomizationSpecArgs] = None,
        type: Optional[str] = None) -> GuestOsCustomization
func GetGuestOsCustomization(ctx *Context, name string, id IDInput, state *GuestOsCustomizationState, opts ...ResourceOption) (*GuestOsCustomization, error)
public static GuestOsCustomization Get(string name, Input<string> id, GuestOsCustomizationState? state, CustomResourceOptions? opts = null)
public static GuestOsCustomization get(String name, Output<String> id, GuestOsCustomizationState state, CustomResourceOptions options)
resources:  _:    type: vsphere:GuestOsCustomization    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ChangeVersion string
The number of last changed version to the customization specification.
Description string
The description for the customization specification.
LastUpdateTime string
The time of last modification to the customization specification.
Name string
The name of the customization specification is the unique identifier per vCenter Server instance.
Spec Pulumi.VSphere.Inputs.GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
Type string
The type of customization specification: One among: Windows, Linux.
ChangeVersion string
The number of last changed version to the customization specification.
Description string
The description for the customization specification.
LastUpdateTime string
The time of last modification to the customization specification.
Name string
The name of the customization specification is the unique identifier per vCenter Server instance.
Spec GuestOsCustomizationSpecArgs
Container object for the Guest OS properties about to be customized . See virtual machine customizations
Type string
The type of customization specification: One among: Windows, Linux.
changeVersion String
The number of last changed version to the customization specification.
description String
The description for the customization specification.
lastUpdateTime String
The time of last modification to the customization specification.
name String
The name of the customization specification is the unique identifier per vCenter Server instance.
spec GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type String
The type of customization specification: One among: Windows, Linux.
changeVersion string
The number of last changed version to the customization specification.
description string
The description for the customization specification.
lastUpdateTime string
The time of last modification to the customization specification.
name string
The name of the customization specification is the unique identifier per vCenter Server instance.
spec GuestOsCustomizationSpec
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type string
The type of customization specification: One among: Windows, Linux.
change_version str
The number of last changed version to the customization specification.
description str
The description for the customization specification.
last_update_time str
The time of last modification to the customization specification.
name str
The name of the customization specification is the unique identifier per vCenter Server instance.
spec GuestOsCustomizationSpecArgs
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type str
The type of customization specification: One among: Windows, Linux.
changeVersion String
The number of last changed version to the customization specification.
description String
The description for the customization specification.
lastUpdateTime String
The time of last modification to the customization specification.
name String
The name of the customization specification is the unique identifier per vCenter Server instance.
spec Property Map
Container object for the Guest OS properties about to be customized . See virtual machine customizations
type String
The type of customization specification: One among: Windows, Linux.

Supporting Types

GuestOsCustomizationSpec
, GuestOsCustomizationSpecArgs

DnsServerLists List<string>
The list of DNS servers for a virtual network adapter with a static IP address.
DnsSuffixLists List<string>
A list of DNS search domains to add to the DNS configuration on the virtual machine.
Ipv4Gateway string
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
Ipv6Gateway string
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
LinuxOptions Pulumi.VSphere.Inputs.GuestOsCustomizationSpecLinuxOptions
A list of configuration options specific to Linux virtual machines.
NetworkInterfaces List<Pulumi.VSphere.Inputs.GuestOsCustomizationSpecNetworkInterface>
A specification of network interface configuration options.
WindowsOptions Pulumi.VSphere.Inputs.GuestOsCustomizationSpecWindowsOptions
A list of configuration options specific to Windows virtual machines.
WindowsSysprepText string
Use this option to specify a windows sysprep file directly.
DnsServerLists []string
The list of DNS servers for a virtual network adapter with a static IP address.
DnsSuffixLists []string
A list of DNS search domains to add to the DNS configuration on the virtual machine.
Ipv4Gateway string
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
Ipv6Gateway string
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
LinuxOptions GuestOsCustomizationSpecLinuxOptions
A list of configuration options specific to Linux virtual machines.
NetworkInterfaces []GuestOsCustomizationSpecNetworkInterface
A specification of network interface configuration options.
WindowsOptions GuestOsCustomizationSpecWindowsOptions
A list of configuration options specific to Windows virtual machines.
WindowsSysprepText string
Use this option to specify a windows sysprep file directly.
dnsServerLists List<String>
The list of DNS servers for a virtual network adapter with a static IP address.
dnsSuffixLists List<String>
A list of DNS search domains to add to the DNS configuration on the virtual machine.
ipv4Gateway String
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
ipv6Gateway String
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
linuxOptions GuestOsCustomizationSpecLinuxOptions
A list of configuration options specific to Linux virtual machines.
networkInterfaces List<GuestOsCustomizationSpecNetworkInterface>
A specification of network interface configuration options.
windowsOptions GuestOsCustomizationSpecWindowsOptions
A list of configuration options specific to Windows virtual machines.
windowsSysprepText String
Use this option to specify a windows sysprep file directly.
dnsServerLists string[]
The list of DNS servers for a virtual network adapter with a static IP address.
dnsSuffixLists string[]
A list of DNS search domains to add to the DNS configuration on the virtual machine.
ipv4Gateway string
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
ipv6Gateway string
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
linuxOptions GuestOsCustomizationSpecLinuxOptions
A list of configuration options specific to Linux virtual machines.
networkInterfaces GuestOsCustomizationSpecNetworkInterface[]
A specification of network interface configuration options.
windowsOptions GuestOsCustomizationSpecWindowsOptions
A list of configuration options specific to Windows virtual machines.
windowsSysprepText string
Use this option to specify a windows sysprep file directly.
dns_server_lists Sequence[str]
The list of DNS servers for a virtual network adapter with a static IP address.
dns_suffix_lists Sequence[str]
A list of DNS search domains to add to the DNS configuration on the virtual machine.
ipv4_gateway str
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
ipv6_gateway str
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
linux_options GuestOsCustomizationSpecLinuxOptions
A list of configuration options specific to Linux virtual machines.
network_interfaces Sequence[GuestOsCustomizationSpecNetworkInterface]
A specification of network interface configuration options.
windows_options GuestOsCustomizationSpecWindowsOptions
A list of configuration options specific to Windows virtual machines.
windows_sysprep_text str
Use this option to specify a windows sysprep file directly.
dnsServerLists List<String>
The list of DNS servers for a virtual network adapter with a static IP address.
dnsSuffixLists List<String>
A list of DNS search domains to add to the DNS configuration on the virtual machine.
ipv4Gateway String
The IPv4 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
ipv6Gateway String
The IPv6 default gateway when using network_interface customization on the virtual machine. This address must be local to a static IPv4 address configured in an interface sub-resource.
linuxOptions Property Map
A list of configuration options specific to Linux virtual machines.
networkInterfaces List<Property Map>
A specification of network interface configuration options.
windowsOptions Property Map
A list of configuration options specific to Windows virtual machines.
windowsSysprepText String
Use this option to specify a windows sysprep file directly.

GuestOsCustomizationSpecLinuxOptions
, GuestOsCustomizationSpecLinuxOptionsArgs

Domain This property is required. string
The domain name for this virtual machine.
HostName This property is required. string
The hostname for this virtual machine.
HwClockUtc bool
Specifies whether or not the hardware clock should be in UTC or not.
ScriptText string
The customization script to run before and or after guest customization
TimeZone string
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
Domain This property is required. string
The domain name for this virtual machine.
HostName This property is required. string
The hostname for this virtual machine.
HwClockUtc bool
Specifies whether or not the hardware clock should be in UTC or not.
ScriptText string
The customization script to run before and or after guest customization
TimeZone string
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
domain This property is required. String
The domain name for this virtual machine.
hostName This property is required. String
The hostname for this virtual machine.
hwClockUtc Boolean
Specifies whether or not the hardware clock should be in UTC or not.
scriptText String
The customization script to run before and or after guest customization
timeZone String
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
domain This property is required. string
The domain name for this virtual machine.
hostName This property is required. string
The hostname for this virtual machine.
hwClockUtc boolean
Specifies whether or not the hardware clock should be in UTC or not.
scriptText string
The customization script to run before and or after guest customization
timeZone string
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
domain This property is required. str
The domain name for this virtual machine.
host_name This property is required. str
The hostname for this virtual machine.
hw_clock_utc bool
Specifies whether or not the hardware clock should be in UTC or not.
script_text str
The customization script to run before and or after guest customization
time_zone str
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.
domain This property is required. String
The domain name for this virtual machine.
hostName This property is required. String
The hostname for this virtual machine.
hwClockUtc Boolean
Specifies whether or not the hardware clock should be in UTC or not.
scriptText String
The customization script to run before and or after guest customization
timeZone String
Customize the time zone on the VM. This should be a time zone-style entry, like America/Los_Angeles.

GuestOsCustomizationSpecNetworkInterface
, GuestOsCustomizationSpecNetworkInterfaceArgs

DnsDomain string
A DNS search domain to add to the DNS configuration on the virtual machine.
DnsServerLists List<string>
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
Ipv4Address string
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
Ipv4Netmask int
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
Ipv6Address string
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
Ipv6Netmask int
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
DnsDomain string
A DNS search domain to add to the DNS configuration on the virtual machine.
DnsServerLists []string
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
Ipv4Address string
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
Ipv4Netmask int
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
Ipv6Address string
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
Ipv6Netmask int
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
dnsDomain String
A DNS search domain to add to the DNS configuration on the virtual machine.
dnsServerLists List<String>
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
ipv4Address String
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
ipv4Netmask Integer
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
ipv6Address String
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
ipv6Netmask Integer
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
dnsDomain string
A DNS search domain to add to the DNS configuration on the virtual machine.
dnsServerLists string[]
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
ipv4Address string
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
ipv4Netmask number
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
ipv6Address string
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
ipv6Netmask number
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
dns_domain str
A DNS search domain to add to the DNS configuration on the virtual machine.
dns_server_lists Sequence[str]
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
ipv4_address str
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
ipv4_netmask int
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
ipv6_address str
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
ipv6_netmask int
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.
dnsDomain String
A DNS search domain to add to the DNS configuration on the virtual machine.
dnsServerLists List<String>
Network-interface specific DNS settings for Windows operating systems. Ignored on Linux.
ipv4Address String
The IPv4 address assigned to this network adapter. If left blank, DHCP is used.
ipv4Netmask Number
The IPv4 CIDR netmask for the supplied IP address. Ignored if DHCP is selected.
ipv6Address String
The IPv6 address assigned to this network adapter. If left blank, default auto-configuration is used.
ipv6Netmask Number
The IPv6 CIDR netmask for the supplied IP address. Ignored if auto-configuration is selected.

GuestOsCustomizationSpecWindowsOptions
, GuestOsCustomizationSpecWindowsOptionsArgs

ComputerName This property is required. string
The host name for this virtual machine.
AdminPassword string
The new administrator password for this virtual machine.
AutoLogon bool
Specifies whether or not the VM automatically logs on as Administrator.
AutoLogonCount int
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
DomainAdminPassword string
The password of the domain administrator used to join this virtual machine to the domain.
DomainAdminUser string
The user account of the domain administrator used to join this virtual machine to the domain.
DomainOu string
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
FullName string
The full name of the user of this virtual machine.
JoinDomain string
The domain that the virtual machine should join.
OrganizationName string
The organization name this virtual machine is being installed for.
ProductKey string
The product key for this virtual machine.
RunOnceCommandLists List<string>
A list of commands to run at first user logon, after guest customization.
TimeZone int
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
Workgroup string
The workgroup for this virtual machine if not joining a domain.
ComputerName This property is required. string
The host name for this virtual machine.
AdminPassword string
The new administrator password for this virtual machine.
AutoLogon bool
Specifies whether or not the VM automatically logs on as Administrator.
AutoLogonCount int
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
DomainAdminPassword string
The password of the domain administrator used to join this virtual machine to the domain.
DomainAdminUser string
The user account of the domain administrator used to join this virtual machine to the domain.
DomainOu string
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
FullName string
The full name of the user of this virtual machine.
JoinDomain string
The domain that the virtual machine should join.
OrganizationName string
The organization name this virtual machine is being installed for.
ProductKey string
The product key for this virtual machine.
RunOnceCommandLists []string
A list of commands to run at first user logon, after guest customization.
TimeZone int
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
Workgroup string
The workgroup for this virtual machine if not joining a domain.
computerName This property is required. String
The host name for this virtual machine.
adminPassword String
The new administrator password for this virtual machine.
autoLogon Boolean
Specifies whether or not the VM automatically logs on as Administrator.
autoLogonCount Integer
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
domainAdminPassword String
The password of the domain administrator used to join this virtual machine to the domain.
domainAdminUser String
The user account of the domain administrator used to join this virtual machine to the domain.
domainOu String
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
fullName String
The full name of the user of this virtual machine.
joinDomain String
The domain that the virtual machine should join.
organizationName String
The organization name this virtual machine is being installed for.
productKey String
The product key for this virtual machine.
runOnceCommandLists List<String>
A list of commands to run at first user logon, after guest customization.
timeZone Integer
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
workgroup String
The workgroup for this virtual machine if not joining a domain.
computerName This property is required. string
The host name for this virtual machine.
adminPassword string
The new administrator password for this virtual machine.
autoLogon boolean
Specifies whether or not the VM automatically logs on as Administrator.
autoLogonCount number
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
domainAdminPassword string
The password of the domain administrator used to join this virtual machine to the domain.
domainAdminUser string
The user account of the domain administrator used to join this virtual machine to the domain.
domainOu string
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
fullName string
The full name of the user of this virtual machine.
joinDomain string
The domain that the virtual machine should join.
organizationName string
The organization name this virtual machine is being installed for.
productKey string
The product key for this virtual machine.
runOnceCommandLists string[]
A list of commands to run at first user logon, after guest customization.
timeZone number
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
workgroup string
The workgroup for this virtual machine if not joining a domain.
computer_name This property is required. str
The host name for this virtual machine.
admin_password str
The new administrator password for this virtual machine.
auto_logon bool
Specifies whether or not the VM automatically logs on as Administrator.
auto_logon_count int
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
domain_admin_password str
The password of the domain administrator used to join this virtual machine to the domain.
domain_admin_user str
The user account of the domain administrator used to join this virtual machine to the domain.
domain_ou str
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
full_name str
The full name of the user of this virtual machine.
join_domain str
The domain that the virtual machine should join.
organization_name str
The organization name this virtual machine is being installed for.
product_key str
The product key for this virtual machine.
run_once_command_lists Sequence[str]
A list of commands to run at first user logon, after guest customization.
time_zone int
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
workgroup str
The workgroup for this virtual machine if not joining a domain.
computerName This property is required. String
The host name for this virtual machine.
adminPassword String
The new administrator password for this virtual machine.
autoLogon Boolean
Specifies whether or not the VM automatically logs on as Administrator.
autoLogonCount Number
Specifies how many times the VM should auto-logon the Administrator account when auto_logon is true.
domainAdminPassword String
The password of the domain administrator used to join this virtual machine to the domain.
domainAdminUser String
The user account of the domain administrator used to join this virtual machine to the domain.
domainOu String
The MachineObjectOU which specifies the full LDAP path name of the OU to which the virtual machine belongs.
fullName String
The full name of the user of this virtual machine.
joinDomain String
The domain that the virtual machine should join.
organizationName String
The organization name this virtual machine is being installed for.
productKey String
The product key for this virtual machine.
runOnceCommandLists List<String>
A list of commands to run at first user logon, after guest customization.
timeZone Number
The new time zone for the virtual machine. This is a sysprep-dictated timezone code.
workgroup String
The workgroup for this virtual machine if not joining a domain.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere