Data Object - FarmMaintenanceSpec

Class: VMware.Hv.MaintenanceSpec
Parameter to: Farm_ImageManagementScheduleMaintenance, Farm_ScheduleMaintenance
See also: FarmComputeProfileSpec, FarmImageMaintenanceSettings, FarmImageManagementMaintenanceSettings, FarmRecurringMaintenanceSettings, RDSServerId
Since: Horizon 7.1

Data Object Description

Settings for maintenance operations. This is applicable only for RDSH Instant Clone Farm

Data Object Properties

Properties

Name

Type

Description

maintenanceMode

xsd:string

The mode of schedule maintenance for Instant Clone Farm

This property will be one of:

Value	Description
"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

scheduledTime

xsd:dateTime

When to actually perform the next maintenance. For IMMEDIATE if unset, maintenance will begin immediately. For RECURRING If unset, will be calculated based on current recurring maintenance configuration. If in the past, maintenance will begin immediately.

This property need not be set.

logoffSetting

xsd:string

Determines when to perform the operation on machines which have an active session.

This property will be one of:

Value	Description
"FORCE_LOGOFF"	Users will be forced to log off when the system is ready to operate on their RDS Servers. Before being forcibly logged off, users may have a grace period in which to save their work (Global Settings).
"WAIT_FOR_LOGOFF"	Wait for connected users to disconnect before the task starts. The operation starts immediately on RDS Servers without active sessions.

stopOnFirstError

xsd:boolean

Indicates that the operation should stop on first error.

This property has a default value of true.
This property need not be set.

recurringMaintenanceSettings

FarmRecurringMaintenanceSettings

Recurring maintenance configuration settings. Required only if maintenanceMode == RECURRING

This property need not be set.
This property is required if maintenanceMode is set to "RECURRING".

imageMaintenanceSettings

FarmImageMaintenanceSettings

Settings for the Image maintenance. This is required only if maintenance is triggered using Farm_ScheduleMaintenance API.

This property need not be set.

imageManagementMaintenanceSettings

FarmImageManagementMaintenanceSettings

Settings for the Image maintenance if farm is created using image catalog. This is required only if maintenance is triggered using Farm_ImageManagementScheduleMaintenance API.

Since Horizon 7.10

This property need not be set.

selectiveScheduleMaintenance

xsd:boolean

Set to true for selective schedule maintenance. Indicates if the new image should be applied to a subset of the rds servers in the farm. The image published with this option, will be held as a pending Image, unless it is either promoted canceled.

Since Horizon 8.4