apiRollingRestartClusterArgs
Arguments used for Rolling Restart Cluster command.
JSON
| property | type | description |
|---|---|---|
| slaveBatchSize | slaveBatchSize (int) | Number of hosts with slave roles to restart at a time. Must be greater than zero. Default is 1. |
| sleepSeconds | sleepSeconds (int) | Number of seconds to sleep between restarts of slave host batches. Must be greater than or equal to 0. Default is 0. |
| slaveFailCountThreshold | slaveFailCountThreshold (int) |
The threshold for number of slave host batches that are allowed to fail
to restart before the entire command is considered failed.
Must be greather than or equal to 0. Default is 0.
This argument is for ADVANCED users only. |
| staleConfigsOnly | staleConfigsOnly (boolean) | Restart roles with stale configs only. |
| unUpgradedOnly | unUpgradedOnly (boolean) | Restart roles that haven't been upgraded yet. |
| redeployClientConfiguration | redeployClientConfiguration (boolean) | Re-deploy client configuration. Available since API v6. |
| rolesToInclude | rolesToInclude (apiRolesToInclude) | Role types to restart. Default is slave roles only. |
| restartServiceNames | array of restartServiceNames (string) | List of services to restart. |