EngineAction

The action to perform on the child servers. Use the following option:

  • Add. Add a child server to the DIH. You must specify the Host and Port parameters to specify the host and port of the new child server. You can also:

    • add the server as online or offline using the Disabled parameter.

      NOTE: By default, when you add a child server by setting EngineAction to add, the DIH pings the specified Host and Port and the add action fails if the child server is not running. You can set Disabled to true to skip this step and add the child server in the offline state.

    • add a weight for the new server using the Weight parameter.

    • choose whether the DIH polls jobs sent to this child server, or marks the jobs as finished immediately using the Polling parameter.

    • add the child server as UpdateOnly using the UpdateOnly parameter.

  • Edit. Edit the status of the child server specified by ID. When EngineAction is set to Edit, you can:

    • bring servers online or offline using the Disabled parameter.

    • change the weight of a server using the Weight parameter.

    • change whether the DIH polls jobs sent to this child server, or marks the jobs as finished immediately using the Polling parameter.

    • edit the UpdateOnly status of a server using the UpdateOnly parameter.

    • recreate a child server that has become inaccessible, by using the Host and Port parameters to add a new child server in place of the inaccessible one. If you specify only one of Host and Port, the other remains unchanged.
  • Remove. Remove the child server specified by ID (or the child server group specified by Group). You can use this option only in UseConsistentHashing mode. Before you remove the child server or group, you must set the Weight to zero, and use the DREREDISTRIBUTE index action to redistribute the virtual nodes.

When you add, update, or remove a child server from the DIH by using the EngineManagement action, the DIH updates the configuration file so that the changes are persistent. For details of the configuration parameters that it changes, see Child Server Configuration Parameters.

Actions: EngineManagement
Type: String
Default:  
Example: EngineAction=Edit
See Also: Disabled
Group
Host
ID
Polling
Port
UpdateOnly
Weight
Polling configuration parameter
UpdateOnly configuration parameter
Weight configuration parameter
UseConsistentHashing configuration parameter