vSphere v4.13.2, Apr 9 25

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi

vsphere.getGuestOsCustomization

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  vm:
    type: vsphere:VirtualMachine
    properties:
      templateUuid: ${template.id}
      customizationSpec:
        - id: ${windows.id}
variables:
  datacenter:
    fn::invoke:
      function: vsphere:getDatacenter
      arguments:
        name: dc-01
  template:
    fn::invoke:
      function: vsphere:getVirtualMachine
      arguments:
        name: windows-template
        datacenterId: ${datacenter.id}
  windows:
    fn::invoke:
      function: vsphere:getGuestOsCustomization
      arguments:
        name: windows

Using getGuestOsCustomization

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getGuestOsCustomization(args: GetGuestOsCustomizationArgs, opts?: InvokeOptions): Promise<GetGuestOsCustomizationResult>
function getGuestOsCustomizationOutput(args: GetGuestOsCustomizationOutputArgs, opts?: InvokeOptions): Output<GetGuestOsCustomizationResult>

def get_guest_os_customization(name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetGuestOsCustomizationResult
def get_guest_os_customization_output(name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetGuestOsCustomizationResult]

func LookupGuestOsCustomization(ctx *Context, args *LookupGuestOsCustomizationArgs, opts ...InvokeOption) (*LookupGuestOsCustomizationResult, error)
func LookupGuestOsCustomizationOutput(ctx *Context, args *LookupGuestOsCustomizationOutputArgs, opts ...InvokeOption) LookupGuestOsCustomizationResultOutput

> Note: This function is named LookupGuestOsCustomization in the Go SDK.

public static class GetGuestOsCustomization 
{
    public static Task<GetGuestOsCustomizationResult> InvokeAsync(GetGuestOsCustomizationArgs args, InvokeOptions? opts = null)
    public static Output<GetGuestOsCustomizationResult> Invoke(GetGuestOsCustomizationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGuestOsCustomizationResult> getGuestOsCustomization(GetGuestOsCustomizationArgs args, InvokeOptions options)
public static Output<GetGuestOsCustomizationResult> getGuestOsCustomization(GetGuestOsCustomizationArgs args, InvokeOptions options)

fn::invoke:
  function: vsphere:index/getGuestOsCustomization:getGuestOsCustomization
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

Name string: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

name String: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

name string: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

name str: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

name String: The name of the customization specification is the unique identifier per vCenter Server instance. ## Attribute Reference

getGuestOsCustomization Result

The following output properties are available:

ChangeVersion string
Description string
Id string: The provider-assigned unique ID for this managed resource.
LastUpdateTime string
Name string
Specs List<Pulumi.VSphere.Outputs.GetGuestOsCustomizationSpec>
Type string

ChangeVersion string
Description string
Id string: The provider-assigned unique ID for this managed resource.
LastUpdateTime string
Name string
Specs []GetGuestOsCustomizationSpec
Type string

changeVersion String
description String
id String: The provider-assigned unique ID for this managed resource.
lastUpdateTime String
name String
specs List<GetGuestOsCustomizationSpec>
type String

changeVersion string
description string
id string: The provider-assigned unique ID for this managed resource.
lastUpdateTime string
name string
specs GetGuestOsCustomizationSpec[]
type string

change_version str
description str
id str: The provider-assigned unique ID for this managed resource.
last_update_time str
name str
specs Sequence[GetGuestOsCustomizationSpec]
type str

changeVersion String
description String
id String: The provider-assigned unique ID for this managed resource.
lastUpdateTime String
name String
specs List<Property Map>
type String

Supporting Types

GetGuestOsCustomizationSpec

DnsServerLists List<string>: A 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.
LinuxOptions List<Pulumi.VSphere.Inputs.GetGuestOsCustomizationSpecLinuxOption>: A list of configuration options specific to Linux.
NetworkInterfaces List<Pulumi.VSphere.Inputs.GetGuestOsCustomizationSpecNetworkInterface>: A specification of network interface configuration options.
WindowsOptions List<Pulumi.VSphere.Inputs.GetGuestOsCustomizationSpecWindowsOption>: A list of configuration options specific to Windows.
WindowsSysprepText string: Use this option to specify use of a Windows Sysprep file.

DnsServerLists []string: A 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.
LinuxOptions []GetGuestOsCustomizationSpecLinuxOption: A list of configuration options specific to Linux.
NetworkInterfaces []GetGuestOsCustomizationSpecNetworkInterface: A specification of network interface configuration options.
WindowsOptions []GetGuestOsCustomizationSpecWindowsOption: A list of configuration options specific to Windows.
WindowsSysprepText string: Use this option to specify use of a Windows Sysprep file.

dnsServerLists List<String>: A 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.
linuxOptions List<GetGuestOsCustomizationSpecLinuxOption>: A list of configuration options specific to Linux.
networkInterfaces List<GetGuestOsCustomizationSpecNetworkInterface>: A specification of network interface configuration options.
windowsOptions List<GetGuestOsCustomizationSpecWindowsOption>: A list of configuration options specific to Windows.
windowsSysprepText String: Use this option to specify use of a Windows Sysprep file.

dnsServerLists string[]: A 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.
linuxOptions GetGuestOsCustomizationSpecLinuxOption[]: A list of configuration options specific to Linux.
networkInterfaces GetGuestOsCustomizationSpecNetworkInterface[]: A specification of network interface configuration options.
windowsOptions GetGuestOsCustomizationSpecWindowsOption[]: A list of configuration options specific to Windows.
windowsSysprepText string: Use this option to specify use of a Windows Sysprep file.

dns_server_lists Sequence[str]: A 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.
linux_options Sequence[GetGuestOsCustomizationSpecLinuxOption]: A list of configuration options specific to Linux.
network_interfaces Sequence[GetGuestOsCustomizationSpecNetworkInterface]: A specification of network interface configuration options.
windows_options Sequence[GetGuestOsCustomizationSpecWindowsOption]: A list of configuration options specific to Windows.
windows_sysprep_text str: Use this option to specify use of a Windows Sysprep file.

dnsServerLists List<String>: A 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.
linuxOptions List<Property Map>: A list of configuration options specific to Linux.
networkInterfaces List<Property Map>: A specification of network interface configuration options.
windowsOptions List<Property Map>: A list of configuration options specific to Windows.
windowsSysprepText String: Use this option to specify use of a Windows Sysprep file.

GetGuestOsCustomizationSpecLinuxOption

Domain string: The domain name for this virtual machine.
HostName 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

Domain string: The domain name for this virtual machine.
HostName 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

domain String: The domain name for this virtual machine.
hostName 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

domain string: The domain name for this virtual machine.
hostName 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

domain str: The domain name for this virtual machine.
host_name 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

domain String: The domain name for this virtual machine.
hostName 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: Set the time zone on the guest operating system. For a list of the acceptable values for Linux customization specifications, see List of Time Zone Database Zones on Wikipedia.

GetGuestOsCustomizationSpecNetworkInterface

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.

GetGuestOsCustomizationSpecWindowsOption

AdminPassword string: The new administrator password for this virtual machine.
AutoLogon bool: Specifies whether or not the guest operating system automatically logs on as Administrator.
AutoLogonCount int: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
ComputerName string: The hostname for this virtual machine.
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.
JoinDomain string: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
DomainAdminPassword string: The user account used to join this virtual machine to the Active Directory domain.

AdminPassword string: The new administrator password for this virtual machine.
AutoLogon bool: Specifies whether or not the guest operating system automatically logs on as Administrator.
AutoLogonCount int: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
ComputerName string: The hostname for this virtual machine.
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.
JoinDomain string: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
DomainAdminPassword string: The user account used to join this virtual machine to the Active Directory domain.

adminPassword String: The new administrator password for this virtual machine.
autoLogon Boolean: Specifies whether or not the guest operating system automatically logs on as Administrator.
autoLogonCount Integer: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
computerName String: The hostname for this virtual machine.
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.
joinDomain String: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
domainAdminPassword String: The user account used to join this virtual machine to the Active Directory domain.

adminPassword string: The new administrator password for this virtual machine.
autoLogon boolean: Specifies whether or not the guest operating system automatically logs on as Administrator.
autoLogonCount number: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
computerName string: The hostname for this virtual machine.
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.
joinDomain string: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
domainAdminPassword string: The user account used to join this virtual machine to the Active Directory domain.

admin_password str: The new administrator password for this virtual machine.
auto_logon bool: Specifies whether or not the guest operating system automatically logs on as Administrator.
auto_logon_count int: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
computer_name str: The hostname for this virtual machine.
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.
join_domain str: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
domain_admin_password str: The user account used to join this virtual machine to the Active Directory domain.

adminPassword String: The new administrator password for this virtual machine.
autoLogon Boolean: Specifies whether or not the guest operating system automatically logs on as Administrator.
autoLogonCount Number: Specifies how many times the guest operating system should auto-logon the Administrator account when auto_logon is true.
computerName String: The hostname for this virtual machine.
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.
joinDomain String: The Active Directory domain for the virtual machine to join.
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 an Active Directory domain.
domainAdminPassword String: The user account used to join this virtual machine to the Active Directory 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

vsphere.getGuestOsCustomization

On this page

On this page

Example Usage

Using getGuestOsCustomization

getGuestOsCustomization Result

Supporting Types

GetGuestOsCustomizationSpec

GetGuestOsCustomizationSpecLinuxOption

GetGuestOsCustomizationSpecNetworkInterface

GetGuestOsCustomizationSpecWindowsOption

Package Details

On this page

On this page