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.
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 theroot
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 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": ""}}}'
Related links
Give documentation feedback