esscallhomeevent command

Use the esscallhomeeevent command to send call home events to the Electronic Service Agent (ESA).

Synopsis


esscallhomeevent [ --systemid EVENTSID ] 
                 [ --event { postRGTakeover | postRGRelinquish | rgOpenFailed | rgPanic 
                 | pdFailed | pdRecovered | pdReplacePdisk | pdPathDown | daRebuildFailed 
                 | nodeEvent | disk_call_home | node_call_home| test | test_call_home 
                 | bootDrvFail | bootDrvMirDegraded | bootDrvMirFailed | bootDrvMissing 
                 | bootDrvSmtFailed | canFanFailed | canFailed | canTempBusFailed 
                 | canTempSensorFailed | coinBatLow | coinBatMissing | cpuMissing 
                 | cpuSpeedWrong | dimmMissing | dimmSizeWrong | dimmSpeedWrong 
                 | fanFailed | fanSpeedHigh | fanSpeedLow | pairCanFailed | psHighCurrent 
                 | psHighVoltage | psFailed | psFanFailed | tempBusFailed | tempSensorFailed 
                 | voltBusFailed | voltSensorFailed | bootdrive_mirror_degraded 
                 | bootdrive_mirror_failed | bootdrive_missing | bootdrive_smart_failed 
                 | can_fan_failed | canister_failed | can_temp_bus_failed 
                 | can_temp_sensor_failed | coin_battery_low | coin_battery_missing 
                 | cpu_unit_missing | cpu_unit_speed_wrong | dimm_module_missing 
                 | dimm_module_size_wrong | dimm_module_speed_wrong | fan_failed 
                 | fan_speed_high | fan_speed_low | pair_canister_failed | power_high_current 
                 | power_high_voltage | power_supply_failed | ps_fan_failed | temp_bus_failed 
                 | temp_sensor_failed | voltage_bus_failed | voltage_sensor_failed } ] 
                 [ --eventName EVENTNAME ] [ --eventId EVENTID ][ --myNode MYNODE ] 
                 [ --rgName RGNAME ] [ --rgErr RGERR ] 
                 [ --rgReason RGREASON ] [ --daName DANAME ] 
                 [ --pdName PDNAME ] [ --pdLocation PDLOCATION ] 
                 [ --pdFru PDFRU ] [ pdWwn PDWWN ][ --pdState PdState ] 
                 [ --daRemainingRedundancy DAREMAININGDEDUNDANCY ]
                 [ --compName COMPNAME ] [ --compId COMPID ]           
                 [ --eventDesc EVENTDESC ] [ --compSerial COMPSERIAL ] 
                 [ --verbose ] [ --show ][ --upload UPLOADFILES ] 
                 [ --collector COLLECTOR ] [ --heartbeatnode HEARTBEATNODE ]
                 [ --esa-hostname-fqdn ESA_HOSTNAME_FQDN ]
                 [ -h | --help ]

Availability

Available with IBM Storage Scale System.

Description

You can use the esscallhomeevent command to send call home events to the ESA agent.

Parameters

-h | --help: Displays usage information about this command and exits.
-systemid EVENTSID: Specifies the system ID of the event.
--event {postRGTakeover, postRGRelinquish,rgOpenFailed,rgPanic,pdFailed,pdRecovered,
pdReplacePdisk,pdPathDown,daRebuildFailed,nodeEvent,disk_call_home,node_call_home,
test,test_call_home,bootDrvFail,bootDrvMirDegraded,bootDrvMirFailed,
bootDrvMissing,bootDrvSmtFailed,canFanFailed,canFailed,canTempBusFailed,
canTempSensorFailed,coinBatLow,coinBatMissing,cpuMissing,cpuSpeedWrong,
dimmMissing,dimmSizeWrong,dimmSpeedWrong,fanFailed,fanSpeedHigh,fanSpeedLow,
pairCanFailed,psHighCurrent,psHighVoltage,psFailed,psFanFailed,tempBusFailed,
tempSensorFailed,voltBusFailed,voltSensorFailed,bootdrive_mirror_degraded,
bootdrive_mirror_failed,bootdrive_missing,bootdrive_smart_failed,
can_fan_failed,canister_failed,can_temp_bus_failed,can_temp_sensor_failed,
coin_battery_low,coin_battery_missing,cpu_unit_missing,cpu_unit_speed_wrong,
dimm_module_missing,dimm_module_size_wrong,dimm_module_speed_wrong,
fan_failed,fan_speed_high,fan_speed_low,pair_canister_failed,power_high_current,
power_high_voltage,power_supply_failed,ps_fan_failed,temp_bus_failed,
temp_sensor_failed,voltage_bus_failed,voltage_sensor_failed}: Specifies event for call home.
--eventName EVENTNAME: Specifies the event name.
--eventId EVENTID: Specifies the unique event ID. Applicable for hardware call home events only.
--myNode MYNODE: Specifies the node that generates the event.
--rgName RGNAME: Specifies the recovery group (RG) name associated with the event.
--rgErr RGERR: Specifies the RG error information.
--rgReason RGREASOn: Specifies the RG reason.
--daName DANAME: Specifies the declustered array (DA) name that is associated with the event.
--pdName PDNAME: Specifies the physical disk (pdisk) name.
--pdLocation PDLOCATION: Specifies the pdisk location.
--pdFru PDFRU: Specifies the pdisk field replaceable unit (FRU).
--pdWwn PDWWN: Specifies the pdisk unique worldwide name (WWN).
--pdState PDSTATE: Specifies the physical disk (pdisk) state.
--deRemainingRedundancy DAREMAININGREDUNDANCY: Specifies the remaining redundancy of the associated DA.
--compNameCOMPNAME: Specifies the component name.
--compIdCOMPID: Specifies the component ID.
--eventDescEVENTDESC: Specifies the event description.
--compSerialCOMPSERIAL: Specifies the component serial number.
--verbose: Specifies the verbose output.
--show: Specifies the endpoint and event details.
--upload UPLOADFILES: Specifies the list of upload files and their location for the event.
--collector COLLECTOR: Specifies the command or script to generate the upload file. There is no default value.
--heartbeatnode HEARTBEATNODE: Specifies the heartbeat that is sent from the heartbeat node to ESA agent. This can be any node or enclosure.
--esa-hostname-fqdn ESA_HOSTNAME_FQDN: Provides the fully qualified domain name of ESA server for the certificate validation.

Security

You must have root authority to run the esscallhomeevent command.

Exit status

0: Successful completion.
nonzero: A failure occurs.

Example

This examples shows how to send call home events to the ESA agent.

esscallhomeevent --eventName ReplaceDisk --event 
pdReplacePdisk --systemid 37a6259cc0c1dae299a7866489dff0bd

Location

/opt/ibm/ess/tools/bin