esacli contactSettings

Edit online

Use the esacli contactSettings command to configure the service contact information.

Synopsis

esacli contactSettings [-d [script]]

esacli contactSettings [-d [script]] {-o organization} [-a address] 
[-b address] [-h address] [-m city] [-s state] {-c country} 
[-z postal-code] [-f phone] [-g alt fax] [-q help] {-n contact name} 
{-p contact phone} [-i alt phone] {-e contact email} [-j alt email] 
[-y pager] {-w secondary name} {-k secondary contact phone} 
[-r secondary contact alt phone] {-x secondary contact email}

Description

The esacli contactSettings command configures the service contact information. The esacli contactSettings command displays and sets the configuration information for IBM® Electronic Service Agent™ instance associated with the service contact information. All required fields must be entered to run this command. All optional fields not specified will be cleared. This command will indicate that it completed successfully with a message: This command completed successfully. When the display option is specified, the new settings will be displayed. This command will also display the current settings when run with only the display option or no option is specified.

Options

-d | --display
Specifies the setting values are to be displayed.
The optional script option generates this command containing all the current values, which can be used for updates. For example, to create an executable script file that you can use to specify contactSettings values, follow these steps:
  1. Display the current contactSettings values by running the following command:
    esacli contactSettings -d
    Tip: You can display the help for the contactSettings command by running the following command: esacli help contactSettings.
  2. Save the output of the contactSettings command to a file by running the following command:
    esacli contactSettings -d script > contacts.script
  3. Edit the contacts.script file to specify the wanted values.
  4. Change the contacts.script file to an executable script file.
  5. Run the contacts.script file to set the contactSettings values on this or other systems.
-o | --organization organization
Specifies the name of the organization or company responsible for the system.
-a | --organization.address1 address
Specifies the address line 1 where the organization is located.
-b | --organization.address2 address
Specifies the address line 2 where the organization is located.
-h | --organization.address3 address
Specifies the address line 3 where the organization is located.
-m | --organization.city city
Specifies the name of the city where the organization is located.
-s | --organization.state state
Specifies the name of the state or province where the organization is located. If the organization country is set to the United States or Canada, then a valid state or province setting must be a valid 2 character state or province abbreviation.
-c | --organization.country country
Specifies the name of the country or region for the organization. The country must be specified as a valid two letter code as defined by ISO-3166. This setting cannot be cleared.
-z | --organization.postal postal_code
Specifies the postal code where the organization is located.
-f | --organization.fax phone
Specifies the facsimile (fax) number where the organization is located. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length.
-g | --organization.altfax phone
Specifies the alternate facsimile (fax) number where the organization is located. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length.
-q | --organization.help phone
Specifies the telephone help desk number for the organization. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length.
-n | --contact.name name
Specifies the name of the primary person responsible for the system. This setting cannot be cleared.
-p | --contact.phone phone
Specifies the telephone number where the primary contact person can be reached. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length. This setting cannot be cleared.
-i | --contact.altphone phone
Specifies the telephone number where the primary contact person can be reached. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length.
-e | --contact.email email
Specifies the email address for the primary contact person. This setting cannot be cleared.
-j | --contact.altemail email
Specifies the alternative email address for the primary contact person.
-y | --contact.pager phone
Specifies the pager number where the secondary contact person can be reached. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length. This number can contain a PIN number.
-w | --sec.contact.name name
Specifies the name of the secondary person in the organization responsible for the system. This setting cannot be cleared.
-k | --sec.contact.phone phone
Specifies the telephone number where the secondary contact person can be reached. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length. This setting cannot be cleared.
-r | --sec.contact.altphone phone
Specifies an alternative telephone number where the secondary contact person can be reached. Valid United States and Canada numbers must be 10 - 30 alphanumeric characters in length. Other telephone numbers must be 5 - 30 characters in length.
-x | --sec.contact.email email
Specifies the email address for the secondary contact person. This setting cannot be cleared.

Exit status

The following table contains the codes that are returned by this command.
  • 0: The operation completed successfully.
  • 1: IBM Electronic Service Agent instance is not running.
  • 10: Unsupported option was specified. Option: {option}.
  • 14: A required option was not provided. Option: {option}.
  • 18: An option was set more than once. Option: {option}.
  • 19: An option value was not provided when required. Option: {option}.
  • 22: An invalid email address was specified. Email: {email} for option {option}.
  • 23: An invalid country was specified. Country: {country}.
  • 24: An invalid phone number was specified. Phone: {Phone}
  • 25: An invalid state or province was specified. State: {State}
  • 26: An invalid postal code: {code} for country code {country code} and state/province {state/province}
  • 30: The IBM Electronic Service Agent instance is currently suspended.
  • 42: Invalid value {value} specified for the {option} option.
  • 50: The primary and secondary contacts can not be the same.

Examples

  • Display the current contact settings

    This example shows how to use esacli contactSettings to display the current settings. 

    esacli contactSettings -d
Company Information
		Company name:               IBM
		Street address Line 1:      2455 South Rd
		Line 2:                     
		Line 3:                     
		City:                       Poughkeepsie
		State or province:          NY
		Country or region:          US
		Postal code:                12603
		Fax number:                 9296307095
		Alternate fax number:       0016024545
		Help desk number:           4777736840
Primary Contact
		Contact name:               Primary Contact
		Telephone number:           0312810438
		Alternate telephone number: 6724959392
		E-mail:                     email1@ibm.com
		Alternate e-mail:           email2@ibm.com
		Pager number:               5638578295
Secondary Contact
		Contact name:               Secondary Contact
		Telephone number:           4233691129
		Alternate telephone number: 7173103933
		E-mail:                     email3@lotus.com
  • Set several values

    This example shows how to use esacli contactSettings to set several values. 

    esacli contactSettings –o IBM 
–a “2455 South Rd.”
–m “Poughkeepsie” 
–s “NY”
–c “US”
–z “12601”
–n “John Primary” 
–p “8455559464” 
–e “jd@ibm.com”
–w “Joe Backup” 
–k “8455551212” 
–x “jbackup@us.ibm.com”