Skip to main content

GET /osdeployment/globalSettings

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

Authentication

Authentication with username and password is required.

Request URL

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

Query parameters

None

Request body

None

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
403ForbiddenThe 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.

500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDescription
deploySettingsObjectInformation about deployment settings
 ipDuplicationCheckEnabledBooleanIndicates 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
 stateTransitionTimeoutIntegerAmount of time, in seconds, to wait between status updates before failing the OS deployment
globalSettingObjectInformation about global settings
 activeDirectoryObjectInformation about Active Directory
  allDomainsArray of objectsInformation about all Active Directory domains
   idStringID of the Active Directory domain
   domainNameStringName of the Active Directory domain
   OUStringOrganizational unit of the Active Directory domain
  defaultDomainStringName of the default domain. This is one of the Active Directory domains in the AllDomains list)
 credentialsArray of objectsInformation about user credentials
  name​​StringUser name. This can be one of the following values.
  • root. For Linux and ESXi users.
  • Administrator​. For Windows users
  passwordStringEncrypted password
  typeStringOperating system type. This can be one of the following values.
  • ESXi
  • LINUX
  • WINDOWS
 ipAssignmentStringHost network setting option for operating-system deployment. This can be one of the following values.
  • dhcpv4
  • staticv4
  • staticv6
 isVLANModeBooleanIndicates whether VLAN mode is used. This can be one of the following values.
  • true. VLAN mode is used.
  • false. VLAN mode is not used.
 licenseKeysObjectInformation about volume-license keys
  win10ObjectInformation about volume-license keys for Microsoft Windows 10
   enterpriseLicenseKeyStringVolume-license key that is used to deploy the enterprise version of Microsoft Windows 10
   workstationLicenseKeyStringVolume-license key that is used to deploy the workstation version of Microsoft Windows 10
  win11ObjectInformation about volume-license keys for Microsoft Windows 11
   enterpriseLicenseKeyStringVolume-license key that is used to deploy the enterprise version of Microsoft Windows 11
   workstationLicenseKeyStringVolume-license key that is used to deploy the workstation version of Microsoft Windows 11
  win2022r1ObjectInformation about volume-license keys for Microsoft Windows 2022 R1
   dataCenterLicenseKeyStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2022 R1
   standardLicenseKeyStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2022 R1
  win2019r1ObjectInformation about volume-license keys for Microsoft Windows 2019 R1
   dataCenterLicenseKeyStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2019 R1
   standardLicenseKeyStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2019 R1
  win2016r1ObjectInformation about volume-license keys for Microsoft Windows 2016 R1
   dataCenterLicenseKeyStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2016 R1
   standardLicenseKeyStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2016 R1
resultStringResult 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.
messagesArray of objectsMessage that is related to the result of the request
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned message
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 textStringMessage 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"
}
}
}
}