psm setup

This command connects your installation of the command-line interface to your Oracle Cloud identity domain. You can connect either over basic authorization or OAuth.


psm setup

When you issue this command, PSM prompts you to enter values for each of the parameters described below unless you specify a payload file by using the ––config-payload parameter.


All parameters are required unless otherwise noted.

Parameter Description
Username The user name for your Oracle Cloud account.
Password The password for your Oracle Cloud account.
Identity domain The identity domain for your Oracle Cloud account.
Region (Optional) Your geographical region. Valid values are: us, emea or aucom.

Default: us

Output format (Optional) The valid values for command output, are: short, json , html.

Default: short

Use Oauth (Optional) A yes/no flag that determines whether you want to communicate with the PSM REST API over Oauth or use basic authorization. Selecting y will launch additional prompts, as described below.

Default: n

Client ID (Optional; required only if you selected to use OAuth) The identifier for your client, as provided by Identity Cloud Service.
Client Secret (Optional; required only if you selected to use OAuth) The secret passcode for your client, as provided by Identity Cloud Service.
Access Token Server (Optional; required only if you selected to use OAuth) URL to the access token server. This value is derived from the identity domain specified. You should accept the default unless you want to use a different server than the default.
-c|--config-payload pathToPayloadFile (Optional) Specifies the path to the configuration payload, a JSON file containing the user parameters for this account. If you use this option, you will not be prompted for the preceding parameters. Payload Exampleshows a properly-formatted payload file. See Configuring the CLI by Using a Profile.
-p|--print (Optional) Print the PSM options.
-v|--version (Optional) Print the PSM version.

Payload Example

If you configure a CLI implementation by using the --config-payload parameter, you need to point to a payload file that takes the following format (required parameters are so indicated):


This example shows manual configuration:

$ psm setup
Retype Password: 
Identity domain: ExampleDomain
Region [us]: emea
Output format [json]: html
Use Oauth [n]
'psm setup' was successful. Available services are:

  o ANALYTICS : Oracle Analytics Cloud
  o APICS : Oracle API Platform Cloud Service
  o APICatalog : Oracle API Catalog Service
  o BDCSCE : Oracle Big Data Cloud Service - Compute Edition
  o BOTSCFG : Oracle Bots Configuration Service
  o BOTSCON : Oracle Bots Connector Service
  o BOTSINT : Oracle Bots Intent Service
  o BOTSMGM : Oracle Bots Management API Service
  o BOTSPIP : Oracle Bots Pipeline Service
  o BigDataAppliance : Oracle Big Data Cloud Service
  o CONTAINER : Oracle Container Cloud Service

This example shows how to configure the PSM CLI by using a profile:

$ psm setup -c /home/templates/psm-setup-payload.json

This example shows how to use the-p option with PSM CLI:

$ psm setup -p 
Identity Domain:                   idcs-12345678910
Region:                            us
Output Format:                     short
Oracle PaaS Version:               18.2.6-551
Oracle PaaS CLI Client Version:    1.1.24