Changing Administrator Account Preferences

When logged in to the Service CLI you can change certain settings for your own administrator account. Those changes take effect immediately and are persisted for all your future CLI connections.

However, you can also change settings temporarily for just your current CLI session. To do so, replace the object UserPreference with CliSession in the command examples below.

Setting Options Description

alphabetizeMode

YES, NO

Enable this setting to display any managed object's attributes in alphabetical order. The default setting is "No".

attributeDisplay

DISPLAYNAME, ATTRIBUTENAME

Use this setting to control whether the name of each object's attribute is displayed. The default setting is "displayName".

endLineCharsDisplayValue

CRLF, CR, LF

Specify the end-of-line character to be used when the CLI output consists of multiple lines. The default setting is "CRLF".

outputMode

VERBOSE, SPARSE, XML

Specify the CLI output format. The default setting is "Sparse".

wsCallMode

SYNCHRONOUS, ASYNCHRONOUS

Use this setting to determine whether the CLI output from a command is invoked synchronously or asynchronously. The default setting is "Asynchronous".

wsTimeoutInSeconds

<value>

When the CLI is set to "Synchronous" call mode, use this setting to determine how many seconds the CLI waits for a job returned by an operation to complete.

Using the Service CLI

  1. Display your current account preferences.

    PCA-ADMIN> show UserPreference
    Command: show UserPreference
    Status: Success
    Time: 2021-08-25 12:23:41,265 UTC
    Data:
      Id = ec433c0f-4208-4e92-859e-498218d0f5c9
      Type = UserPreference
      WS Call Mode = Asynchronous
      Alphabetize Mode = No
      Attribute Display = Display Name
      End Line Characters Display Value = CRLF
      Output Mode = Verbose
      Command Wait Timeout In Seconds = 240
      UserId = id:401fce73-5bee-48b1-b86d-fba1d85e049b  type:User  name:admin
  2. Change the setting of your choice using the edit userPreference command.

    PCA-ADMIN> edit UserPreference outputMode=XML
    Command: edit UserPreference outputMode=XML
    Status: Success
    Time: 2021-08-25 12:32:02,102 UTC
    JobId: 9d312d9b-6169-47cb-97d4-6a8984237fa0
  3. Execute the same command for any other settings you wish to change.

  4. Display your current account preferences again to verify the changes you made.

    PCA-ADMIN> show UserPreference
    Command: show UserPreference
    Status: Success
    Time: 2021-08-25 12:32:40,664 UTC
    Data:
      Id = ec433c0f-4208-4e92-859e-498218d0f5c9
      Type = UserPreference
      WS Call Mode = Asynchronous
      Alphabetize Mode = No
      Attribute Display = Display Name
      End Line Characters Display Value = CRLF
      Output Mode = Xml
      Command Wait Timeout In Seconds = 180
      UserId = id:401fce73-5bee-48b1-b86d-fba1d85e049b  type:User  name:admin