esacli locationSettings

Use the esacli locationSettings command to configure and display the system location information.

Synopsis

esacli locationSettings [-d [script]]

esacli locationSettings [-d [script]] {-c country} {-s state-or-province} 
{-z postal-code{ {-m city} {-a address}{-b building} 
{-p phone}

Description

The esacli locationSettings command configures and displays the system location information. The esacli locationSettings command enables you to display and or change the configuration settings for IBM® Electronic Service Agent instance associated with the system location. 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 locationSettings values, follow these steps:
  1. Display the current locationSettings values by running the following command:
    esacli locationSettings -d
    Tip: You can display the help for the locationSettings command by running the following command: esacli help locationSettings.
  2. Save the output of the locationSettings command to a file by running the following command:
    esacli locationSettings -d script > locations.script
  3. Edit the locations.script file to specify the wanted values.
  4. Change the locations.script file to an executable script file.
  5. Run the locations.script file to set the locationSettings values on this or other systems.
-c | --location.country country
Specifies the name of the country or region for the system location. The country must be specified as a valid two letter code as defined by ISO-3166.
-s | --location.state state
Specifies the name of the state or province where the system is located. If the location 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.
-z | --location.postal postal code
Specifies the postal code where the system is located.
-m | --location.city city
Specifies the name of the city where the system is located.
-a | --location.address address
Specifies the address where the system is located.
-b | --location.building location
Specifies the address where the system is located.
-p | --location.phone phone
Specifies the telephone number where the system is located. Valid United States and Canada telephone numbers must be between 10 and 30 alphanumeric characters and cannot contain any dashes. Other telephone numbers can include any type of character but must be between 5 and 30 characters in length.

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}.
  • 23: An invalid country or region 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}
  • 42: Invalid value {value} specified for the {option} option.

Examples

  • Display the current system location settings
    This example illustrates running the esacli locationSettings to display the current settings.
    esacli locationSettings -d
     System Location
      Country or region: United States
      State or province: NY
      Postal code: 12601
      City: Poughkeepsie
      Street address: 2455 South Rd
      Building, floor, office: 707, 1M-71
      Telephone number: 8005551212
  • Set system location values

    This example illustrates running the esacli locationSettings to set several values.

    esacli locationSettings –a “2455 South Rd.” –m “Poughkeepsie” –s “NY” –c “US” 
    –z “12601” –p “8455559464” –b “Building 707 Floor 2 Rm M71”