gsscallhomeconf script

Availability

Available with the Elastic Storage Server.

Description

You can use the gsscallhomeconf script to configure ESS for call home event generation by using the Electronic Service Agent (ESA). The call home event is generated when a disk failure or a node failure event occurs and replacement is required.

gsscallhomeconf or gsscallhomeevent can communicate with ESA over a REST API and can generate events upload failure data when a disk replacement is required. I/O server nodes, EMS node, and attached enclosures are considered end point that can generate events.

gsscallhomeconf also configures software call home along with hardware call home unless --no-swcallhome is specified. If you do not want to use software call home along with hardware call home, use the --no-swcallhome option.

The gsscallhomeconf --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/gss/tools/samples/callhomemon.sh and IBM Spectrum® Scale Software call home documentation.

Parameters

-N NODE-LIST

Provides a list of nodes to configure.

-G NODE-GROUP

Provides the name of node group.

--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 -.

-E ESA-AGENT

Provides the node name on which the ESA agent is installed and running.

--register {node,all}

Registers the endpoints (nodes, enclosure or all) with ESA.

--no-swcallhome

Specifies to not configure software call home while configuring hardware call home. The gsscallhomeconf command configures software call home with hardware call home by default unless this option is specified.

--crvpd

Creates the solution vital product data (VPD) file.

--serial SOLN-SERIAL

Provides the ESS solution serial number in the VPD file.

--model SOLN-MODEL

Provides the ESS model.

--verify-esa-cert {yes,no}

Specifies whether to validate the ESA Https certification or not. The default value is yes.

Make sure that the ESA certificate is not self-signed otherwise provide the certificate path by using the --esa-cert-location switch

--esa-cert-location CERT-LOCATION

Provides the ESA server certificate location.

--esa-hostname-fqdn FQDN

Provides the fully qualified domain name of ESA server for the certificate validation.

--stop-auto-event-report

Stops report of automatic event to ESA if any hardware call home event is reported to the system.

--verbose

Provides the verbose output.

-h | --help

Displays usage information about this script and exits.

Exit status

0

Successful completion.

nonzero

A failure has occurred.

Security

You must have root authority to run the gsscallhomeconf script.

Example

./gsscallhomeconf -G gss_ppc64 -E ems1 --suffix=-ib --register node 
--esa-hostname-fqdn ems1.gpfs.net --esa-cert-location /tmp/esa.crt
    
    2019-05-23T02:40:35.422902 Generating node list...
    2019-05-23T02:40:36.129896 nodelist:    gssio1 gssio2
    2019-05-23T02:40:36.129933 suffix used for endpoint hostname: -ib
    End point gssio1-ib registered successfully with systemid 3ecc9e664c8ce85d6bba3f6c7c3ae523
    End point gssio2-ib registered successfully with systemid da4b3bd9d127d9285a4f73a55c232ecd
    ESA configuration for ESS Call home is complete.
    Started configuring software callhome
    Checking for ESA is activated or not before continuing.
    Fetching customer detail from ESA.
    Customer detail has been successfully fetched from ESA.
    Setting software callhome customer detail.
    Successfully set the customer detail for software callhome.
    Enabled daily schedule for software callhome.
    Enabled weekly schedule for software callhome.
    Direct connection will be used for software calhome.
    Successfully set the direct connection settings for software callhome.
    Enabled software callhome capability.
    Creating callhome automatic group
    Created auto group for software call home and enabled it.
    Software callhome configuration completed.

 
# gsscallhomeconf -E ems3 -N ems3,gss_ppc64 --suffix=-te --register=all 
--no-swcallhome --esa-hostname-fqdn ems1.gpfs.net --esa-cert-location /tmp/esa.crt

    2019-01-23T05:34:42.005215 Generating node list...
    2019-01-23T05:34:42.827295 nodelist:    ems3 essio31 essio32
    2019-01-23T05:34:42.827347 suffix used for endpoint hostname: -te
    End point ems3-te registered sucessfully with systemid 37e5c23f98090750226f400722645655
    End point essio31-te registered sucessfully with systemid 35ae41e0388e08fd01378ae5c9a6ffef
    End point essio32-te registered sucessfully with systemid 9ea632b549434d57baef7c999dbf9479
    End point enclosure SV50321280 registered sucessfully with systemid 600755dc0aa2014526fe5945981b0e08
    End point enclosure SV50918672 registered sucessfully with systemid 92aa6428102b44a4a1c9a293402b324c
    ESA configuration for ESS Callhome is complete.

Location

/opt/ibm/gss/tools/bin