Page History
...
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 products in maintenance mode.
- The job template authenticates with the JS7 - REST Web Service API with a user account/password and/or a certificate, for details see JS7 - Authentication.
- For details about configuration items see JS7 - JITL Common Authentication.
Display feature availability | ||
---|---|---|
|
Usage
When defining the job either:
- invoke the Wizard that which is available from the job properties tab in the Configuration view and select the JITL MaintenanceWindowJob and relevant arguments from the Wizard
...
- specify the
JITL
job class andcom.sos.jitl.jobs.maintenance.MaintenanceWindowJob
Java class name and add arguments specifying what components products to switch-over as explained in the documentation below.
...
In a next step invoke the job wizard that which you will find in the upper right corner of the job property editor. The wizard brings up the following popup window:
...
- Required arguments include the
state
argument to specify specifying:inactive
: indicates a switch-over by in which the component product is set to the inactive state.active
: indicates a switch-back by in which the component product is set to the active state.
- The
controller_host
andjoc_host
arguments specify the host name of the Controller and JOC Cockpit for switch-over or switch-back.- One of the Either one or both of these arguments can be used and both 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
andsubagent_ids
arguments specify Agents that should be disabled during switch-over and enabled during switch-back. - The
controller_host
,joc_host
,agent_ids
andsubagent_ids
arguments can be used at the same time to perform switch-over and switch-back operations for all 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.
...
The MantenanceWindowlJob class accepts the following arguments:
Name | Required | Default Value | Purpose | Example |
---|---|---|---|---|
state | yes | Desired state of the JS7 |
product:
|
|
| inactive | |||
| no | Specifies the identifier of a Standalone Controller or Controller Cluster
| controller_prod | |
| 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 | |
| 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_ids | no | Specifies the unique identifiers of Agents that should be disabled during switch-over and enabled during switch-back operations. | ||
subagent_ids | no | Specifies the unique identifiers of Subagents that should be disabled during switch-over and enabled during switch-back operations. |