esacli opTestSettings

Edit online

Use the esacli opTestSettings to set and display information indicating when Electronic Service Agent attempts to perform an automatic operational test.

Synopsis

esacli opTestSettings [[-d [script]]

esacli opTestSettings [–e true] {–x time} {–i interval in days} 

esacli opTestSettings {-e false}

Description

The esacli opTestSettings command sets and displays information indicating when Electronic Service Agent attempts to perform an automatic operational test to IBM® servers.

Options

-d | --display
Specifies the setting values are to be displayed.
The optional script option generates this command containing all the current values, which can be used for updates. For example, to create an executable script file that you can use to specify opTestSettings values, follow these steps:
  1. Display the current opTestSettings values by running the following command:
    esacli opTestSettings -d
    Tip: You can display the help for the opTestSettings command by running the following command: esacli help opTestSettings.
  2. Save the output of the opTestSettings command to a file by running the following command:
    esacli opTestSettings -d script > optest.script
    Note: For Windows systems, create a batch file in the following format: esacli opTestSettings -d script > optest.bat.
  3. Edit the optest.script file to specify the wanted values.
  4. Change the optest.script file to an executable script file.
  5. Run the optest.script file to set the opTestSettings values on this or other systems.
-e | --enable true or false
Specifies if the operational test is enabled or not. The default is true.
-i | --interval days
Number of days between operational tests. Must be a value between 1-21.
-x | --time test time
Specifies when the test should be run in 15 minute intervals. The format of the time uses the ISO 8601 standard. It is expressed as HH:MM using a 24 hour clock. Times are rounded to 15 minute intervals.

Exit status

The following table contains the codes that are returned by this command.
  • 0: The operation completed successfully.
  • 1: IBM Electronic Service Agent instance is not running.
  • 10: An unsupported option was specified. Option: {option}.
  • 14: A required option was not provided. Option: {option}.
  • 18: An option was set more than once. Option: {option}.
  • 19: An option value was not provided when required. Option: {option}.
  • 31: An integer value was not provided when required. Option: {name} Value: {value}.
  • 32: An integer value was not in the valid range. Option: {option value} Range: {min-max}.
  • 42: Invalid value {value} specified for the {option} option.

Examples

  • Lists operational test settings 
    esacli opTestSettings -d
Operational test
 Automatically test connection to IBM support
 	Enabled: true
	Interval: 10 days			
	Scheduled time: 15:00
  • Set operational test settings 
    esacli opTestSettings --enable "true" --interval "11" --time "10:00"
The operation completed successfully.