psm analytics stop

Use this command to stop a service created with Oracle Analytics Cloud - Classic.


In the following syntax, line breaks have been added for clarity. Do not include them when entering the command.

psm analytics stop -s|--service-name service-name 
  -c|--config-payload path-to-json-payload
    [-of|--output-format json|html|short]


All parameters are required unless otherwise noted.

Parameter Description

-s|--service-name service-name

Specifies the name of the service.


Path to the JSON file that contains the configuration parameters for accessing the service.

-of|-–output-format (Optional) Desired output format.

Accepted values: json, html, short

JSON Payload

The JSON payload has the following syntax:

Parameter Description


(Optional) Set to True to force the operation, even if blocking errors are generated.


(Optional) Set to True to apply the command to all host names associated with the service name. This parameter can be the only parameter in the payload.


Container for the analytics component and host information.


The service type.


The host name of the service. The host name is the fully qualified name of the Virtual Machine. For example, in a service named analytics, the host name takes the format analytics-bi-1.


The following example stops the Example1Service service.

$ psm analytics stop -s Example1Service -c /tmp/stop-service-payload.json 
Job ID : 34348

The payload for this command can be one of the following:




Note that this command returns a job ID. To see the status of your stop operation, use this ID with the psm analytics operation-status command:

$ psm analytics operation-status -j 34348

When you see the message:


the service was successfully stopped.