GuestWindowsConfiguration

The WindowsConfiguration structure specifies the settings for customizing a windows guest operating system.


Properties

reboot Optional

The WindowsConfiguration.RebootOption enumerated type specifies what should be done to the guest after the customization.
REBOOT : Reboot the guest after customization.
NO_REBOOT : Take no action. Leave the guest OS running after customization. This option can be used to look at values for debugging purposes.
SHUTDOWN : Shutdown the guest after customization.

Possible values are: REBOOTNO_REBOOTSHUTDOWN


sysprep Optional

Customization settings like user details, administrator details, etc for the windows guest operating system. Exactly one of WindowsConfiguration.sysprep or WindowsConfiguration.sysprep-xml must be specified. If unset, sysprep settings will not be applied to the windows guest operating system.


string
sysprep_xml Optional

All settings specified in a XML format. This is the content of a typical answer.xml file that is used by System administrators during the Windows image customization. Check https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/update-windows-settings-and-scripts-create-your-own-answer-file-sxs Exactly one of WindowsConfiguration.sysprep or WindowsConfiguration.sysprep-xml must be specified. If unset, sysprep settings will not be applied to the windows guest operating system.

JSON Example

{
	"reboot": "REBOOT",
	"sysprep": {
		"domain": {
			"domain": "string",
			"domain_password": "string",
			"domain_username": "string",
			"type": "WORKGROUP",
			"workgroup": "string"
		},
		"gui_run_once_commands": [
			"string"
		],
		"gui_unattended": {
			"auto_logon": false,
			"auto_logon_count": 0,
			"password": "string",
			"time_zone": 0
		},
		"user_data": {
			"computer_name": {
				"fixed_name": "string",
				"prefix": "string",
				"type": "FIXED"
			},
			"full_name": "string",
			"organization": "string",
			"product_key": "string"
		}
	},
	"sysprep_xml": "string"
}

Feedback

Was this page helpful?