Enabling and configuring call home using the installation toolkit

You can use the installation toolkit to enable and configure the call home function in the cluster definition file. Based on the call home configuration options specified in the cluster definition file using the installation toolkit, the call home function is enabled and configured in the cluster accordingly during the installation. By default, the call home function is enabled and the call home package (gpfs.callhome-ecc-client) is installed on all nodes in the cluster. If you plan to use the call home function, you must configure call home with the mandatory parameters by using the installation toolkit. For more information, see this command example.

Note: If you want to only configure and install call home for a subset of supported cluster nodes, or if you want to manually assign specific nodes to a specific call home group, see Configuring call home to enable manual and automated data upload.

The installation toolkit does not support all operating systems and platforms supported by call home. For example, the installation toolkit supports SLES and Ubuntu only on x86_64 and s390x, while call home also supports SLES and Ubuntu on Power®.

The call home node needs to have network connectivity to the IBM® Support Center because the call home node needs to upload data to IBM Support Center for all Start of change the members of its End of change call home group. The call home node must be able to reach https://esupport.ibm.com either directly or using the proxy, which is specified in the call home configuration.

For more information about the call home function, see Monitoring the IBM Spectrum Scale system by using call home.

You can specify the call home node using the installation toolkit by issuing the following command:

./spectrumscale node add -c CallHomeNode

Note: This step is not mandatory. If a call home node is not specified, the installation toolkit assigns one of the nodes in the cluster as the call home node.

You can specify more than one node with this command. Start of change

It is recommended to have at least one call home node for every 128 call home group members to prevent potential performance issues. End of change

To configure call home options in the cluster definition file by using the installation toolkit, use the ./spectrumscale callhome command as follows.

To enable the call home in the cluster definition file by using the installation toolkit, issue the following command.
```
./spectrumscale callhome enable
```
A sample output is as follows.
```
[ INFO  ] Enabling the callhome.
[ INFO  ] Configuration updated.
```
Note: By default, call home is listed as enabled in the cluster definition file.
To disable the call home in the cluster definition file by using the installation toolkit, issue the following command.
```
./spectrumscale callhome disable
```
A sample output is as follows.
```
[ INFO  ] Disabling the callhome.
[ INFO  ] Configuration updated.
```
The call home function is enabled by default in the cluster definition file. If you disable it in the cluster definition file, when you issue the ./spectrumscale install command, the call home packages are installed on the nodes but no configuration is done.

To specify the call home configuration settings in the cluster definition file by using the installation toolkit, issue the ./spectrumscale callhome config command. The following command example shows configuring the mandatory call home parameters:

./spectrumscale callhome config -n username -i 456123 -e username@example.com -cn US

A sample output is as follows.

[ INFO  ] Setting Customer name to username
[ INFO  ] Setting Customer id to 456123
[ INFO  ] Setting Customer email to username@example.com
[ INFO  ] Setting Customer country to US

You are then prompted to accept or decline the support information collection message.

By accepting this request, you agree to allow IBM and its subsidiaries to store and use 
your contact information and your support information anywhere they do business worldwide. For more 
information, please refer to the Program license agreement and documentation. If you agree, please 
respond with 'accept' for acceptance, else with 'not accepted' to decline: accept

If you accept, the following output is displayed.

[ INFO  ] License is accepted so the call home will be configured, if it is enabled.
[ INFO  ] Configuration is updated.

Note: You can specify the -a parameter with ./spectrumscale callhome config to accept the support information collection message in advance.

To clear the call home configuration specified in the cluster definition file by using the installation toolkit, issue the ./spectrumscale callhome clear command. For example:
```
./spectrumscale callhome clear -i -e -cn
```
A sample output is as follows.
```
[ INFO  ] Clearing Customer id
[ INFO  ] Clearing Customer email
[ INFO  ] Clearing Customer country
```
To schedule the call home data collection in the cluster definition file by using the installation toolkit, issue the ./spectrumscale callhome schedule command. For example:
```
./spectrumscale callhome schedule -d
```
A sample output is as follows.
```
[ INFO  ] Setting scheduling to daily.
[ INFO  ] Configuration is updated.
```
If call home data collection is scheduled daily, data uploads are by default executed at 02:xx AM each day. If call home data collection is scheduled weekly, data uploads are by default executed at 03:xx AM each Sunday. In both cases, xx is a random number from 00 to 59.

You can use the ./spectrumscale callhome schedule -c command to clear the call home data collection schedule.

To list the call home configuration settings in the cluster definition file by using the installation toolkit, issue the following command.

./spectrumscale callhome list

A sample output is as follows.

[ INFO  ] Current settings are as follows:
[ INFO  ] Callhome is enabled.
[ INFO  ] Schedule is daily.
[ INFO  ] Setting Customer name to username
[ INFO  ] Setting Customer id to 456123
[ INFO  ] Setting Customer email to username@example.com
[ INFO  ] Setting Customer country to US
[ WARN  ] No value for Proxy ip in clusterdefinition file.
[ WARN  ] No value for Proxy port in clusterdefinition file.
[ WARN  ] No value for Proxy user in clusterdefinition file.
[ WARN  ] No value for Proxy password in clusterdefinition file.

Note: These call home configuration-related changes become effective after the installation procedure, initiated with ./spectrumscale install, is completed.

For detailed information on the ./spectrumscale callhome command options, see spectrumscale command.