Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The JITL MaintenanceWindowJob template can be used by a job to switch-over and to switch-back clustered JS7 cluster componentsproducts.

  • The job template is used to switch-over between active and passives cluster instances of JOC Cockpit, Controller and Agents.
  • The job template cannot be used for standalone instances of JOC Cockpit and Controller.

The job template makes use of the JS7 - REST Web Service API to in order to stop or to put JS7 components products in maintenance mode.

...

  • specify the JITL job class and com.sos.jitl.jobs.maintenance.MaintenanceWindowJob Java class name and add arguments specifying what components products to switch-over as explained in the documentation below.

...

  • Required arguments include the state argument specifying:
    • inactive:  indicates a switch-over in which the component product is set to the inactive state.
    • active:  indicates a switch-back in which the component product is set to the active state.
  • The controller_host and joc_host arguments specify the host name of the Controller and JOC Cockpit for switch-over or switch-back.
    • Either one or both of these arguments can be used.
    • The controller_id argument has to be used if the JOC Cockpit is connected to more than one Controller. The Controller ID is the unique identifier of a Standalone Controller or Controller Cluster.
  • The agent_ids and subagent_ids arguments specify Agents that should be disabled during switch-over and enabled during switch-back.
  • The controller_host, joc_hostagent_ids and subagent_ids arguments can be used at the same time to perform switch-over and switch-back operations for all components products from a single job.
  • Select the check box provided with each argument if you want this argument to be added to the arguments of the MaintenanceWindowJob template.

...

NameRequiredDefault ValuePurposeExample
stateyes

Desired state of the JS7 componentproduct

  • inactive:  indicates a switch-over operation by which the component product is set to the inactive state.
  • active:  indicates a switch-back operation by which the component product is set to the active state.
inactive

controller_id

no

Specifies the identifier of a Standalone Controller or Controller Cluster

  • if the controller_host argument is used and
  • if the JOC Cockpit is connected to more than one Controller.
controller_prod

controller_host

no

Specifies the host name of the Controller should a switch-over or switch-back operation for a Controller be performed.

controller-2-0-primary

joc_host

no

Specifies the host name of the JOC Cockpit instance should a switch-over or switch-back operation for JOC Cockpit be performed.

joc-2-0-primary
agent_idsno
Specifies the unique identifiers of Agents that should be disabled during switch-over and enabled during switch-back operations.
subagent_idsno
Specifies the unique identifiers of Subagents that should be disabled during switch-over and enabled during switch-back operations.

...