esacli serviceSettings

Use the esacli serviceSettings command to set and display information about the types of inventory collected and the schedule for sending that inventory to IBM®.

Synopsis

esacli serviceSettings {–t type} [-d [script]]

esacli serviceSettings {–t type} {–e false} 

esacli serviceSettings {–t type} [–e true] {–x time} {–f frequency} [-g day-of-the-week] 
[-m day-of-the-month] [-q month-of-the-quarter]]

Description

The esacli serviceSettings command sets and displays types of inventory collected and the schedule for collecting the information. Times values are rounded to 15-minute intervals. This command will indicate that it completed successfully with a message: This command completed successfully. When the display option is specified, the new settings will be displayed. This command will also display the current settings when run with only the display option or no option is specified.

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 serviceSettings values, follow these steps:
  1. Display the current serviceSettings values by running the following command:
    esacli serviceSettings -d
    Tip: You can display the help for the serviceSettings command by running the following command: esacli help serviceSettings.
  2. Save the output of the serviceSettings command to a file by running the following command:
    esacli serviceSettings -d script > services.script
  3. Edit the services.script file to specify the wanted values.
  4. Change the services.script file to an executable script file.
  5. Run the services.script file to set the serviceSettings values on this or other systems.
-e | --enable true or false
Specifies whether inventory collection is enabled. The default value is true.
-f | --frequency {daily | weekly | monthly | quarterly}
Specifies how frequently inventory is collected. The words are not case-sensitive.
-g | --dayofweek Day of the Week
If frequency is Weekly, specifies the day of the week. Locale info can be used for different starts of the week. Monday Tuesday, Wednesday, etc.
-m | --dayofmonth 1-28
If frequency is Monthly, specifies the day of the month.
-q | --monthofquarter 1-3
If frequency is Quarterly, specifies the month of the quarter.
-t | --type type of service information
Specifies the type of service information that is collected. Options are hardware, software, and sysconfig or "system configuration". The types are case insensitive
-x | --time collection time
Specifies when the inventory is collected 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 will be 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: 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}.
  • 41: Invalid value specified: {value}. Value should be specified like {date format} for option {option}.
  • 42: Invalid value {value} specified for the {option} option.
  • 55: Option {option} is not a valid option when {option} is set to {value}.

Examples

  • List service settings information
    esacli serviceSettings –d –t Hardware
    Service information  
    	Hardware
    		Enabled: true
    		Collection time: 11:15
    		Frequency: Quarterly
    		Collection month of quarter: First
    Collection day of month: 1
  • Set service settings information
    esacli serviceSettings –t hardware –e true –x 13:15 –f daily
    
    esacli serviceSettings -t hardware –e true –x 13:15 –f weekly –g Monday
    
    esacli serviceSettings -t hardware –e true –x 13:15 –f monthly –m 28
    
    esacli serviceSettings -t software –e true –x 13:15 –f quarterly –q 1 –m 14