esscallhomeconf script

Performs ESS HW call home configuration

Synopsis 

esscallhomeconf [-h] [--prefix PREFIX] [--suffix SUFFIX] [--verbose] [-N NODE] --icn ICN [--proxy-ip PROXY-IP-HOSTNAME] \
                      [--proxy-port PROXY-PORT] [--proxy-userid PROXY-USERNAME] [--proxy-password PROXY-PASSWORD] \
                      -m CALLHOME_CONFIG_M -u CALLHOME_CONFIG_U \
                      -n CALLHOME_CONFIG_N -e CALLHOME_CONFIG_E \
                      -t CALLHOME_CONFIG_T -g CALLHOME_CONFIG_G \
                      -a CALLHOME_CONFIG_A -z CALLHOME_CONFIG_Z \
                      -y CALLHOME_CONFIG_Y -r CALLHOME_CONFIG_R

Availability

Available with IBM Storage Scale System.

Description

You can use the esscallhomeconf script to configure IBM Storage Scale System for call home event generation. It is only applicable for IBM Storage Scale Systems on PPC64 architecture. The call home event is generated when a disk failure event occurs in the attached enclosure and replacement is required.

I/O server nodes, EMS node, and attached enclosures are considered end point that can generate events. In this release, only disk replacement events in attached enclosures are supported.

The esscallhomeconf --stop-auto-event-report switch instructs ESA to not report automatic event and not create any PMR automatically for any hardware failure. The callhomemon.sh script must be configured as a part of crontab to report any event to ESA on periodic intervals. For more information, see /opt/ibm/ess/tools/samples/callhomemon.sh and IBM Spectrum® Scale Software call home documentation.

Parameters

--prefix PREFIX
Provides the hostname prefix. Use = between --prefix and value if the value starts with -.
--suffix SUFFIX
Provides the hostname suffix. Use = between --suffix and value if the value starts with -.
--verbose
Provides the verbose output.
-N Node
Specifies name of the management sever node used for connections to esupport.ibm.com.
--icn ICN
Specifies IBM customer number.
Start of change--proxy-ip PROXY-IP-HOSTNAMEEnd of change
Start of changeSpecifies a hostname or IP address of a proxy, if the proxy must be used for connections to esupport.ibm.com.End of change
Start of change--proxy-port PROXY-PORTEnd of change
Start of changeSpecifies the port number for the proxy configuration.End of change
Start of change--proxy-userid PROXY-USERNAMEEnd of change
Start of changeSpecifies the user ID for the proxy configuration.End of change
Start of change--proxy-password PROXY-PASSWORDEnd of change
Start of changeSpecifies the password for the proxy configuration.End of change
-m CALLHOME_CONFIG_M
Specifies name of the organization that owns or is responsible for this system.
-u CALLHOME_CONFIG_U
Specifies country or region of contract that is corresponding to the ICN.
-n CALLHOME_CONFIG_N
Specifies name of the primary person in your organization who is responsible for administration of this system.
-e CALLHOME_CONFIG_E
Specifies group or task e-mail address for contacting the storage administrators of this system. Ensure that this is not a personal email address.
-t CALLHOME_CONFIG_T
Specifies a telephone number to contact the primary contact person.
-g CALLHOME_CONFIG_G
Specifies a country or region where the system is located.
-a CALLHOME_CONFIG_A
Specifies a state or province where the system is located.
-z CALLHOME_CONFIG_Z
Specifies a postal code where the system is located.
-y CALLHOME_CONFIG_Y
Specifies a city where the system is located.
-r CALLHOME_CONFIG_R
Specifies an address of where the system is located.

Exit status

0
Successful completion.
nonzero
A failure has occurred.

Security

You must have root authority to run the esscallhomeconf script.

Example

The following examples show configuring call home:
  1. Configure call home on an IBM Storage Scale System.
    esscallhomeconf --suffix=-hs -N <MGMT_NODE> --icn '<ID_NUMBER>' -m '<COMPANY>' -n '<USER_NAME>' -e '<EMAIL>' -u '<COUNTRY>' \
                         -t '<PHONE_NUMBER>' -g '<COUNTRY>' -a '<STATE>' -z '<ZIP_CODE>' -y '<CITY>' -r '<ADDRESS>'
  2. Check customer information.
    mmcallhome info list
    A sample output is as follows:
    group    customerName customerID   email     countryCode   type      primary-contact primary-contact-phone    machine-city   machine-zip   machine-address  machine-country   machine-state
-------- ------------ ------------ --------- ------------ ---------- --------------  ---------------------    -------------  -----------   --------------   -------------    -----------------
global   <Company>    <ID_NUMBER>  <EMAIL>   <COUNTRY>    production <USER_NAME>     <PHONE_NUMBER>           <CITY>         <ZIP_CODE>    <ADDRESS>        <COUNTRY>        <STATE>

Location

/opt/ibm/ess/tools/bin