Skip to main content

osimages globalsettings

This command retrieves or modifies global operating-system deployment settings. Global settings serve as defaults settings when operating systems are deployed.

Syntax

osimages globalsettings  -h

osimages globalsettings -o <settings_JSON> [-v <filter>]

Options

{-h | --help}
Displays the syntax and brief usage information for this command.
{-o | --osimages_dict} <settings_JSON>
Modifies the global operating-system deployment settings. This must be a correctly formatted JSON of the settings that you want to modify.

If not specified, this command returns the current settings.

ParametersRequired / OptionalTypeDescription
activeDirectoryRequiredObjectInformation about Active Directory
 allDomainsRequiredArray of objectsInformation about all Active Directory domains
  domainNameRequiredStringName of the Active Directory domain
  idRequiredStringID of the Active Directory domain
  OURequiredStringOrganizational unit of the Active Directory domain
 defaultDomainRequiredStringName of the default domain. This is one of the Active Directory domains in the AllDomains list).
credentialsRequiredArray of objectsInformation about user credentials
 passwordRequiredStringPassword 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.

 passwordChangedRequiredBooleanIndicates whether to modify the password. This can be one of the following values.
  • true
  • false
 typeRequiredStringOperating system type. This can be one of the following values.
  • ESXi
  • LINUX
  • WINDOWS
deploySettingsOptionalObjectInformation about deployment settings
 ipDuplicationCheckEnabledOptionalBooleanIndicates 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

 stateTransitionTimeoutOptionalIntegerAmount of time, in seconds, to wait between status updates before failing the OS deployment
ipAssignmentRequiredStringHost network setting option for operating system deployment. This can be one of the following values.
  • dhcpv4
  • staticv4
  • staticv6
​isVLANModeRequiredStringIndicates whether VLAN mode is used. This can be one of the following values.
  • true. VLAN mode is used.
  • false. VLAN mode is not used.
licenseKeysRequiredObjectInformation about volume-license keys
 win11RequiredObjectInformation about volume-license keys for Microsoft Windows 11
  enterpriseLicenseKeyRequiredStringVolume-license key that is used to deploy the enterprise version of Microsoft Windows 11
  workstationLicenseKeyRequiredStringVolume-license key that is used to deploy the workstation version of Microsoft Windows 11
 win10RequiredObjectInformation about volume-license keys for Microsoft Windows 10
  enterpriseLicenseKeyRequiredStringVolume-license key that is used to deploy the enterprise version of Microsoft Windows 10
  workstationLicenseKeyRequiredStringVolume-license key that is used to deploy the workstation version of Microsoft Windows 10
 win2022r1RequiredObjectInformation about volume-license keys for Microsoft Windows 2022 R1
  dataCenterLicenseKeyRequiredStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2022 R1
  standardLicenseKeyRequiredStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2022 R1
 win2019r1RequiredObjectInformation about volume-license keys for Microsoft Windows 2019 R1
  dataCenterLicenseKeyRequiredStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2019 R1
  standardLicenseKeyRequiredStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2019 R1
 win2016r1RequiredObjectInformation about volume-license keys for Microsoft Windows 2016 R1
  dataCenterLicenseKeyRequiredStringVolume-license key that is used to deploy the data center version of Microsoft Windows 2016 R1
  standardLicenseKeyRequiredStringVolume-license key that is used to deploy the standard version of Microsoft Windows 2016 R1

For example,

{
"activeDirectory": {
"defaultDomain": "labs.lenovo.com",
"allDomains": []
},
"credentials": [{
"passwordChanged": true,
"password": "Test1234",
"type": "LINUX",
"name": "root"
},
{
"passwordChanged": false,
"password": null,
"type": "WINDOWS",
"name": "Administrator"
}],
"ipAssignment": "dhcpv4",
"isVLANMode": false,
"licenseKeys": {
"win2022r1": {
"dataCenterLicenseKey": "",
"standardLicenseKey": ""
},
"win2019r1": {
"dataCenterLicenseKey": "",
"standardLicenseKey": ""
},
"win2016r1": {
"dataCenterLicenseKey": "",
"standardLicenseKey": ""
},
"win2012r2": {
"dataCenterLicenseKey": "",
"standardLicenseKey": ""
},
"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"
}
}
}

{-v | --view} <filter>
Identifies the view to use for the returned data. If a filter is not specified, the default view is used.

You can also create custom views (see Creating custom views).

Examples

The following example returns the current global settings.
connect --url https://192.0.2.0 --user ADMIN --noverify
osimages globalsettings -v globalsettings
The following example sets the default password for Linux.
connect --url https://192.0.2.0 --user ADMIN -noverify 
osimages globalsettings -v result -o '{"activeDirectory": {"defaultDomain": "labs.lenovo.com",
"allDomains": []}, "credentials": [{"passwordChanged": true, "password": "Test1234",
"type": "LINUX", "name": "root"}, {"passwordChanged": false, "password": null,
"type":"WINDOWS", "name": "Administrator"}], "ipAssignment": "dhcpv4",
"isVLANMode": false,"licenseKeys": {"win2019r1": {"dataCenterLicenseKey": "",
"standardLicenseKey": ""},"win2016r1": {"dataCenterLicenseKey": "",
"standardLicenseKey": ""},"win2012r2":{"dataCenterLicenseKey": "",
"standardLicenseKey": ""}, "standardLicenseKey": ""}}}'