Dell Optimizer Version 1.0 User's Guide

PDF

Command line interface for Dell Optimizer

As an administrator you can use the following CLI commands for batch and scripting scenarios. You can view the location and filename of the CLI in C:\Program Files\Dell\DellOptimizer\do-cli.exeC:\Program Files\Dell\DellOptimizer\do-cli.exe.

NOTE: The return code is sent to stderr, and command output is sent to stdout.

Table 1. CLI Commands for Dell OptimizerThis table describes the CLI commands for Dell Optimizer.
CLI Command	Description
/help	Displays the list of available arguments.
/version	Displays the current version.
/get	Displays all available settings and their properties. You can combine the command with additional options for specific setting details.
/configure	Configures a setting and the command must be combined with additional options for a specific setting. These settings are dynamic, and it is not a static list.
/appperformance	Displays the Applications feature settings and configuration information. The command must be used with additional options. These settings are dynamic, and it is not a static list.

Table 2. /get commands for Dell OptimizerThis table describes the get commands for Dell Optimizer.
/get command	Details
/get	Displays all settings details.
/get -name=Telemetry.State	Displays current participation status in the Dell Optimizer Customer Experience Improvement Program.
/get -listcategories	Displays the name of all currently available feature categories. For example, Application, Audio, Power, and so on.
/get -category=<categoryname>	Displays all settings and current values of the selected category.
/get -name=Audio.State	Displays details about the audio state.
/get -name=Audio.Audio3D	Displays details about the audio 3D state.
/get -name=Audio.Environment	Displays details about the audio environment state.
/get -name=Audio.IsNXOSEnabled	Displays details about the audio IsNXOS state.
/get -name=Audio.JackNotification	Displays details about the audio jack state.
/get -name=BatteryExtender.State	Displays details about the battery extender state.
/get -name=DynamicCharge.State	Displays details about the dynamic charge state.
/get -name=ProximitySensor.State	Displays details about the proximity sensor state.
/get -name= ProximitySensor.EnableWithExternalMonitor	Displays details about the proximity sensor enabled with external monitor state.
/get -name="ProximitySensor.KeepAlive"	Displays details about the proximity sensor keep alive state.
/get -name= ProximitySensor.WakeOnApproach	Displays details about the proximity sensor wake on approach state.
/get -name=ProximitySensor.WalkAwayLock	Displays details about the proximity sensor walk away lock state.
/get -name=ProximitySensor.WalkAwayLockTimer	Displays details about the proximity sensor walk away lock timer state.

Table 3. Configure commands for Dell OptimizerThis table describes the configure commands for Dell Optimizer.
/configure command	Details	Supported Values
/configure -name=<settingname> -lock=	Locks the specific setting from being changed by user.	true and false
/configure -name=Telemetry.State -value=	Configures Dell Optimizer Customer Experience Improvement Program.	true and false
/configure -name=AppPerformance.State -value=	Configures the application performance state value.	true and false
/configure -name=Audio.State -value=	Configures the audio state value.	true and false
/configure -name=Audio.Audio3D -value=	Configures the audio 3D value.	true and false
/configure -name=Audio.IsNXOSEnabled -value=	Configures the audio sNXOS value.	true and false
/configure -name=Audio.JackNotification -value=	Configures the audio jack notification value.	true and false
/configure -name=Audio.Environment -value=	Configures the audio environment value.	QuietRoom, NoisyOffice, MultipleVoices, and RecordingStudio
/configure -name=BatteryExtender.State -value=	Configures the battery extender state value.	true and false
/configure -name=DynamicCharge.State -value=	Configures the dynamic charge state value.	true and false
/configure -name=ProximitySensor.State -value=	Configures the proximity sensor state value.	true and false
/configure -name=ProximitySensor.EnableWithExternalMonitor -value=	Configures the proximity sensor enabled with external monitor state value.	true and false
/configure -name=ProximitySensor.KeepAlive -value=	Configures the proximity sensor keep alive state value.	true and false
/configure -name=ProximitySensor.SnoozeTimer -value=	Configures the proximity sensor snooze timer value.	30, 60, 90, and 120 minutes
/configure -name=ProximitySensor.WakeOnApproach -value=	Configures the proximity sensor wake on approach value.	true and false
/configure -name=ProximitySensor.WalkAwayLock -value=	Configures the proximity sensor walk away lock value.	true and false
/configure -name=ProximitySensor.WalkAwayLockTimer -value=	Configures the proximity sensor walk away lock timer value.	1, 2, and 3 minutes

Table 4. Application performance commands for Dell Optimizer This table describes the Application performance commands for Dell Optimizer.
/AppPerformance command	Details
/AppPerformance -listProfiles	Displays the list of applications that are in optimized state.
/AppPerformance -listLearningApps	Displays the list of applications that are in learning state.
/AppPerformance -setPriority -profileName=<profile name> -priority=<value>	Sets the priority of an application profile using the name.
/AppPerformance -setPriority -profileGuid=<profile guid> -priority=<value>	Sets the priority of an application profile using the GUID.
/AppPerformance -restoreToDefault	Restores all settings back to default for optimized applications.
/AppPerformance -startLearning -profileName=<profile name> -processName=<value> -priority=<value>	Starts the optimization process for the specified application.
/AppPerformance -pauseLearning -profileName=<profile name>	Pauses optimization learning for the specific application.
/AppPerformance -resumeLearning -profileName=<profile name>	Resumes optimization learning for the specific application.
/AppPerformance -deleteProfile -profileName=<profile name>	Deletes an existing optimized application profile by name.
/AppPerformance -deleteProfile -profileGuid=<profile guid>	Deletes an existing optimized application profile by GUID.
/AppPerformance -enableProfile -profileName=<profileName>	Enables an existing profile by name.
/AppPerformance -enableProfile -profileGuid=<profile guid>	Enables an existing profile by GUID.
/AppPerformance -disableProfile -profileName=<profile Name>	Disables an existing profile by name.
/AppPerformance -disableProfile -profileGuid=<profile guid>	Disables an existing profile by GUID.
/AppPerformance -importProfile -profilePath=<profile file path>	Imports an optimized app profile.
/AppPerformance -exportProfile -profileName=<profile Name> -profilePath=<profile file path>	Exports an optimized app profile by name.
/AppPerformance -exportProfile -profileGuid=<profile guid> -profilePath=<profile file path>	Exports an optimized app profile by GUID.

Table 5. Return codes for Dell OptimizerThis table describes the Return codes for Dell Optimizer.
CLI Return Codes	Condition
0	Success
1	Failure
2	Reboot required
3	Failed to configure the read-only setting
4	Failed to configure licensed feature
5	Dell Optimizer service not installed
6	Dell Optimizer service is disabled
7	Dell Optimizer service is not running
8	Another instance of CLI is active
9	Another instance of GUI is active