PUT /osdeployment/globalSettings

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

Authentication

Authentication with user name 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
  • RHEL/ESXi (This value will be deprecated in a future release. Use "ESXi" or "LINUX" instead.)
  • 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
  win2012r1 Required Object Information about volume-license keys for Microsoft Windows 2012 R1
    dataCenterLicenseKey Required String Volume-license key that is used to deploy the data center version of Microsoft Windows 2012 R1
    standardLicenseKey Required String Volume-license key that is used to deploy the standard version of Microsoft Windows 2012 R1
  win2012r2 Required Object Information about volume-license keys for Microsoft Windows 2012 R2.
    dataCenterLicenseKey Required String Volume-license key that is used to deploy the data center version of Microsoft Windows 2012 R2
    standardLicenseKey Required String Volume-license key that is used to deploy the standard version of Microsoft Windows 2012 R2
  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
  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

Request example

{
   "activeDirectory": {
      "allDomains": [{
         "domainName": "domain1", 
         "id": 0, 
         "OU": "domain1-unit1"
      }, 
      {
         "domainName": "domain2", 
         "id": 1, 
         "OU": "domain2-unit"
      }],
      "defaultDomain": "domain2/domain2-unit"
   }
   "credentials": [{
      "name": "root",
      "password": null,
      "type": "ESXi"
   },
   {
      "name": "root",
      "password": null,
      "type": "LINUX"
   },
   {
      "name": "root",
      "password": null,
      "type": "RHEL\/ESXi"
   },
   {
      "password": "U2FsdGVkX1/fiTzKhVZaIG4JcGBuCkoqucvGBmrjtK5/ejaLy8TFkFgb9AeDoZtt", 
      "passwordChanged": false,
      "type": "WINDOWS"
   }], 
   "deploySettings": { 
      "ipDuplicationCheckEnabled": false, 
      "stateTransitionTimeout": 120 
   }
   "ipAssignment": "dhcpv4", 
   "licenseKeys": {
      "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"
      },
      "win2012r2": {
         "dataCenterLicenseKey": "AAAA4-BBBBB-CCCCC-DDDDD-EEEEE",
         "standardLicenseKey": "AAAA3-BBBBB-CCCCC-DDDDD-EEEEE"
      }
      "win2012r1": {
         "dataCenterLicenseKey": "AAAA2-BBBBB-CCCCC-DDDDD-EEEEE",
         "standardLicenseKey": "AAAA1-BBBBB-CCCCC-DDDDD-EEEEE"
      }
   }
}

Response codes

Code Description
200 OK
500 Internal server error

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

Response example

When the request is successful (response code of 200), a message body similar to the following is returned:

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

When the request is not successful (such as a response code of 500), a message body similar to the following is returned:

{
   "result": "failed", 
   "messages": [{
      "explanation": "The request data is not valid while setting the Global Setting data.", 
      "id": "FQXHMFC0130M", 
      "recovery": {
         "text": "Modify your request data. If the problem persists, contact Support.", 
         "URL": ""
      },
      "text": "Unable to set the Global Setting data."
   }]
}