Dell Optimizer Version 2.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.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	Use this command to display the list of available arguments.
/version	Use this command to display the current version of Dell Optimizer.
/get	Use this command to display all available settings and their properties. You can combine the command with additional options for specific setting details.
/configure	Use this command to configure 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	Use this command to display 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	Use this command to display all settings details.
/get -name=Analytics.State	Use this command to display details about the analytics state.
/get -name=AppPerformance.State	Use this command to display details about the application performance state.
/get -name=Audio.Audio3D	Use this command to display details about the 3D audio state.
/get -name=Audio.AutoMute	Use this command to display details about the audio automute state.
/get -name=Audio.Environment	Use this command to display details about the audio environment setting.
/get -name=Audio.IsNXOSEnabled	Use this command to know if your system supports 3D audio over speakers.
/get -name=Audio.JackNotification	Use this command to display details about the audio jack state.
/get -name=Audio.State	Use this command to display details about the audio state.
/get -name=BatteryExtender.State	Use this command to display details about the battery extender state.
/get -category=<categoryname>	Use this command to display all settings and current values of the selected category.
/get -list categories	Use this command to display the name of all available feature categories. For example, Application, Audio, Power.
/get -name=DellOptimizerConfiguration.BetaFeatures	Use this command to display details about the Beta feature.
/get -name=DellOptimizerConfiguration.StickyBanners	Use this command to display details about the sticky banners component state.
get -name=DellOptimizerConfiguration.Suggestions	Use this command to display details about the suggestions component state.
/get -name=DynamicCharge.State	Use this command to display details about the dynamic charge state.
/get -name=Privacy.EnablePrivacyNotifications	Use this command to display details about the privacy notifications.
/get -name=ProximitySensor.CameraBasedDetection	Use this command to display details about the proximity sensor camera based detection state on products supporting Intel® Visual Sensing Technology.
/get -name= ProximitySensor.EnableWithExternalMonitor	Use this command to display details about the proximity sensor feature state when an external monitor is connected.
/get -name=ProximitySensor.KeepAlive	Use this command to display details about the proximity sensor keep alive state.
/get -name=ProximitySensor.SnoozeTimer	Use this command to display details about the proximity sensor snooze timer.
/get -name=ProximitySensor.State	Use this command to display details about the proximity sensor state.
/get -name= ProximitySensor.WakeOnApproach	Use this command to display details about the proximity sensor wake on approach state.
/get -name=ProximitySensor.WalkAwayLock	Use this command to display details about the proximity sensor walk away lock state.
/get -name=ProximitySensor.WalkAwayLockTimer	Use this command to display details about the proximity sensor walk away lock timer.
/get -name=Network.AutoSwitch	Use this command to display details about the network auto switch.
/get -name=Network.ConferenceBandwidthPerformance	Use this command to display details about the network conference bandwidth performance.
/get -name=Network.OptimizeTraffic	Use this command to display details about optimizing network traffic.
/get -name=Network.OutdatedRouterWiFi	Use this command to find out if your router Wi-Fi technology is outdated compared to your device.
/get -name=Network.State	Use this command to display details about the network state.
/get -name=Telemetry.State	Use this command to display current participation status in the Dell Optimizer Customer Experience Improvement Program.
/get -name=Toast.GlobalNotification	Use this command to display details about the global notifications.

Table 3. Configure commands for Dell OptimizerThis table describes the configure commands for Dell Optimizer.
/configure command	Details	Supported Values
/configure -name=AppPerformance.State -value=	Use this command to configure the application performance state value.	`True` and `false`
/configure -name=Analytics.State -value=	Use this command to configure the analytics sate value.	`True` and `false`
/configure -name=Audio.Audio3D -value=	Use this command to configure the audio 3D value.	`True` and `false`
/configure -name=Audio.AutoMute -value	Use this command to configure the audio automute value.	`True` and `false`
/configure -name=Audio.Environment -value=	Use this command to configure the audio environment value.	QuietRoom, NoisyOffice, MultipleVoices, and RecordingStudio
/configure -name=Audio.JackNotification -value=	Use this command to configure the state of the audio jack notification.	`True` and `false`
/configure -name=Audio.State -value=	Use this command to configure the audio state value.	`True` and `false`
/configure -name=BatteryExtender.State -value=	Use this command to configure the battery extender state value.	`True` and `false`
/configure -name=DellOptimizerConfiguration.BetaFeatures -value=	Use this command to configure the Beta feature value.	`True` and `false`
/configure -name=DellOptimizerConfiguration.StickyBanners -value=	Use this command to configure the sticky banners value.	`True` and `false`
/configure -name=DellOptimizerConfiguration.Suggestions -value=	Use this command to configure the suggestions component value.	`True` and `false`
/configure -name=DynamicCharge.State -value=	Use this command to configure the dynamic charge state value.	`True` and `false`
/configure -name=Privacy.EnablePrivacyNotifications -value=	Use this command to configure the privacy notifications value.	`True` and `false`
/configure -name=ProximitySensor.CameraBasedDetection - value	Use this command to configure proximity sensor camera based detection state on products supporting Intel® Visual Sensing Technology.	`True` and `false`
/configure -name=ProximitySensor.EnableWithExternalMonitor -value=	Use this command to configure the state of proximity sensor features when system is connected to an external monitor.	`True` and `false`
/configure -name=ProximitySensor.KeepAlive -value=	Use this command to configure the proximity sensor keep alive state value.	`True` and `false`
/configure -name=ProximitySensor.SnoozeTimer -value=	Use this command to configure the proximity sensor snooze timer value for the walk away lock feature.	`0,30, 60, 90,` and `120 minutes`
/configure -name=ProximitySensor.WalkAwayLock -value=	Use this command to configure the proximity sensor walk away lock value.	`True` and `false`
/configure -name=ProximitySensor.WalkAwayLockTimer -value=	Use this command to configure the proximity sensor walk away lock timer value.	`30, 60,` and `120 seconds`
/configure -name=ProximitySensor.WakeOnApproach -value=	Use this command to configure the proximity sensor wake on approach value.	`True` and `false`
/configure -name=Network.AutoSwitch -value	Use this command to configure the network auto switch value.	`True` and `false`
/configure -name=Network.ConferenceBandwidthPerformance - value	Use this command to configure the network conference bandwidth performance value.	`True` and `false`
/configure -name=Network.OptimizeTraffic -value	Use this command to configure the network traffic value optimization.	`True` and `false`
/configure -name=Network.State -value	Use this command to configure the network state.	`True` and `false`
/configure -name=Telemetry.State -value=	Use this command to configure Dell Optimizer Customer Experience Improvement Program.	`True` and `false`
/configure -name=Toast.GlobalNotification -value=	Use this command to configure the global notifications value.	`True` and `false`
/configure -name=<settingname> -lock=	Use this command to lock the specific setting from being changed by user.	`True` and `false`

Table 4. Application performance commands for Dell Optimizer This table describes the Application performance commands for Dell Optimizer.
/AppPerformance command	Details
/AppPerformance -listProfiles	Use this command to display the list of applications that are in optimized state.
/AppPerformance -listLearningApps	Use this command to display the list of applications that are in learning state.
/AppPerformance -setPriority -profileName=<profile name> -priority=<value>	Use this command to set the priority of an application profile using the name.
/AppPerformance -setPriority -profileGuid=<profile guid> -priority=<value>	Use this command to set the priority of an application profile using the GUID.
/AppPerformance -restoreToDefault	Use this command to restore all settings back to default for optimized applications.
/AppPerformance -startLearning -profileName=<profile name> -processName=<value> -priority=<value>	Use this command to start the optimization process for the specified application.
/AppPerformance -pauseLearning -profileName=<profile name>	Use this command to pause optimization learning for the specific application.
/AppPerformance -resumeLearning -profileName=<profile name>	Use this command to resume optimization learning for the specific application.
/AppPerformance -deleteProfile -profileName=<profile name>	Use this command to delete an existing optimized application profile by name.
/AppPerformance -deleteProfile -profileGuid=<profile guid>	Use this command to delete an existing optimized application profile by GUID.
/AppPerformance -enableProfile -profileName=<profileName>	Use this command to enable an existing profile by name.
/AppPerformance -enableProfile -profileGuid=<profile guid>	Use this command to enable an existing profile by GUID.
/AppPerformance -disableProfile -profileName=<profile Name>	Use this command to disable an existing profile by name.
/AppPerformance -disableProfile -profileGuid=<profile guid>	Use this command to disable an existing profile by GUID.
/AppPerformance -importProfile -profilePath=<profile file path>	Use this command to import an optimized app profile.
/AppPerformance -exportProfile -profileName=<profile Name> -profilePath=<profile file path>	Use this command to export an optimized app profile by name.
/AppPerformance -exportProfile -profileGuid=<profile guid> -profilePath=<profile file path>	Use this command to export an optimized app profile by GUID.

Table 5. Network commands for Dell Optimizer Network commands for Dell Optimizer
/network command	Description	Supported values
/network -getnetworkwifidiags	Use this command to get the following information about your currently connected WiFi network: Network name Speed to router Router class Adapter class	NA
/network -gettrafficpriority	Use this command to get the current priority order of network traffic types(conference, streaming, cloud).	NA
/network -settrafficpriority -priority=	Use this command to set the network traffic priority. You have to list the traffic types (conference, streaming, cloud) in priority order and separate them by commas.	"conference,streaming,cloud"

Table 6. 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 user interface is active
10	It requires administrator privilege