GET /osdeployment/globalSettings

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

Authentication

Authentication with user name and password is required.

Request URL

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

Query parameters

None

Request body

None

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
deploySettings				Object	Information about deployment settings
	ipDuplicationCheckEnabled			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			Integer	Amount of time, in seconds, to wait between status updates before failing the OS deployment
globalSetting				Object	Information about global settings
	activeDirectory			Object	Information about Active Directory
		allDomains		Array of objects	Information about all Active Directory domains
			id	String	ID of the Active Directory domain
			domainName	String	Name of the Active Directory domain
			OU	String	Organizational unit of the Active Directory domain
		defaultDomain		String	Name of the default domain. This is one of the Active Directory domains in the AllDomains list)
	credentials			Array of objects	Information about user credentials
		name		String	User name. This can be one of the following values. root. For Linux and ESXi users. Administrator. For Windows users
		password		String	Encrypted password
		type		String	Operating system type. This can be one of the following values. ESXi LINUX WINDOWS
	ipAssignment			String	Host network setting option for operating-system deployment. This can be one of the following values. dhcpv4 staticv4 staticv6
	isVLANMode			Boolean	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			Object	Information about volume-license keys
		win10		Object	Information about volume-license keys for Microsoft Windows 10
			enterpriseLicenseKey	String	Volume-license key that is used to deploy the enterprise version of Microsoft Windows 10
			workstationLicenseKey	String	Volume-license key that is used to deploy the workstation version of Microsoft Windows 10
		win11		Object	Information about volume-license keys for Microsoft Windows 11
			enterpriseLicenseKey	String	Volume-license key that is used to deploy the enterprise version of Microsoft Windows 11
			workstationLicenseKey	String	Volume-license key that is used to deploy the workstation version of Microsoft Windows 11
		win2022r1		Object	Information about volume-license keys for Microsoft Windows 2022 R1
			dataCenterLicenseKey	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2022 R1
			standardLicenseKey	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2022 R1
		win2019r1		Object	Information about volume-license keys for Microsoft Windows 2019 R1
			dataCenterLicenseKey	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2019 R1
			standardLicenseKey	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2019 R1
		win2016r1		Object	Information about volume-license keys for Microsoft Windows 2016 R1
			dataCenterLicenseKey	String	Volume-license key that is used to deploy the data center version of Microsoft Windows 2016 R1
			standardLicenseKey	String	Volume-license key that is used to deploy the standard version of Microsoft Windows 2016 R1
result				String	Result 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.
messages				Array of objects	Message that is related to the result of the request
	explanation			String	Additional information to clarify the reason for the message
	id			String	Message identifier of a returned message
	recovery			Array	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
	text			String	Message text associated with the message identifier

The following example is returned when the request is successful.

{
   "deploySettings": {
      "ipDuplicationCheckEnabled": false,
      "stateTransitionTimeout": 120
   },
   "globalSetting": {
      "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"
         }
      }
   }
}

Give documentation feedback

GET /osdeployment/globalSettings

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​