Call Home - list configuration parameters

Lists the configuration parameters for the Call Home feature. When enabled, this feature can monitor, track, and capture system hardware errors and service information, and report them to IBM® Support. The command-line interface for the console uses a local cache. There are two commands:

admin.callhome

This command displays the configuration parameters for the Call Home feature that are stored in the local cache. If there are no values in the local cache, the command retrieves the most recent configuration parameters for the Call Home feature from IBM Cloud Pak System Software for x86, places them in the local cache, and displays them.

admin.callhome.refresh()

This command retrieves the most recent configuration parameters for the Call Home feature from IBM Cloud Pak System Software for x86, places them in the local cache, and displays them.

Output:


{
  "callhome_collect_logs": True,
  "callhome_create_service_ticket": True,
  "callhome_upload_logs": True,
  "company_address_line1": "123 abc st",
  "company_address_line2": "suite 3",
  "company_address_line3": "",
  "company_alternate_email": "jdoe2@bigbox.com",
  "company_alternate_fax": "",
  "company_alternate_phone": "555-345-6789",
  "company_city": "Minneapolis",
  "company_contact_name": "John Doe",
  "company_contact_preference": "email",
  "company_country_or_region": "US",
  "company_fax": "555-234-5678",
  "company_language_preference": "English",
  "company_name": "Big Box Company",
  "company_pager_number": "555-456-7890",
  "company_phone": "555-123-4567",
  "company_phone_extension": "2",
  "company_postal_code": "55556",
  "company_primary_email": "jdoe1@bigbox.com",
  "company_state_or_province": "MN",
  "ftp_proxy_enabled": False,
  "ftp_proxy_host_name": "",
  "ftp_proxy_port": "",
  "ftp_proxy_pw": "",
  "ftp_proxy_requires_authentication": False,
  "ftp_proxy_user": "",
  "http_proxy_enabled": True,
  "http_proxy_host_name": "172.15.248.104",
  "http_proxy_port": "3128",
  "http_proxy_pw": None,
  "http_proxy_requires_authentication": False,
  "http_proxy_user": "",
  "system_additional_information": "Email Nick for access to the system",
  "system_address": "123 abc st",
  "system_aisle": "5",
  "system_altitude_in_meters": "500",
  "system_building": "102",
  "system_city": "St. Paul",
  "system_country_or_region": "US",
  "system_floor": None,
  "system_height_in_centimeters": "52",
  "system_phone": "555-567-8901",
  "system_phone_extension": "3",
  "system_postal_code": "55555",
  "system_room_number": "100",
  "system_row": "2",
  "system_state_or_province": "MN"
}

The available parameters use a certain naming convention, depending on the category they belong to:

Parameters that start with callhome are used for the call home configuration.
Parameters that start with company are used for the company contact information.
Parameters that start with ftp_proxy and http_proxy are used for the proxy configuration in case the system cannot access IBM directly.
Parameters that start with system are used for the system information.

callhome_collect_logs: Collect log files if a Call Home event occurs. This option can be specified only if the callhome_create_service_ticket parameter is set to true.
callhome_create_service_ticket: Create a service ticket with IBM Support if a Call Home event occurs.
callhome_upload_logs: Upload log files if a Call Home event occurs. This option can be specified only if both the callhome_create_service_ticket and callhome_collect_logs parameters are set to true.
company_address_line1: The company street address line 1.
company_address_line2: The company street address line 2.
company_address_line3: The company street address line 3.
company_alternate_email: The company alternative email.
company_alternate_fax: The company alternative fax number.
company_alternate_phone: The company alternative phone number.
company_city: The company city.
company_contact_name: The name of the company contact person. This parameter is required.
company_contact_preference: The contact preference for the company contact person. Valid options are: email, mail, voice, pager, and fax.
company_country_or_region: The company country or region. This parameter is required.
company_fax: The company fax number.
company_language_preference: The language preference for the company contact person.
company_name: The company name. This parameter is required.
company_pager_number: The company pager number.
company_phone: The company telephone number. This parameter is required.
company_phone_extension: The company telephone extension number.
company_postal_code: The company postal code.
company_primary_email: The company email address. This parameter is required.
company_state_or_province: The company state or province.
ftp_proxy_enabled: Enables or not the use of an FTP proxy server to send large files to IBM. If set to true, you must also set the ftp_proxy_host_name and ftp_proxy_port parameters.
ftp_proxy_host_name: The host name or IP address of the FTP proxy server.
ftp_proxy_port: The port number of the FTP proxy server.
ftp_proxy_pw: The password for the user to access the FTP proxy server.
ftp_proxy_requires_authentication: Specifies if the FTP proxy server requires authentication. If set to true, you must also set the ftp_proxy_user and ftp_proxy_pw parameters.
ftp_proxy_user: The user identifier to access the FTP proxy server.
http_proxy_enabled: Enables or not the use of an HTTP or HTTPS proxy server to communicate with IBM. If set to true, you must also set the http_proxy_host_name and http_proxy_port parameters.
http_proxy_host_name: The host name or IP address of the HTTP or HTTPS server.
http_proxy_port: The port number of the HTTP or HTTPS proxy server.
http_proxy_pw: The password for the user to access the HTTP or HTTPS proxy server.
http_proxy_requires_authentication: Specifies if the HTTP or HTTPS proxy server requires authentication. If set to true, you must also set the http_proxy_user and http_proxy_pw parameters.
http_proxy_user: The user identifier to access the HTTP or HTTPS proxy server.
system_additional_information: Additional information about the system.
system_address: The street address where the system is located. This parameter is required.
system_aisle: The aisle in the building where the system is located.
system_altitude_in_meters: The altitude, in meters, of the building where the system is located.
system_building: The building where the system is located. This parameter is required.
system_city: The city where the system is located. This parameter is required.
system_country_or_region: The country or region where the system is located in. This parameter is required.
system_floor: The floor in the building where the system is located in.
system_height_in_centimeters: The system height, in centimeters.
system_phone: The telephone number at the place where the system is located. This parameter is required.
system_phone_extension: The telephone number extension at the place where the system is located.
system_postal_code: The postal code at the place where the system is located. This parameter is required.
system_room_number: The room number where the system is located in.
system_row: The row in the building where the system is located in.
system_state_or_province: The state or province where the system is located in. This parameter is required.