PUT /osdeployment/globalSettings

Use this method to modify the current global settings for operating-system deployment.

Authentication

Authentication with username and password is required.

Request URL

PUT https://{management_server_IP}/osdeployment/globalSettings

Query parameters

None

Request body

Parameters			Required / Optional	Type	Description
activeDirectory			Required	Object	Information about Active Directory
	allDomains		Required	Array of objects	Information about all Active Directory domains
		domainName	Required	String	Name of the Active Directory domain
		id	Required	String	ID of the Active Directory domain
		OU	Required	String	Organizational unit of the Active Directory domain
	defaultDomain		Required	String	Name of the default domain. This is one of the Active Directory domains in the AllDomains list).
credentials			Required	Array of objects	Information about user credentials
	password		Required	String	Password of the operating system to be deployed For Windows 2012, this is the password for the Administrator user. For Linux and ESXi, this is the password for the root user.
	passwordChanged		Required	Boolean	Indicates whether to modify the password. This can be one of the following values. true false
	type		Required	String	Operating system type. This can be one of the following values. ESXi LINUX WINDOWS
deploySettings			Optional	Object	Information about deployment settings
	ipDuplicationCheckEnabled		Optional	Boolean	Indicates whether the duplicate-IP check runs at the beginning of an OS deployment. This can be one of the following values. true. Duplicate-IP check runs false. Duplicate-IP check does not run
	stateTransitionTimeout		Optional	Integer	Amount of time, in seconds, to wait between status updates before failing the OS deployment
ipAssignment			Required	String	Host network setting option for operating system deployment. This can be one of the following values. dhcpv4 staticv4 staticv6
isVLANMode			Required	String	Indicates whether VLAN mode is used. This can be one of the following values. true. VLAN mode is used. false. VLAN mode is not used.
licenseKeys			Required	Object	Information about volume-license keys
	win11		Required	Object	Information about volume-license keys for Microsoft Windows 11
		enterpriseLicenseKey	Required	String	Volume-license key that is used to deploy the enterprise version of Microsoft Windows 11
		workstationLicenseKey	Required	String	Volume-license key that is used to deploy the workstation version of Microsoft Windows 11
	win10		Required	Object	Information about volume-license keys for Microsoft Windows 10
		enterpriseLicenseKey	Required	String	Volume-license key that is used to deploy the enterprise version of Microsoft Windows 10
		workstationLicenseKey	Required	String	Volume-license key that is used to deploy the workstation version of Microsoft Windows 10
	win2022r1		Required	Object	Information about volume-license keys for Microsoft Windows 2022 R1
		dataCenterLicenseKey	Required	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2022 R1
		standardLicenseKey	Required	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2022 R1
	win2019r1		Required	Object	Information about volume-license keys for Microsoft Windows 2019 R1
		dataCenterLicenseKey	Required	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2019 R1
		standardLicenseKey	Required	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2019 R1
	win2016r1		Required	Object	Information about volume-license keys for Microsoft Windows 2016 R1
		dataCenterLicenseKey	Required	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2016 R1
		standardLicenseKey	Required	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2016 R1

The following example modifies the global OS-deployment settings.

{
   "activeDirectory": {
      "allDomains": [{
         "domainName": "domain1",
         "id": 0,
         "OU": "domain1-unit1"
      },
      {
         "domainName": "domain2",
         "id": 1,
         "OU": "domain2-unit"
      }],
      "defaultDomain": "domain2/domain2-unit"
   },
   "credentials": [{
      "passwordChanged": false,
      "password": null,
      "type": "ESXi"
   },
   {
      "passwordChanged": false,
      "password": null,
      "type": "LINUX"
   },
   {
      "passwordChanged": false,
      "password": null,
      "type": "RHEL/ESXi"
   },
   {
      "password": "U2FsdGVkX1/fiTzKhVZaIG4JcGBuCkoqucvGBmrjtK5/ejaLy8TFkFgb9AeDoZtt",
      "passwordChanged": false,
      "type": "WINDOWS"
   }],
   "deploySettings": {
      "ipDuplicationCheckEnabled": false,
      "stateTransitionTimeout": 120
   },
   "ipAssignment": "dhcpv4",
   "isVLANMode": false,
   "licenseKeys": {
      "win10": {
         "enterpriseLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "workstationLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      },
      "win11": {
         "enterpriseLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "workstationLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      },
      "win2022r1": {
         "dataCenterLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "standardLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      },
      "win2019r1": {
         "dataCenterLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "standardLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      },
      "win2016r1": {
         "dataCenterLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "standardLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      }
   }
}

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
403	Forbidden	The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.
500	Internal Server Error	An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes			Type	Description
result			String	Results of the request. This can be one of the following values. success. The request completed successfully. failed. The request failed. A descriptive error message was returned. warning. The request completed with a warning. A descriptive error message was returned.
messages			Array of objects	Information about one or more messages
	id		String	Message identifier of a returned message
	text		String	Message text associated with the message identifier
	explanation		String	Additional information to clarify the reason for the message
	recovery		Array of objects	Recovery information
		text	String	User actions that can be taken to recover from the event
		URL	String	Link to the help system for more information, if available

The following example is returned when the request is successful.

{
   "result": "success", 
   "messages": [ ]
}

Give documentation feedback

PUT /osdeployment/globalSettings

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​