Error "No API session has been established" during CLI session (KBA6777)

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

KBA

KBA# 6777

Issue

During execution of a long-running task in the Admin or System Setup CLI, a CLI session may report an error

Error: No API session has been established.
Action: Create an API session by calling /resources/json/delphix/session

Most frequently, this may be encountered after initiating tests using the Storage Performance Test Tool.

Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies

Major Release	All Sub Releases
6.0	6.0.0.0, 6.0.1.0, 6.0.1.1, 6.0.2.0, 6.0.2.1, 6.0.3.0, 6.0.3.1, 6.0.4.0, 6.0.4.1, 6.0.4.2, 6.0.5.0, 6.0.6.0 6.0.6.1, 6.0.7.0, 6.0.8.0, 6.0.8.1
5.3	5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0
5.2	5.2.2.0, 5.2.2.1, 5.2.3.0, 5.2.4.0, 5.2.5.0, 5.2.5.1, 5.2.6.0, 5.2.6.1
5.1	5.1.0.0, 5.1.1.0, 5.1.2.0, 5.1.3.0, 5.1.4.0, 5.1.5.0, 5.1.5.1, 5.1.6.0, 5.1.7.0, 5.1.8.0, 5.1.8.1, 5.1.9.0, 5.1.10.0
5.0	5.0.1.0, 5.0.1.1, 5.0.2.0, 5.0.2.1, 5.0.2.2, 5.0.2.3, 5.0.3.0, 5.0.3.1, 5.0.4.0, 5.0.4.1 ,5.0.5.0, 5.0.5.1, 5.0.5.2, 5.0.5.3, 5.0.5.4
4.3	4.3.1.0, 4.3.2.0, 4.3.2.1, 4.3.3.0, 4.3.4.0, 4.3.4.1, 4.3.5.0
4.2	4.2.0.0, 4.2.0.3, 4.2.1.0, 4.2.1.1, 4.2.2.0, 4.2.2.1, 4.2.3.0, 4.2.4.0 , 4.2.5.0, 4.2.5.1
4.1	4.1.0.0, 4.1.2.0, 4.1.3.0, 4.1.3.1, 4.1.3.2, 4.1.4.0, 4.1.5.0, 4.1.6.0

Resolution

Although it may be perceived that this error indicates a failure of the activity in question, it is ultimately benign. The message occurs when the API session times out, but no Engine job or action (Provision, Storage Test, etc) is aborted due to a session timeout. These activities run asynchronously and will complete as expected despite any session timeout.

Any pending CLI transaction that has not been committed (indicated by asterisk in command prompt) may be discarded when the session is timed out and re-established.

To re-establish the CLI session, simply log out and log back into the Engine.

If this event occurs during a hypervisor console session (during first-time setup or storage tests, for example), exit the existing CLI session by typing exit, and log in again.

Alternatively, the job may be executed asynchronously, by setting the global CLI option setopt wait=false. This CLI feature is referenced in Product Documentation:

Asynchronous Jobs

Note:

It is currently not possible to configure the session timeout for a System Setup (sysadmin) user via GUI; this must be completed via CLI if desired. An example is provided below.

Delphix> user
Delphix user> select sysadmin
Delphix user 'sysadmin'> ls
Properties
    type: User
    name: sysadmin
    apiUser: true
    authenticationType: NATIVE
    emailAddress: user.name@domain.com
    enabled: true
    firstName: (unset)
    homePhoneNumber: (unset)
    isDefault: true
    lastName: (unset)
    locale: en-US
    mobilePhoneNumber: (unset)
    passwordUpdateRequest: NONE
    principal: sysadmin
    publicKey: (empty)
    reference: USER-1
    sessionTimeout: 30min
    userType: SYSTEM
    workPhoneNumber: (unset)

Operations
delete
update
disable
enable
updateCredential
Delphix user 'sysadmin'> update
Delphix user 'sysadmin' update *> set sessionTimeout=180
Delphix user 'sysadmin' update *> commit

The following articles may provide more information or related information to this article:

KBA

Issue

Delphix Versions

Resolution

Related Articles