Schedule Maintenance V2
Note: This operation is applicable only to Instant clone farms. This can be used for creating both immediate or recurring maintenance. At most one schedule of both the types can co-exist at same time. Optionally user can request an update of the Image in the specified farm. This marks the old image to be replaced by new image, which is performed asynchronously. Once the new image is successfully updated, all eligible RDS servers in the farm would also be marked for update with new image, this operation is also performed asynchronously. This operation can also be used to replace an existing scheduled maintenance. Immediate maintenance will take priority over any existing scheduled recurring maintenance. Recurring maintenance for this farm will be put on hold until immediate maintenance has completed.
All the listed privileges are required -
| Privileges | Description |
|---|---|
| POOL_SVI_IMAGE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of the farm. |
Farm ID
{
"compute_profile_num_cores_per_socket": 1,
"compute_profile_num_cpus": 4,
"compute_profile_ram_mb": 4096,
"im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"im_tag_id": "3d45b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"logoff_policy": "FORCE_LOGOFF",
"maintenance_mode": "IMMEDIATE",
"next_scheduled_time": 1237081283000,
"parent_vm_id": "vm-2",
"rds_server_ids": [
"816d44cb-b486-3c97-adcb-cf3806d53657",
"414927f3-1a3b-3e4c-81b3-d39602f634dc"
],
"recurring_maintenance_settings": {
"maintenance_period": "MONTHLY",
"maintenance_period_frequency": 10,
"start_index": 2,
"start_time": "10:00"
},
"selective_schedule_maintenance": true,
"snapshot_id": "snapshot-1",
"stop_on_first_error": false
}Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.
Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.
Indicates the RAM in MB in the compute profile to be configured on clones.
New image management stream for the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.
New image management tag for the farm. This tag must be within the im_stream_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.
Determines when to perform the operation on RDS servers which have an active session.
- FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.
- WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
The mode of schedule maintenance for Instant Clone Farm.
- IMMEDIATE: All server VMs will be refreshed once, immediately or at user scheduled time.
- RECURRING: All server VMs will be periodically refreshed based on FarmInstantCloneRecurringMaintenancePeriod and StartTime
Time when next scheduled maintenance would happen. If maintenance_mode is set to IMMEDIATE and next_scheduled_time is not set, maintenance will begin immediately. If maintenance_mode is set to RECURRING and next_scheduled_time is not set, it will be calculated based on current recurring maintenance configuration. If the value is in the past, maintenance will begin immediately. Measured as epoch time.
New base image VM for the instant clone farm. This must be in the same datacenter as the base image of the farm. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.
Set of RDS servers from the farm on which the new image is to be applied. This can be set when selective_schedule_maintenance is set to true.
recurring_maintenance_settings
Indicates whether selective scheduled maintenance is to be applied. If set to true, the new image will be applied to specified rds_server_ids in the farm. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.
New base image snapshot for the instant clone farm. This must be a snapshot of the parent_vm_id. Either parent_vm_id and snapshot_id or im_stream_id and im_tag_id are to be specified.
Indicates whether the operation should stop on first error. Default value is true.
OK
[
{
"error_messages": [
"Entity does not exist.",
"Property is mandatory."
],
"errors": [
{
"error_key": "inventory.machine.not.found",
"error_message": "username cannot be empty"
}
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"key": "user1",
"status_code": 200,
"timestamp": 1561939200000
}
]Bad Request
User is not authenticated
Access to the resource is forbidden
Not Found