Configuring the Command Line Interface

Prior to running CLI commands, configure your connection to the Oracle Cloud.

Basic Configuration

  1. Run the setup command.
    psm setup
  2. When prompted, enter your cloud user name, password, and identity domain.

    For example:

    Username: myuser321
    Password:
    Retype Password:
    Identity domain: MyIdentityDomain54321

    Note:

    If you are configuring your CLI for use with Identity Cloud Service (IDCS), you need to enter your IDCS tenant name rather than your identity domain. The IDCS tenant name is usually a lengthy string of characters preceded by a service ID, for example, idcs-6********. To find your IDCS tenant name:
    1. From your My Services dashboard, click Identity Cloud.

    2. In the Service Instances section of the service page, hover over the Service Instance URL and copy the link location. The tenant name begins with the characters idcs- and then is followed by a string of numbers and letters, for example, idcs-6********.identity.oraclecloud.com.

      Alternatively, the Oracle Identity Cloud Service tenant name appears in the browser URL when you click My Services to log in or if you click Open Admin Console from the Service Instances section.

  3. Enter your cloud data center region based on the REST API server that you identified earlier:
    • If your REST API server contains the text emea , enter emea.
    • If your REST API server contains the text aucom , enter aucom.
    • Otherwise accept the default value, us .

    For example:

    Region [us]: emea

    Note:

    Only Oracle Cloud at Customer This topic applies only to Oracle Cloud at Customer.

    Using Oracle Cloud at Customer you must specify a URL to the Oracle Cloud at Customer machine (https://example.com) a hostname instead of a region name.

  4. Enter your preferred output format or accept the default value:
    • short (this is the default); this output displays only a few important properties:
       Service:                    JCS1
       Status:                     Ready
       Version:                    12.2.1.2.171220
       Edition:                    Enterprise Edition
       Compute Site:               N/A
       Cloud Storage Container:    https://ocloud.storage.oraclecloud.com/v1/Storage-ocloud/JCS
       Created On:                 2018-02-21T17:43:02.955+0000
      
    • json; this output appears in a standard JSON format:
      {
          "serviceId":529421,
          "serviceUuid":"***",
          "serviceLogicalUuid":"***",
          "serviceName":"JCS1",
          "serviceType":"JaaS",
          "domainName":"idcs-***",
          "serviceVersion":"12cRelease212",
          "releaseVersion":"12.2.1.2.171220",
          "baseReleaseVersion":"12.2.1.2.171220",
          "metaVersion":"18.2.2-1805081521",
          "serviceLevel":"PAAS",
          "subscription":"HOURLY",
          "meteringFrequency":"HOURLY",
          "edition":"EE",
          "totalSSDStorage":0,
          "storageContainer":"https://ocloud.storage.oraclecloud.com/v1/Storage-ocloud/JCS",
          "state":"READY",
          "serviceStateDisplayName":"Ready",
          "clone":false,
          "creator":"example_name@oracle.com",
          "creationDate":"2018-02-21T17:43:02.955+0000",
          "serviceEntitlementId":"****",
          "isBYOL":false,
          "isSharedManaged":false,
          "isNonSharedmanaged":false,
          "isDefaultManaged":false,
          "isManaged":false,
          "isOAuthForStorageConfigured":false,
          "iaasProvider":"NIMBULA",
          "attributes":{
      .
      .
      .
    • html ; this produces HTML that you can redirect to a file or copy and then paste to a file:

    For example:

    Output format [short]: json
  5. If you want to communicate with the PSM REST API over Oauth, at the Use OAuth? prompt type y.
    • If you select the default (n), communication between the CLI and the REST API will continue to use basic authorization.

    • If you select y, you will be further prompted for your OAuth credentials, specifically your Client ID and Client Secret (the Access Token Server is derived from the identity domain and the prompt is optional).

      To obtain the OAuth credentials:
      1. Go to Oracle Identity Cloud Service Console. For more information, see Administering Oracle Identity Cloud Service

      2. Sign in to the console as a user with the Application Administrator or Identity Domain Administrator role.

      3. Click navigation icon in the top corner of the page and then click Applications.

      4. Click PSMApp-cacct-<GUID>

      5. Click the Configuration tab:


        Description of pscli_oauth_secret.png follows
        Description of the illustration pscli_oauth_secret.png
      6. Locate the Client ID

      7. Click Show Secret

      Enter a URL (only if you are using a different server):
      Use OAuth? [n]: y
      Client ID: myPlatApp-ccact-568c865cbfb64d5f1245d9012fru72_APPID
      Client Secret: def21eb7-cab0-42b9-99af-21c1234f08f5
      Access Token Server [default]: https://myCorp.identity.mydev1.ab1qadev.com/oauth2/v1/token

After the CLI successfully connects to the Oracle Cloud, it will list the available services in this cloud account. For example:

----------------------------------------------------
'psm setup' was successful. Available services are:
  o JaaS : Oracle Java Cloud Service
  o accs : Oracle Application Container Cloud Service
  o dbcs : Oracle Database Cloud Service
  o elasticSearch : Oracle Elasticsearch Service
  o stack : Oracle Cloud Stack Manager
.
.
.
----------------------------------------------------

Note:

You can further customize the output level for all CLI commands with the log command. The default level is info.