psm caching stop

Use this command to stop an Oracle Application Container Cloud Service application cache.

Syntax

psm caching stop 
-s|--service-name name 
-c|--config-payload payload-file 
[-of|--output-format json|html|short]

Parameters

All parameters are required unless otherwise noted.

Parameter Description
-s, --service-name Name of the cache.
-c, --config-payload Name of the JSON file that contains configuration information for the application cache.

-of|--output-format json|html|short

(Optional) Specifies the output format of the command’s response:

  • json—output is formatted as a JSON array.

  • html—output is formatted as HTML

  • short—output is formatted as a brief summary.

The default output format is the one you specified when using the psm setup command to configure the psm CLI.

Payload File Properties

All properties are required unless otherwise noted.

Parameter Description
force (Optional) Forces the cache to stop despite any PaaS script failures.
allServiceHosts (Optional) Stops all cluster members of the cache.

Example

The contents of the stop—start-payload.json file referenced in the command are:

{
    "force":"true",
    "allServiceHosts":"true"
}

The example command and its output are:

$ psm caching stop -s MyCacheService -c stop-start-payload.json
{
    "details":{
        "jobId":"23774",
        "message":"Submitted job to [stop] VMs in service [MyCacheService] in domain [apaasuser]."
    }
}
Job ID : 23774

More Information

Exploring the Cache Service Overview Page in Using Caches in Oracle Application Container Cloud Service