psm MySQLCS stop
Stop an MySQL Cloud Service instance.
Syntax
In the following syntax, line breaks have been added for clarity. Do not include them when entering the command.
psm MySQLCS stop -s|--service-name instance-name
-c|--config-payload path-to-json-payload
[-wc|--wait-until-complete true|false]
[-of|--output-format json|html|short]
Parameters
Parameter | Description |
---|---|
|
Specifies the name of the MySQL Cloud Service instance. |
|
Specifies the path to the JSON payload file. |
|
(Optional) If set to Waiting for the job to complete... (it cannot be cancelled) The default value is |
|
(Optional) Specifies the output format of the command’s response:
The default output format is the one you specified when using the |
JSON Payload
The json payload has the following syntax:
{
"force":"",
"allServiceHosts":"",
"components":{
"mysql":{
"hosts":""
}
}
}
Parameter | Description |
---|---|
|
(Optional) Set to |
|
(Optional) set to |
|
Container for the MySQL 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 MySQL57–aas, the host name takes the format mysql57–aas-mysql-1. |
Examples
The following example stops the MySQL57–aas
service.
$ psm MySQLCS stop -s MySQL57–aas -c /tmp/stop-service-payload.json
The payload for this command can be one of the following:
{
"components":{
"mysql":{
"hosts":"[mysql57–aas-mysql-1]"
}
}
}
or
{
"allServiceHosts":"true"
}