Schedule Maintenance

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.

Request

URI

POST

https://{api_host}/rest/inventory/v1/farms/{id}/action/schedule-maintenance

COPY

Path Parameters

string

Required

Farm ID

Request Body

FarmMaintenanceSpec of type(s) application/json

Required

{
    "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",
    "recurring_maintenance_settings": {
        "maintenance_period": "MONTHLY",
        "maintenance_period_frequency": 10,
        "start_index": 2,
        "start_time": "10:00"
    },
    "snapshot_id": "snapshot-1",
    "stop_on_first_error": false
}

string

im_stream_id

Optional

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.

string

im_tag_id

Optional

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.

string

logoff_policy

Required

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.

Possible values are : FORCE_LOGOFF, WAIT_FOR_LOGOFF,

string

maintenance_mode

Required

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

Possible values are : IMMEDIATE, RECURRING,

integer As int64 As int64

next_scheduled_time

Optional

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.

string

parent_vm_id

Optional

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.

FarmRecurringMaintenanceSettingsSpec

recurring_maintenance_settings

Optional

recurring_maintenance_settings

string

snapshot_id

Optional

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.

boolean

stop_on_first_error

Optional

Indicates whether the operation should stop on first error. Default value is true.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

204

No Content

Operation doesn't return any data structure

400