esacli help
Use the esacli help command to request information about using the esacli functions.
Synopsis
esacli help <subcommand>
Description
The esacli help command enables you to display the syntax and a brief description of the specified subcommand.
Operands
- subcommand
- Specifies the specific subcommand for which help is requested.
Exit status
The following table contains the codes that are returned by this command.0: The operation completed successfully.51: The help subcommand {command} is not supported.
Examples
- No subcommand specified
This example illustrates running the esacli help command without specifying a subcommand.
esacli help Provide command help. Usage: esacli help [subcommand] Subcommands: activity Show activity log entries. connectionSettings Configures connectivity to IBM through proxy servers. contactSettings Sets and lists contact information for the monitored system. export Export configuration settings. help Provides command help. ibmId Sets IBM ids associated with this ESA system. import Import configuration settings. interfaces Lists the network interface cards. locationSettings Configures and displays system location information. logSettings Sets and lists logging level. notificationSettings Configures notification settings. problem Work with problems. problemSettings Configures frequency of notification retries in case of failure and displays settings. resume ESA resumes monitoring of the system. service Displays inventory collection settings and collects inventory. serviceSettings Configures the frequency of inventory collection. start Starts ESA. status Display agent status. stop Stops ESA. supportProxySettings Configures and displays Service and Support Proxy settings. suspend ESA suspends monitoring of the system. test Performs test operations for connectivity, notification, operations, and problem generation. - Provide command help
This example illustrates running the esacli help command.
esacli help activity Help for activity Summary Use the esacli activity command to display activity log entries for IBM Electronic Service Agent instance. Synopsis esacli activity [[-m count] | [{-b start-date-time} {-e end-date-time}]] Description The esacli activity command displays activity log entries for IBM Electronic Service Agent instance. Options -m | --max count Specifies the maximum number of entries from the end of the activity log to be displayed. A positive integer value must be specified. The entire activity log is displayed if this option is not specified. -b | --begin date-timestamp Specifies a date and time for the earliest entry from the activity log to be returned. The date and time may be specified using local conventions for specifying a date and time. Use help for this command to see a sample format for specifying a date and time value. The date and time can also be specified using ISO 8601 an international system for specifying dates and times. An ISO 8601 date and time should be expressed with the following format: YYYY-MM-DD HH:MM. The time is expressed using a 24 clock. -e | --end date-timestamp Specifies a date and time for the latest entry from the activity log to be returned. The date and time may be specified using local conventions for specifying a date and time. Use help for this command to see a sample format for specifying a date and time value. The date and time can also be specified using ISO 8601 an international system for specifying dates and times. An ISO 8601 date and time should be expressed with the following format: YYYY-MM-DD HH:MM. The time is expressed using a 24 clock. Exit status 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}. 29 = IBM Electronic Service Agent instance has not been activated. 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. 45 = Mutually exclusive arguments used together. Examples 1. List the last 6 entries in the activity log This example illustrates running esacli activity to list the last 6 entries in the activity log. > esacli activity -m 6 Activity log entries: Jul 23, 2010 5:43:39 PM: Operational test successful. Jul 22, 2010 8:59:28 PM: Software service information sent. Jul 22, 2010 8:58:34 PM: Software service information collection initiated. Jul 22, 2010 8:57:39 PM: Software service information sent. Jul 22, 2010 8:55:40 PM: Hardware service information collection initiated. Jul 22, 2010 8:56:34 PM: Software service information sent. 2. List the activity entries between two dates using a locale format. This example illustrates running esacli activity to list the activity between two dates and times using a locale specific format. > esacli activity -b "7/21/12 9:09 AM" -e "7/24/12 9:09 AM" Activity log entries: Jul 23, 2012 5:43:39 PM: Operational test successful. Jul 22, 2012 8:59:28 PM: Software service information sent. Jul 22, 2012 8:58:34 PM: Software service information collection initiated. Jul 22, 2012 8:57:39 PM: Software service information sent. Jul 22, 2012 8:55:40 PM: Hardware service information collection initiated. Jul 22, 2012 8:56:34 PM: Software service information sent. 3. List the activity entries between two dates using a standard format. This example illustrates running esacli activity to list the activity between two dates using an ISO 8601 format. > esacli activity -b 2012-07-21 -e 2012-07-24 Activity log entries: Jul 23, 2012 5:43:39 PM: Operational test successful. Jul 22, 2012 8:59:28 PM: Software service information sent. Jul 22, 2012 8:58:34 PM: Software service information collection initiated. Jul 22, 2012 8:57:39 PM: Software service information sent. Jul 22, 2012 8:55:40 PM: Hardware service information collection initiated. Jul 22, 2012 8:56:34 PM: Software service information sent.