Apache CloudStack 4.21.0.0 Root Admin API Reference
prepareForMaintenance
Prepares management server for maintenance by preventing new jobs from being accepted after completion of active jobs and migrating the agents
Request parameters
| Parameter Name | Description | Required |
| managementserverid | the id of the management server | true |
| algorithm | indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered | false |
| forced | Force management server to maintenance after the maintenance window timeout, default is false | false |
Response Tags
| Response Name | Description |
| agents | The host agents this management server is responsible for |
| agentscount | The number of host agents this management server is responsible for |
| maintenanceinitiated | Indicates whether maintenance has been initiated |
| managementserverid | The id of the management server |
| pendingjobscount | The number of jobs in progress |
| readyforshutdown | Indicates whether CloudStack is ready to shutdown |
| shutdowntriggered | Indicates whether a shutdown has been triggered |
| state | the state of the management server |