esacli

Description

The esacli command enables you to control the locally running IBM Electronic Service Agent instance.

Operands

subcommand

Specifies the specific subcommand to be performed.

Options

subcommand-options

Specifies the options specific to the subcommand to be performed. See the specific subcommand documentation for the options specific to the command.

Exit status

• 0: The operation completed successfully.
• 1: IBM Electronic Service Agent instance is not running.
• 5: An unsupported command was specified.
• 9: Unexpected error. Contact your support.
• 10: Unsupported option was specified. Option: {option}.
• 13: An invalid host name was specified for a subcommand host option.
• 14: A required option was not provided. Option: {option}.
• 16: The export operation failed. Reason: {Reason}
• 17: The import operation failed. Reason: {Reason}
• 18: An option was set more than once. Option: {option}.
• 19: An option value was not provided when required. Option: {option}.
• 20: An output file could not be created. Reason: {Reason}
• 21: An input file could not be read. Reason: {Reason}
• 22: An invalid email address was specified. Email: {email} for option {option}.
• 23: An invalid country was specified. Country: {country}.
• 24: An invalid phone number was specified. Phone: {Phone}
• 25: An invalid state or province was specified. State: {State}
• 26: An invalid postal code: {code} for country code {country code} and state/province {state/province}
• 27: An invalid IBM ID was specified. IBM ID: {id}
• 28: Activation failed. Reason: {Reason}.
• 29: The IBM Electronic Service Agent instance has not been activated.
• 30: The IBM Electronic Service Agent instance is currently suspended.
• 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}.
• 33: Connectivity test failed.
• 34: Notification test failed. Reason: {Reason}
• 35: Operational test failed
• 36: Test problem creation failed.
• 37: Invalid problem ID specified.
• 38: Problem deletion failed.
• 39: Problem update failed.
• 40: IBM Electronic Service Agent instance is not currently suspended.
• 41: Invalid value specified: {value}. Value should be specified like {date format} for option {option}.
• 42: Invalid value {value} specified for the {option} option.
• 43: IBM Electronic Service Agent is already active.
• 44: IBM Electronic Service Agent did not start.
• 45: Mutually exclusive arguments used together.
• 46: Can not delete required information.
• 47: Unable to update connection settings. Reason: {reason}
• 49: The {collector} collector did not start. Reason: {Reason}
• 50: The primary and secondary contacts can not be the same.
• 51: The help subcommand {command} is not supported.
• 52: Administrator privileges needed to run this command.
• 55: Option {option} is not a valid option when {option} is set to {value}.
• 56: Interface {interface} not valid. Reason: {reason}.
• 61: Not a valid option value. Option: {option}.
• 62: Token already exists.
• 63: Cache could not be updated.
• 64: Please provide a valid system ID.

Examples

• No command specified

  This example illustrates running the esacli command without specifying a subcommand to run.

  Usage: esacli <subcommand> <subcommand-options>
  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 Electronic Service 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.